Style Guide

Schriften & Fonts

Als Schriftart wird je nach System eine andere Schriftart verwendet verwendet. Die Schriftarten sind hier einzusehen.

Ebenso lassen sich dort die Schriftgrößen nachschauen. Der Fließtext wird in 15px verfasst. Die Überschriften variieren von 36px bis 16px.

Aufzählungen erfolgen durch Aufzählungspunkte. Die einzelnen Unterpunkte müssen nicht mit Kommata getrennt werden, wenn sie kein in sich geschlossener Satz darstellen.

Farben

Um ein barrierefreies Lesen der Inhalte für Personen mit Farbfehlsichtigkeiten zu unterstützen, sollen folgende Farben eingesetzt werden:

• Blau #0072BD
• Orange #D95319
• Schwarz #000000
• Grau #808080

Sprachliche Besonderheiten

Sprache

Wir schreiben die Texte, Abbildungsunterschriften usw. auf Deutsch.

Die Codes werden ausschließlich auf Englisch formuliert und kommentiert.

Gendergerechte Sprache

Wir gendern mit :innen. Generell gilt es, wo es möglich ist genderneutral zu schreiben, bspw. mit Studierende anstatt Student:innen. Hierfür bietet sich eine Formulierung im Plural häufig an. Das führt zu einem flüssigen Lesefluss, sodass die genderneutrale Sprache meist gar nicht wahrgenommen wird.

Abkürzungen

Wir kürzen gängige Begrifflichkeiten aus dem allgemeinen Sprachgebrauch ohne Erklärung ab. Welche das sind, kann hier auf Seite 14 eingesehen werden.

Andere Begriffe werden zunächst ausgeschrieben mit der Abkürzung in Verbindung gebracht und können später dann uneingeschränkt abgekürzt verwendet werden.

Schreibkonventionen

• Differential schreiben wir mit t statt mit z.
• Wir schreiben Matlab und nicht MATLAB.
• Punkt als Dezimaltrennzeichen im Fließtext, damit es einheitlich zum Matlab-Code ist.
• Der Leser wird über "Sie" (possesiv "Ihr"), als Einzelperson angeschrieben. Sie also immer groß schreiben.

File-naming conventions

• Numbering starts at 00_ for chapters and exercises.
• Chapters are ordered in folders in /content.
• Exercises are ordered in the folder with the corresponding topic in .md or .ipynb files.
• Titles of chapters must be titles in the first file within the folder, e.g. # Interpolation und Approximation in 05_interp_approx/00_interpolation_Und_approximation.md. Same goes for titles of sections and subsections, e.g. Skripte und Funktionen in 00_einleitung/02_first_steps/02_skripte_und_funktionen.ipynb.

Also keep in mind the conventions from JupyterBooks:

• Each sub-folder must have at least one content file inside it
• The ordering of files in _toc.yml will depend on the alphanumeric order of the filenames (e.g., folder_01 comes before folder_02, and apage comes before b_page)
• If there is a file called index.md in any folder, it will be listed first.