Bug 120200 (Help-Changes-Features) - [META] Update or correct help for features
Summary: [META] Update or correct help for features
Status: NEW
Alias: Help-Changes-Features
Product: LibreOffice
Classification: Unclassified
Component: Documentation (show other bugs)
Version:
(earliest affected)
unspecified
Hardware: All All
: medium normal
Assignee: Not Assigned
URL:
Whiteboard:
Keywords:
Depends on: 43983 63175 63548 67026 72461 73359 83780 86427 91336 91344 91755 92407 95182 95462 98566 104822 105152 106335 106523 107078 107081 113131 113426 113803 113975 118336 119207 119421 119723 119936 120179 120220 120247 120550 124562 125636 127170 127477 128836 128981 129051 129492 130185 130273 130442 130617 131075 Document_Field_Help 131305 131927 134456 135360 138418 141322 144206 144511 145060 33749 34398 43516 43527 53491 57204 58136 59801 61586 61588 67497 68103 75923 92497 92845 93783 96446 96496 98230 99613 103419 103463 103527 106023 106195 107192 107219 107290 108007 108869 108875 109084 112872 113976 114660 116576 117078 117890 118076 118093 118834 119753 120221 120333 121090 122162 122720 122753 123980 125891 126800 127959 128215 128569 129517 129554 130064 130884 131413 132695 132702 133465 Help_for_Navigator 135895 136948 137133 137141 137190 137221 137401 138193 138728 139122 140075 141748 141756 142562 144712 145135
Blocks: Help
  Show dependency treegraph
 
Reported: 2018-09-29 18:36 UTC by Thomas Lendo
Modified: 2021-10-14 15:25 UTC (History)
3 users (show)

See Also:
Crash report or crash signature:


Attachments
List of duplicate keys in the "hid2files.js" file (5.41 KB, text/plain)
2021-09-24 10:51 UTC, Ross Johnson
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Thomas Lendo 2018-09-29 18:36:53 UTC
This meta bug is for:
- Removed features.
- Stuff about changes to existing features.
- Correction of help files.
Comment 1 George 2.0 Hope 2020-03-03 02:58:07 UTC
If I understand the purpose of this Bug (the collation of other related bugs), then the following bug should be added to the list:

 ○ Error in Help for LibreLogo
 ○ https://bugs.documentfoundation.org/show_bug.cgi?id=96446
Comment 2 Ross Johnson 2021-09-24 10:51:14 UTC
Created attachment 175244 [details]
List of duplicate keys in the "hid2files.js" file

This seems like an appropriate place to record this for anyone working on Help pages.

The attachment I've uploaded is the output of:

sed -n "s;^\('[^']*'\):'.*$;\1;p" hid2file.js | sort | uniq -dc

It shows only those keys that appear more than once in the file, with the number of occurrences shown in the left-most column.

The "hid2files.js" file is a javascript array that uses strings as the keys. It cannot have duplicate keys in it. The documentation on the .xhp source help files also specifically notes that bookmark hid branch values must be unique. So, for example, there can only be one <bookmark branch="hid/.uno:MergeCells"/> throughout all of the .xhp files.

I'm guessing that it is the last duplicate of a key whose value results in the page seen by users. It is the case in the two examples I've seen recently. 

There are 152 separate keys that appear more than once. There are at least this many errant bookmarks in .xhp files and possibly that many help pages that have fallen into the cracks and never seen.

The affected pages need to be consolidated together into single .xhp files using the <switch> element to select the content that is displayed for a given module.