Technikspezifische Elemente

(Auszug aus "DocBook-XML: Medienneutrales und plattformunabhängiges Publizieren" von Thomas Schraitle)

nonterminal (ab DocBook 5)

"Nichtterminal" einer EBNF-Produktion, siehe Produktionsregeln (EBNF).

option

Eine Befehlsoption: <option>--help</option>

optional

Eine freiwillige Information, meistens in Kombination mit synopsis:

<synopsis>cd <optional>dir</optional></synopsis>

package (erst ab DocBook 4.4)

Identifiziert ein Paket irgendeiner Art. Dies kann ein Java-Paket sein oder ein betriebssystemabhängiges Format (RPM, DEB, …):

<para>In openSUSE 11.0 ist DocBook 5 im RPM-Paket <package>docbook_5</package> enthalten.</para>
parameter

Wert oder symbolische Referenz auf einen Wert:

<para>Der Parameter <parameter>-l</parameter> des UNIX-Befehls <command>ls</command> zeigt den Inhalt als langes Listing an.</para>
property

Dateneinheit, die mit einem Teil des Computersystems verknüpft ist. Dies kann eine Eigenschaft eines objektorientierten Codes sein, die Komponente einer grafischen Oberfläche oder eine Eigenschaft einer relationalen Datenbank:

<para>Windows speichert Hardwareabhängige Daten unter dem Registrierungsschlüssel <property>HKEY_LOCAL_MACHINE</property> ab.</para>
replaceable

Ein Platzhalter:

<para>Ersetzen Sie <replaceable>USER</replaceable> durch Ihren Benutzernamen.</para>
systemitem

Ein systembezogener Begriff. Durch das Attribut class können Sie weiter differenzieren:

... der Administrator <systemitem class="username">root<systemitem> ...
Wert Beispiel Erklärung
daemon syslogd Name eines Daemons (nur in DocBook 5 verfügbar)
domainname docbook.org Domainname eines Rechners
etheraddress 192.168.10.5 Ethernetadresse
event SIGHUP Ereignis
eventhandler hangup Ereignishandler
filesystem ReiserFS, NTFS Name eines Dateisystems
fqdomainname jupiter.sol "Fully Qualified Domainname"
groupname users Name einer Gruppe
ipaddress 192.168.0.1 IP-Adresse
library Glibc Name einer Bibliothek
macro Makro
netmask 255.255.255.0 Netzwerkmaske
newsgroup de.comp.text.xml Newsgruppe
osname Linux, Windows Betriebsystemname
process init Prozess
protocol http Protokoll
resource allgemeine Ressource
server edison.example.com Server
service ntp Service
systemname zeus Name eines Systems
username toms Benutzername
termdef (erst ab DocBook 4.5)

Die Definition eines Begriffs. Ein termdef muss genau ein firstterm enthalten:

<termdef>Ein <firstterm>Attribut</firstterm> ist ein Paar aus Attributnamen und Wert innerhalb eines Start-Tags.</termdef>

[Definition: Ein Attribut ist ein Paar aus Attributnamen und Wert innerhalb eines Start-Tags.]

  

<< zurück vor >>
Tipp der data2type-Redaktion:
Zum Thema DocBook bieten wir auch folgende Schulungen zur Vertiefung und professionellen Fortbildung an:

Copyright © 2009 Millin Verlag
Für Ihren privaten Gebrauch dürfen Sie die Online-Version ausdrucken.
Ansonsten unterliegt dieses Kapitel aus dem Buch "DocBook-XML: Medienneutrales und plattformunabhängiges Publizieren" denselben Bestimmungen, wie die gebundene Ausgabe: Das Werk einschließlich aller seiner Teile ist urheberrechtlich geschützt. Alle Rechte vorbehalten einschließlich der Vervielfältigung, Übersetzung, Mikroverfilmung sowie Einspeicherung und Verarbeitung in elektronischen Systemen.

Millin Verlag, Siebengebirgsring 36, 53797 Lohmar, info(at)millin.de