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

!docinfo

Set document information.

Type & position: command, preamble
Syntax: !docinfo [<name>] <text>
Description:
Description: This command is used to add various information output to 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 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 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> will be used as the title of every page (instead of using [title] and [program]).

robots

<text> entspricht einer der Robots-Anweisungen, 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:

Before:
# Vorspann
!docinfo [domain_link]    http://www.udo-open-source.org/
!docinfo [domain_name]    UDO OpenSource
!docinfo [contact_link]   webmaster@udo-open-source.org
!docinfo [contact_name]   E-Mail an den Webmaster

# Dokument
!begin_document
!make_title
!end_document

Afterwards:

Copyright © UDO OpenSource (E-Mail an den Webmaster)
Letzte Aktualisierung am March 5, 2010

Werden weniger Informationen angegeben, so werden die Kontaktdaten in der Fußzeile entsprechend angepasst. Nachfolgend einige weitere Beispiele.

Before:
# Vorspann
!docinfo [domain_link]    http://www.meinedomain.de/
!docinfo [contact_link]   ich@meinedomain.de

# Dokument
!begin_document
!make_title
!end_document

Afterwards:

Copyright © http://www.meinedomain.de/ (ich@meinedomain.de)
Letzte Aktualisierung am March 5, 2010

Before:
# Vorspann
!docinfo [domain_name]    Meine Firma
!docinfo [contact_name]   Mein Name

# Dokument
!begin_document
!make_title
!end_document

Afterwards:

Copyright © Meine Firma (Mein Name)
Letzte Aktualisierung am March 5, 2010

Das zuletzt gezeigte Beispiel zeigt, dass nur die Parameter mit url 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.

Before:
# 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
!make_title
!end_document

Afterwards:

Copyright © Meine Domäne (Kontakt)
Letzte Aktualisierung am March 5, 2010

Hint: If you don't specify any data or use the switch !no_footers [html] in the preamble, UDO will output nothing.

translator

<text> describes the name of the localizer who has translated the product or document. When translator is used, the title page will show it below author and company as Translator: translator.

distributor

<text> describes the company which distributes the product or document. When distributor is used, the title page will show it below author and company as Distributor: distributor.

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 (Kontakt)
Last updated on March 5, 2010

Home D... !depth !doclayout