Bug 120200 (Help-Changes-Features)

Summary: [META] Update or correct help for features
Product: LibreOffice Reporter: Thomas Lendo <thomas.lendo>
Component: DocumentationAssignee: Not Assigned <libreoffice-bugs>
Status: NEW ---    
Severity: normal CC: olivier.hallot, regis.perdreau, Ross.Johnson, xiscofauli
Priority: medium    
Version: unspecified   
Hardware: All   
OS: All   
See Also: https://bugs.documentfoundation.org/show_bug.cgi?id=92825
https://bugs.documentfoundation.org/show_bug.cgi?id=80430
https://bugs.documentfoundation.org/show_bug.cgi?id=97629
Whiteboard:
Crash report or crash signature: Regression By:
Bug Depends on: 43983, 63548, 92407, 95462, 104822, 106335, 106523, 113426, 113803, 113975, 119207, 120220, 124562, 127170, 128836, 128981, 129051, 129492, 130273, 130617, 131927, 134456, 141322, 144206, 144511, 147862, 147901, 148364, 148875, 151829, 153653, 153945, 154055, 155012, 156072, 156208, 33749, 34398, 43516, 43527, 53491, 57204, 58136, 59801, 61586, 61588, 63175, 67026, 67497, 68103, 72461, 73359, 75923, 83780, 86427, 91336, 91344, 91755, 92497, 92845, 93783, 95182, 96446, 96496, 98230, 98566, 99613, 103419, 103463, 103527, 105152, 106023, 106195, 107078, 107081, 107192, 107219, 107290, 108007, 108869, 108875, 109084, 112872, 113131, 113976, 114660, 116576, 117078, 117890, 118076, 118093, 118336, 118834, 119421, 119723, 119753, 119936, 120179, 120221, 120247, 120333, 120550, 121090, 122162, 122720, 122753, 123980, 125636, 125891, 126800, 127477, 127959, 128215, 128569, 129517, 129554, 130064, 130185, 130442, 130884, 131075, 131206, 131305, 131413, 132695, 132702, 133465, 135360, 135668, 135895, 136948, 137133, 137141, 137190, 137221, 137401, 138193, 138418, 138728, 139122, 140075, 141748, 141756, 142562, 144712, 145060, 145135, 147808, 147898, 148302, 148444, 148483, 148486, 148861, 148901, 149012, 149130, 149301, 149572, 150404, 151347, 152873, 152977, 153050, 153551, 153876, 159863    
Bug Blocks: 106040    
Attachments: List of duplicate keys in the "hid2files.js" file

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.