[de-discuss] [Doku] richtige Formatierung

Hallo liebe Doku-Mitstreiter,

ich stehe immer wieder vor dem Problem, dass ich nicht genau weiß, wie
ich bestimmte Begriffe formatieren oder bestimmte Formulierungen
vereinheitlichen soll und habe z.T. verschiedene Formatierungen und
Formulierungen in den bisherigen Dokumentationsteilen gefunden.

Deshalb möchte ich eine Diskussion dazu anregen und ein einheitliches
Vorgehen finden (vielleicht ist Jochen dann wieder so nett, das
*Ergebnis* im Wiki festzuhalten). Eventuell sollte man für das Eine oder
Andere dann auch eine neue Formatvorlage erstellen, dass das klar und
sofort sichtbar geregelt ist.

Klar sind Menüpfade und Tastenkombinationen, dafür gibt es direkt
Zeichenformatierungen.

Was macht man aber bei Registern, Optionen, Schaltflächen etc., das sind
eigentlich keine Menüpfade, auch wenn im englischen Original teilweise
so formatiert sind (z.B. bei "Extras -> AutoKorrektur-Optionen... ->
Optionen -> Tabelle erzeugen). In der deutschen Übersetzung finden sich
verschiedene Schreibweisen, da werden diese in Anführungszeichen
gesetzt, als "LibOMenüPfad" oder mit "LibOStarkeBetonung" formatiert,
manchmal auch nur als "LibOBetonung", aber alles durcheinander.

Meine Präferenz wäre, dafür Formatvorlagen zu erstellen, die bei
Registern und Optionen der Formatierung "LibOBetonung" entsprechen bzw.
ähnlich sind (jedenfalls nicht fett), oder uns darauf zu einigen,
"LibOBetonung" für beide zu verwenden, und bei Schaltflächen ein
Formatvorlage ähnlich "LibOMenüPfad" zu erstellen oder diese zu
verwenden. Ungeeignet finde ich, irgendetwas in Anführungszeichen zu
setzen, außer für Optionen, da macht das für mich noch Sinn.

Ähnlich willkürlich sind Kapitelbezeichnungen, dort würde ich
vorschlagen, diese unformatiert zu lassen und tatsächlich in
Anführungszeichen zu setzen (z.B.: Lesen Sie mehr dazu in Kapitel 7
"Arbeiten mit Formatvorlagen" im Writer-Handbuch).

Bei der Formulierung in Kapitel- und Abbildungsbezügen finden ich häufig
die Übersetzung (siehe Abbildung XYZ). Hier wird der Leser plötzlich
geduzt. Entweder sollten wir den Leser konsequent siezen (also z.B.
"Vergleichen Sie Abbildung XYZ") oder bei obigem Beispiel nur (Abbildung
XYZ) schreiben. Bei Kapitelangaben, die nicht im fließenden Text stehen,
sondern in Klammern, könnte man z.B. auch mit einem Pfeil arbeiten (->
Kapitel 3), wobei der Pfeil auch ein anderes Symbol sein könnte, z.B.
ein kleines Dreieck, das in Richtung des Kapitels zeigt.

Soweit meine Überlegungen zur Dokumentation und in der Hoffnung auf eine
schnelle Lösungsfindung oder der Verweis auf einen bestehenden Beschuss
diesbezüglich.

Gruß,
Christian.

--
Informationen zum Abmelden: E-Mail an discuss+help@de.libreoffice.org
Tips zu Listenmails: http://wiki.documentfoundation.org/Netiquette/de
Listenarchiv: http://listarchives.libreoffice.org/de/discuss/
Alle E-Mails an diese Liste werden unlöschbar öffentlich archiviert