bugGNU Octave - Bugs: bug #64752, [request] make the...

 
 

bug #64752: [request] make the "next" hyperlink take you the next page, even if deeper in the hierarchy

Submitter:  None
Submitted:  Thu 05 Oct 2023 06:08:23 PM UTC
   
 
Category:  Documentation Severity:  2 - Minor
Priority:  3 - Low Item Group:  Feature Request
Status:  Need Info Assigned to:  None
Originator Name:  tj Originator Email:  -email is unavailable-
Open/Closed:  * Open Release:  * stable
Operating System:  * Any Fixed Release:  None
Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Jump to the original submission

Sat 06 Jan 2024 02:50:59 PM UTC, comment #7: 

With the development version and with conversion done with C, the change in customization need to be set through the API. I attach an updated .pm file.

I have not tested with the current version.

(file #55533)

Patrice Dumas <pertusus>
Sat 14 Oct 2023 09:25:33 AM UTC, comment #6: 

It is possible, there is a direction that corresponds to next in reading order, called 'Forward' (and there is one for previous in reading order, which is called 'Back'). Now, the difficulty is how to add it to the header buttons. I attach an init file that adds the 'Forward' direction after a space button to all the possibilities for buttons. This may not be suitable for your case, but gives you an idea on how to do that.

Information on directions:
https://www.gnu.org/software/texinfo//manual/texi2any_api/html_node/Directions.html

Information on calling user defined functions:
https://www.gnu.org/software/texinfo//manual/texi2any_api/html_node/Init-File-Calling-at-Different-Stages.html

Information on buttons
https://www.gnu.org/software/texinfo//manual/texi2any_api/html_node/Simple-Navigation-Panel-Customization.html

(file #55234)

Patrice Dumas <pertusus>
Fri 13 Oct 2023 09:43:36 PM UTC, comment #5: 

I'm adding the Texinfo help email to the cc for this bug report, if they accept cross-project links.

Texinfo users: Is there a way to make HTML links point to "reading order next" instead of "hierarchical next", as described at https://savannah.gnu.org/bugs/?64752#comment3 in more detail?

Arun Giridhar <arungiridhar>
Group Member
Thu 05 Oct 2023 06:52:46 PM UTC, comment #4: 

FWIW, that behavior is set by Texinfo and it seems to be a design decision by them:

https://www.gnu.org/software/texinfo/manual/texinfo/texinfo.html#Texinfo-Document-Structure

(If the link breaks, section 3.6 on Texinfo Document Structure describes it.)

There doesn't seem to be a setting listed to override that behavior and go to "chronological next" as opposed to "hierarchical next".

The Postgres docs look like they were generated by a different doc system (Sphinx? Tha page source didn't list any). The LISP website's page source says it was generated by (name of person), likely using custom code.

Octave's docs are all written in Texinfo and changing that to a different markup is a non-starter in terms of effort. But if anyone knows a way to make Texinfo do what's requested, we can try it.

One workaround: docs.octave.org hosts the PDF equivalents of the HTML pages, and the PDFs are all in one big doc.

Arun Giridhar <arungiridhar>
Group Member
Thu 05 Oct 2023 06:29:31 PM UTC, comment #3: 

If you're in e.g. https://docs.octave.org/latest/Introduction.html (section 1), clicking "next" would preferably take you to https://docs.octave.org/latest/Running-Octave.html (section 1.1); instead it takes you to "https://docs.octave.org/latest/Getting-Started.html" (section 2)

Of course, in a way it's a matter of preference, but I find this behavior unusual.

Some docs that behave the way I described as "better":
http://www.lispworks.com/documentation/HyperSpec/Body/01_.htm
https://www.postgresql.org/docs/current/index.html

Anonymous
Thu 05 Oct 2023 06:18:48 PM UTC, comment #2: 

(sorry, i thought you were referring to the document tab in the octave program.  same initial question though.)

Nicholas Jankowski <nrjank>
Group Member
Thu 05 Oct 2023 06:17:45 PM UTC, comment #1: 

I'm not sure I follow your concern.  Could you provide a specific example of links you follow in the current document tab, what opens, and what you would prefer to open?  Presently when I click any hyperlink it opens that link in the tab as i would expect.  Also, can you check whether or not the link-following behavior you're concerned about is the same as the website docs at https://docs.octave.org/latest/

Nicholas Jankowski <nrjank>
Group Member
Thu 05 Oct 2023 06:08:23 PM UTC, original submission:  

There's no easy way to navigate the doc pages in sequence; in most html docs I'm familiar with, clicking the "next" hyperlink takes you to the next page as if turning pages in a book. In octave docs, if you're in a high section level, it takes you to the next page on the same level, e.g. from 1 to 2, instead of 1 to 1.1. That makes for a slightly painful navigation experience.

It would be nice to change the behavior so that it matches most docs out there.

https://docs.octave.org/latest/index.html

Anonymous

 

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

Attach Files:
   
   
Comment:
   

Attached Files
file #55533:  add_forward_button.pm added by pertusus (527B - application/x-perl)
file #55234:  add_forward_button.pm added by pertusus (471B - application/x-perl - init file to add Forward button direction)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by pertusus (Updated the item)
  • -email is unavailable- added by arungiridhar (TexInfo help needed for this question)
  • -email is unavailable- added by arungiridhar (Posted a comment)
  • -email is unavailable- added by nrjank (Posted a comment)
  • -email is unavailable- added by None (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 7 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2024-01-06 pertusus Attached File- Added add_forward_button.pm, #55533
    2023-10-14 pertusus Attached File- Added add_forward_button.pm, #55234
    2023-10-13 arungiridhar Severity3 - Normal 2 - Minor
        Priority5 - Normal 3 - Low
        Item GroupNone Feature Request
        Carbon-Copy- Added -email is unavailable-
    2023-10-05 nrjank StatusNone Need Info

    Back to the top

    Powered by Savane 3.13-6ae7.
    Corresponding source code