Bug 153228 - Documentation Not Complete On Table of Content Help
Summary: Documentation Not Complete On Table of Content Help
Status: RESOLVED INVALID
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Documentation (show other bugs)
Version:
(earliest affected)
7.4.4.2 release
Hardware: All All
: medium normal
Assignee: Not Assigned
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2023-01-26 21:14 UTC by kitchm
Modified: 2023-02-22 19:47 UTC (History)
4 users (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 kitchm 2023-01-26 21:14:47 UTC
The Help documentation on the subject of Table of Contents offers explanation as one steps thru the options in the dialog box for setting up the table.  As one goes down the page, the reader comes to "Protected against manual changes" and sees "If you want the cursor to scroll through a protected area,".  What?  What's a "protected area"?  What's that got to do with "manual changes"?

Next we come to "Evaluate up to level".  What?  What are levels?  What is evaluation?  Why would someone have to specify a level?  Is that a number or a name?

How about "Create From".  What?  There is no actual explanation of what, when, why or how.

Next is "Additional Styles".  Why is that not simply named "Assigned Styles"?  It is after all, the only option.

And finally, "Index Marks".  There is no explanation of what they are or look like, or why one needs them.
Comment 1 Rafael Lima 2023-01-31 12:27:43 UTC
I suppose you were reading this page, right?

https://help.libreoffice.org/latest/en-US/text/swriter/01/04120222.html

I suggest you read this one instead:

https://help.libreoffice.org/latest/en-US/text/swriter/guide/indices_toc.html

See the related topics in the help page above. The description is more in-depth.
Comment 3 sdc.blanco 2023-02-17 22:31:27 UTC
@kitchm -- Implicit in the OP is an (incorrect) expectation that it is possible to learn how to use the software from the (online) Help pages, such as the one you cite in comment 2.  

The Help pages are intended primarily to document the behavior of different controls and commands. Occasionally there is a brief "guide" about how to do some limited action, such as the second URL cited in comment 1.  

Meanwhile, the OP does not give any indication of whether you attempted to use "extended tips", which answers many of your questions.

Finally, if you want to learn how to use Table of Contents functions, then I would recommend to look in Chapter 15 of the Writer's Guide 7.3.  It will discuss the options in the dialog and how to use them.

As it happens, this dialog (including the extended tips) and its help page are getting some corrections in connection with bug 153596 and bug 152605. I will see if some tooltips can be added.

In relation to the OP, I think this ticket should be closed as INVALID ("problem described is not a proper bug report") or INSUFFICIENTDATA ("problem lacks information ... to follow up with the bug triage").