bugGNU Octave - Bugs: bug #52772, Cruft at the start of user manual...

 
 

bug #52772: Cruft at the start of user manual / guide concept and function indeces

Submitted by:  Dan Sebald <sebald>
Submitted on:  Mon 01 Jan 2018 03:39:17 AM UTC  
 
Category: DocumentationSeverity: 3 - Normal
Priority: 5 - NormalItem Group: Documentation
Status: FixedAssigned to: None
Originator Name: Open/Closed: Closed
Release: devOperating System: Any

Add a New Comment(Rich Markup)
   

You are not logged in

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

 

Thu 04 Jan 2018 06:37:19 AM UTC, comment #2:

I pushed the patch at bug #52774 as well as making some other changes. Closing this report.

Rik <rik5>
Project Administrator
Tue 02 Jan 2018 10:38:10 AM UTC, comment #1:

I posted a changeset at

https://savannah.gnu.org/bugs/index.php?52774

https://savannah.gnu.org/bugs/download.php?file_id=42787

that would have made more sense posted here, now that I look back at these posts. The changeset covers both bugs, I guess, but it ended up covering more with regard to this bug than when I started.

Dan Sebald <sebald>
Mon 01 Jan 2018 03:39:17 AM UTC, original submission:

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.

Dan Sebald <sebald>

 

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

Attach File(s):
   
   
Comment:
   

 

Digest:
   bug dependencies.

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by rik5 (Posted a comment)
  • -unavailable- added by sebald (Submitted the item)
  •  

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

    Only project members can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 5 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Thu 04 Jan 2018 06:37:19 AM UTCrik5StatusNone=>Fixed
      Open/ClosedOpen=>Closed
    Wed 03 Jan 2018 10:42:20 AM UTCsiko1056Dependencies-=>Depends on bugs #52774
    Mon 01 Jan 2018 03:39:17 AM UTCsebaldAttached File-=>Added manual_p1003_concept_index_Screenshot_from_2017-12-31_21-10-48.png, #42777
      Attached File-=>Added manual_p1015_function_index_Screenshot_from_2017-12-31_21-07-01.png, #42778

    Back to the top


    Powered by Savane 3.1-cleanup1