HomeD...!depth!doclayout
Handbuch UDO > Befehlsindex > D... Index

!docinfo

Dokumentinformationen setzen.

Typ & Position: Kommando, Vorspann
Syntax: !docinfo [<name>] <text>|<datei>
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 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, dass Sie hier z.B. auch mehrere E-Mail-Adressen auf der Titelseite angeben können.
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
Mit !docinfo [stgdatabase] können Sie angeben, was UDO für die @database-Zeile beim ST-Guide-Format ausgeben soll. Wird !docinfo [stgdatabase] nicht verwendet, erzeugt UDO wie gehabt eine Zeile, gebildet aus !docinfo [title] und !docinfo [program.
drcstatusline
Mit !docinfo [drcstatusline] können Sie den Text setzen, den UDO für die Statuszeile verwendet. Fehlt diese Angabe, so erzeugt UDO eine Zeile der Art Copyright © by . Wurde !docinfo [author] nicht angegeben, 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 Vorrang.

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 Vorrang.

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.
appletitle
Wird für HTML Apple Help benötigt und beschreibt den Titel der Hilfe.
appleicon
Wird für HTML Apple Help benötigt. Damit wird das Icon angegeben, welches der Apple Help Viewer anzeigen soll.
domain_name|domain_link|contact_name|contact_link
Werden alle diese Kontaktdaten (in vier einzelnen Zeilen!) angegeben, erzeugt UDO standardmäßig am Ende einer jeden Seite Folgende Kontektdaten-Fußzeile:
Vorher:
# Vorspann
!docinfo [domain_link]    http://www.udo-open-source.org/
!docinfo [domain_name]    UDO OpenSource
!docinfo [contact_link]   mailto:webmaster@udo-open-source.org
!docinfo [contact_name]   E-Mail an den Webmaster

# Dokument
!begin_document
!maketitle
!end_document

Nachher: Copyright © UDO OpenSource (E-Mail an den Webmaster)
Letzte Aktualisierung am 19. Mai 2014
Werden weniger Informationen angegeben, so werden die Kontaktdaten in der Fußzeile entsprechend angepasst. Nachfolgend einige weitere Beispiele.
Vorher:
# Vorspann
!docinfo [domain_link]    http://www.meinedomain.de/
!docinfo [contact_link]   ich@meinedomain.de

# Dokument
!begin_document
!maketitle
!end_document

Nachher: Copyright © http://www.meinedomain.de/ (ich@meinedomain.de)
Letzte Aktualisierung am 19. Mai 2014
Vorher:
# Vorspann
!docinfo [domain_name]    Meine Firma
!docinfo [contact_name]   Mein Name

# Dokument
!begin_document
!maketitle
!end_document

Nachher: Copyright © Meine Firma (Mein Name)
Letzte Aktualisierung am 19. Mai 2014
Das zuletzt gezeigte Beispiel zeigt, dass nur die Parameter mit link im Parameternamen tatsächlich anklickbare Links ergeben.
Aber es ist auch möglich, als Kontaktlink keine echte E-Mail-Adresse, sondern einen URL anzugeben, der zu einem Kontaktformular führt. Denn mittlerweile ist es nicht mehr unbedingt erwünscht, dass E-Mail-Adressen im Klartext in Webseiten zu sehen sind. Sonst sind sie für Roboter, die E-Mail-Adressen zum Spammen suchen, eine leichte Beute.
Vorher:
# Vorspann
!docinfo [domain_link]  http://www.meinedomain.de/
!docinfo [domain_name]  Meine Domäne
!docinfo [contact_link] http://www.meinedomain.de/kontakt.php
!docinfo [contact_name] Kontakt

# Dokument
!begin_document
!maketitle
!end_document

Nachher: Copyright © Meine Domäne (Kontakt)
Letzte Aktualisierung am 19. Mai 2014
Hinweis: Werden keine Angaben gemacht oder im Vorspann !no_footers [html] benutzt, so gibt UDO nichts aus.
translator
<text> bezeichnet den Namen des Übersetzers, der das Produkt oder Dokument übersetzt hat. Wenn translator benutzt wird, wird auf der Titelseite nach Autor und Firma Übersetzung: translator eingefügt.
distributor
<text> bezeichnet die Firma, die das Produkt oder Dokument vertreibt. Wenn distributor benutzt wird, wird auf der Titelseite nach Autor und Firma Distributor: distributor eingefügt.
Existiert seit: Release 6 Patchlevel 2
Siehe auch: !maketitle, Titelseite

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 [domain_link]  http://www.dirk-hagedorn.de/
!docinfo [contact_link] mailto:webmaster@dirk-hagedorn.de
!docinfo [authorimage] dh
!docinfo [date] (!today)

Copyright © www.udo-open-source.org (Kontakt)
Letzte Aktualisierung am 19. Mai 2014

HomeD...!depth!doclayout