Bug 128893 - List of categories in online Navigator help may need to be updated
Summary: List of categories in online Navigator help may need to be updated
Status: RESOLVED FIXED
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Documentation (show other bugs)
Version:
(earliest affected)
6.4.0.0.alpha1+
Hardware: All All
: medium normal
Assignee: sdc.blanco
URL:
Whiteboard: target:6.5.0 target:6.4.0.1
Keywords:
Depends on:
Blocks:
 
Reported: 2019-11-19 12:01 UTC by sdc.blanco
Modified: 2019-11-22 11:08 UTC (History)
1 user (show)

See Also:
Crash report or crash signature:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description sdc.blanco 2019-11-19 12:01:23 UTC
According to:  https://help.libreoffice.org/6.4/en-US/text/shared/guide/navigator.html?DbPAR=SHARED#bm_id3147008

All contents of the Navigator window are referred to here as "categories," whether titles, sheets, tables, text frames, graphics, OLE objects, sections, hyperlinks, references, indexes or comments.

I believe the following changes are needed to align with Navigator in LO 6.4

1. "titles" and "sheets" should be removed.
2. "headings" added to beginning of the list.
3. "drawing objects" added to the end of the list.

I am willing to make the changes in the master, if someone can confirm that this is the needed change.

Additional question:

I could not find any documentation on the Reference category (and tried several different ways -- unsuccessfully -- to get a "reference" to show up in Navigator). 
Should I file a separate bug for documentation about reference?
Comment 1 Olivier Hallot 2019-11-19 12:13:23 UTC
The navigator categories depends on the module. Sheets are displayed in Calc and Headings are displayed in Writer, etc... The referred help page contents is generic and covers objects of several document types.
Comment 2 sdc.blanco 2019-11-19 12:46:00 UTC
(In reply to Olivier Hallot from comment #1)
> The referred help page contents is generic and covers objects of several document types.

Thanks for clarification.  Should I do nothing then? 
Or maybe change "titles" to "heading" and add "drawing objects"?

Also, a new question.  

> The navigator categories depends on the module

According to help page:

"The Navigator displays all types of objects contained in a document."

I would propose to drop "all".  

For example, in Draw, hyperlinks, comments, images are not shown in the Navigator (and maybe more). 
Also, in Impress, hyperlinks, comments, images, tables are not shown (for example).  
Finally, (for now) QR codes are not shown (even though it is a drawing object).
Comment 3 Olivier Hallot 2019-11-19 18:57:35 UTC
Actually, I am wrong. The page has a selector tag that display contents depending on the application (*). The selector is activated by the parameter DbPAR= in the page URL, therefore for Calc, this is what you see:

https://help.libreoffice.org/6.4/en-US/text/shared/guide/navigator.html?DbPAR=CALC#bm_id3147008

and for Writer:

https://help.libreoffice.org/6.4/en-US/text/shared/guide/navigator.html?DbPAR=WRITER#bm_id3147008

(look at the "related topics" on the bottom). The selector DbPAR is activated if you land on the Help coming from Calc or Writer.

If you want a more precise description for all modules, please provide the flat contents you wish per module here, and I'll make it work.

Now on the fact that QRcodes, signature lines and other objects don't show in the navigator, I think this is another issue that indeed deserves its own bug entry.


(*) https://opengrok.libreoffice.org/xref/help/source/text/shared/guide/navigator.xhp?r=e20b575c
Comment 4 sdc.blanco 2019-11-19 23:13:21 UTC
(In reply to Olivier Hallot from comment #3)

Thanks for the clarifications.

> Actually, I am wrong. The page has a selector tag that display contents
> depending on the application (*). 

As best as I can tell these two pages are identical. 

> Now on the fact that QRcodes, signature lines and other objects don't show
> in the navigator, I think this is another issue that indeed deserves its own
> bug entry.

Yes -- that was also my point.

To summarize:  I propose to make the following changes on that online help page.

1.  Change  "titles" to "headings"  (because "headings" does show up in Navigator, but I do not think that titles appears).

2.  Add "drawing objects" to the list (because it appears in both Writer and Calc navigator). 

3.  Drop the word  "all" from the sentence:  "The Navigator displays all types of objects contained in a document."   (because as we agree, there are some objects that are not shown in the document).

If those changes seem appropriate, then I am willing to make the commits.  And may I add you as code reviewer?

(and I guess you do not know anything about the Reference category in Navigator?)

Thanks.
Comment 5 Commit Notification 2019-11-21 20:23:09 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/b01173d325490f19537e67193bd383d475a55237

tdf#128893 corrections in Navigator for Document Overview
Comment 6 Commit Notification 2019-11-22 10:41:05 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "libreoffice-6-4":

https://git.libreoffice.org/help/commit/ebc8d71fc8187ca344e8189495fbb774cad463d1

tdf#128893 corrections in Navigator for Document Overview