bugGNU Octave - Bugs: bug #57846, doc: make plaintext rendering of...

 
 

bug #57846: doc: make plaintext rendering of document references intuitively readable

Submitter:  Nicholas Jankowski <nrjank>
Submitted:  Tue 18 Feb 2020 02:35:51 AM UTC
   
 
Category:  Documentation Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Feature Request
Status:  Duplicate Assigned to:  None
Originator Name:  Nicholas Jankowski Open/Closed:  * Closed
Release:  * dev Operating System:  * Any
Fixed Release:  None Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Tue 18 Feb 2020 03:32:29 PM UTC, comment #3: 

Finishing this off, the changes to fix bug #56929 will be part of the 6.1 release, not the last bug fix release 5.2.

Rik <rik5>
Group administrator
Tue 18 Feb 2020 05:18:36 AM UTC, comment #2: 

you think I'd remember a bug i submitted only a few months ago. apparently I forgot I complained about that formatting before and y'all were gracious enough to fix it. I'm reading the help with Octave v5.2.0 and it still displays with *Note.  Assume that'll hit one of the next couple releasese.

Sounds like this should just get marked as duplicate of bug #56929 and closed.



Nicholas Jankowski <nrjank>
Group Member
Tue 18 Feb 2020 04:26:54 AM UTC, comment #1: 

I don't see this.  Running "help text" yields


 Programming Notes: The full list of properties is documented at
 Text Properties.


See, perhaps, bug #56929.


Rik <rik5>
Group administrator
Tue 18 Feb 2020 02:35:51 AM UTC, original submission:  

low priority request as per discussion in bug #50247:

rendering of reference links using @ref, @xref, @pxref generate clickable hyperlinks in PDFs, web pages, and Octave doc browser, etc. But in plain text rendering environments they appear less than intuitive, especially in Octave's help browser.

example:

in text.m, the reference to the doc page for property/value pairs is:


## Programming Note: The full list of properties is documented at
## @ref{Text Properties,,Text Properties}.


In rendered environs this appears simply as

Programming Note: The full list of properties is documented at Text Properties.

Where "Text Properties" is a hyperlink

help text produces:

Programming Note: The full list of properties is documented at
*note Text Properties: Text Properties.


running octave in a CLI, 'doc text' produces the same thing, except the first part (*note Text Properties) is a clickable link.

Another bug (bug #57845) has been submitted regarding removing the redundant @ref arguments (the duplicate 'Text Properties' above.), but it was suggested in bug #50247 that it may be possible to render in plaintext for help (or similar) rather than in info format. 

it was suggested a macro could be written that would expand to something like "doc Text Properties" in plaintext but @xref{Text Properties} for texinfo, etc.

Nicholas Jankowski <nrjank>
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

 

Digest:
   bug dependencies.

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 nrjank (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 4 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2020-02-18 mtmiller StatusWorks For Me Duplicate
        Open/ClosedOpen Closed
        Dependencies- Depends on bugs #56929
    2020-02-18 rik5 StatusNone Works For Me

    Back to the top

    Powered by Savane 3.13-758e.
    Corresponding source code