konventionen

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen gezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
konventionen [2020/01/16 17:53]
wh
konventionen [2020/05/19 05:53] (aktuell)
wh
Zeile 40: Zeile 40:
  
 {{:dokumentation:zusammenfassung.png?nolink |Zusammenfassung}} eine Zusammenfassung. {{:dokumentation:zusammenfassung.png?nolink |Zusammenfassung}} eine Zusammenfassung.
 +
 +{{:dokumentation:frage.png?nolink |Frage}} eine Frage.
  
 Die verwendeten Schreibregeln der Publikationen: Die verwendeten Schreibregeln der Publikationen:
Zeile 46: Zeile 48:
   * Namen von §Formeln sind mit vorausgestelltem § notiert.   * Namen von §Formeln sind mit vorausgestelltem § notiert.
   * Namen von Kapiteln und Seiten sind in "Anführungsteichen" 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, Namen von Dateien, Verzeichnissen, Feldern, Schaltflächen sowie Registerkarten sind in spitzen »Klammern« notiert:
     * Menüpunkte: In dem Menübefehl »Datei > Beenden« wird ...     * Menüpunkte: In dem Menübefehl »Datei > Beenden« wird ...
     * Dateinamen: In der Datei »format.css« 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. 
-<code> 
-int ledPin = 13;                // LED-Pin 
-int buttonPin = 2;              // Taster-Pin 
-int buttonState = 0;            // Tasterstatus 
-</code> 
   * Bezeichnungen von Tasten der Tastatur wie die [A] in rechteckige Klammern setzen und Tastenkombination wie [Strg + A] mit einem Pluszeichen versehen. Einige Tastenbezeichnungen:   * Bezeichnungen von Tasten der Tastatur wie die [A] in rechteckige Klammern setzen und Tastenkombination wie [Strg + A] mit einem Pluszeichen versehen. Einige Tastenbezeichnungen:
-    * Eingabetaste: []+    * Eingabetaste: []
     * Leertaste: [□]      * Leertaste: [□] 
     * Umschalttaste: [⇧]     * Umschalttaste: [⇧]
-    * Tabulatortaste [+    * Tabulatortaste [
-  * phonetische Schrift erscheint ebenfalls in rechteckigen Klammern [] +  * Phonetische Schrift erscheint ebenfalls in rechteckigen Klammern []. 
-  * Synonyme erscheinen  in geschweiften Klammern {} +  * Synonyme erscheinen in geschweiften Klammern {}. 
-  * "Typografische Anführungszeichen" zur Hervorhebung mit der Tastenkombination [⇧ + 2] setzen. Alternativ eine farbige ''Hervorhebung'' verwenden.+  * Zur Betonung dienen "Typografische Anführungszeichen" oder folgende Formatierung ''mit Hintergrund''.
   * 'Apostrophe' sind Bestandteil von Code.   * 'Apostrophe' sind Bestandteil von Code.
   * Arbeitschritte mit der Maus am Computer verwenden die linke Maustaste, sofern nicht anders angegeben.   * Arbeitschritte mit der Maus am Computer verwenden die linke Maustaste, sofern nicht anders angegeben.
- 
-{{dokumentation:hinweis.png?nolink |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.  
- 
-{{dokumentation:hinweis.png?nolink |Hinweis}} In Überschriften keine doppelten Formatierungen verwenden. Als Überschriften gelten: 
-  *Überschrift 1 
-  *Überschrift 2 
-  *Überschrift 3 
-  *Überschrift 4 
-  *Überschrift 5 
  
 == Abkürzungen und Schreibweisen== == Abkürzungen und Schreibweisen==
 Grundlage der Rechtschreibung ist das tolaris know-how [[[spraxx:woerterbuch|Wörterbuch]]. Darin sind Abkürzungen und Schreibweisen, zulässige und nicht zulässige Synonyme geregelt:  Grundlage der Rechtschreibung ist das tolaris know-how [[[spraxx:woerterbuch|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: 
-    * <fc #b7274c>tolaris know-how</fc>-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** **Hoch- und Tiefstellungen**
Zeile 137: Zeile 94:
  
    * Ein Link von <fc #b7274c>tolaris know-how</fc> in das Internet ist mit dem vorausgestelltem Symbol der Weltkugel und der Domainangabe wie bei [[https://tolaris.de|tolaris.de]] versehen.    * Ein Link von <fc #b7274c>tolaris know-how</fc> in das Internet ist mit dem vorausgestelltem Symbol der Weltkugel und der Domainangabe wie bei [[https://tolaris.de|tolaris.de]] versehen.
-   * Ein Link als Download ist mit den vorausgestellten Symbolen der Weltkugel plus ⇓ dargestellt wie bei [[https://etok.de/lib/exe/fetch.php/musizieren/av_075.myr|⇓AV75]]. +   * Ein Link als Download ist mit den vorausgestellten Symbolen der Weltkugel plus ⇓ dargestellt wie bei [[https://etok.de/lib/exe/fetch.php/musik-technik/m_075.mscz|⇓M75]]. 
-   * Ein Link mit einem Codebeispiel ist mit den vorausgestellten Symbolen der Seite plus ⇓ dargestellt wie bei <file JavaScript Beispiel.ino>...</file> +   * Ein Link mit einem JavaScript-Beispiel ist vorausgestellten JS-Symbol dargestellt wie bei <file JavaScript Beispiel.js>...</file> 
 +   * Ein Link mit einem HTML-Beispiel ist vorausgestellten HTML-Symbol dargestellt wie bei <file HTML Beispiel.html>...</file> 
 +   * Ein Link mit einem anderen Code ist mit vorausgestellten Seitensymbol dargestellt wie bei <file JavaScript Beispiel.ino>...</file>
 **Offline**  **Offline** 
  
Zeile 148: Zeile 106:
  
 <html><a name='programmierung'></a></html> <html><a name='programmierung'></a></html>
-== Programmierung ==+ 
 +== 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: 
 +<code> 
 +int ledPin = 13;                // LED-Pin 
 +int buttonPin = 2;              // Taster-Pin 
 +int buttonState = 0;            // Tasterstatus 
 +</code> 
 + 
 +Komplette Beispiele zeigen den Dateinamen als Überschrift und verwenden den DokuWiki-Farbcode zur Syntaxbetonung. Der Dateiname ist als farbiger Link zum Download ausgeführt: 
 + 
 +<file JavaScript nc_0001.js> 
 +var tnmNr1 = require('./tnm_0001'); 
 +tnmNr1.world(); 
 +</file> 
 + 
 +{{dokumentation:hinweis.png?nolink |Hinweis}} In einigen Fällen kommt es zu Überschneidungen bei den Konventionen. Ein Beispiel ist im laufenden Text: 
 +   * <fc #d7946b>nc_0001.js</fc> farbig notiert, wenn die Bedeutung als Code im Vordergrund steht 
 +   * als farbiger Link notiert, wenn es an entfernterer Stelle zu finden ist 
 +   * »nc_0001.js« in spitzen Klammern notiert, wenn die Bedeutung als Datei im Vordergrund steht 
 +   * ''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.  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. 
Zeile 158: Zeile 138:
    * Ein ''nm'' kennzeichnet ein node.js-Modul, z.B. ''nmHttp1''.    * Ein ''nm'' kennzeichnet ein node.js-Modul, z.B. ''nmHttp1''.
    * Ein ''c'' kennzeichnet eine Konstante z.B. ''cPort1'' in JavaScript.     * 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''+   * Ein ''v'' kennzeichnet eine beliebige Variable, wenn die Sprache (wie z.B. JavaScript) keine speziellen Datentypen für Strings {Zeichenkettenoder 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..+   * 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:    * 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 ''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 ''f'' kennzeichnet eine numerische Variable für Gleitkommazahlen, z.B. ''fN1''.
-     * Ein ''b'' kennzeichnet eine Wahrheits­va­riable, z.B. ''bZustand1''.+     * Ein ''b'' kennzeichnet eine Wahrheits­va­riable, z.B. ''bStatus1''.
    * Dieses Schema kann je nach Programmiersprache angepasst werden:    * Dieses Schema kann je nach Programmiersprache angepasst werden:
      * Ein ''s'' kennzeichnet eine Stringvariable, z.B. ''sUrl1''      * Ein ''s'' kennzeichnet eine Stringvariable, z.B. ''sUrl1''
Zeile 179: Zeile 159:
 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.  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 name='audio'></a></html> +<html><a name='musizieren'></a></html> 
-== Musizieren ==+ 
 +== Musik & Technik ==
  
 Die Grundlage bildet die abendländische Musik mit ihren 12 Tonarten, den Tonintervallen und dem Harmonieverständnis mit der internationalen Notation. Die Namen von Tönen sind in Kleinbuchstaben notiert: <fc #C4A000>c</fc> - <fc #C4A000>d</fc> - <fc #C4A000>e</fc> - <fc #C4A000>f</fc> - <fc #C4A000>g</fc> - <fc #C4A000>a</fc> - <fc #C4A000>b</fc> - <fc #C4A000>c</fc>. Die Grundlage bildet die abendländische Musik mit ihren 12 Tonarten, den Tonintervallen und dem Harmonieverständnis mit der internationalen Notation. Die Namen von Tönen sind in Kleinbuchstaben notiert: <fc #C4A000>c</fc> - <fc #C4A000>d</fc> - <fc #C4A000>e</fc> - <fc #C4A000>f</fc> - <fc #C4A000>g</fc> - <fc #C4A000>a</fc> - <fc #C4A000>b</fc> - <fc #C4A000>c</fc>.
Zeile 209: Zeile 190:
    * Bei Moll-Akkorden wird <fc #C4A000>m</fc> angehängt.    * Bei Moll-Akkorden wird <fc #C4A000>m</fc> angehängt.
    * Bei verminderten Dreiklängen wird <fc #C4A000>dim</fc> angehängt.    * Bei verminderten Dreiklängen wird <fc #C4A000>dim</fc> angehängt.
-   * Bei voll verminderten Vierklängen wird <fc #C4A000>dim7</fc> angehängt. 
    * Bei übermäßigen Akkorden wird <fc #C4A000>aug</fc> angehängt.    * Bei übermäßigen Akkorden wird <fc #C4A000>aug</fc> angehängt.
-   * Bei Akkorden ohne Terz wird <fc #C4A000>sus</fc> angehängt:+   * Bei Dreiklängen ohne Terz wird <fc #C4A000>sus</fc> angehängt:
      * <fc #C4A000>sus2</fc> ersetzt die Terz durch eine (große) Sekunde.      * <fc #C4A000>sus2</fc> ersetzt die Terz durch eine (große) Sekunde.
-     * <fc #C4A000>sus4</fc> ersetzt die Terz durch eine [[musizieren:musiklexikon:quarte|Quarte]]. +     * <fc #C4A000>sus4</fc> ersetzt die Terz durch eine [[musik-technik:musiklexikon:quarte|Quarte]]. 
-   * Bei Zweiklängen ohne Terz  (power chord) wird <fc #C4A000>5</fc> angehängt.+   * Bei Zweiklängen ohne Terz (power chord) wird <fc #C4A000>5</fc> angehängt.
    * Bei Vierklängen wird angehängt:    * Bei Vierklängen wird angehängt:
      * <fc #C4A000>Δ</fc> für eine große Septime.      * <fc #C4A000>Δ</fc> für eine große Septime.
      * <fc #C4A000>7</fc> für eine kleine Septime.      * <fc #C4A000>7</fc> für eine kleine Septime.
      * <fc #C4A000>♭7</fc> für eine verminderte Septime.      * <fc #C4A000>♭7</fc> für eine verminderte Septime.
 +     * <fc #C4A000>dim7</fc> (bei voll verminderten Vierklängen).
    * Eine Halbtonerhöhung eines Tons in einem Akkord ist mit einer Ziffer und <fc #C4A000>♯</fc> notiert, z.B. <fc #C4A000>C♯5</fc> für eine übermäßige Quinte statt der reinen Quinte.    * Eine Halbtonerhöhung eines Tons in einem Akkord ist mit einer Ziffer und <fc #C4A000>♯</fc> notiert, z.B. <fc #C4A000>C♯5</fc> für eine übermäßige Quinte statt der reinen Quinte.
    * Eine Halbtonerniedrigung eines Tons in einem Akkord ist mit einer Ziffer und <fc #C4A000>b</fc> notiert, z.B. <fc #C4A000>C♭5</fc> für eine verminderte Quinte statt der reinen Quinte.    * Eine Halbtonerniedrigung eines Tons in einem Akkord ist mit einer Ziffer und <fc #C4A000>b</fc> notiert, z.B. <fc #C4A000>C♭5</fc> für eine verminderte Quinte statt der reinen Quinte.
Zeile 224: Zeile 205:
 {{:dokumentation:hinweis.png?nolink |Hinweis}} Für die Notationen gibt es in der Literatur keine einheitlichen Schreibweisen. Das bei <fc #b7274c>tolaris know-how</fc> benutzte Regelwerk bildet ein durchgängiges logisches Schema, das sowohl im Text wie auch in den Partituren Anwendung findet.  {{:dokumentation:hinweis.png?nolink |Hinweis}} Für die Notationen gibt es in der Literatur keine einheitlichen Schreibweisen. Das bei <fc #b7274c>tolaris know-how</fc> benutzte Regelwerk bildet ein durchgängiges logisches Schema, das sowohl im Text wie auch in den Partituren Anwendung findet. 
  
-{{musizieren:m_063.gif}}+{{musik-technik:m_063.gif}}
  
 <fs 14px>M63: Oktavverschiebung.</fs> <fs 14px>M63: Oktavverschiebung.</fs>
  • Zuletzt geändert: 2020/01/16 17:53
  • von wh