bugGNU Octave - Bugs: bug #38862, HTML manual "seealso"...

 
 

bug #38862: HTML manual "seealso" links do not work

Submitter:  Mike Miller <mtmiller>
Submitted:  Wed 01 May 2013 03:45:19 AM UTC
   
 
Category:  Documentation Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Documentation
Status:  Fixed Assigned to:  None
Originator Name:  Open/Closed:  * Closed
Release:  * dev Operating System:  * Any
Fixed Release:  None Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Wed 19 Jun 2013 03:35:57 AM UTC, comment #2: 

I've known about this for a while.  It seems rather lame that we should have to code around a bug in Texinfo that they have acknowledged and fixed.  On the other hand, I think plenty of people will be using Texinfo 4.X for at least another two years.

I modified all the documentation and the munge-texi.pl script to use the prefix 'docX' instead of 'doc-' and HTML links now work for me.  See this changeset (http://hg.savannah.gnu.org/hgweb/octave/rev/7eff3032d144).

Rik <rik5>
Group administrator
Wed 01 May 2013 05:39:43 AM UTC, comment #1: 

I'm seeing this also.

Ben Abbott <bpabbott>
Group Member
Wed 01 May 2013 03:45:19 AM UTC, original submission:  

The "seealso" links from one function to another in the HTML manual do not link to the correct target. The links from the "Function Index" do work correctly. The pdf and info manuals work correctly.

I have narrowed this down to a bug in texinfo 4.x that has been fixed in 5.0 and higher. The links generated between the @anchor and @ref tags are not consistent in 4.x if they contain non-alphanumeric characters (ours are "doc-FUNCTION").

For example:

  1. browse to http://www.gnu.org/software/octave/doc/interpreter/Utility-Functions.html
  2. click on "round" in ceil's seealso list
  3. observe the resulting wrong anchor in the address bar and page has not scrolled to the round function


The anchor target should be "#doc_002dround" but the link ends up going to "#doc%2dround".

Now that bug #38392 is fixed, one way to fix this would be to just make sure the official Octave releases and the manual published to the web site are always built with texinfo >= 5.0.

Or change munge-texi.pl to remove the "-" from function anchors and texinfo 4.x should be happy as well.

Mike Miller <mtmiller>
Group Member

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by rik5 (Posted a comment)
  • -email is unavailable- added by bpabbott (Posted a comment)
  • -email is unavailable- added by mtmiller (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only group members can vote.

     

    Follow 3 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2013-06-19 rik5 StatusConfirmed Fixed
        Open/ClosedOpen Closed
    2013-05-01 bpabbott StatusNone Confirmed

    Back to the top

    Powered by Savane 3.13-f8d8.
    Corresponding source code