10.24 -U - Dateien in HTML-Seiten einbinden

RTFC Hypertext-Compiler

  Home
  Wegweiser
  Braille
  Daisy
  Download
  Kontakt
  Datenschutz
  Impressum

  Inhalt
  Index
  Suche

10.24 -U - Dateien in HTML-Seiten einbinden

201 Syntax

-Uinclude,position

wobei "include" für eine Datei mit HTML-Code (ohne Dateikopf und BODY-Tags), ein CSS Style Sheet oder eine JavaScript-Datei steht. Anstelle von HTML-Code können innerhalb dieser Datei auch serverseitige Includes angegeben werden, falls die Seiten für eine entsprechende Skriptsprache (ASP, PHP o. ä.) aufbereitet werden.

Bei fehlender Dateiendung wird .htm ergänzt.

Mit "position" wird festgelegt, an welcher Stelle oder für welchen Zweck die Datei innerhalb der HTML-Seiten eingebunden wird. Folgende Angaben sind möglich (Groß-/Kleinschreibung spielt keine Rolle):

Parameter	Position in der HTML-Datei
Top	Seitenanfang (direkt hinter dem einleitenden BODY-Tag)
Bottom	Seitenende (direkt vor dem abschließenden BODY-Tag)
Start	Textanfang (hinter der letzten Seitenüberschrift)
End	Textende (vor der Datei-Info am Seitenende)
AfterNavi	Unmittelbar nach den Hyperlinks zur Navigation (zur Ergänzung eigener Links oder anderer Elemente). Die Datei wird nur auf solchen Seiten eingebunden, auf denen Hyperlinks für die vorangehende oder nächste Seite erscheinen.
Navi	Unmittelbar vor den Hyperlinks zur Navigation (zur Ergänzung eigener Links oder anderer Elemente). Die Datei wird nur auf solchen Seiten eingebunden, auf denen Hyperlinks für die vorangehende oder nächste Seite erscheinen.
Decl	Bei den Deklarationen im Dateikopf.
Head	Bei den META-Angaben Im Dateikopf. Ersetzt neben MetaAngaben auch die Einbindung des von RTFC erzeugten Stylesheets.
CSS	In den Style Sheet-Angaben für das Medium "screen". Dies eignet sich zur Angabe projektübergreifender Formate für die Bildschirmdarstellung.
PRN	In den Style Sheet-Angaben für das Medium "print". Dies eignet sich zur Angabe projektübergreifender Formate für die Druckausgabe.
JavaScript	Dateikopf (als externe JavaScript-Datei). Wenn zusätzlich der Parameter -4,s oder -4,p angegeben wurde, wird die Datei mit RTFC-eigenen JavaScript-Funktionen ergänzt. Beachten Sie, dass externe JavaScript-Dateien offiziell erst ab dem HTML-Standard 4.0 unterstützt werden.

Anstelle der genannten Begriffe genügt auch die Angabe des jeweiligen Anfangsbuchstabens.

202 Beschreibung

Dieser Parameter ist nur dann wirksam, wenn als Ausgabeformat mit dem Parameter -O HTML oder XML gewählt wurde.

RTFC fügt die genannte Datei an der gewünschten Stelle innerhalb jeder HTML-Seite ein. Eine Ausnahme bilden die Angaben "AfterNavi" und "Navi", bei der die Datei nur auf HTML-Seiten mit Verweisen zur vorangehenden oder nächsten Seite) eingebunden wird. Also z. B. nicht im Inhaltsverzeichnis, der lokalen Suchmaschine und der RTFC Link-Liste. Sie darf deshalb nicht von den anderen Includes abhängig sein.

Innerhalb der eingebundenen HTML- und JavaScript-Dateien können Sie bestimmte Symbole in der Form $$symbol$ verwenden, um z. B. Querverweise auf die erzeugten HTML-Dateien oder Ihr Quelldokument zu machen. Folgende Symbole können verwendet werden:

Symbol	Ersatzzeichenkette
$$anchor=verweistext$	Der angegebene Verweistext wird wie bei einem manuellen Querverweis mit dem relativen Pfad oder der URL aus der Standard-Map-Datei einschliesslich lokalem Anker ersetzt (ermöglicht einen Sprung auf eine bestimmte Stelle innerhalb der Seite).
$$contents$	Relativer Pfad zum Inhaltsverzeichnis (Startseite).
$$credits$	HTML-Code für die Datei-Info am Seitenende. Erlaubt das Einfügen der Info an einer beliebigen Stelle. Um die bisherige Info zu entfernen, muss der Parameter -Ne angegeben werden.
$$date$	Datum der letzten Änderung (aktueller Compiliervorgang)
$$datetime$	Datum und Uhrzeit der letzten Änderung (aktueller Compiliervorgang)
$$default$	Relativer Pfad zur ersten Seite (Deckblatt).
$$destbase$	Dateiname der Startseite ohne Endung (ergibt sich aus dem Namen der Ausgabedatei).
$$destbmp$	Dateiname der Grafik für den Überschriftsbereich.
$$destfile$	Name der momentanen Ausgabedatei (HTML-Datei).
$$exclude$	Ende des Codebereichs, der auf bestimmten HTML-Seiten entfernt werden soll (siehe unten).
$$exclude=dateiname$	Angabe einer Datei mit einer Liste von HTML-Seiten, auf denen der nachfolgende Code entfernt werden soll (die Liste ist eine ANSI-Datei mit einem Dateinamen pro Zeile). Das Ende des Codebereichs wird mit $$exclude$ ohne Dateiangabe abgeschlossen (siehe oben).
$$glossary$	Relativer Pfad zum Glossar.
$$include=dateiname$	Angabe einer Datei, die an dieser Stelle zusätzlich eingebunden werden soll.
$$index$	Relativer Pfad zum Stichwortverzeichnis.
$$page=verweistext$	Der angegebene Verweistext wird wie bei einem 203 manuellen Querverweis mit dem relativen Pfad oder der URL aus der Standard-Map-Datei ersetzt (ermöglicht einen Sprung an den Seitenanfang).
$$search$	Relativer Pfad zur Stichwortsuche.
$$srcbase$	Dateiname des Quelldokuments ohne Endung.
$$srcdoc$	Dateiname des Quelldokuments im DOC-Format.
$$srcfile$	Dateiname des Quelldokuments im RTF-Format.
$$title$	Titel des Dokuments (laut Kommandozeile bzw. Datei-Info).

Bei den Angaben $$srcfile$ und $$srcdoc$ wird das Quelldokument (RTF- oder DOC-Datei) automatisch ins Zielverzeichnis kopiert, damit ein Hyperlink auf die Datei funktionieren kann.

Sie können innerhalb einer eingebundenen HTML-Datei auch Verweise auf Grafiken oder andere Dateien machen. Bei den Angaben "SRC=" in einem IMG-Tag oder "HREF=" in einem A-Tag werden lokale Dateien beim Übersetzen automatisch in das richtige Zielverzeichnis kopiert und der Verweis angepaßt. Voraussetzung ist, dass die Dateiangabe in Anführungszeichen steht.

Wenn Sie mit CSS Style Sheets arbeiten (HTML 4.0 oder XHTML), können Sie sich innerhalb der eingebundenen Dateien auch auf die Styles aus dem durch RTFC erzeugten Style Sheet oder einem zusätzlich eingebundenen Style Sheet beziehen. Dabei gelten neben den Formatangaben aus dem Quelldokument folgende vordefinierte Styles:

Style	Verwendungszweck
DIV.rtfctoc1	Einträge für Hauptüberschriften im Hypertext-Inhaltsverzeichnis.
DIV.rtfctoc2 bis DIV.rtfctoc6	Einträge für untergeordnete Überschriften im Hypertext-Inhaltsverzeichnis.
A.rtfctoc	Querverweise aus dem Hypertext-Inhaltsverzeichnis.
A.rtfchide	Verborgene Querverweise (erscheinen nicht unterstrichen).
.rtfcftn	Fußnotentext.
.rtfcbtn	Hyperlinks zur Navigation am Seitenanfang oder -ende.

Tipp:

Durch die eingebundenen HTML-Dateien können Sie das Seitenlayout Ihres gesamten Projekts beeinflussen und somit z. B. ein eigenes Firmendesign (Corporate Design) realisieren. Hierfür eignen sich besonders Tabellen sehr gut, da HTML verschachtelte Tabellen erlaubt. So ist es möglich, jede HTML-Seite in eine Tabelle mit den entsprechenden Rahmenelementen einzuschließen, indem Sie mit -Utop.htm,t den Tabellenanfang und mit -Ubottom.htm,b das Tabellenende beim Aufruf von RTFC einbinden.

Ein Beispiel hierfür bietet das RTFC-Benutzerhandbuch im HTML-Format, das als Demo zu RTFC geliefert wird.

204 Hinweis:

Die eingebundenen Dateien werden von RTFC nicht auf Syntaxfehler oder falschen HTML-Code überprüft. Sie müssen selbst darauf achten, dass diese Dateien korrekt codiert werden. Fehler in Includes können Ihre Seiten komplett unbrauchbar machen. Als Hilfe zum Prüfen der Seiten gibt es u. a. folgende Programme im Internet:

http://validator.w3.org
(W3C: HTML Validation Service - ermöglicht die Prüfung von HTML-Seiten im Internet)

http://www.htmlhelp.com/tools/validator/upload.html
(WDG HTML Validator - ermöglicht den Upload einer zu prüfenden Datei von Ihrer lokalen Festplatte)

http://bobby.watchfire.com/bobby/html/en/index.jsp
(Watchfire: Bobby - HTML Accessibility Analyzer - nützlich zum Erzeugen barrierefreier Internet-Seiten für Menschen mit Behinderungen)

Vorgabewert bei fehlender Positionsangabe

Die angegebene HTML-Datei wird am Seitenanfang eingebunden.

Beispiele

RTFC -Utop.htm,t -Ubottom.htm,b -Odokument.htm dokument.rtf

Die Datei top.htm wird am Seitenanfang, die Datei bottom.htm am Seitenende eingebunden. Auf diese Weise kann ein gemeinsamer "Rahmen" für alle HTML-Seiten definiert werden.

RTFC -Uend.htm,e -Odokument.htm dokument.rtf

Die Datei end.htm wird vor der Datei-Info eingebunden (auch wenn der Parameter -Ne angegeben wurde) und kann z. B. zusätzliche Hyperlinks oder allgemeine Informationen enthalten, die am Ende jeder Seite erscheinen sollen.

RTFC -Uprint.css,p -Odokument.htm dokument.rtf

Die Datei print.css wird als externes Style Sheet in jede HTML-Seite eingebunden. Sie kann zur Definition von Formaten für die Druckausgabe verwendet werden.

RTFC -Uscreen.css,c -Odokument.htm dokument.rtf

Die Datei screen.css wird als externes Style Sheet in jede HTML-Seite eingebunden. Sie kann zur Definition von Formaten für die Bildschirmdarstellung verwendet werden.

Beispiele für eingebundene Dateien

Wenn Sie folgenden HTML-Code mit der Angabe -Uend.htm,e in Ihre HTML-Seiten einbinden, erscheint auf jeder Seite ein Verweis auf Ihr Quelldokument im RTF-Format. Dies ermöglicht dem Anwender z. B. einen Download der Datei, um diese im eigenen Textverarbeitungsprogramm anzuzeigen oder zu drucken. Die Grafik download.png muss beim Compilieren im gleichen Verzeichnis wie end.htm stehen. Das Symbol $$srcfile$ wird von RTFC durch den Namen des Quelldokuments ersetzt.

<p>

<a href="$$srcfile$">Diese Dokumentation im RTF-Format</a>

</p>

205 Wenn Sie Ihre HTML-Seiten in eine Tabelle mit bestimmten Rahmenelementen einschließen wollen, müssen Sie 2 Dateien zur Definition des Tabellenanfangs und Tabellenendes einbinden. Dabei kann folgender Code als Vorlage dienen:

RTFC Benutzerhandbuch

</b></big></font></td>

</tr>

</td>

</td>

</tr>

</table>

Siehe auch:

Einbinden von HTML- und XML-Code

10.23 -T - Überschriftsbereich für die Seitenaufteilung

10.25 -V - Verzeichnis für temporäre Dateien