Dies ist eine alte Version des Dokuments!


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.

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 eine als eBook lieferbare Publikation.

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

Forum ein verfügbares Forum.

Zusammenfassung eine Zusammenfassung.

Die verwendeten Schreibregeln der Publikationen:

  • Namen von →Bildern und →Tabellen und →Codebeispielen sind als Überschrift 5 mit vorausgestelltem Symbol notiert.
  • Namen von §Formeln sind 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: [🡅]
    • Tabulatortaste [⭾]
  • phonetische Schrift erscheint ebenfalls in rechteckigen Klammern []
  • Synonyme erscheinen in geschweiften 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 tolaris know-how 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 /^3^/⁄/,8,/” 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.

Begriffe

  • Tap bezeichnet das Antippen einer sensitiven Oberfläche.
  • Klick bezeichnet das Klicken mit der Maus oder/und das Antippen einer sensitiven Oberfläche.
  • Mausklick bezeichnet ausdrücklich die Bedienung per Maus.

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.

Programmierung

Unter Programmierern hat sich in einigen Sprachen eine mehr oder weniger einheitliche Schreibweise durchgesetzt, wie Programme notiert werden sollen. Das klingt besser, als es in der Praxis ist. Wegen der Sprachunterschiede sind auch die Konventionen in den einzelnen Sprachen unter­schied­lich. Für den Programmierer, der mit mehreren Sprachen umgeht – früher oder später betrifft das jeden – wird es schwierig, die einzelnen Konventionen auseinander zu halten.

Deswegen hier ein Vorschlag für Programmierkonventionen, die einerseits nicht zu kompliziert ist und andererseits in mehreren Programmiersprachen verwendet werden können.

Variablennamen beginnen mit einem kleinen Buchstaben. Der erste Buchstabe macht eine Aussage über den Datentyp:

  • Ein o kennzeichnet eine Objektvariable, z.B. oBild1 in JavaScript.
  • Ein nm kennzeichnet ein node.js-Modul, z.B. nmHttp1.
  • Ein c kennzeichnet eine Konstante z.B. cPort1 in JavaScript.
  • Ein v kennzeichnet eine beliebige Variable, wenn die Sprache (wie z.B. JavaScript) keine speziellen Datentypen für Zeichenketten (Synonym: Strings) oder numerische Variablen kennt – z.B. vZahl1 oder vText1.
  • Der zweite Buchstabe wird groß geschrieben. Bei Zahlen und Texten sind das N=Nummer und T=Text. Bei anderen Variablen beschreibt der damit beginnende Name die Aufgabe, z.B. Bild. Schließlich wird eine Ziffer angehängt. Mit dieser Notation ergeben sich eindeutige Namen, die beim automatischen »Suchen & Ersetzen« im Quelltext problemlos sind. Auch das Nummerierungsschema kann fortgesetzt werden: Die nächste Variable mit ähnlicher Aufgabe heißt z.B. vN2, vT2 etc..
  • Kennt die Programmiersprache mehrere Daten­typen, dient der erste Buchstabe zur näheren Bezeichnung des Datentyps:
    • Ein i kennzeichnet eine numerische Vari­able für Ganzzahlen, z.B. iN1.
    • Ein f kennzeichnet eine numerische Variable für Gleitkommazahlen, z.B. fN1.
    • Ein b kennzeichnet eine Wahrheits­va­riable, z.B. bZustand1.
  • Dieses Schema kann je nach Programmiersprache angepasst werden:
    • Ein s kennzeichnet eine Stringvariable, z.B. sUrl1.
    • Ein t kennzeichnet eine Datumsvariable, z.B. tDatum1.

Häufig werden noch mehr Datentypen ver­wendet, als in diesen Konventionen aufgeführt. Ganzzahlen verwenden z.B. in BASIC und Java zwei Datentypen, die jeweils einen unter­schiedlichen Wertebereich haben. Bei den Gleit­kommazahlen ist es ebenso. Die Unter­scheidung zwischen der Ganzzahl (i steht für „integer“ – ohne damit den Datentyp integer zu meinen!) und der Gleitkommazahl (f steht für „floating point“) sollte für die Lesbarkeit des Programms jedoch ausreichend sein.

Hilfsvariablen in Schleifen wie in for (int i=1; i⇐1000; ++i können mit einem Buchstaben i oder j) benannt werden. Diese Hilfsvariablen fungieren als Zähler. Variablen als Argumente wie in function tauscheBild(v1, o1)) werden mit einem Buchstaben und einer Ziffer v1 oder o1 benannt.

Konstanten werden groß geschrieben, einzelne Worte werden mit einem '_' getrennt, z.B. MW_STEUER.

Frei wählbare Namen von Funktionen, Methoden und Subroutinen beginnen mit einem kleinen Buchstaben. Bei zusammengesetzten Namen wird der erste Buchstabe des zweiten Wortes groß geschrieben, z.B. schliesseFenster() für eine Funktion. Dabei bezeichnet der erste Teil des Namens die Aufgabe schliesse und der zweite Teil des Namens das Objekt Fenster, für das die Aufgabe ausgeführt wird.

Klassen beginnen mit einem Großbuchstaben, werden klein weiter geschrieben und enden mit einer dreistelligen Zahl, z.B. Computer001. Auch hier gilt der Vorteil eines eindeutigen Namens.

Audio/Musik

Die Grundlage bildet die abendländische Musik mit ihren 12 Tonarten, den Tonintervallen und dem Harmonieverständnis.

  • Es wird die internationale Notation verwendet, sofern nicht anders angegeben.
  • Eine Halbtonerhöhung wird mit # notiert, aber als Suffix „is" gesprochen.
  • Eine Halbtonerniedrigung wird mit b notiert, aber als Suffix „es" gesprochen. Der um einen Halbton reduzierte Ton b wird mit bb notiert und als bes (statt b-flat) ausgesprochen.

Namen von Tönen werden in Kleinbuchstaben notiert, z.B. c, d, e, f etc. Die Namen von Saiten werden mit einem Großbuchstaben notiert, z.B. E-Saite etc.

Namen von Tonarten und Akkorden beginnen mit einem Großbuchstaben notiert, z.B. C-Dur, A-Moll (abgekürzt Am) etc.

Viele Beispiele sind – wie bei Noten für Gitarren üblich – eine Oktave höher notiert. Diese Oktavenverschiebung ist mit einer 8 unter dem Notenschlüssel notiert.

→AV63: Oktavenverschiebung.

1: Der zweite Ton a im Notensystem der Gitarre im 2. Bund der G-Saite entspricht dem ersten Ton a im Notensystem des Klaviers.

2: Der Hinweis auf die Oktavenverschiebung wird mit einer 8 unter dem Notenschlüssel notiert.

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.1546900835.txt.gz
  • Zuletzt geändert: 2019/04/03 15:07
  • (Externe Bearbeitung)