Univention Bugzilla – Bug 19187
Stichwortindex für UCS Handbuch
Last modified: 2024-04-17 13:16:28 CEST
Ein Stichwortindex im UCS Handbuch ist aus meiner Sicht hilfreich, um konkrete Anhaltspunkte z.B. zum Thema Hook-Scripte, die im Handbuch verteilt sind, zu haben.
Das ist nicht geplant, das Handbuch wurde zu 3.0 von der Struktur her deutlich überarbeitet und ggf. kann in der Dokumentation gesucht werden.
Bei einer Schulung wurde angemerkt, daß <quote>es ein Unding sei, heutzutage noch ein Handbuch ohne Index herauszugeben.</quote> Es gibt durchaus auch IT-Personen, die ein gedrucktes Handbuch vorziehen. Und eine Volltextsuche ist auch kein Ersatz für einen vom Autorenteam ordentlich gepflegten Index. In DocBook ist das technisch recht einfach umzusetzen, der Hauptaufwand liegt natürlich darin, die richtigen Begriffe und Stellen zu finden. Bonus-Punkte für einen zweiten Index der UCR-Variablen. <http://www.docbook.org/tdg/en/html/indexterm.html> <http://www.docbook.org/tdg/en/html/index.html> Da ich selber privat auch gerade ein Handbuch mit DB erstellt habe, hier eine kleine Anmerkung, um einen Bug im XSL zu vermeiden: Man sollte derzeit den <indexterm> nicht nach einem <section><title/> platzieren, sondern innerhalb des <title>-Elements, also <section id="..."><title>...<indexterm><primary>...</primary></indexterm></title>...</section> Ansonsten platziert das XSL nach dem <title/> ein leeres <fo:wrap/>-Element das als leerer Absatz gilt. Das macht das "keey-with-next"-Verhalten des Titels kaputt, weshalb dann gerne der Titel auf der vorherigen Seite ganz unten steht und der Absatz dazu dann erst auf der nächsten Seite oben steht.
Wurde erneut angemerkt: Ticket #2013112021003518. Gleicher Kunde wie bei Comment #3. Ich denke wir sollten das zu einem der nächsten Releases umsetzen.
Some advise for generating an index: <http://www.cpynebookindexing.com/how_to_write_an_index.htm> <https://authornet.cambridge.org/information/productionguide/stm/Guide_on_Making_an_Index.pdf> <http://www.ugapress.org/upload/indexing.pdf>
Thanks, as discussed, we won't implement it in the next months.
This bug hasn't seen any update for several years. I close it. If you still see a need for it, you can reopen the bug. Please add an argumentation about why it's important to take care of it.