AGSS Hilfe:Auflistungen

Aus AGSS

Kategorien

Der Dateiname ist die Hauptüberschrift! Damit ergibt sich von selbst, dass diese eindeutig sein müss(t)en. Das würde bedeuten, wenn z.B. für das Installationshandbuch eine Seite "Webserver" erstellt wird, dann kann für das Administratorhandbuch normalerweise keine Seite mit dem Dateinamen "Webserver" mehr erstellt werden.

Als Ausweg biete sich die von Mediawiki bereitgestellten Kategorien an. Stellen Sie sich diese als Verzeichnisnamen vor und in unterschiedlichen Verzeichnissen können natürlich die gleichen Dateinamen vorkommen. Hier für uns bedeutet das, dass in verschiedenen Kategorien dann durchaus gleiche Bezeichner verwendet werden können.

folgende Kategorien sind angelegt worden: Nutzerhandbuch, Installationshandbuch, Administrationshandbuch, Tools, Anleitungen.

Dateinamen

Die Hauptüberschrift ist der Dateiname! Der Dateiname sollte "gut lesbar" sein, damit er als Überschrift geeignet ist. Innerhalb dieser Kategorien muss der Dateiname eindeutig sein, aber es sind z.B. unter Nutzerhandbuch ebenso wie unter Anleitung der Dateiname "Wiki" möglich. Als Überschrift bzw. Dateiname erscheint dann z.B. "Nutzerhandbuch:Wiki" oder "Anleitung:Wiki".

weitere Überschriften

Bitte beachten: keine eigene Nummerierung vornehmen, auch nicht mit a) II)...

Hinweis: Vor dem ersten " = " darf kein Leerzeichen stehen, sonst wird der Text nicht als Überschrift erkannt.

Da die Hauptüberschrift der Dateiname darstellt, macht eine einzelne Überschrift der Kategorie 2 ("== Überschrift ==") normalerweise nur dann Sinn, wenn es überhaupt keine weitere Überschrift gibt.

Inhaltsverzeichnisse

Inhaltsverzeichnisse werden automatisch erstellt, wenn mehrere Überschriften vorhanden sind. Wenn Sie kein Inhaltsverzeichnis auf dieser Seite haben wollen, dann geben Sie in der ersten Zeile __NOTOC__ an.

Formulare und Programmmenüs

Button, Tasten und Tastenkombination

Bezeichnungen für Button werden einfach in Anführungsstriche geschrieben, z.B. "weiter"

Tasten werden üblicherweise in eckigen Klammern geschrieben, z.B. [Enter]

Bei Tastenkombinationen verbinden Sie die Tasten jeweils mit eine "+" (ohne Leerzeichen) z.B. [Strg]+[Alt]+[Entf]

Schrittfolgen

verwenden Sie bitte dazu eine Liste.
bitte nicht so: partitionieren --> formatieren --> installieren --> usw.

Platzhalter

ein Beispiel für Platzhalter: <schulname>.<stadt>.<kreis>.<bundesland>.schule.de

Listen

unnummerierte Listen

Listen sind praktisch:

sie sorgen für Struktur
sie sehen sauber aus
- man kann sie schachteln

Dieses Beispiel schreibt man so:

* sie sorgen für Struktur
* sie sehen sauber aus
** man kann sie schachteln

Das Listenzeichen (der Stern) muss das erste Zeichen der Zeile sein!

nummerierte Listen

nummerierte Listen werden nur verwendet, wenn

die Reihenfolge wichtig ist oder
die Nummern als Referenz nötig sind

Dieses Beispiel schreibt man so:

# die Reihenfolge wichtig ist oder
# die Nummern als Referenz nötig sind

Das Listenzeichen (die Raute) muss das erste Zeichen der Zeile sein!

Begriffserklärungen und Definitionen

Zwischen dem Text und der Definition lassen Sie bitte am Anfang und am Ende genau eine Leerzeile frei. Danach geben Sie die Definition wie im angegebenen Beispiel an:

:; mount /cdrom : zum Einklinken der DVD oder CD-ROM :; umount /cdrom : zum Ausklinken der DVD oder CD-ROM :; mount /a : zum Einklinken der Diskette in Laufwerk A: und :; umount /a : zum Ausklinken derselben.

stellt sich dann so dar:

mount /cdrom: zum Einklinken der DVD oder CD-ROM
umount /cdrom: zum Ausklinken der DVD oder CD-ROM
mount /a: zum Einklinken der Diskette in Laufwerk A: und
umount /a: zum Ausklinken derselben.

ASCII-Texte

Befehle auf der Kommandozeile

Zwischen dem Text und dieser dazustellenden Anweisung lassen Sie bitte am Anfang und am Ende genau eine Leerzeile. Rücken Sie diese Befehlszeile um exakt ein Leerzeichen ein.
ein Beispiel:

ein ls -l /home liefert:

drwx--x---+ 8 mmustermann root 4096 2004-07-19 14:57 mmustermann

stellt sich dann so dar:

ein ls -l /home liefert:

drwx--x---+ 8 mmustermann root 4096 2004-07-19 14:57 mmustermann

Ausgaben auf der Konsole

Zwischen dem Text und der darzustellenden Bildschirmausgabe lassen Sie bitte am Anfang und am Ende genau eine Leerzeile. Jede Zeile der Bildschirmausgabe rücken Sie um exakt ein Leerzeichen ein. Sind in dieser Ausgabe Leerzeilen, dann muss in dieser Zeile mindestens ein Leerzeichen stehen. ein Beispiel:
# file: mmustermann # owner: mmustermann # group: root user::rwx user:wwwrun:--x group::--x mask::--x other::---
stellt sich dann so dar:

# file: mmustermann
# owner: mmustermann
# group: root
user::rwx
user:wwwrun:--x
group::--x
mask::--x
other::---

conf-Dateien und Quelltexte

Die Darstellung von Dateien erfolgt wie bei Ausgaben auf der Konsole, nur das eine "Unterschrift" unter diese Darstellung kommt. Lassen Sie zwischen den Zeilen der Datei und dieser "Unterschrift" keine Leerzeile.

net use u: \\arktur\homes /yes net use p: \\arktur\pub /yes net use t: \\arktur\tmp /yes net time \\arktur /set /yes ''Abbildung: logon.bat''