konventionen

Dies ist eine alte Version des Dokuments!


Konventionen

Typografische Konventionen

Dieses Symbol kennzeichnet:

Aktion eine Eingabe oder Arbeitsschritt am Computer. Wortwörtliche Eingaben sind mit Hintergrund 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 angestrebte Ziel und in den Quiz das Urteil, ob das Ziel erreicht ist.

Forum ein verfügbares Forum.

Zusammenfassung eine Zusammenfassung.

Frage eine Frage.

Die verwendeten Schreibregeln der Publikationen:

  • Namen von Bildern beginnen mit
    • 𝄞 für den Bereich Musik & Technik
    • ❑ für alle anderen Bereiche
  • Namen von ▤Tabellen sind mit vorausgestelltem ▤ notiert.
  • Namen von §Formeln sind mit vorausgestelltem § notiert.
  • Menüpunkte, Namen von Dateien, Verzeichnissen, Feldern, Schaltflächen sowie Registerkarten sind farbig notiert:
    • Menüpunkte: In dem Menübefehl Datei > Beenden wird …
    • Dateinamen: In der Datei format.css wird …
  • 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 [].
  • Ein Ausdruck in geschweiften Klammern {} ist ein Synonym.
  • Ein Doppelpfeil ↔ kennzeichnet einen gegenseitigen Bezug.
  • Zur Betonung dienen „typografische Anführungszeichen” oder eine Formatierung mit Hintergrund.
  • 'Apostrophe' und "Anführungszeichen oben" sind Bestandteil von Code.
  • Arbeitsschritte mit der Maus am Computer verwenden die linke Maustaste, sofern nicht anders angegeben.
Abkürzungen und Schreibweisen

Grundlage der Rechtschreibung ist der tolaris know-how Thesaurus. Darin sind Abkürzungen und Schreibweisen, zulässige und nicht zulässige Synonyme geregelt:

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 Esslöffel
  • g für Gramm
  • kg für Kilogramm
  • l für Liter
  • Min. für Minute oder min für Minute mit vorangestellter Wertangabe
  • Sek. für Sekunde oder s für Sekunde mit vorangestellter Wertangabe

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 tolaris know-how in das Internet ist mit dem vorausgestelltem Symbol der Weltkugel und der Domainangabe wie bei tolaris.de versehen.
  • Ein Link als Download ist mit den vorausgestellten Symbolen der Weltkugel plus ⇓ dargestellt wie bei ⇓M75c.
  • Ein Link mit einem JavaScript-Beispiel ist vorausgestellten JS-Symbol dargestellt wie bei
    Beispiel.js
    ...
  • Ein Link mit einem HTML-Beispiel ist vorausgestellten HTML-Symbol dargestellt wie bei
    Beispiel.html
    ...
  • Ein Link mit einem anderen Code ist mit vorausgestellten Seitensymbol dargestellt wie bei
    Beispiel.ino
    ...

Offline

In Publikationen wie eBooks und eMags ist ein Link:

  • in das Internet mit der Domainangabe ohne Weltkugel dargestellt.
  • zu tolaris know-how ohne Domainangabe notiert, jedoch farbig.
  • zu einer Stelle im gleichen eBook/eMag mit dem vorausgestelltem Symbol ↓ versehen.

<html><a name='programmierung'></a></html>

Informationstechnik

Programmieranweisungen, Ein- und Ausgaben in einem Terminal und Eintragungen in Konfigurationsdateien sind betont wie z.B. int ledPin = 13; oder in einem Rahmen mit grauem Hintergrund notiert:

int ledPin = 13;                // LED-Pin
int buttonPin = 2;              // Taster-Pin
int buttonState = 0;            // Tasterstatus

Komplette Beispiele zeigen den Dateinamen als Überschrift und verwenden den DokuWiki-Farbcode zur Syntaxbetonung. Der Dateiname ist als farbiger Link zum Download ausgeführt:

nc_0001.js
var tnmNr1 = require('./tnm_0001');
tnmNr1.world();

Hinweis In einigen Fällen kommt es zu Überschneidungen bei den Konventionen. Ein Beispiel ist im laufenden Text:

  • nc_0001.js farbig notiert, wenn die Bedeutung als Code vorrangig ist
  • als farbiger Link notiert, wenn es an entfernterer Stelle zu finden ist
  • »nc_0001.js« in spitzen Klammern notiert, wenn die Bedeutung als Datei vorrangig ist
  • nc_0001.js mit Hintergrund notiert, wenn ein Terminalbefehl gemeint ist

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 Strings {Zeichenketten} oder Zahlenvariablen kennt – z.B. vZ1 oder vT1.
  • 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. bStatus1.
  • 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.

<html><a id="musik-tontechnik"></a></html>

Musik- & Technik

Die Grundlage bildet die abendländische Musik mit ihren 12 Tonarten, ihren Tonintervallen und ihrem Harmonieverständnis mit der internationalen Notation.

Töne

  • Die Tonnamen sind in Kleinbuchstaben notiert: cdefgabc.
  • Töne mit Angabe der Oktavlage verwenden eine Hochstellung, z.B. etc.

Tonarten

  • Dur-Tonarten beginnen mit einem Großbuchstaben wie z.B. C (ohne Dur) oder wie z.B. C-Dur.
  • Moll-Tonarten beginnen mit einem Großbuchstaben sind immer mit Moll notiert wie z.B. C-Moll.
  • Eine Halbtonerhöhung ist mit hinter der Tonart notiert, z.B. C♯-Moll.
  • Eine Halbtonerniedrigung ist mit hinter der Tonart notiert, z.B. B♭-Dur.

Saiten und Oktavlagen

Namen von Saiten, Oktavlagen und Notenschlüsseln sind mit einem Großbuchstaben notiert, z.B. -Saite, -Oktave, G-Schlüssel etc.

M.27 Tonnamen und Oktavlagen.

Halbtonschritte bei Tönen

  • Eine Halbtonerhöhung eines einzelnen Tons ist mit hinter dem Ton notiert, z.B. c♯ für den um einen Halbton erhöhten Ton c.
  • Eine Halbtonerniedrigung eines einzelnen Tons ist mit hinter dem Ton notiert, z.B. b♭ für den um einen Halbton reduzierten Ton b.

Akkorde

  • Dur-Akkorde beginnen mit einem Großbuchstaben wie z.B. C (ohne Dur) oder wie C-Dur
  • Moll-Akkorde beginnen mit einem Großbuchstaben wie z.B. Cm oder wie C-Moll
  • Bei einer Halbtonerhöhung wird angehängt.
  • Bei einer Halbtonerniedrigung wird angehängt.
  • Bei verminderten Dreiklängen wird dim angehängt.
  • Bei übermäßigen Akkorden wird aug angehängt.
  • Bei Dreiklängen ohne Terz wird sus angehängt:
    • sus2 ersetzt die Terz durch eine (große) Sekunde.
    • sus4 ersetzt die Terz durch eine Quarte.
  • Bei Zweiklängen aus Akkordbasis und Terz wird 3 angehängt.
  • Bei Zweiklängen aus Akkordbasis und Quinte wird 5 angehängt.
  • Bei Vierklängen wird angehängt:
    • Δ für eine große Septime.
    • 7 für eine kleine Septime.
    • ♭7 für eine verminderte Septime.
    • dim7 (bei halb verminderten Vierklängen).
    • dim♭7 (bei voll verminderten Vierklängen).
  • Eine Halbtonerhöhung eines Tons in einem Akkord ist mit einer Ziffer und notiert, z.B. C♯5 für eine übermäßige Quinte statt der reinen Quinte.
  • Eine Halbtonerniedrigung eines Tons in einem Akkord ist mit einer Ziffer und b notiert, z.B. C♭5 für eine verminderte Quinte statt der reinen Quinte.
  • In Partituren tragen die Akkorde eine laufende Nummerierung wie z.B. C①, C② etc.

Hinweis Für die Notationen gibt es in der Literatur keine einheitlichen Schreibweisen. Das bei tolaris know-how benutzte Regelwerk bildet ein durchgängiges logisches Schema, das sowohl im Text wie auch in den Partituren Anwendung findet.

M.63 Die Oktavverschiebung ist im Notensystem G1 mit einer 8 unter dem Notenschlüssel notiert.

Cookies helfen bei der Bereitstellung von Inhalten. Diese Website verwendet Cookies. Mit der Nutzung der Website erklären Sie sich damit einverstanden, dass Cookies auf Ihrem Computer gespeichert werden. Außerdem bestätigen Sie, dass Sie unsere Datenschutzerklärung gelesen und verstanden haben. Wenn Sie nicht einverstanden sind, verlassen Sie die Website.Weitere Information
  • Zuletzt geändert: 2024/03/14 00:41
  • (Externe Bearbeitung)