Archiv des LibreOffice- und OpenOffice.org-Wiki

[ÜberSicht] [TitelIndex] [WortIndex] [SeiteFinden

Aufbau einer Seite im Wiki

Sprache

Jede Seite sollte mit der Anweisung

#language de

beginnen, sodass in der HTML-Ausgabe die verwendete (natürliche) Sprache korrekt angegeben wird (wichtig für die interne Suche sowie für Suchmaschinen, Screenreader usw.)

Version

Auf jeder Seite sollte außerdem angegeben werden, mit welchem Programm und welcher Version die Anleitung getestet wurde:

(./) OOo2

Ergibt:

(./) OOo2

In der Regel dürfte es reichen, die erste (jüngste) Version anzugeben, auf die diese Anleitung zutrifft, bzw. diejenige Version, die man benutze, als man die Anleitung geschrieben hat, und danach die Versionsnummer jeder Hauptversionen (z.B. 2 oder 3), mit der die Anleitung später überprüft wurde, also z.B.

(./) OOo2.3 OOo3

Inhaltsangabe

Jede Seite sollte mit einem Abstract (Kurzinhaltsangabe) beginnen, in dem kurz erklärt wird, worum es in dem nachfolgendem Artikel geht (wichtig zur Orientierung für die Benutzer).

Inhaltsverzeichnis

Es folgt ggf. ein Inhaltsverzeichnis, das mit

<<TableOfContents>>

automatisch erzeugt wird.

Gliederung

Der Inhalt sollte durch Überschriften sinnvoll gegliedert werden. Dabei ist immer mit der Überschriften-Ebene 1 zu beginnen:

= Überschrift 1 =

Bei Unterpunkten soll keine Überschriftenebene übersprungen werden, also nicht eine Überschrift 3. Ebene auf eine 1. Ebene folgen lassen, selbst wenn es „besser aussieht“.

Textauszeichnung

Festbreitenschrift wird verwendet, wenn etwas ein- oder ausgegeben wird (Dateinamen, Pfade, Zellnamen, Tastennamen). Diese erzeugt man mit fallenden Akzent-Zeichen (`Text`). Beispiele:

`dateiname.odt`
`Strg`+`v`
Zelle `A1`

„Anführungszeichen“ werden verwendet, wenn wirklich etwas angeführt wird (Zitat) oder eine kursive Darstellung schlecht lesbar ist. Benutzen Sie bitte deutsche typographische Anführungszeichen („Text“).

Kursiv werden Bestandteile eines Dialogs (Schaltflächen, Optionen usw.), Namen und Begriffe dargestellt. Kursive Schrift wird durch zwei Apostrophe erzeugt (''Text''). Beispiel:

Mit einem Klick auf die SchaltFläche ''Durchsuchen…'' erhalten Sie eine Liste.

Fett wird die Menü-/ Befehlsfolge dargestellt, mit der man zu einem Dialog gelangt. Fette Schrift wird durch drei Apostrophe erzeugt ('''Text'''). Beispiel:

Weitere Einfügeoptionen erhalten Sie über '''Bearbeiten → Inhalte Einfügen…'''.

Die einzelnen Bestandteile einer Menüfolge werden durch einen Pfeil () voneinander abgegrenzt. Bitte achten Sie immer auf die exakte Schreibweise aller Begriffe (also genau so, wie sie in der Benutzeroberfläche erscheinen) und darauf, dass innerhalb von Menüfolgen keine Links entstehen, z.B.:

'''Extras → Optionen… → !OpenOffice.org → Darstellung'''

Fettkursiv wird nur im Fließtext zur Betonung eines Wortes verwendet, jedoch bitte nur äußerst sparsam, weil diese Darstellung sehr aufdringlich ist. Beispiel:

Verwenden Sie '''''nicht''''' die Option ''Korrektur''!

Unterstrichen wird in der Regel nie – der Leser würde einen Link erwarten.

Grafiken

Die Möglichkeiten Grafiken (z.B. Screenshots) und Text zu platzieren sind etwas begrenzt. Bewährt hat sich eine Layout-Tabelle, bei der je Zeile eine Grafik (rechts) eingebunden wird. Beispiel:

|| Beispieltext || {{attachment:beispielgrafik.png}} ||

Bei Screenshots sollte das IconSet Galaxy (Standard) (unter Linux leider nicht der Default) und der Font DejaVu (für Texte und sonstige Eingaben) bevorzugt werden. Es ist außerdem empfehlenswert, dass jede Grafik einen „sprechenden“ Namen erhält und/oder mit einem Alternativ-Text versehen wird, der das Dargestellte verbalisiert, z.B.:

{{attachment:feldbefehle.png|Dialog Feldbefehl Variable setzen}}

Kommentare

Es sind auch Inline-Kommentare möglich, die mit dem Link „Kommentare“ ein- und ausgeblendet werden können. Jedoch verwendet man besser als Autor Fußnoten (<<FootNote(Fußnote)>>) und als Leser ggf. die Diskussions-Unterseite.

Kategorie

Eine Seite wird mit einer horizontalen Linie und einer oder mehreren Kategorie-Markierungen abgeschlossen. Jeder Seite soll immer wenigstens eine Kategorie zugewiesen werden, im Zweifel die Kategorie, die dem Modul entspricht, auf die sich die Anleitung bezieht. Beispiel:

----
KategorieWiki

Auch bei der Einordnung in mehrere Kategorien soll wenigstens auch eine Modul-spezifische Kategorie gewählt werden.


KategorieWiki


LizenzBedingungen | AnbieterKennzeichnung | DatenschutzErklärung | Stand: 2013-04-28