Deutsch:

Die freie und offene Büro-Software
Apache OpenOffice 4.1.1 ist verfügbar!

1 Über dieses Dokument

1.1 Zielsetzung

In diesem Styleguide sollen einige Grundregeln für die Gestaltung der im deutschen OpenOffice.org Projekt erstellten Dokumente definiert werden. Es soll sichergestellt werden, dass Dokumente einheitlich gestaltet sind und eine weitere Bearbeitung durch andere Mitglieder vereinfacht wird.

Der vorliegende Styleguide bezieht sich auf Druckdokumente und ist nicht ohne diverse Anpassungen für Onlineveröffentlichungen geeignet.

Dieser Styleguide ist eine Empfehlung! Der Inhalt ist wichtiger als die Form. Der Styleguide soll eine Arbeitserleichterung bieten, um Dokumente zu erstellen. Dazu dienen die auf diesem Styleguide basierenden Dokumentvorlagen.

1.2 Anwendung

Dokumente sollten stets mit OpenOffice.org erstellt werden, da dann Dokumentvorlagen genutzt werden und Formate auch nachträglich zentral geändert werden können. Werden Dokumente mit einer anderen Software erstellt, sollten die Formatvorschläge unter 6 umgesetzt werden.

Es werden folgende Dateien als Arbeitserleichterung zur Verfügung gestellt.

Bezeich­nung

Dateiname

Zweck

Stylevorlage

styleguide.stw

Dokumentvorlage mit allen im Styleguide definierten Formatvorlagen. Sie kann als Ausgangsdokument genutzt werden. Gleichzeitig können über die Funktion Format - Vorlagen - Laden... die Formatvorlagen eines bestehenden Dokumentes aktualisiert werden.

Farbtabelle

styleguide.soc

Farbtabelle, die im Dialog „Fläche“, Karteikarte „Farben“ geladen werden kann.

Tabellen­vorlage

sg_tabellen.sxw

Enthält Tabellen, die im Menü Format - AutoFormat den Tabellen Autoformaten hinzugefügt werden können.

Dokument­vorlagen

template.zip

Enthält ein Dokumentgerüst und die wichtigsten Grafiken.

Fonts

www.gnome.org/fonts

Frei verfügbaren Schriften (Bitstream Vera im TTF Format sollten genutzt werden).

Tabelle 1: Arbeitsmittel zum Styleguide

Um die Richtlinien hinsichtlich Rechtschreibung und Begriffen einzuhalten, sollte mit eingeschalteter Rechtschreibprüfung gearbeitet werden. Oft benötigte Begriffe können in der Autokorrektur definiert werden (z.B. OOo -> OpenOffice.org).

1.3 Änderung des Styleguides

Dieser Styleguide deckt sicherlich nicht alle Belange ab, die bei der Erstellung von Dokumentationen zu beachten sind. Änderungen und Ergänzungen werden über das deutsche OpenOffice.org Projekt eingearbeitet.

Dazu ist ein Issue mit der Beschreibung (Summary) „Erweiterung Styleguide“ für die Komponente „de“ zu eröffnen. Der Issue kann direkt einem der Autoren (siehe 7 Autoren) zugewiesen werden (Feld Assigned to“). Alternativ können die Autoren auch nachträglich informiert werden (Feld „Add cc“).

Bedenken Sie aber, dass das Team wechselt, einzelne Mitglieder also evtl. nicht zur Verfügung stehen.

1.4 Was ist noch zu tun

Der Styleguide muss noch anhand der zu bereits vorhandenen Dokumentationen geprüft werden. Folgende Fragen stehen z.B. noch offen:

2 Sprache, Rechtschreibung, Textgestaltung

2.1 Ausdrucksstil

2.2 Rechtschreibung

Neue deutsche Rechtschreibung verwenden, im Zweifelsfall die Rechtschreibprüfung zu Hilfe nehmen oder unter www.neue-rechtschreibung.de prüfen.

Das „ß“ nicht nutzen, wo es nicht hingehört.

Werden Wörter von Hand getrennt, nur weiche Trennungen verwenden (<Strg>+<->), um zu vermeiden, dass bei Änderungen keine Wörter mit Trennzeichen mitten in der Zeile stehen (z.B. Trenn-zeichen).

2.3 Kennzeichnung von Schlüsselwörtern, Dialogelementen

Um Schlüsselwörter, Tastenkombinationen, Dialogelemente u.ä. klar zu kennzeichnen, werden eine einheitliche Notationsweise und spezielle Zeichenvorlagen für die Hervorhebung benutzt.

In der folgenden Tabelle sind in den Hinweisen zur Notation mit Leerzeichen immer geschützte Leerzeichen ( <Strg>+<Leerzeichen> ) gemeint.

Kategorie

Notation

Zeichenvorlage

Beispiel

Dialoge, Dialogelemente

Beschreibung des Elementes (z.B. „Schaltfläche“, „Options­feld“) bzw. „Dialog“ und dann in Anführungszeichen die Bezeichnung wie am Bildschirm angezeigt.

Dialog

Dialog „Öffnen“

Schaltfläche „Abbruch“

Hervorhebung

Sonstige hervorzuhebende Elemente

Betont

Der Satz ist wichtig!

Menüeinträge

Bezeichnung der Menüeinträge in der Reihenfolge der Auswahl, jeweils getrennt durch „ - „

Menü

Datei - Neu - Text­dokument

Nutzer­ein­gaben

Genauen Text der Eingabe ohne Anführungszeichen wiedergeben.

Nutzer­ein­gabe

Geben Sie TestDB ein

System-, Status-, Fehler­mel­dun­gen

Genauen Text der Meldung wieder­geben. Im Fließtext in An­führungszeichen setzen oder auf eine separate Zeile ohne Anfüh­rungszeichen.

Meldung

„Die Rechtschreib­prüfung ist abgeschlossen“

Tasten und Tastenkombinationen

In spitze Klammern einschließen, bei Kombinationen mit „+“ verbinden.

Tastatur

<Strg>+<p>
<AltGr>

Internet Link, Verweis

Minimal benötigter Linktext ohne Anführungszeichen.

Internet Link

de.openoffice.org

Tabelle 2: Hervorhebungen

2.4 Tipps und systemspezifische Hinweise

Tipps, die besondere Aufmerksamkeit verdienen bzw. eine Zusammenfassung einer längeren Textpassage darstellen, werden durch ein Symbol am linken Textrand gekennzeichnet. Der Text selbst wird entsprechend eingerückt und grau hinterlegt.

Erklärungen, die nur auf ein bestimmtes Betriebssystem zutreffen werden auf die gleiche Art gekennzeichnet.

Als Symbole stehen Hinweis , Tipp und Achtung zur Verfügung.

Für die Systemplattformen stehen die Symbole Linux , Solaris , Unix und Windows zur Verfügung

Die hier gezeigte Darstellung wird durch einfügen einer Tabelle erreicht. Der Tabelle wird das Autoformat Ooo Hinweis“ zugewiesen. Nachträglich muss die Breite der ersten Spalte auf 1,30cm gestellt und die vertikale Textausrichtung in Spalte 1 auf „Mitte“ gestellt werden. Das Symbol erhält die Rahmenvorlage Hinweissymbol. Um die Trennung vom normalen Text zu wahren, wird der obere und untere Abstand auf 12pt gesetzt.

Anstatt beim Einfügen eines Hinweises die Spaltenbreite per Hand anzupassen und die Tabelle per Autoformat zu formatieren und der Grafik die entsprechende Vorlage zuzuweisen ist die Verwendung eines AutoText Bausteins zu empfehlen:

  • Eine Hinweistabelle mit Grafik und ohne Hinweistext erstellen und korrekt formatieren.

  • Tabelle komplett markieren und Bearbeiten - Autotext aufrufen.

  • Namen und Kürzel vergeben und Schaltfläche „Autotext“ - “Neu“ wählen.

Ein neuer Hinweis kann dann bequem per Kürzel+<F3> eingefügt werden. Es muss nur der eigentliche Hinweistext hinzugefügt werden, Formate, Grafiken, etc. ist dann bereits vorhanden.

3 Formatierung

3.1 Grundregeln

3.2 Farben

Farben haben einen hohen Wiedererkennungswert und sind ein gutes gestalterisches Mittel. Trotzdem sollte nur eine begrenzte Farbpalette sparsam eingesetzt werden.

Der großflächige Einsatz von Farben (z.B. farbige Flächendiagramme über eine ganze Seite) sollte vermieden werden.

Farben sollten nie als alleiniges Mittel zur Unterscheidung von Inhalten genutzt werden. Die Dokumente werden oftmals privat auf schwarz-weiß Druckern ausgedruckt.

Name


RGB

CMYK

Hex

Beispiel

Schwarz

Text

0,0,0

0,0,0,100

#000000



OOo Blau

Logo Farbe

6,52,140

53,35,0,45




OOo Rot

Über­schriften

195,0,0

0,76,76,24

#c30000



Weiß

Hintergrund

255,255,255


#ffffff



Grau 6%

Betonter Hintergrund

240,240,240

0,0,0,6

#f0f0f0



Grau 20%


204,204,204

0,0,0,20

#cccccc



Grau 80%


51,51,51

0,0,0,80

#333333



Hellblau


0,0,255

100,100,0,0

#0000ff



OOo Blau 1

Tabellen­hinter­grund

153,204,255

40,20,0,0

#99ccff



OOo Blau 2

Link auf Webseite

102,102,204

40,40,0,20

#6666cc



OOo Blau 3


0,49,90

35,16,0,65

#00315a



OOo Rot 1


204,51,51


#cc3333



Tabelle 3: Farbtabelle

3.3 Formatvorlagen und deren Bedeutung

Bezeich­nung

Klasse

Verwendung

Hinweise

Abbildung

Absatzvorlage

Abbildungsbe­schriftungen


Aufzählung 1 ..
Aufzählung n

Absatzvorlage

Aufzählungen

Es sollten nicht mehr als drei Ebenen verwendet werden.

Lizenz

Absatzvorlage

Lizenztext


Tabelle

Absatzvorlage

Tabellen­be­schriftung


Tabellen Inhalt

Absatzvorlage

Text in Tabellen


Tabellen Überschrift

Absatzvorlage

Überschrift von Tabellen


Teilüber­schrift

Absatzvorlage

Überschrift zur Trennung größe­rer Teile der Dokumenta­tion


Textkörper

Absatzvorlage

Standardtext

Für normale Absätze und allgemeinen Text.

Titel

Absatzvorlage

Dokumenttitel


Überschrift 1 ..
Überschrift n

Absatzvorlage

Überschriften

Es sollten nicht mehr als fünf Ebenen verwendet werden.

Untertitel

Absatzvorlage

Untertitel / Zwischen­überschrift


Grafik

Rahmen­vorlage

Allgemeine Grafiken

Grafiken werden normalerweise als Zeichen verankert. Andere Verankerungen sowie Textfluss wird über einen umliegenden Rahmen gesteuert, der sich z.B. nach der Beschriftung ergibt

Grafik als Zeichen

Rahmen­vorlage

Kleine Grafiken

Symbole, die direkt im Text mitfließen

Hinweis­symbol

Rahmen­vorlage

Symbole für Hinweise

Siehe 2.4

Rahmen

Rahmen­vorlage

Standard­rahmen für Screenshots


Rahmen Rechts

Rahmen­vorlage

Kleinere Grafiken

Für kleinere Grafiken (weniger als 50% Spaltenbreite), die mit Textumfluss angezeigt werden können

Erste Seite

Seitenvorlage

Erste Seite / Deckblatt


Buchteil

Seitenvorlage

Trennseite von Buchteilen


Standard

Seitenvorlage

Normale Seite im Dokument


Verzeichnis

Seitenvorlage

Seiten zwischen erster Seite und Text

Für Copyright, Inhaltsverzeichnis ...

OOo mit Rahmen

Tabellen­autoformat

Tabellen

Einer Tabelle über Menü Format - AutoFormat zuweisen

OOo ohne Rahmen

Tabellen­autoformat

Tabellen

Einer Tabelle über Menü Format - AutoFormat zuweisen

Betont

Zeichen­vorlage

Allgemeine Hervorhebungen

Siehe 2.3

Dialog

Zeichen­vorlage

Dialogelemente

Siehe 2.3

Internet Link

Zeichen­vorlage

Internet Link, Verweis

Siehe 2.3

Meldung

Zeichen­vorlage

Statusmeldung

Siehe 2.3

Menü

Zeichen­vorlage

Menüeinträge

Siehe 2.3

Nutzereingabe

Zeichen­vorlage

Nutzer­ein­ga­ben

Siehe 2.3

Tastatur

Zeichen­vorlage

Tasten und Tasten­kom­bi­nationen

Siehe 2.3

Tabelle 4: Formatvorlagen

Werden in einem Dokument zusätzliche Formatierungen verwendet, sollten diese eine eindeutige Bezeichnung erhalten und im Dokument erwähnt werden bzw. in diesen Style­guide einfließen.

4 Umgang mit Dokumenten

4.1 Einbinden von Grafiken

4.2 Erstellen von Screenshots

4.3 Positionieren von Grafiken

4.4 Einbinden von Objekten

4.5 Einbinden von OpenOffice.org Dokumenten

Dieser Abschnitt sollte geschrieben werden, sobald benötigt.

4.6 Richtlinien für Gliederungen

Es sollten enthalten sein:

Je nach Größe des Dokumentes können einige Punkte entfallen.

5 Glossar

5.1 Grundregeln für Begriffe

5.2 Begriffsliste

Die hier vorgestellte Begriffsliste ist eine Orientierungshilfe, keineswegs komplett

zu ver­wen­dender Begriff

Artikel

Mögliche Alternativen

Nicht zu verwendende Alternativen

Anliegen


der Issue


Aufgabe


der Task


Verweis

der

der Link

Die URL

Firewall

die



Benutzer


Anwender

Der User

OpenOffice.org Writer



Writer

OpenOffice.org Calc



Calc

OpenOffice.org



OOo

StarOffice



SO

Microsoft Office



MS Office, MSO

Cursor

der


Texteinfügemarke

Mauszeiger



Mauspointer, Mauspfeil

Dialog




Dialogfeld




Schaltfläche



Button, Knopf

Pull Down Menü

das



Drop Down Menü

das



Auswahlliste




Kontrollkästchen



Checkbox

Optionsfeld



Radiobutton

Karteikarte


Reiter

Seite, Registerkarte

Tabelle 5: Begriffsliste

6 Formatvorschläge

6.1 Schriftarten

Die Verwendung von Schriftarten wird durch die unter 3.3 definierten Formatvorlagen geregelt.

6.2 Formatvorschläge

Zur Verwendung der Vorlagen siehe 3.3.

Bezeichnung

Klasse

Vorschlag

Abbildung

Absatz­vorlage

Bitstream Vera Sans 10pt kursiv, links ausgerichtet

Aufzählung 1 ..
Aufzählung n

Absatz­vorlage

  • Bitstream Vera Sans 12pt, links ausgerichtet, Einzug links 0,5cm*Ebene

  • ....

Lizenz

Absatz­vorlage

Bitstream Vera Sans 8pt, Blocksatz, keine Silbentrennung, Englisch, Abstand nach Absatz 0,1cm

Tabelle

Absatz­vorlage

Bitstream Vera Sans 10pt kursiv, links ausgerichtet

Tabellen Inhalt

Absatz­vorlage

Bitstream Vera Sans 12pt, links ausgerichtet

Tabellen Überschrift

Absatz­vorlage

Bitstream Vera Sans 12pt fett kursiv, zentriert

Teilüberschrift

Absatz­vorlage

Bitstream Vera Sans 20pt, zentriert

Textkörper

Absatz­vorlage

Bitstream Vera Sans 12pt, Blocksatz, Silbentrennung, Abstand 6pt nach Absatz

Titel

Absatz­vorlage

Bitstream Vera Sans 24pt fett, zentriert, 48pt Abstand vor und nach Absatz

Überschrift 1 ..
Überschrift n

Absatz­vorlage

Bitstream Vera Sans 20pt .. Bitstream Vera Sans 12, links, Nummerierung arabisch, Seitenwechsel vor Überschrift 1

Untertitel

Absatz­vorlage

Bitstream Vera Sans 14pt, rechts, OOo rot

Grafik

Rahmen­vorlage

Kein Umlauf, keine Umrandung, Abstände 0,0 cm, Verankerung am Absatz, Ausrichtung unten.

Grafik als Zeichen

Rahmen­vorlage

Kein Umlauf, keine Umrandung, Abstände 0,0 cm, Verankerung als Zeichen, Ausrichtung oben von Grundlinie.

Hinweissymbol

Rahmen­vorlage

Wie „Grafik als Zeichen“, Abstand oben/unten 0,3cm. Ausrichtung Mitte von Grundlinie, Breit 0,68 cm

Rahmen

Rahmen­vorlage

Kein Umlauf, keine Umrandung, Abstände 0,3 cm. Ausrichtung unten

Erste Seite

Seiten­vorlage

A4, Ränder 2cm, Rand oben 3cm, keine Kopf- / Fußzeile

Buchteil

Seiten­vorlage

A4, Ränder 2cm, Rand oben 8cm, keine Kopf- / Fußzeile

Standard

Seiten­vorlage

A4, Ränder 2cm, Kopf- / Fußzeile abgetrennt mit Linie 0.5pt

Verzeichnis

Seiten­vorlage

A4, Ränder 2cm, keine Kopf- / Fußzeile

OOo Hinweis

Tabellen­autoformat

Zwei Spalten, eine Zeile. Linke Spalte 1,3cm breit. Rechte Spalte mit Hintergrund grau 6%, Doppelte Randlinie 1,1pt oben und unten.

OOo mit Rahmen

Tabellen­autoformat

Keine Tabellenüberschrift, Zeilen Hintergrund abwechselnd Weiß und Grau 6%, Umrandung Grau0 80% 0,05pt innen und außen, 0,2cm Innenabstand zum Inhalt

OOo ohne Rahmen

Tabellen­autoformat

Tabellenüberschrift – Hintergrund OOo Blau 1, Zeilen Hintergrund abwechselnd Weiß und Grau 6%, Umrandung weiß 2,5pt innen, 0,2cm Innenabstand zum Inhalt

Betont

Zeichen­vorlage

Bitstream Vera Sans 12pt fett kursiv

Dialog

Zeichen­vorlage

Bitstream Vera Sans 12pt fett

Internet Link

Zeichen­vorlage

Bitstream Vera Sans 12pt unterstrichen, OOo Blau 2

Meldung

Zeichen­vorlage

Bitstream Vera Sans mono 12pt, Kapitälchen

Menü

Zeichen­vorlage

Bitstream Vera Sans 12pt fett

Nutzereingabe

Zeichen­vorlage

Bitstream Vera Sans mono 12 pt

Tastatur

Zeichen­vorlage

Bitstream Vera Sans 12pt fett

Tabelle 6: Formatvorschläge

7 Autoren

Andre Schnabel (AndreSchnabel@openoffice.org)

Christian Lohmaier (cloph@openoffice.org)

Rene Lemke (RLemke@openoffice.org)

Tobias Sager (tsager@openoffice.org)

Apache Software Foundation

Apache Software Foundation

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.