Home D... !depth !doclayout
 The guide of UDO
 Command index
 D...

!docinfo

Set document information.

Type & position: command, preamble
 
Syntax: !docinfo [<name>] <text>
 
Description:
 
Description: This command is used to set several informations printed on the title page. "<name>" can have one of the following values:
 
title
"<text>" will be displayed on the title page before the contents of the program name. It's also used inside the headlines.
 
program
"<text>" will be displayed on the title page below the title. Furthermore "<text>" will be used by some destination formats to generate the header line.
 
programimage
"<file>" will be displayed instead of the name of the program on the title page if the destination format supports images.
 
version
"<text>" will be given out right below the contents of the program name on the title page.
 
date
"<text>" will be displayed on the title page below the contents of the program version. The example shows how to use the current system time for the title page.
 
author
"<text>" will be used as the name of the author on the title page and for different other purposes.
 
authorimage
"<file>" will be displayed above the name of the author on the title page if the destination format supports images.
 
authoricon
"<file>" will be displayed as image in the left frame or left column when using the frame layout or "modern" layout of HTML.
 
address
"<text>" will be given out below the author's name on the title page. !docinfo [address] can be used up to 15 times, and can contain any address lines, such as email-addresses.
 
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
With this command you can specify the contents of the @database-line that is generated for the ST-Guide format. If you don't use this command, UDO will construct a line containing the title and the program name.
 
drcstatusline
This command is used to specify the contents of the status line for the DRC format. If you don't use this command, UDO will use a line like "Copyright © by <author>". If you did not set the name of the author, UDO will use the text "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>" will be used as the title of every page (instead of using [title] and [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
If you specify webmaster informations, UDO will output following lines at the end of each page:
 
Copyright (!copyright) <webmastername> [<webmasteremail>|<webmasterurl>]
Last updated on (!today)

<webmasterurl> has priority over <webmasteremail>. If you don't specify any data or use the switch !no_footers [html] in the preamble, UDO will output nothing.
 

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.
 
Examples:
 
!docinfo [title] The Windows Help of
!docinfo [program] UDO
!docinfo [author] Dirk Hagedorn
!docinfo [address] Asmecke 1
!docinfo [address] D-59846 Sundern
!docinfo [address] Germany
!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)


 
Exists since: Release 6 Patchlevel 2
 
See also: !maketitle, Title page
 

Copyright © www.udo-open-source.org
Last updated on November 5, 2006

Home D... !depth !doclayout