Dokumentation mit DocBook

Dokumentation mit DocBook

Posts 1-3 of 3
  • Gerald Hirsch
    Gerald Hirsch    Premium Member
    The company name is only visible to registered members.
    Wieviel Tags werden benoetigt?
    Hallo,
    ich arbeite mich gerade in die Tiefen von DocBook ein und bei der Ansicht der moeglichen Tags und Attributen frage ich mich gerade, wie hoch der Anteil an tatsächlich verwendeten Tags und Attributen in einer Dokumentation mittlerer Größe ist. Ich bin mich fast sicher, dass ich fuer die Erstellung z.B. eines Handbuchs für das Qualitätsmanagement in einem Unternehmen gerade mal 5% der Tags und Attribute ueberhaupt benoetigt werden. Da ich aber noch kein DocBook-Projekt begleitet habe, ist das natuerlich nur eine Vermutung und daher hoffe ich, dass ich ueber dieses Forum etwas Feedback von Praktikern erhalte, die schon seit laengerem mit DocBook erfolgreich gearbeitet haben.
    In freudiger Erwartung moeglichst vieler Antworten

    Gerald Hirsch
    • 16 Feb 2005, 1:08 pm
  • Lars Trieloff
    Lars Trieloff
    The company name is only visible to registered members.
    Re: Wieviel Tags werden benoetigt?
    Hallo Herr Hirsch,

    welche Elemente Sie wirklich benötigen, hängt von den Texten ab, die Sie schreiben möchten, aber mit dieser Auswahl an Elementen können Sie starten und immer dann, wenn Sie Ihre Inhalte verfeinern möchten oder weitere Features nutzen möchten, in den entsprechenden Referenzen nachschlagen.

    Grundstruktur des Dokuments;
    article, title, preface, section, appendix

    Absatzelemente:
    para, itemizedlist, orderedlist, listitem, figure, mediaobject, imageobject (mit Attribut fileref)

    Verknüpfungen:
    das Attribut id, die Elemente link und xref mit dem Attribut linkend und das Element ulink.

    Meta-Informationen:
    author, firstname, surname, date, subtitle, abstract.

    Dies sind die Attribute und Elemente, die am häufigsten eingesetzt werden und damit kann man 80% der Inhalte abdecken, die man in der Regel beschreibt.

    viele Grüße

    Lars Trieloff
    • 16 Feb 2005, 6:22 pm
  • Klaus Ebner
    Klaus Ebner    Premium Member   Group moderator
    The company name is only visible to registered members.
    Re: Wieviel Tags werden benoetigt?
    Hallo,

    ergänzend zu der Antwort von Hr. Trieloff kamen bei einem grösseren Dokument (160 Seiten) hier noch ein Glossar (glossary, glossdiv, glossterm, glossentry) dazu.
    Ich hab grade mal gezählt: Tags die jeweils mehr als 1% der Gesamtmenge aller genutzten Tags ausmachen:
    mediaobject
    revnumber
    authorinitials
    date
    glossentry
    glossdef
    imageobject
    revision
    revdescription
    row
    entry
    itemizedlist
    title
    section (10%)
    listitem (13%)
    para (30%)


    Mit freundlichen Grüssen,
    Klaus Ebner
    • 22 Feb 2005, 08:08 am