[Octave-bug-tracker] [bug #54053] keywords should have XREF entries so "doc KEYWORD" works

[Mike Miller]

Update of bug #54053 (project octave):

                Category:                     GUI => Documentation          
                Severity:              3 - Normal => 1 - Wish               
              Item Group:                    None => Documentation          
                  Status:               Need Info => Confirmed              
                 Summary: the doc command does not show the info page for its
argument => keywords should have XREF entries so "doc KEYWORD" works

    _______________________________________________________

Follow-up Comment #3:

Sure. The help text that is shown at the command line for "help KEYWORD" is a
stub documentation that is maintained separately from the user manual.
Meanwhile, the user manual has a more pedagogical approach for introducing the
keywords.

If some or all keywords should be accessible in the manual with the "doc"
command, then manual XREF anchor points will have to be added into the Texinfo
manual sources. See for example XREFpersistent, which allows "doc persistent"
to work as you would expect.

A list of all keywords can be obtained with "doc keywords" or "__keywords__",
and anchors can be added to the relevant place in the Texinfo source.

    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/bugs/?54053>

_______________________________________________
  Message sent via Savannah
  https://savannah.gnu.org/