cryptocd/ccd-infos/policy_formatierung.lyx

801 lines
13 KiB
Text
Raw Normal View History

#LyX 1.4.2 created this file. For more info see http://www.lyx.org/
\lyxformat 245
\begin_document
\begin_header
2005-04-23 22:35:52 +02:00
\textclass article
\begin_preamble
\usepackage{hyperref}
2005-05-13 11:17:11 +02:00
\usepackage{html}
\usepackage{german}
2005-04-23 22:35:52 +02:00
\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
2005-04-23 22:35:52 +02:00
\paperorientation portrait
\secnumdepth 3
\tocdepth 3
\paragraph_separation skip
\defskip medskip
\quotes_language swedish
2005-04-23 22:35:52 +02:00
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes true
\end_header
2005-04-23 22:35:52 +02:00
\begin_body
2006-07-27 22:59:06 +02:00
\begin_layout Title
2006-07-28 10:20:45 +02:00
Hinweise zur Erstellung von Lyx-Dokumenten
\end_layout
2005-04-23 22:35:52 +02:00
2006-07-27 22:59:06 +02:00
\begin_layout Author
f<EFBFBD>r Lyx 1.4.x
\end_layout
2005-04-23 22:35:52 +02:00
\begin_layout Standard
2005-04-23 22:35:52 +02:00
\begin_inset LatexCommand \tableofcontents{}
\end_inset
2005-04-23 22:35:52 +02:00
\end_layout
2005-04-23 22:35:52 +02:00
2006-07-27 22:59:06 +02:00
\begin_layout Section
Dokumenteigenschaften
\end_layout
2005-04-23 22:35:52 +02:00
2006-07-27 22:59:06 +02:00
\begin_layout Subsection
Einstellungen f<>r latex2html
\end_layout
2005-04-23 22:35:52 +02:00
2006-07-27 22:59:06 +02:00
\begin_layout Standard
Damit der latex2html-Konverter ein tex-Dokument korrekt umwandelt (inklusive
deutscher <20>bersetzung der Begriffe), muss zuerst in Lyx-Men<65>
\emph on
Dokument --> Einstellung --> LaTeX-Vorspann
\emph default
folgendes eingetragen werden:
\end_layout
2005-04-23 22:35:52 +02:00
2006-07-27 22:59:06 +02:00
\begin_layout Itemize
2005-04-23 22:35:52 +02:00
\backslash
2005-04-23 22:35:52 +02:00
usepackage{html}
\end_layout
2005-04-23 22:35:52 +02:00
2006-07-27 22:59:06 +02:00
\begin_layout Itemize
2005-04-23 22:35:52 +02:00
\backslash
2005-04-23 22:35:52 +02:00
usepackage{hyperref}
\end_layout
2005-05-13 11:17:11 +02:00
2006-07-27 22:59:06 +02:00
\begin_layout Itemize
2005-05-13 11:17:11 +02:00
\backslash
2005-05-13 11:17:11 +02:00
usepackage{german}
\end_layout
2005-04-23 22:35:52 +02:00
2006-07-27 22:59:06 +02:00
\begin_layout Subsection
Sonstiges
\end_layout
2005-04-23 22:35:52 +02:00
2006-07-27 22:59:06 +02:00
\begin_layout Standard
Die Sprache des Dokumentes auf Deutsch stellen:
\end_layout
2006-07-27 22:59:06 +02:00
\begin_layout Itemize
Im Lyx-Men<65>:
\emph on
Dokument
\emph default
->
\emph on
Einstellungen
\emph default
->
\emph on
Sprache
\end_layout
2006-07-27 22:59:06 +02:00
\begin_layout Section
Dokumentformatierung
\end_layout
2006-07-27 22:59:06 +02:00
\begin_layout Standard
Nachfolgend ist beschreiben, wie ein Lyx-Dokument aufgebaut ist.
Bitte beachte, dass du die Reihenfolge der Formatierungen beibeh<65>lst.
\end_layout
2006-07-27 22:59:06 +02:00
\begin_layout Subsection
Kopf: Die Titelleiste
\end_layout
\begin_layout Standard
Ein Lyx-Dokument beginnt mit dem Einf<6E>gen der Datei
\emph on
titlebar.inc.
\emph default
Das geht so:
\end_layout
\begin_layout Itemize
Im Lyx-Men<65>:
\emph on
Einf<EFBFBD>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<65>
\end_layout
\begin_layout Standard
Die eingef<65>gte Datei
\emph on
menue.inc
\emph default
ist daf<61>r verantwortlich, dass das Men<65> dargestellt wird.
<20>nderungen am Men<65> musst du also in dieser Datei vornehmen.
\end_layout
\begin_layout Standard
Das Einf<6E>gen geht so:
\end_layout
\begin_layout Itemize
Im Lyx-Men<65>: Einf<6E>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
2006-07-27 22:59:06 +02:00
\begin_layout Itemize
Beispiel:
\begin_inset Include \input{menue.inc}
2006-07-27 22:59:06 +02:00
preview false
\end_inset
\end_layout
\begin_layout Subsection
Kopf: css-Tag
\end_layout
\begin_layout Standard
Unterhalb des Men<65>s kommt ein Abschnitt mit sogenannten
\emph on
Evil Red Text (ERT)
\emph default
.
Klicke im Lyx-Men<65> auf den Button mit den roten Buchstaben
\emph on
TEX
\emph default
und f<>ge den folgenden Code ein:
\end_layout
\begin_layout Quotation
2006-07-27 22:59:06 +02:00
\begin_inset ERT
status open
\begin_layout Standard
\backslash
begin{rawhtml}
\end_layout
2006-07-27 22:59:06 +02:00
\begin_layout Standard
<!-- main starts here -->
\end_layout
2006-07-27 22:59:06 +02:00
\begin_layout Standard
<div id="main">
\end_layout
2006-07-27 22:59:06 +02:00
\begin_layout Standard
\backslash
end{rawhtml}
\end_layout
2006-04-10 17:40:31 +02:00
\end_inset
2006-04-10 17:40:31 +02:00
2006-07-27 22:59:06 +02:00
\end_layout
\begin_layout Subsection
Hauptteil: Titel
\end_layout
\begin_layout Standard
2006-07-27 22:59:06 +02:00
Der Hauptteil beginnt immer mit einem Titel.
Denke dir was sch<63>nes aus.
\end_layout
2005-04-23 22:35:52 +02:00
\begin_layout Subsection
2006-07-27 22:59:06 +02:00
Hauptteil: Autor (optional)
\end_layout
2005-04-23 22:35:52 +02:00
2006-07-27 22:59:06 +02:00
\begin_layout Enumerate
Die optionale Formatierung
\emph on
Autor
\emph default
kannst du f<>r eine weitere Beschreibung des Dokumentes benutzen.
<20>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<68>sselt Mailen
\end_layout
\begin_layout Subsection
Hauptteil: Inhaltsverzeichnis (optional)
\end_layout
2005-04-23 22:35:52 +02:00
\begin_layout Standard
2006-07-27 22:59:06 +02:00
Bei umfangreichen Dokumenten kannst du nun ein Inhaltsverzeichnis einf<6E>gen.
Das geht so:
\end_layout
2005-04-23 22:35:52 +02:00
2006-07-27 22:59:06 +02:00
\begin_layout Itemize
Im Lyx-Men<65>:
\emph on
Einf<EFBFBD>gen
\emph default
->
\emph on
Liste / Inhaltsverzeichnis
\emph default
->
\emph on
Inhaltsverzeichnis
\end_layout
2005-04-23 22:35:52 +02:00
\begin_layout Standard
2006-07-27 22:59:06 +02:00
<EFBFBD>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 <20>berschriften nicht
auf.
\end_layout
2005-04-23 22:35:52 +02:00
2006-07-28 10:20:45 +02:00
\begin_layout Subsection
Hauptteil: sonstiges
\end_layout
\begin_layout Subsubsection
2005-04-23 22:35:52 +02:00
Alle weiteren <20>berschriften werden als 'Subsection' formatiert
\end_layout
2005-04-23 22:35:52 +02:00
\begin_layout Subsubsection
2005-04-23 22:35:52 +02:00
Zitate werden als 'Quote' formatiert.
\end_layout
\begin_layout Standard
Im html wird daraus <blockquote>
\end_layout
2005-04-23 22:35:52 +02:00
\begin_layout Subsubsection
2005-05-12 20:53:56 +02:00
Hervorhebungen werden mit '!' markiert
\end_layout
2005-04-23 22:35:52 +02:00
\begin_layout Standard
2005-04-23 22:35:52 +02:00
\emph on
2005-04-23 22:35:52 +02:00
Eigennamen usw.
am besten mit '!' formatieren.
Im html wird daraus <class=
\begin_inset Quotes erd
\end_inset
2005-04-23 22:35:52 +02:00
textit
\begin_inset Quotes erd
\end_inset
2005-04-23 22:35:52 +02:00
>
\end_layout
2005-04-23 22:35:52 +02:00
\begin_layout Subsubsection
2005-04-23 22:35:52 +02:00
Bilder zentriert mit Beschreibung darstellen
\end_layout
2005-04-23 22:35:52 +02:00
\begin_layout Standard
2005-04-23 22:35:52 +02:00
Bilder werden normalerweise im html-Dokument linksb<73>ndig dargestellt.
Um dieses Verhalten zu <20>ndern oder um dem Bild eine Beschreibung hinzuzuf<75>gen,
2006-07-28 10:20:45 +02:00
muss es innerhalb eines
\emph on
Gleitobjekts
\emph default
liegen.
\end_layout
2005-04-23 22:35:52 +02:00
\begin_layout Standard
2005-04-23 22:35:52 +02:00
\begin_inset Float figure
wide false
sideways false
status open
2005-04-23 22:35:52 +02:00
\begin_layout Standard
2005-04-23 22:35:52 +02:00
\begin_inset Graphics
filename /home/phil/daten/sao/svn/cryptocd/trunk/documents/winpt/winpt_systray.png
2005-04-23 22:35:52 +02:00
\end_inset
2005-04-23 22:35:52 +02:00
\end_layout
2005-04-23 22:35:52 +02:00
\begin_layout Caption
2005-04-23 22:35:52 +02:00
dies ist eine Beschreibung
\end_layout
2005-04-23 22:35:52 +02:00
\end_inset
2005-04-23 22:35:52 +02:00
\end_layout
\begin_layout Standard
2005-04-23 22:35:52 +02:00
Folgende Schritte sind notwendig:
\end_layout
2005-04-23 22:35:52 +02:00
\begin_layout Enumerate
2006-07-28 10:20:45 +02:00
Im Lyx-Men<65>:
\emph on
Einf<EFBFBD>gen
\emph default
->
\emph on
Gleitobjekt
\emph default
->
\emph on
Abbildung
\end_layout
2005-04-23 22:35:52 +02:00
\begin_layout Enumerate
2006-07-28 10:20:45 +02:00
Hinter
\emph on
Abbildung #
\emph default
: die Beschreibung einf<6E>gen
\end_layout
2005-04-23 22:35:52 +02:00
\begin_layout Enumerate
2005-04-23 22:35:52 +02:00
Den Cursor an den Satzanfang der Beschreibung bringen dann 'Enter' - nun
ist <20>ber der Beschreibung Platz f<>r das Bild
\end_layout
2005-04-23 22:35:52 +02:00
\begin_layout Enumerate
2006-07-28 10:20:45 +02:00
Im Lyx-Men<65>:
\emph on
Einf<EFBFBD>gen
\emph default
->
\emph on
Grafik...
\end_layout
2005-04-23 22:35:52 +02:00
\begin_layout Standard
2005-04-23 22:35:52 +02:00
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<63>n aussieht.
\end_layout
\begin_layout Subsubsection
Screenshots - Nachbearbeitung
\end_layout
\begin_layout Itemize
2006-08-01 23:42:25 +02:00
maximale Pixelbreite: 600
\end_layout
\begin_layout Itemize
mit Gimp um den Wert 30 sch<63>rfen
\end_layout
\begin_layout Itemize
2006-08-04 12:35:23 +02:00
Hervorhebungen
\end_layout
2006-01-21 21:41:01 +01:00
2006-08-04 12:35:23 +02:00
\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<74>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
2006-07-27 22:59:06 +02:00
Gnome 2.12)
\end_layout
\begin_layout Subsubsection
2006-07-28 10:20:45 +02:00
B<EFBFBD>ser roter Tex
\end_layout
\begin_layout Standard
2006-07-28 10:20:45 +02:00
Bestimmte Formatierungen werden nur umgewandelt, wenn sie dem Konverter
direkt <20>bergeben werden.
Das erfordert die Eingabe von sogenannten
\emph on
Evil Red Text (ERT)
\emph default
.
Dieses Erfolgt <20>ber das Men<65> und den Button
\emph on
TEX
\emph default
.
\end_layout
\begin_layout Standard
2006-07-28 10:20:45 +02:00
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
2006-07-28 10:20:45 +02:00
\begin_layout Subsubsection
Links einf<6E>gen
\end_layout
2006-08-04 12:35:23 +02:00
\begin_layout Itemize
2006-07-28 10:20:45 +02:00
Links werden mit einer
\emph on
ERT
\emph default
-Formatierung eingef<65>gt:
\end_layout
2006-08-04 12:35:23 +02:00
\begin_deeper
\begin_layout Itemize
2006-07-28 10:20:45 +02:00
\begin_inset ERT
status open
\begin_layout Standard
\backslash
2006-07-28 10:20:45 +02:00
htmladdnormallink{Beschreibung}{Adresse}
\end_layout
\end_inset
\end_layout
2006-08-04 12:35:23 +02:00
\begin_layout Itemize
2006-07-28 10:20:45 +02:00
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
2006-04-21 12:52:53 +02:00
2006-08-04 12:35:23 +02:00
\begin_layout Itemize
2006-07-28 10:20:45 +02:00
Jedes Dokument liegt in einem gesonderten Verzeichnis, das genauso bezeichnet
2006-08-04 12:35:23 +02:00
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
2006-08-04 12:35:23 +02:00
\end_deeper
\begin_layout Standard
Enth<EFBFBD>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
2006-07-28 10:20:45 +02:00
Eine horizontale Linie einf<6E>gen
\end_layout
\begin_layout Standard
Die Dokumentation enth<74>lt zus<75>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
2006-07-28 10:20:45 +02:00
htmlrule
\end_layout
\end_inset
2006-08-01 23:42:25 +02:00
\end_layout
\begin_layout Subsubsection
Verweise auf Men<65>punkte der Programme
\end_layout
\begin_layout Standard
Falls du im Text auf einen Men<65>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
<span class="kbd">
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
\backslash
end{rawhtml}
\end_layout
\end_inset
$MEN<45>PUNKT
\begin_inset ERT
status open
\begin_layout Standard
\backslash
begin{rawhtml}
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
</span>
\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<65>hrt! Eventuell beinhaltet
die Fussnote einen Link mit "%"-Zeichen.
Die L<>sung findest du im Abschnitt
\begin_inset Quotes srd
\end_inset
Links einf<6E>gen
\begin_inset Quotes erd
\end_inset
.
\end_layout
2006-07-28 10:20:45 +02:00
\begin_layout Subsection
Ende: Der Fortschrittsbalken (optional)
\end_layout
\begin_layout Standard
2006-07-28 10:20:45 +02:00
Am Ende der meisten Dokumente erscheint ein Fortschrittsbalken.
Er zeigt auf, welche Seiten in der Dokumentation bereits bearbeitet wurden
2006-07-28 10:20:45 +02:00
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
<20>nderungen vorgenommen werden, die auf der aktuellen Formatierung der Fortschri
ttsbalken aufbauen.
\end_layout
\begin_layout Standard
2006-07-28 10:20:45 +02:00
Das Einf<6E>gen geht so:
\end_layout
2006-07-28 10:20:45 +02:00
\begin_layout Itemize
Im Lyx-Men<65>: Einf<6E>gen -> Datei -> Unterdokument
\end_layout
\begin_layout Itemize
Der Dateiname ist: $TITEL.inc, der Speicherort ist: progress/
2006-07-28 10:20:45 +02:00
\end_layout
2006-07-28 10:20:45 +02:00
\begin_layout Itemize
Im Eingabefeld muss es dann so lauten: progress/$TITEL.inc
2006-07-28 10:20:45 +02:00
\end_layout
2006-07-28 10:20:45 +02:00
\begin_layout Itemize
die Art der Einbindung ist ''Input''
\end_layout
2006-07-28 10:20:45 +02:00
\begin_layout Itemize
Beispiel:
\begin_inset Include \input{progress/policy_formatierung.inc}
2006-07-28 10:20:45 +02:00
preview false
\end_inset
\end_layout
2006-07-27 22:59:06 +02:00
\begin_layout Section
Verzeichnisstruktur und Dateinamen
2006-07-27 22:59:06 +02:00
\end_layout
\begin_layout Standard
Zum Speichern stehen dir einige Verzeichnisse unterhalb von trunk/documents
2006-07-28 10:20:45 +02:00
zur Verf<72>gung:
2006-07-27 22:59:06 +02:00
\end_layout
2006-07-28 10:20:45 +02:00
\begin_layout Enumerate
common/ -- Hier kommen allgemeine Dokumente rein
2006-07-27 22:59:06 +02:00
\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
2006-07-27 22:59:06 +02:00
\end_layout
2006-07-28 10:20:45 +02:00
\begin_layout Standard
Beim Speichern gilt folgendes (dies ist wichtig f<>r die Verlinkung innerhalb
der Lyx-Dokumente):
\end_layout
2006-07-27 22:59:06 +02:00
2006-07-28 10:20:45 +02:00
\begin_layout Itemize
Lege innerhalb eines der o.g.
Verzeichnisse ein neues Verzeichnis an,
2006-07-28 10:20:45 +02:00
\end_layout
2006-07-27 22:59:06 +02:00
2006-07-28 10:20:45 +02:00
\begin_layout Itemize
das neue lyx-Dokument in diesem Verzeichnis sollte denselben Namen tragen,
2006-07-28 10:20:45 +02:00
\end_layout
\begin_layout Itemize
speichere das Lyx-Dokument ab.
2006-07-27 22:59:06 +02:00
\end_layout
\end_body
\end_document