[Octave-bug-tracker] [bug #52772] Cruft at the start of user manual / guide concept and function indeces

[Dan Sebald]

URL:
  <http://savannah.gnu.org/bugs/?52772>

                 Summary: Cruft at the start of user manual / guide concept
and function indeces
                 Project: GNU Octave
            Submitted by: sebald
            Submitted on: Mon 01 Jan 2018 03:39:17 AM UTC
                Category: Documentation
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Documentation
                  Status: None
             Assigned to: None
         Originator Name: 
        Originator Email: 
             Open/Closed: Open
         Discussion Lock: Any
                 Release: dev
        Operating System: Any

    _______________________________________________________

Details:

I'm attaching two screenshots of octave.pdf manual showing some cruft at the
start of the concept index and the start of the function index.  Decide if we
should clean these up.

Concept Index:
manual_p1003_concept_index_Screenshot_from_2017-12-31_21-10-48.png

There are a half dozen non alpha numeric entries that are typically considered
operators, namely

# % . : \ ~

It's probably best to remove all of these from Concept Index and move their
references to the Operator Index.  Having these at the start of Concept Index
might mislead someone into thinking this is all the reference there is for the
above operators.  Some of these entries might also be mistakes.  For example,

.octaverc
~/.inputrc
~/.octaverc

have hidden file attributes creating "bogus" subcategories.  I'd think that
references to just "octaverc" and "inputrc" would be better; that's where the
typically reader will look for a reference, i.e., ~/. will be disregarded.

The ":end" seems extraneous--it refers to the same page as ":" jumps to. 
Perhaps an "end" should appear in the Concept Index.  There is one reference
there already, but I think it is referring to the "end" of "endfunction", etc.
 Not the in-index "end", which is a whole different concept and an important
one.  Dropping the ":" of ":end" will cause another page number to appear in
the index.  That's good.

The two that stand out are ... and \ continuation operator.  They should exist
somewhere.  But, actually I suppose those could go into the Operator Index
still including th "continuation operator" part.  There should be automatic
entries for those.  In fact, that is probably what I should have done for the
@ symbol in https://savannah.gnu.org/bugs/index.php?52771 , i.e.,

@ (function handle)
@ (class directory)


Function Index:
manual_p1015_function_index_Screenshot_from_2017-12-31_21-07-01.png

There are three entries at the very start of the index associated with "(". 
Those must be typos or perhaps just the alpha-numeric portion should have a
link in the index.



    _______________________________________________________

File Attachments:


-------------------------------------------------------
Date: Mon 01 Jan 2018 03:39:17 AM UTC  Name:
manual_p1003_concept_index_Screenshot_from_2017-12-31_21-10-48.png  Size:
68KiB   By: sebald

<http://savannah.gnu.org/bugs/download.php?file_id=42777>
-------------------------------------------------------
Date: Mon 01 Jan 2018 03:39:17 AM UTC  Name:
manual_p1015_function_index_Screenshot_from_2017-12-31_21-07-01.png  Size:
60KiB   By: sebald

<http://savannah.gnu.org/bugs/download.php?file_id=42778>

    _______________________________________________________

Reply to this item at:

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

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/