bugGNU Octave - Bugs: bug #50247, add text properties link/info to...

 
 

bug #50247: add text properties link/info to help text for text, title, xlabel, and others

Submitted by:  Nicholas Jankowski <nrjank>
Submitted on:  Tue 07 Feb 2017 08:36:16 PM UTC  
 
Category:  Documentation Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Feature Request
Status:  None Assigned to:  None
Originator Name:  Nick Jankowski Open/Closed:  Open
Release:  4.2.0 Operating System:  Any

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

( Jump to the original submission)

Thu 09 Feb 2017 04:42:07 PM UTC, comment #7:

We've lived with the current behavior of links in plaintext format for years. So, I again vote to make that a separate issue report which we may or may not deal with. The immediate issue is just adding @pxref entries to the docstrings for text, title, etc. That's just documentation so it could be made on the stable branch.

Rik <rik5>
Project Administrator
Wed 08 Feb 2017 11:50:04 PM UTC, comment #6:

Probably the reason that we don't use the --plaintext option for makeinfo is that hasn't always existed. Even if I knew about it, I don't know that it would have been clear to me that there was any advantage for using it. It seems to be the same as Info format with --no-headers, though I guess it does allow you to check for "plaintext" as different from "info".

John W. Eaton <jwe>
Project Administrator
Wed 08 Feb 2017 05:18:12 PM UTC, comment #5:

There are two separate issues here. One is adding a reference to "Text Properties". That is the subject of this bug report and should be easy for someone to fix.

The second issue is the display of links in a plaintext environment. That could be the subject of another bug report, although we have lived with the current behavior for quite a while. Texinfo does provide conditionals for using different text in different output formats. The one that would be of most use here is

However, the tricky thing to resolve is that Octave is running the formatter for 'info' output when producing the text for the terminal. The file scripts/help__makeinfo__.m would need modification. I've attached a quick implementation to this report as plaintext.diff, but I haven't checked if it breaks anything.

If you do carry through on the second bug report, it would be best to create a macro so that one could write

and have it expand out to the longer inlinefmtifelse Texinfo command.

Rik <rik5>
Project Administrator
Wed 08 Feb 2017 08:54:03 AM UTC, comment #4:

I don't understand exactly why the help text displayed in a terminal is still in info format. If it was plain text we could use some conditionals like

So that pdf, info and html versions would provide a link while the terminal help text would provide a command to be run in the terminal.

Pantxo Diribarne <pantxo>
Project Member
Wed 08 Feb 2017 05:41:56 AM UTC, comment #3:

The rendering in plain text isn't that great, but that is Texinfos fault. It would look like this

Rik <rik5>
Project Administrator
Wed 08 Feb 2017 05:27:59 AM UTC, comment #2:

yeah, that would take care of it in the document. how would that render for 'help xlabel'?

Nicholas Jankowski <nrjank>
Wed 08 Feb 2017 05:11:58 AM UTC, comment #1:

Why not just put an xref or pxref entry to "text properties"? This will be a hyperlink in the Info or online documentation.

For example,

Rik <rik5>
Project Administrator
Tue 07 Feb 2017 08:36:16 PM UTC, original submission:

following from a mailing list discussion [1]

requesting a link or other information be added to the functions text, title, xlabel, ylabel, zlabel, and maybe others that currently contain the text:

"Optional property/value pairs may be used to control the appearance of the text."

There is a page in the manual providing this information [2] but seems to be no way to link to it with "help" or "doc".

This appears to be at least in part a GUI manual limitation, as discussed in bug #44202.

Recommend making this bug dependent on bug #44202, then when it's fixed by changing the help text in the subject functions to:

"Optional property/value pairs may be used to control the appearance of the text. Use doc("text properties") to see a list of available options."

[1] http://octave.1599824.n4.nabble.com/property-options-for-text-others-tp4681786.html

[2] https://www.gnu.org/software/octave/doc/interpreter/Text-Properties.html#Text-Properties

Nicholas Jankowski <nrjank>

 

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

Attach Files:
   
   
Comment:
   

Attached Files
file #39704:  plaintext.diff added by rik5 (2KiB - application/x-download)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by jwe (Posted a comment)
  • -email is unavailable- added by pantxo (Posted a comment)
  • -email is unavailable- added by rik5 (Posted a comment)
  • -email is unavailable- added by nrjank (Submitted the item)
  • -email is unavailable- added by nrjank
  •  

    Do you think this task is very important?
    If so, you can add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.

     

     

     

    Follow 2 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2017-02-08 rik5 Attached File- => Added plaintext.diff, #39704
    2017-02-07 nrjank Carbon-Copy- => Added pantxo

    Back to the top


    Powered by Savane 3.3