Wissen > Doku-Richtlinien

Doku-Richtlinien

Freundlicher ausgedrückt: Ideen/Vorschläge, wie wir uns das Leben leichter machen können ... ;-D ... damit das Gesamt-Ding irgendwie einheitlich aussieht. Gutgemeinte Kommentare bitte an Martin .

Kurzanleitung

  1. Man lädt die bereits exisiterende Doku von Gruppe 5 von team5/welcome.html herunter, verwendet sie als Vorlage und passt sie den eigenen Bedürfnissen entsprechend an, damit man sich rundherum keine Gedanken machen muss :o)
    Achtung: Hirn nicht völlig abschalten, auch die Gruppe 5 produziert gelegentlich Blödsinn.
  2. Jede Gruppe lädt ihre HTML-Dateien per FTP in den Ordner mit der jeweiligen Gruppennummer (Nummern: siehe Hauptseite )
    Beispiel: Gruppe 5 legt ihre Dokumentation in team5/welcome.html am server ftp://cartoon.iguw.tuwien.ac.at/ als user fit08 ab.

Laaangversion, Details

ANWENDUNG
DO's
DONT's
Dateinamen
Einstiegsseite = "welcome.html"
nur Kleinbuchstaben (englisch)
Endung: ".html"
"index.html" als Startseite
Sonderzeichen und Umlaute
Stylesheets
Im Dateikopf einbinden mit <link rel="stylesheet" href="../fit08.css" type="text/css">
In der Datei neu definieren
Bilder
JPEG oder GIF (optimal: 72 dpi)
maximal 600 x 400 Pixel groß
zentriert
Mehrere Bilder nebeneinander (Bildschirmbreite!)
PNG, TIFF, BMP, ...
Überschrift 1 = Titel
<H1> ( = Überschriften erster Ordnung) sind reserviert für den Seitentitel (also bei der "Hauptseite" das Thema der 2er-Kleingruppe)
<H1> in der Seitengliederung verwenden wie <H2> bis <H6>
"Kopfzeile" = Navigations-
bereich
in der ersten Zeile findet sich der "Dokumentpfad" mit Links zu allen übergeordneten Seiten, getrennt durch Größerzeichen.
Beispiel: In der Kopfzeile des Dokuments der Gruppe 5 steht "Wissen > 5. Data Mining & Data Warehousing" - man sollte also immer auf den ersten Blick erfahren, "wo man gerade ist", und wie man (in der Hierarchie) "hinauf kommt".
Seite ohne Navigationsbereich
Gliederung
<H2> ... <H6>, <P> und <BR> verwenden (Überschriften, Absätze und Zeilenvorschübe)
Eine lange Wurscht produzieren
Schrift-
Formatierung
Fett- und Kursivschrift einsetzen (<B> und <I>)
Schriftarten explizit auswählen (das kollidiert dann mit den Stylesheets und wird wunderbar unschön ...)
Tabellen
Besser hoch als breit
Breite <= 600 Pixel erhöht Druckbarkeit
Über drei Bildschirmbreiten, damit der horizontale Scrollbalken auch ja schön schmal wird *g*
Layout
einfach und skalierbar halten
pixel-genau positionieren
Aufzählungen
<UL> und <OL> verwenden ((Un-)Geordnete Listen)
Ziffern oder "x)" hinschreiben und dann immer mit möglichst vielen Zeilenvorschüben und Leerzeichen einrücken
Quellen-
Angaben
Eigener Abschnitt (<H2> mit benanntem Anker) am Ende jedes HTML-Dokuments: <h2> <a name="quellen"> </a> Quellennachweis </h2>
<OL> mit Aufzählung der Quellen
Aus dem Dokument heraus mittels [5] auf den benannten Anker linken: <a href="#quellen">[5]</a>
Nix Zitaten
Nix Zitierregeln
Nix Quellenverzeichnissen