#LyX 1.4.2 created this file. For more info see http://www.lyx.org/ \lyxformat 245 \begin_document \begin_header \textclass article \begin_preamble \usepackage{hyperref} \usepackage{html} \usepackage{german} \end_preamble \language ngerman \inputencoding auto \fontscheme default \graphics default \paperfontsize default \spacing single \papersize default \use_geometry false \use_amsmath 1 \cite_engine basic \use_bibtopic false \paperorientation portrait \secnumdepth 3 \tocdepth 3 \paragraph_separation skip \defskip medskip \quotes_language swedish \papercolumns 1 \papersides 1 \paperpagestyle default \tracking_changes false \output_changes true \end_header \begin_body \begin_layout Title Hinweise zur Erstellung von Lyx-Dokumenten \end_layout \begin_layout Author für Lyx 1.4.x \end_layout \begin_layout Standard \begin_inset LatexCommand \tableofcontents{} \end_inset \end_layout \begin_layout Section Dokumenteigenschaften \end_layout \begin_layout Subsection Einstellungen für latex2html \end_layout \begin_layout Standard Damit der latex2html-Konverter ein tex-Dokument korrekt umwandelt (inklusive deutscher Übersetzung der Begriffe), muss zuerst in Lyx-Menü \emph on Dokument --> Einstellung --> LaTeX-Vorspann \emph default folgendes eingetragen werden: \end_layout \begin_layout Itemize \backslash usepackage{html} \end_layout \begin_layout Itemize \backslash usepackage{hyperref} \end_layout \begin_layout Itemize \backslash usepackage{german} \end_layout \begin_layout Subsection Sonstiges \end_layout \begin_layout Standard Die Sprache des Dokumentes auf Deutsch stellen: \end_layout \begin_layout Itemize Im Lyx-Menü: \emph on Dokument \emph default -> \emph on Einstellungen \emph default -> \emph on Sprache \end_layout \begin_layout Section Dokumentformatierung \end_layout \begin_layout Standard Nachfolgend ist beschreiben, wie ein Lyx-Dokument aufgebaut ist. Bitte beachte, dass du die Reihenfolge der Formatierungen beibehälst. \end_layout \begin_layout Subsection Kopf: Die Titelleiste \end_layout \begin_layout Standard Ein Lyx-Dokument beginnt mit dem Einfügen der Datei \emph on titlebar.inc. \emph default Das geht so: \end_layout \begin_layout Itemize Im Lyx-Menü: \emph on Einfügen \emph default -> \emph on Datei \emph default -> \emph on Unterdokument \end_layout \begin_layout Itemize Der Dateiname ist \emph on titlebar.inc \end_layout \begin_layout Itemize Im Eingabefeld darf nur der Dateiname auftauchen - keine Pfadangaben! \end_layout \begin_layout Itemize Die Art der Einbindung ist ''Input'' \end_layout \begin_layout Itemize Beispiel: \begin_inset Include \input{titlebar.inc} preview false \end_inset \end_layout \begin_layout Subsection Kopf: Das Menü \end_layout \begin_layout Standard Die eingefügte Datei \emph on menue.inc \emph default ist dafür verantwortlich, dass das Menü dargestellt wird. Änderungen am Menü musst du also in dieser Datei vornehmen. \end_layout \begin_layout Standard Das Einfügen geht so: \end_layout \begin_layout Itemize Im Lyx-Menü: Einfügen -> Datei -> Unterdokument \end_layout \begin_layout Itemize Der Dateiname ist \emph on menue.inc \end_layout \begin_layout Itemize Im Eingabefeld darf nur der Dateiname auftauchen - keine Pfadangaben! \end_layout \begin_layout Itemize die Art der Einbindung ist ''Input'' \end_layout \begin_layout Itemize Beispiel: \begin_inset Include \input{menue.inc} preview false \end_inset \end_layout \begin_layout Subsection Kopf: css-Tag \end_layout \begin_layout Standard Unterhalb des Menüs kommt ein Abschnitt mit sogenannten \emph on Evil Red Text (ERT) \emph default . Klicke im Lyx-Menü auf den Button mit den roten Buchstaben \emph on TEX \emph default und füge den folgenden Code ein: \end_layout \begin_layout Quotation \begin_inset ERT status open \begin_layout Standard \backslash begin{rawhtml} \end_layout \begin_layout Standard \end_layout \begin_layout Standard
\end_layout \begin_layout Standard \backslash end{rawhtml} \end_layout \end_inset \end_layout \begin_layout Subsection Hauptteil: Titel \end_layout \begin_layout Standard Der Hauptteil beginnt immer mit einem Titel. Denke dir was schönes aus. \end_layout \begin_layout Subsection Hauptteil: Autor (optional) \end_layout \begin_layout Enumerate Die optionale Formatierung \emph on Autor \emph default kannst du für eine weitere Beschreibung des Dokumentes benutzen. Üblich ist es dort den Namen des Hauptdokumentes anzugeben. Ein Beispiel: \end_layout \begin_layout Itemize Title: Thunderbird installieren \end_layout \begin_layout Itemize Autor: Verschlüsselt Mailen \end_layout \begin_layout Subsection Hauptteil: Inhaltsverzeichnis (optional) \end_layout \begin_layout Standard Bei umfangreichen Dokumenten kannst du nun ein Inhaltsverzeichnis einfügen. Das geht so: \end_layout \begin_layout Itemize Im Lyx-Menü: \emph on Einfügen \emph default -> \emph on Liste / Inhaltsverzeichnis \emph default -> \emph on Inhaltsverzeichnis \end_layout \begin_layout Standard Überschriften werden nicht in das Inhaltsverzeichnis aufgenommen, wenn sie mit der Sternchen-Variante (bspw: \emph on Unterabschnitt* \emph default ) gekennzeichnet wurden. In den html-Dokumenten tauchen die Nummern vor den Überschriften nicht auf. \end_layout \begin_layout Subsection Hauptteil: sonstiges \end_layout \begin_layout Subsubsection Alle weiteren Überschriften werden als 'Subsection' formatiert \end_layout \begin_layout Subsubsection Zitate werden als 'Quote' formatiert. \end_layout \begin_layout Standard Im html wird daraus
\end_layout \begin_layout Subsubsection Hervorhebungen werden mit '!' markiert \end_layout \begin_layout Standard \emph on Eigennamen usw. am besten mit '!' formatieren. Im html wird daraus \end_layout \begin_layout Subsubsection Bilder zentriert mit Beschreibung darstellen \end_layout \begin_layout Standard Bilder werden normalerweise im html-Dokument linksbündig dargestellt. Um dieses Verhalten zu ändern oder um dem Bild eine Beschreibung hinzuzufügen, muss es innerhalb eines \emph on Gleitobjekts \emph default liegen. \end_layout \begin_layout Standard \begin_inset Float figure wide false sideways false status open \begin_layout Standard \begin_inset Graphics filename /home/phil/daten/sao/svn/cryptocd/trunk/documents/winpt/winpt_systray.png \end_inset \end_layout \begin_layout Caption dies ist eine Beschreibung \end_layout \end_inset \end_layout \begin_layout Standard Folgende Schritte sind notwendig: \end_layout \begin_layout Enumerate Im Lyx-Menü: \emph on Einfügen \emph default -> \emph on Gleitobjekt \emph default -> \emph on Abbildung \end_layout \begin_layout Enumerate Hinter \emph on Abbildung # \emph default : die Beschreibung einfügen \end_layout \begin_layout Enumerate Den Cursor an den Satzanfang der Beschreibung bringen dann 'Enter' - nun ist über der Beschreibung Platz für das Bild \end_layout \begin_layout Enumerate Im Lyx-Menü: \emph on Einfügen \emph default -> \emph on Grafik... \end_layout \begin_layout Standard Das Bild wird im html innerhalb einer Tabelle dargestellt - diese ist genauso breit wie das Bild selber. Lange Beschreibungen werden also umgebrochen, was mitunter unschön aussieht. \end_layout \begin_layout Subsubsection Screenshots - Nachbearbeitung \end_layout \begin_layout Itemize maximale Pixelbreite: 600 \end_layout \begin_layout Itemize mit Gimp um den Wert 30 schärfen \end_layout \begin_layout Itemize Hervorhebungen \end_layout \begin_deeper \begin_layout Itemize neue Ebene anlegen, \end_layout \begin_layout Itemize Stelle mit dem Auswahlwerkzeug markieren, \end_layout \begin_layout Itemize Auswahl mitFüllwerzeug und Farbe rot füllen \end_layout \begin_layout Itemize Tranzparenz der Ebene auf Wert 30 setzen \end_layout \end_deeper \begin_layout Itemize das GTK-Theme für die Linux-Screenshots ist Clearlooks (der Standard ab Gnome 2.12) \end_layout \begin_layout Subsubsection Böser roter Tex \end_layout \begin_layout Standard Bestimmte Formatierungen werden nur umgewandelt, wenn sie dem Konverter direkt übergeben werden. Das erfordert die Eingabe von sogenannten \emph on Evil Red Text (ERT) \emph default . Dieses Erfolgt über das Menü und den Button \emph on TEX \emph default . \end_layout \begin_layout Standard Eine Dokumentation zu den latex2html-Befehlen findest du unter \emph on http://www-texdev.mpce.mq.edu.au/l2h/docs/manual/ \emph default . \end_layout \begin_layout Subsubsection Links einfügen \end_layout \begin_layout Itemize Links werden mit einer \emph on ERT \emph default -Formatierung eingefügt: \end_layout \begin_deeper \begin_layout Itemize \begin_inset ERT status open \begin_layout Standard \backslash htmladdnormallink{Beschreibung}{Adresse} \end_layout \end_inset \end_layout \begin_layout Itemize Falls du auf eine Seite auf der CryptoCD verweist, gilt folgendes Schema zur Angabe der Adresse: \end_layout \begin_layout Itemize ../$VERZEICHNIS/DOKUMENT.LYX \end_layout \begin_layout Itemize Jedes Dokument liegt in einem gesonderten Verzeichnis, das genauso bezeichnet ist, wie das Dokument selbst.# \end_layout \end_deeper \begin_layout Itemize E-Mail-Adressen verlinken: \end_layout \begin_deeper \begin_layout Itemize \begin_inset ERT status open \begin_layout Standard \backslash htmladdnormallink{Adresse}{mailto: Adresse} \end_layout \end_inset \end_layout \end_deeper \begin_layout Standard Enthält ein Link ein Prozentzeichen, muss dieses maskiert werden: \backslash % statt %. Angezeigt wird dann ein normales %-Zeichen. Anderfalls wird der Link von latex als Kommentar interpretiert. \end_layout \begin_layout Subsubsection Eine horizontale Linie einfügen \end_layout \begin_layout Standard Die Dokumentation enthält zusätzliche Optionen zur Formatierung einer Linie. Ohne Optionen wird sie wie folgt dargestellt: \end_layout \begin_layout Standard \begin_inset ERT status open \begin_layout Standard \backslash htmlrule \end_layout \end_inset \end_layout \begin_layout Subsubsection Verweise auf Menüpunkte der Programme \end_layout \begin_layout Standard Falls du im Text auf einen Menüpunkt eines Programmes (z.B. Thunderbird) verweist, wir die entsprechende Stelle wie folgt formatiert: \end_layout \begin_layout Standard \begin_inset ERT status open \begin_layout Standard \backslash begin{rawhtml} \end_layout \begin_layout Standard \end_layout \begin_layout Standard \end_layout \begin_layout Standard \end_layout \begin_layout Standard \backslash end{rawhtml} \end_layout \end_inset $MENÜPUNKT \begin_inset ERT status open \begin_layout Standard \backslash begin{rawhtml} \end_layout \begin_layout Standard \end_layout \begin_layout Standard \end_layout \begin_layout Standard \end_layout \begin_layout Standard \backslash end{rawhtml} \end_layout \end_inset \end_layout \begin_layout Subsubsection Fussnoten \end_layout \begin_layout Standard Problem: Eine Fussnote fehlt in der Auflistung am Ende der html-Seite - nur das Verweis-Wort aus dem Text ist aufgeführt! Eventuell beinhaltet die Fussnote einen Link mit "%"-Zeichen. Die Lösung findest du im Abschnitt \begin_inset Quotes srd \end_inset Links einfügen \begin_inset Quotes erd \end_inset . \end_layout \begin_layout Subsection Ende: Der Fortschrittsbalken (optional) \end_layout \begin_layout Standard Am Ende der meisten Dokumente erscheint ein Fortschrittsbalken. Er zeigt auf, welche Seiten in der Dokumentation bereits bearbeitet wurden und welche noch folgen. Falls du einen neuen Fortschrittsbalken erstellen willst, nimm die Formatierung eines Bestehenden als Vorlage. Dies ist wichtig, weil bei einem make durch die Datei mod_html_files.py Änderungen vorgenommen werden, die auf der aktuellen Formatierung der Fortschri ttsbalken aufbauen. \end_layout \begin_layout Standard Das Einfügen geht so: \end_layout \begin_layout Itemize Im Lyx-Menü: Einfügen -> Datei -> Unterdokument \end_layout \begin_layout Itemize Der Dateiname ist: $TITEL.inc, der Speicherort ist: progress/ \end_layout \begin_layout Itemize Im Eingabefeld muss es dann so lauten: progress/$TITEL.inc \end_layout \begin_layout Itemize die Art der Einbindung ist ''Input'' \end_layout \begin_layout Itemize Beispiel: \begin_inset Include \input{progress/policy_formatierung.inc} preview false \end_inset \end_layout \begin_layout Section Verzeichnisstruktur und Dateinamen \end_layout \begin_layout Standard Zum Speichern stehen dir einige Verzeichnisse unterhalb von trunk/documents zur Verfügung: \end_layout \begin_layout Enumerate common/ -- Hier kommen allgemeine Dokumente rein \end_layout \begin_layout Enumerate windows/, linux/, macos/ -- Hier werden jeweils die betriebssystemspezifischen Anleitungen gespeichert \end_layout \begin_layout Itemize progress/ -- Hier werden die Fortschrittsbalken gespeichert \end_layout \begin_layout Standard Beim Speichern gilt folgendes (dies ist wichtig für die Verlinkung innerhalb der Lyx-Dokumente): \end_layout \begin_layout Itemize Lege innerhalb eines der o.g. Verzeichnisse ein neues Verzeichnis an, \end_layout \begin_layout Itemize das neue lyx-Dokument in diesem Verzeichnis sollte denselben Namen tragen, \end_layout \begin_layout Itemize speichere das Lyx-Dokument ab. \end_layout \end_body \end_document