Home D... !depth !doclayout
 Die Anleitung zu UDO
 Befehlsindex
 D...

!docinfo

Dokumentinformationen setzen.

Typ & Position: Kommando, Vorspann
 
Syntax: !docinfo [<name>] <text>
 
Beschreibung: Dieses Kommando dient dazu, verschiedene Informationen für die Titelseite zu setzen. "<name>" kann dabei einer der folgenden Werte sein:
 
title
"<text>" wird auf der Titelseite vor dem Inhalt von !docinfo [program] ausgegeben. "<text>" wird darüber hinaus noch zur Darstellung von Kopfzeilen bei einigen Formaten herangezogen.
 
program
"<text>" wird auf der Titelseite unterhalb der Titelzeile ausgegeben. Desweiteren wird "<text>" bei einigen Formaten zur Darstellung von Kopfzeilen herangezogen.
 
programimage
Das Bild "<datei>" wird anstelle des Inhalts von !docinfo [program] unterhalb der Titelzeile auf der Titelseite ausgegeben.
 
version
"<text>" wird unterhalb des Programmnamens auf der Titelseite ausgegeben. Ansonsten findet "<text>" keine weitere Verwendung.
 
date
"<text>" wird unterhalb der Versionsinformationen auf der Titelseite ausgegeben. Ansonsten werden diese Informationen nicht weiter benötigt. Im Beispiel würde auf der Titelseite das aktuelle Systemdatum eingesetzt.
 
author
"<text>" wird als Name des Autors auf der Titelseite ausgegeben und für weitere, jedoch sehr spezifische Formatbefehle verwendet. Im Text selbst findet "<text>" keine weitere Verwendung.
 
authorimage
"<datei>" wird als Bild (z.B. ein Logo) zusätzlich direkt über dem Namen des Autors auf der Titelseite ausgegeben, falls das Ausgabeformat Unterstützung für Bilder bietet.
 
authoricon
"<datei>" wird als Bild (z.B. ein Logo) im linken Frame bzw. in der linken Spalte beim Frame-Layout bzw. "modernen" Layout von HTML ausgegeben.
 
address
"<text>" wird auf der Titelseite unterhalb des Namens des Autors ausgegeben. "<text>" findet sonst keine weitere Verwendung durch UDO. !docinfo [address] kann bis zu 15 mal angegeben werden, so dass man hier z.B. auch mehrere E-Mail-Adressen auf der Titelseite angeben kann.
 
company
"<text>" bezeichnet die Firma, für die ein Dokument erstellt wird. Wenn company benutzt wird, wird auf der Titelseite unter Autor "für company" eingefügt.
 
category
"<text>" bezeichnet eine Kategorie, zu der das Dokument gehört.
 
stgdatabase
Mittels !docinfo [stgdatabase] kann man angeben, was UDO für die @database-Zeile beim ST-Guide-Format ausgeben soll. Wird !docinfo [stgdatabase] nicht verwendet, so erzeugt UDO wie gehabt eine Zeile, gebildet aus !docinfo [title] und !docinfo [program.
 
drcstatusline
Mittels !docinfo [drcstatusline] kann man den Text setzen, den UDO für die Statuszeile verwendet. Fehlt diese Angabe, so erzeugt UDO eine Zeile der Art "Copyright © by <author>". Wurde !docinfo [author] nicht angegeben, so erzeugt UDO eine Zeile "Made with UDO".
 
keywords
!docinfo [keywords] entspricht dem Kommando !html_keywords. Kann auch bei Postscript genutzt werden.
Bei der HTML-Ausgabe allerdings nur, wenn in einzelnen Dateien nicht !html_keywords benutzt wird. Diese haben also vorang.

 
description
!docinfo [description] entspricht dem Kommando !html_description. Kann auch bei Postscript genutzt werden.
Bei der HTML-Ausgabe allerdings nur, wenn in einzelnen Dateien nicht !html_description benutzt wird. Diese haben also vorang.

 
htmltitle
"<text>" wird für den Titel jeder Seite benutzt (anstelle der Zusammenfassung von [title] und [program]).
 
robots
"<text>" entspricht einer der Robots Anweisung wie sie für Suchmaschinen benutzt werden. Erlaubt sind "none", "noindex", "index", "nofollow" und "follow".
 
appletitel
Wird für HTML Apple Help benötig und beschreibt den Titel der Hilfe.
 
appleicon
Wird für HTML Apple Help benötig. Damit wird das Icon angegeben, welches der Apple Help Viewer anzeigen soll.
 
webmastername|webmasteremail|webmasterurl
Werden Webmaster-Daten angegeben, so erzeugt UDO standardmäßig am Ende einer jeden Seite folgendes:
 
Copyright (!copyright) by <webmastername> [<webmasteremail>|<webmasterurl>]

Letzte Aktualisierung am (!today)

<webmasterurl> hat Priorität vor <webmasteremail>. Werden keine Angaben gemacht oder im Vorspann !no_footers [html] benutzt, so gibt UDO nichts aus.
 

Die Werte Einträge stehen als Defines zur Verfügung in der Form (!KW [UDO_xxx)], also z. B. (!KW [UDO_title]). Natürlich ist dies nur der Fall, wenn sie vorher definiert worden sind.
 
Beispiel:
 
!docinfo [title] Die Windows-Hilfe zu
!docinfo [program] UDO
!docinfo [author] Dirk Hagedorn
!docinfo [address] Asmecke 1
!docinfo [address] D-59846 Sundern
!docinfo [address] Deutschland
!docinfo [address] Internet: info@dirk-hagedorn.de
!docinfo [address] Mausnet: Dirk Hagedorn @ MK2
!docinfo [webmasteremail] webmaster@dirk-hagedorn.de
!docinfo [webmasterurl] http://www.dirk-hagedorn.de/
!docinfo [authorimage] dh
!docinfo [date] (!today)


 
Existiert seit: Release 6 Patchlevel 2
 
Siehe auch: !maketitle, Titelseite
 

Copyright © www.udo-open-source.org
Letzte Aktualisierung am 5. November 2006

Home D... !depth !doclayout