Hilfe:Auflistungen: Unterschied zwischen den Versionen

Aus Delixs
Zur Navigation springen Zur Suche springen
 
K (4 Versionen)
(kein Unterschied)

Version vom 4. März 2008, 23:24 Uhr

Allgemeines

Damit die Dokumentation möglichst wie "aus einem Guss" dem Leser erscheint, sind die folgende Festlegungen möglichst einzuhalten. Außerdem ist nur dadurch die Möglichkeit eines Konvertierprogramms in verschiedene Ausgabeformate gegeben.

Rechtschreibung

Wir sollten uns an der neuen deutschen Rechtschreibung orientieren. Es ist vorgesehen, diese Seiten nach der Fertigstellung durch Deutschlehrer in Hinblick auf die neue deutsche Rechtschreibung Korrekturlesen zu lassen.

"man"-Form?

Die Artikel sollen den Leser direkt ansprechen, also ist die unpersönliche man-Form beim Schreiben zu unterlassen.

Autoren bzw. Copyright-Vermerke

Angaben in der Art:

    © Vorname Name Jahr

gehören nicht in die Doku, dafür gibt es den Link Autoren und Mitwirkende auf der Hauptseite.
Warum? Weil viele an den Artikeln dranrum schreiben und es somit nicht mehr möglich ist, einen Einzelnen dafür verantwortlich zu machen.

Seitenstruktur und Einordnung

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.

Schreibweisen und Textauszeichnung

Usernamen

Schreiben Sie Accountnamen wie sysadm, root, service usw. bitte einheitlich kursiv:

  • ''kursiv'' wird als kursiv angezeigt.

Hinweise

Alle Hinweise, also alles was bei Nichtbeachtung zu Fehlern im System führen kann, schreiben Sie fett.

  • '''fett''' wird als fett angezeigt.

Dateinamen

Dateinamen werden als Code geschrieben.

  • <code>smb.conf</code> wird als smb.conf angezeigt.

URLs (als Text)

URLs wie z.B. http://arktur oder http://arktur/online oder http://arktur/admin haben hier nicht die Funktion eines Links, sondern stellen einen besonderen Text dar. Geben Sie bitte solche Links auch als Code an:

  • <code><nowiki>http://arktur</nowiki></code> wird als http://arktur angezeigt.


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

  1. die Reihenfolge wichtig ist oder
  2. 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.

dieses Beispiel stammt von der Seite Benutzerhandbuch:Datentraeger.


Wiki- und Weblinks

Links innerhalb des Wikis

Für einen einfachen Link brauchen Sie nur den Namen der Seite in zwei eckige Klammern zu setzen.

Wenn ein anderer Text für die Zielseite stehen soll, schreiben Sie das hinter einen senkrechten Strich (Pipe-Symbol)

  • [[Hauptseite|unser Wiki]] wird als unser Wiki angezeigt.

Links auf die Wikipedia u.a. Mediawikis

Man kann auch auf andere Mediawikis verlinken. Für die Seite zum Handbuch der Wikipedia sieht das dann so aus:

Links auf andere Webseiten

Eine URL im Text wird automatisch als Link angezeigt. Ein Beispiel:

Wenn ein anderer Text für die Zielseite stehen soll, dann schreibt man die URL in einfache eckige Klammern und mit einem Leerzeichen als Trennzeichen. Ein Beispiel:

  • [http://arktur.schul-netz.de Arktur-Portal] wird als Arktur-Portal angezeigt.

Links als Angabe im Text

Wenn Sie einen Link im Text angegeben wollen, ohne dass dieser dabei als Link funktionieren soll, dann machen Sie das bitte so:

  • <code><nowiki>http://arktur</nowiki></code> wird als http://arktur angezeigt.

Links als Quellenangaben

  • [http://arktur.schul-netz.de] wird als [1] angezeigt.


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

weitere Beispiele finden Sie z.B. auf der Seite Administratorhandbuch:ACL.

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::---

weitere Beispiele dazu finden Sie auf der Seite Administratorhandbuch:ACL.

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
''Datei 2.3-1: logon.bat''

stellt sich dann so dar: 

net use u: \\arktur\homes /yes
net use p: \\arktur\pub /yes
net use t: \\arktur\tmp /yes
net time \\arktur /set /yes

Datei 2.3-1: logon.bat


Bilder

Nur angemeldete Nutzer dürfen Bilder hochladen.

Zum Bild-Upload dient der Link hochladen links. Das hochgeladene Bild ist dann unter dem Link Spezialseiten in der Bilderliste zu finden.

Fotografien bitte im JPEG-Format mit der Dateiendung .jpg hochladen (ggf. konvertieren). Um Bild-Artefakte zu vermeiden, sollte als Qualitätsfaktor mindestens 90% gewählt werden, und höchstens 98%, um die Dateigröße zu begrenzen.

Im Gegensatz zu Fotografien ist bei allen anderen Grafiken das PNG-Dateiformat besonders geeignet. Falls möglich, sollten vorhandene GIF-Bilder nach PNG konvertiert werden.

Die Bildgröße sollte 500 Pixel Breite nicht übersteigen, da ansonsten der Ausdruck der Handbücher zu Problemen führt. Die einzelnen Bilder sollten 100kByte Dateigröße nicht übersteigen.

Um eine leichte Zuordnung der Dateien zu den Seiten zu ermöglichen, sollten diese Dateien mit kapitelname_nr.png bzw. kapitelname_nr.jpg bezeichnet werden.

Zugunsten eines durchgängig einheitlichen Layouts der Handbücher sollten Sie die hochgeladenen Bilder nun mit folgenden Zeilen einbinden (Kopiervorlage): 

:[[bild:dateiname.png|Beschreibung]]

:
:
:
:''Abbildung 2.3-1: Beschreibung''


Die Nummer der Abbildung ergibt sich aus der Nummerierung im jeweiligen Handbuch (hier 2.3), einem Bindestrich (-) und einer fortlaufenden Nummer (hier 1) auf der jeweiligen Seite.

Von einer Skalierung der Bilder sollten Sie absehen. Besser ist es, die Bilder bereits vor dem Hochladen mit einem Grafikprogramm auf die richtige Größe zu bringen.


Tabellen

Die Tabellenbreite sollte 600 Pixel nicht übersteigen und grundsätzlich einen Rahmen besitzen, da ansonsten der Ausdruck der Handbücher zu Problemen führt.

Die Definition der Spaltenbreite macht nur in der ersten Zeile Sinn.

Eine Tabelle mit zwei Tabellenzeilen und je zwei Zellen erstellen Sie mittels geschweifter Klammern und trennen Zeilen und Spalten mit senkrechten Strichen: 

{| border="1" width="600"
|width="30%"|Zelle 1
|width="70%"|Zelle 2
|-
|Zelle 3
|Zelle 4
|}

Und so sieht sie dann fertig aus:

Zelle 1 Zelle 2
Zelle 3 Zelle 4
Abgerufen von „https://wiki.sachsen.schule/dwiki/index.php?title=Hilfe:Auflistungen&oldid=4401“