Deutsch|
EnglishVersion 1.1
Last edited 08/10/2006
Wenn Du ein Tutorial bei HowtoForge veröffentlichen möchtest, lese bitte vorab diesen Formatierungsleitfaden. Er wird Dir zeigen, wie Du Dein Tutorial so formatierst, dass es dem Format von HowtoForge entspricht und so viele Leser wie möglich anspricht. Dieser Leitfaden hilft Dir außerdem die Größe Deines Dokumentes zu minimieren.
1 Welches Programm verwende ich um mein Howto zu scheiben?
Verwende einen HTML Editor wie zum Beispiel Dreamweaver oder jeden anderen HTML Editor, der gültiges HTML erstellt. Bitte verwende nicht MS Word um HTML Inhalte zu erstellen, da Word “seltsames” HTML hervorruft…
2 Wie fange ich an?
Ok, Du sitzt also startbereit vor Deinem HTML Editor, aber wie geht’s weiter? Bitte kopiere diese HTML-Vorlage in Deinen Editor:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title></title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<style type="text/css">
<!--
.command {
padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;
font-family: Courier New, Courier, mono;
font-size: 12px;
font-style: italic;
}
.system {
color: black;
font-family: Courier New, Courier, mono;
font-size: 12px;
font-style: italic;
}
.highlight {
color: #FF0000;
font-family: Georgia, "Times New Roman", Times, serif;
font-size: 12px;
text-decoration: underline;
}
-->
</style>
</head>
<body>
</body>
</html>
|
Nun schreibst Du Dein Tutorial zwischen die tags <body> und </body>.
3 Formatieren
3.1 Üblicher Text
Verwende immer die Standardschriftart für übliche Texte und Überschriften! Verwende keine <font> tags und definiere keine eigenen CSS Klassen. Die ganze Formatierung wird von HowtoForge Klassen vorgenommen nachdem Du Dein Tutorial veröffentlicht hast.
Zum Beispiel sollte Folgendes vermieden werden:
<p><font size=”2″ face=”Verdana, Arial, Helvetica, sans-serif”>This is a sentence.</font></p>
Verwende stattdessen einfach:
<p>This is a sentence.</p>
Auf HowtoForge wird dies dann so aussehen:
This is a sentence.
3.2 Überschriften
Bitte verwende <h1>…</h1>, <h2>…</h2>, <h3>…</h3>, <h4>…</h4>, oder <h5>…</h5> um Überschriften zu formatieren. Noch einmal, verwende keine <font> tags oder CSS Klassen zum Formatieren.
Die Überschrift,
<h3>This Is A Heading</h3>
wird auf HowtoForge nachher so aussehen:
This Is A Heading
3.3 Befehle
Bitte verwende die CSS Klasse .command (definiert im <head>…</head> Abschnitt der HTML-Vorlage) um Kommandozeilen so zu formatieren, dass der Leser weiß, dass dies etwas ist, was er per Kommandozeile ausführen soll. Zum Beispiel wird die folgende Zeile,
<p class=”command”>chmod 755 /path/to/file</p>
auf HowtoForge so aussehen:
chmod 755 /path/to/file
3.4 Dateiinhalte
Inhalte von Dateien sollten mit <pre>…</pre> angehangen werden. Wenn Du Lesern zum Beispiel den Inhalt von etc/resolv.conf zeigen möchtest, empfiehlt sich Folgendes:
<pre>search server
nameserver 145.253.2.75
nameserver 193.174.32.18
nameserver 194.25.0.60</pre>
Auf HowtoForge wird dies dann so erscheinen:
search server nameserver 145.253.2.75 nameserver 193.174.32.18 nameserver 194.25.0.60
3.5 Dateinamen, Protokollnamen, Systembeschreibungen, technische Daten, etc.
Wenn in Deinem Text Begriffe auftauchen, die mit dem Linuxsystem in Beziehung stehen und keine Befehle sind, Du sie aber dennoch besonders formatiern möchtest, kannst Du die CSS Klasse .system verwenden. Wenn Du zum Beispiel eine Datei im fortlaufenden Text erwähnst, ist es ganz gut diese so zu formatieren:
<p>Next we edit <span class=”system”>/etc/network/interfaces</span> so that it looks like this:…</p>
Auf HowtoForge wird dies so aussehen:
Als Nächstes bearbeiten wir /etc/network/interfaces dass es wie folgt aussehen wird:…
3.6 Markieren
Wenn Du etwas markieren möchtest, kannst Du die CSS Klasse .highlight verwenden. Zum Beispiel sieht Folgendes,
<p class=”highlight”>server1:</p>
so aus:
server1:
4 Das Veröffentlichen Deines Tutorials
Es gibt zwei Möglichkeiten wie Du Dein Tutorial veröffentlichen kannst: story und book page. Wenn Du denkst, dass Dein Tutorial auf eine Seite passt, wähle story. Sollte Dein Tutorial recht lang sein und Du es auf mehere Seiten aufteilen möchtest, wähle bitte book page.
4.1 Einen Beitrag schreiben (story)
Nachdem Du Dich bei HowtoForge eingeloggt hast, klicke bitte auf Contribute -> Create Content -> story:
Du siehst dann die Seite im HowtoForge’s WYSIWYG Editor. Gib den Title Deines Beitrages ein und wähle eine oder mehere Kategorien aus. Ist Dein Beitrag sehr kurz, wähle bitte eine oder mehere Kategorien von der Mini-Howtos Box aus, oder anderenfalls eine oder mehrere Kategorien von der Howtos Box. (Mehr als eine Option kannst Du mit Hilfe der Strg-Taste auswählen. Halte einfach die Strg-Taste gedrückt während Du mit der Mouse auf die Optionen klickst. )
Im Anzeigenfeld des WYSIWYG Editors wechselst Du zum HTML Quelltextmodus:
Kopiere dann den Quelltextmodus Deines HTML Editors (nur den Teil zwischen dem <body> tag und dem </body> tag, nicht inklusive der tags!) und füge ihn in den WYSIWYG Editor ein. Klicke dann auf Update:
You can leave the Excerpt textarea (below the Body textarea) empty, the system will then auto-generate an excerpt for your tutorial.
Klicke danach auf “Preview” oder “Submit” und Du wirst sehen, wie Dein Tutorial auf HowtoForge aussehen wird!
4.2 Ein Buch schreiben
4.2.1 Die erste Seite
Nachdem Du Dich bei HowtoForge eingeloggt hast, klicke bitte auf Contribute -> Create Content -> book page:
Du siehst dann die Seite im HowtoForge’s WYSIWYG Editor. Gib den Titel Deines Beitrags ein und wähle eine oder mehrere Kategorien von der Howtos Box aus - die Mini-Howtos Box findet hier keine Anwendung, da ein Buch nicht als Mini-Howto in Betracht gezogen werden kann. (Mehr als eine Option kannst Du mit Hilfe der Strg-Taste auswählen. Halte einfach die Strg-Taste gedrückt während Du mit der Mouse auf die Optionen klickst.)
Wähle unter Parent <top-level> aus, dass dies die erste Seite ist:
Kopiere dann den HTML Quelltextmodus der ersten Buchseite Deines HTML Editors (nur den Teil zwischen dem <body> tag und dem </body> tag, nicht inklusive der tags!) und füge sie in das Azeigenfeld des WYSIWYG Editors ein. Klicke dann auf Update, wie bereits erwähnt unter 4.1 Einen Beitrag schreiben.
You can leave the Excerpt textarea (below the Body textarea) empty, the system will then auto-generate an excerpt for your tutorial.
Klicke danach auf “Preview” oder “Submit” um zu sehen, wie Dein Tutorial auf HowtoForge aussehen wird!
4.2.2 Weitere Seiten
Um weitere Seiten Deiner ersten Buchseite hinzuzufügen, klicke bitte auf Contribute -> Create Content -> book page.
Gib den gleichen Titel der ersten Seite ein plus - Page [no.] , z. Bsp. - Page 2 für die zweite Seite, - Page 3 für die dritte Seite und so weiter. Unter Parent wählst Du die erste Seite Deines Buches aus, so dass Seite 2, Seite 3, Seite 4 etc den gleichen Vorgänger (nämlich die erste Seite Deines Buches) haben.
Unter Howtos und Mini-Howtos klickst Du zweimal auf <none> :
Der Rest ist genau das gleiche Prozedere wie bei der ersten Seite.
5 Bilder
Bitte lade keine Bilder hoch, die eine Breite von 550 Pixel überschreiten!
Du kannst Bilder Deinem Tutorial wie folgt hinzufügen:
Klicke mit dem Cursor im WYSIWYG Editor an die Stelle, wo Du das Bild einfügen möchtest:
Klicke dann auf das Bildsymbol unter dem Editor:
Ein Fenster öffnet sich:
Klicke auf add image. Gebe den Titel für Dein Bild ein und wähle es von der Festplatte Deines Rechners zum Hochladen aus. Wähle unter Screenshots <none> und lasse das Beschreibungsfeld frei. Klicke dann auf Submit:
Dein Bild wird hochgeladen und erscheint danach im Feld um ausgewählt werden zu können:
Wähle Dein Bild aus. Unter Image to use klicke auf original und dann auf Insert image:
Danch findest Du Dein Bild im WYSIWYG Editor an der Stelle, wo sich der Cursor vorher befand:
6 Zustimmung des Administrators
Dein neues Tutorial wird nicht sofort für andere verfügbar sein. Einer unserer Administratoren wird Formatierung, Inhalt etc. überprüfen. Dein Tutorial wird dann höchstwahrscheinlich freigegeben werden. Danach wird es auf HowtoForge anderen zur Verfügung stehen.
