Konventionen

Typografische Konventionen

Die verwendeten Schreibregeln und Symbole der Publikationen:

  • Dieses Symbol kennzeichnet eine Eingabe oder Arbeitsschritt am Computer. Wortwörtliche Eingaben sind fett und kursiv notiert.
  • Dieses Symbol kennzeichnet die Anzeige des Computers.
  • Dieses Symbol kennzeichnet einen Arbeitsschritt an einem Gerät.
  • Dieses Symbol kennzeichnet den Zustand des Geräts – hier ein Fahrrad.
  • Dieses Symbol kennzeichnet den Zustand des Geräts – hier ein Mikrocontroller.
  • Dieses Symbol kennzeichnet die Voraussetzungen.
  • zielgruppe.jpg Dieses Symbol kennzeichnet die Zielgruppe.
  • Dieses Symbol kennzeichnet eine Reihe von Arbeitsschritten.
  • Dieses Symbol kennzeichnet einen Tipp oder das Konstruktionsprinzip.
  • Dieses Symbol kennzeichnet eine vergleichende Beschreibung.
  • Dieses Symbol kennzeichnet eine Warnung.
  • Namen von →Bildern und →Tabellen sind als Tastatur formatiert und mit vorausgestelltem Symbol notiert.
  • Namen von Kapiteln und Seiten sind in „Anführungsteichen“ notiert.
  • Menüpunkte, Namen von Dateien, Verzeichnissen, Feldern, Schaltflächen sowie Registerkarten sind in »Klammern« notiert:
    • Menüpunkte: In dem Menübefehl »Datei - Beenden« wird …
    • Dateinamen: In der Datei »format.css« wird …
  • Programmieranweisungen sind als < c o d e > … < / c o d e > notiert, ebenso wie Ein- und Ausgaben in der Textkonsole und Eintragungen in Konfigurationsdateien.
int ledPin = 13;                // LED-Pin
int buttonPin = 2;              // Taster-Pin
int buttonState = 0;            // Tasterstatus
  • Bezeichnungen von Tasten wie die [Eingabetaste] in rechteckige Klammern setzen und Tastenkombination wie [Strg + A] mit einem Pluszeichen versehen.
  • „Typografische Anführungszeichen“ zur Hervorhebung mit der Tastenkombination [↑ + 2] setzen. Alternativ eine farbige Hervorhebung verwenden.
  • 'Apostrophe' sind Bestandteil von Code.
  • Arbeitschritte mit der Maus am Computer verwenden die linke Maustaste, sofern nicht anders angegeben.

In einigen Fällen kommt es zu Überschneidungen bei den Konventionen. Ist z.B. ein Programmname gleichzeitig der Dateiname (Schreibweise »in Klammern«) und gleichzeitig unter demselben Namen in der Textkonsole (Schreibweise als Code) aufrufbar, dann gibt die jeweilige Konvention an, was gemeint ist.

In Überschriften keine doppelten Formatierungen verwenden. Als Überschriften gelten:

  • Überschrift 1
  • Überschrift 2
  • Überschrift 3
  • Überschrift 4
  • Überschrift 5

Abkürzungen und Schreibweisen

Grundlage der Rechtschreibung ist das etok.de Wörterbuch. Darin sind Abkürzungen und Schreibweisen, zulässige und nicht zulässige Synonyme geregelt:

Binde- und Gedankenstrich

  • Keinen Bindestrich notieren bei:
    • Angaben wie 5er Schritt oder 8tel.
  • Den Bindestrich ohne Leerzeichen bei Eigennamen und Zahlenangaben verwenden, z.B. bei:
    • etok.de-Projekte
    • .jpg-Datei
    • 20-prozentig
    • 4-silbig
    • 3-Tonner
    • 18-jährig
    • 50-60 Hz
    • 2-zeilig
  • Den Bindestrich mit Leerzeichen bei Menüpunkten mit Unterteilung verwenden, z.B. bei »Bearbeiten - Alles auswählen«.
  • Bei Abgrenzungen den Gedankenstrich verwenden – er ist als Sonderzeichen verfügbar.

Groß- und Kleinschreibung

  • Verzeichnisse bzw. Ordner (z.B. »aufgaben« und »ergebnisse«) klein notieren.
  • Dateikennungen wie ».jpg« klein notieren.

Anglizismen

  • Englische Begriffe ohne deutsche Übersetzung (z.B. back end) klein notieren. Ausnahme: Produkt- und Eigennamen. Gibt es eine deutsche Übersetzung, wird diese verwendet.
  • Eingedeutschte Begriffe wie Bootmanager nach deutscher Schreibweise notieren – im Englischen jedoch boot manager klein schreiben.
  • Eigennamen wie Virtual Private Network in beiden Sprachen groß notieren.

Trenn- und Leerzeichen

  • Keinen Punkt als Trennzeichen für Tausender verwenden wie in 1.000. Der Punkt dient in Programmiersprachen als Dezimalpunkt.
  • Ausdrücke mit Schrägstrich wie bei LibreOffice/OpenOffice ohne Leerzeichen notieren.
  • Angaben wie 720×480 ohne Leerzeichen mit dem Multiplikationszeichen × notieren.

Hoch- und Tiefstellungen

  • Zollangaben wie 1 38” verwenden eine Hochstellung der 3, das Sonderzeichen ⁄ und eine Tiefstellung der 8 sowie das Sonderzeichen ” für die Einheit Zoll.

Abkürzungen

  • Abkürzungen (statt vgl. „Siehe“) bis auf die folgenden Ausnahmen nicht verwenden:
    • z.B. statt zum Beispiel oder beispielsweise
    • etc. statt u.a.m. oder usw.

Übersetzungen und Synonyme

  • Übersetzungen und Synonyme sind in dem Wörterbuch notiert.

Links sind farblich gekennzeichnet und werden ansonsten online und offline unterschiedlich dargestellt.

Online

Ein Link in das Internet ist mit dem vorausgestelltem Symbol der Weltkugel und der Domainangabe wie bei tolaris.de versehen. Detailangaben zum Link sind als Option möglich, z.B. tolaris.de | objekte | bes.t.

Offline

  • In Publikationen wie eBooks und eMags wird ein Link in das Internet wie online dargestellt, jedoch ohne Weltkugel.
  • Ein Link zu etok.de hat keine Domainangabe und fügt sich in den fließenden Text nahtlos ein.
  • Ein Link, der im eBook/eMag verzweigt, ist mit dem vorausgestelltem Symbol ↓ versehen.

WH 2017/07/30 12:41

Cookies helfen bei der Bereitstellung von Inhalten. Durch die Nutzung dieser Seiten erklären Sie sich damit einverstanden, dass Cookies auf Ihrem Rechner gespeichert werden. Weitere Information
konventionen.txt · Zuletzt geändert: 2017/07/30 12:41 von wh