Konventionen

Typografische Konventionen

Dieses Symbol kennzeichnet:

Aktion eine Eingabe oder Arbeitsschritt am Computer. Wortwörtliche Eingaben sind fett und kursiv oder als Code notiert.

Reaktion den Zustand (die Anzeige) des Computers.

Aktion einen Arbeitsschritt an einem Gerät.

Reaktion den Zustand des Gerätes – hier ein Fahrrad.

Reaktion den Zustand des Gerätes – hier ein Mikrocontroller.

Achtung eine Warnung.

Voraussetzungen die Vorkenntnisse.

Zielgruppe die Zielgruppe.

Arbeitsschritte eine Reihe von Arbeitsschritten.

Hinweis einen Hinweis.

Vergleich eine vergleichende Beschreibung.

Konstruktion die Konstruktion.

Werkzeug / Material das benötigte Werkzeug oder Material.

Zugang einen kostenpflichtigen Zugang.

eBook als eBook lieferbar.

Ziel / Urteil das angestebte Ziel und in den Quiz das Urteil, ob das Ziel erreicht ist.

Forum ein verfügbares Forum.

Die verwendeten Schreibregeln der Publikationen:

  • Namen von →Bildern und →Tabellen und →Codebeispielen 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 Eingaben in der Konsole, deren Ausgaben und Eintragungen in Konfigurationsdateien.
int ledPin = 13;                // LED-Pin
int buttonPin = 2;              // Taster-Pin
int buttonState = 0;            // Tasterstatus
  • Bezeichnungen von Tasten der Tastatur wie die [A] in rechteckige Klammern setzen und Tastenkombination wie [Strg + A] mit einem Pluszeichen versehen. Einige Tastenbezeichnungen:
    • Eingabetaste: [✔]
    • Leertaste: [□]
    • Umschalttaste: [↑]
  • phonetische Schrift erscheint ebenfalls in rechteckigen Klammern []
  • "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.

Hinweis 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.

Hinweis 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
    • .html-Datei (wenn auf die Dateikennung verwiesen wird)
    • HTML-Seite (im allgemeinen Sprachgebrauch)
    • 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 (z.B. »aufgaben« und »ergebnisse«) klein und in spitzen Klammern notieren.
  • Dateinamen wie »bild.jpg« klein und in spitzen Klammern 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

  • z.B. statt zum Beispiel oder beispielsweise
  • etc. statt u.a.m. oder usw.
  • TL als Maßeinheit für Teelöffel
  • EL als Maßeinheit für Eßlöffel
  • g für Gramm
  • kg für Kilogramm
  • l für Liter

Ü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 von etok.de in das Internet ist mit dem vorausgestelltem Symbol der Weltkugel und der Domainangabe wie bei tolaris.de versehen.

Offline

In Publikationen wie eBooks und eMags ist ein Link:

  • in das Internet mit der Domainangabe ohne Weltkugel dargestellt.
  • zu etok.de ohne Domainangabe notiert, jedoch farbig.
  • zu einer Stelle im gleichen eBook / eMag mit dem vorausgestelltem Symbol ↓ versehen.
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: 2018/06/29 19:10
  • von wh