Grundregeln für die Arbeit an FOSA

Achtung! Diese Regeln sind noch nicht definitiv und werden noch überarbeitet!

• Zeilenlänge auf (maximal) 80 Zeichen begrenzen
• Das Encoding ist UTF-8
• Einrückung sind mit 4 Whitespaces zu machen
• Eigene Datei für neues Kapitel
• Labels verwenden:
• \label{fig:...} für Grafiken
• \label{sec:...} für Kapitel und Unterkapitel
• \label{tab:...} für Tabellen
• \label{sch:...} für Schemen

Da Core-Developer Commit-Rechte auf das Repository haben, müssen diese strukturiert arbeiten. Um Redundanzen und Merge-Konflikte zu vermeiden wird stets gegen Issues gearbeitet und wenn möglich eines nach dem anderen.

• Issue erstellen falls noch nicht vorhanden
• Issue assignen
• Branch erstellen (für länger dauernde oder grössere Arbeiten)
• Lokal testen und builden
• nach erfolgreichem build pushen
• Falls Issue abgeschlossen pushen mit issue-tag wie "close #33"

Da beliebige Contributor keine Push-Rechte auf das Repository haben gehen diese wie auf Github üblich vor.

• Repository forken
• Patch erstellen
• Pull-Request machen (vorzugsweise über Github, nicht per git)

• NIE in Dateinamen verwenden
• NIE für Labels, Referenzen verwenden (\label{}, \ref{})
• Im Code als UTF-8 Zeichen schreiben (nicht " verwenden)

• Grundsätzlich Lowercase verwenden
• Grundsätzlich "-" Verbinder

• Tabellen auch im Code strukturieren
• Horizontale Linien wo möglich vermeiden
• Wo Hervorhebung nötig Schattierungen verwenden (mit lgray und white)
• Vertikale Linien wo möglich vermeiden

Grundsätzlich werden Grafiken selber erstellt mit Inkscape auf Basis der Vorlage "fig/template.svg" und als PDF mit dem gleichen Dateinamen exportiert (z.B. "plot.svg" wird zu "plot.pdf"). Sowohl die SVG-Datei als auch der PDF-Export davon werden im Repository abgelegt.

• Eigener Ordner für Grafiken
• Vektorgrafiken verwenden (EPS, PDF (SVG))
• Falls Bitmap gleich ein Issue erstellen (JPG, PNG) zur Änderung
• Grundsätzlich selbst erstellt - Tipp: Inkscape verwenden (http://www.inkscape.org/en/download/)
• Fremde Inhalte im Code vermerken mit Quellenverweis (ggf. auch im Output) und evtl. Issue erstellen
• Lizenzen fremder Inhalte beachten und freie vorziehen (wenn möglich cc oder Public Domain)

Jede Fosa hat die gleiche Struktur welche die folgenden Elemente enthält.

README.md
LICENSE
.gitignore

makefile
"helper-skript".sh

"name-der-fosa".tex (z.B. fosamath-tiboth.tex)
"name-des-kapitels".tex
layout.sty
about.tex
content.tex
.header
...

Optional

literatur.bib
glossar.tex
...

Selbsterstellte Vektorgrafiken immer mit Originalformat (z.B. SVG) ablegen. Grafiken die mit TikZ erstellt sind, gehören in die entsprechende .tex Datei.

template.svg
template.eps
template.pdf

"treffender-name".eps
"treffender-name".pdf
"treffender-name".svg

Manchmal möchte oder muss man Fremdinhalte einbinden. Diese sind separiert.

"fremde-inhalte".pdf
...

Um die Kollaboration zu vereinfachen gibt es die FOSA-Tags.

... hat einen Knick im Graphen (siehe Grafik \ref{fig:knick}).

\begin{figure}
	\centering
	>>>FOSA: hier Plot einfügen
	\caption{Graph mit einem Knick}
	\label{fig:knick}
\end{figure}