From BlenderWiki

Jump to: navigation, search

Dies ist der Style Guide für das Blender Benutzerhandbuch. Hier sind nur Dinge aufgenommen worden, die in der deutschsprachigen Version abweichen.

Um die Blender Dokumentation möglichst einheitlich zu gestalten, werden die Autoren freundlich gebeten, sich an den vorliegenden Style Guide zu halten.

Wenn Sie mit der MediaWiki Syntax noch vollkommen unerfahren sind, sollten Sie in die offiziellen MediaWiki Docs schauen.

Generelle Richtlinien

Das deutschsprachige Blender Handbuch sollte in klarem und präzisem Hochdeutsch geschrieben werden. Die Einteilung in Kapitel, Abschnitte und Unterabschnitte wird von der englischsprachigen Vorlage übernommen. Es handelt sich hierbei um eine reine Übersetzung, auch wenn die Vorlage veraltet, fehlerhaft oder nicht vollständig sein sollte. Die lokalisierte Fassung soll weder erweiterte, noch erneuerte Informationen enthalten, die nicht in der englischen Vorlage enthalten sind.

Um den Inhalt eines Abschnittes zu ändern, müsste daher zunächst die englischsprachige Vorlage geändert werden. Bitte beachten Sie insbesondere die Seite Translation Guide.

Die logische Unterteilung der Dokumentation wird vom "Dokumentation Board" bestimmt. Neue Seiten dürfen erst nach Zustimmung durch das DokBoard hinzugefügt werden.

Die logische Unterteilung von Tutorial(s) wird dem jeweiligen Autor überlassen.

Tutorials sollten eine Zusammenfassung von bis zu 300 Worten erhalten, die kurz das Thema, Ziele und Inhalt beschreiben.

Jede Seite sollte eine entsprechende Vorlage als erste Zeile enthalten, die die Navigationhilfen und die Blenderversion enthält, auf die sich die Seite bezieht. Dies geschieht in der deutschen Version durch

 {{Page/Header|2.32}}

wobei 2.32 durch die entsprechende Versionsnummer ersetzt werden muss.

Das Ergebnis ist dann:


Für lange Seiten auf denen sich mehrere Abschnitte befinden, gibt es ein weiteres Template, wenn sich die Abschnitte in der Versionsnummer unterscheiden sollten.

 {{version|2.32}}

Diese Vorlage sollte unmittelbar unter der Abschnittsüberschrift eingefügt werden, so wie es unten gezeigt wird.

Am Fuß jeder Seite wird folgende Navigationsleiste eingefügt:

 {{Page/Footer|VorhergehendeSeite|FolgendeSeite}}

Das zeigt etwa:




VorhergehendeSeite und FolgendeSeite sollten natürlich gültige Links sein.

Vorlagen

Blender 2.32+

Es gibt eine begrenzte Anzahl von Vorlagen, die vom DocBoard definiert wurden. Bitte benutzen Sie diese, und nur diese.

Eine Liste der Vorlagen finden Sie hier: Vorlagen

Die Vorlagen hier leiden leider daran, dass insbesondere für die Tasteneingaben zu wenig Vorlagen vorhanden sind. So gibt es auf einer deutschen Tastatur kein "Ctrl" sondern ein "Strg". Auch ist ein Ausdruck wie KKey usw. nicht geeignet. Man sollte doch für die deutschen Übersetzungen auf die Tastaturvorlagen nach Möglichkeit verzichten, und die Tasteneingaben durch Fettdruck (drei ') kennzeichnen.


Die übrigen Abschnitte des Style Guides haben keine sprachspezifischen Besonderheiten, bitte besuchen Sie daher die Seite Meta/Style Guide.