Benutzer:Lord Skunk/uni/konventionen

Bitte nicht löschen -- dies ist ein kleines Projekt, wo wir erst testen wollen, wie es sich entwickelt. Deshalb steht die Seite noch relativ abgekapselt hier in meinem Benutzerbereich. Daran kann sich bald was ändern, wenn wir Erfolg haben.

Die Texte werden mit UTF-8 gesetzt -- also geschrieben und gelesen. Dies ist das Standarddatenformat für den Austausch im Internet. Für User von Windows könnte es dabei zu Problemen kommen, wenn sie nicht darauf achten. Die meisten Editoren stellen die Codierung jedoch automatisch um oder es gibt eine Einstellung dafür.

So können wir problemlos Umlaute wie äöü oder ß eingeben.

Die Lernkärtchen werden mit LaTeX2e gesetzt. Dazu wird der normale Text in Latex geschrieben und auf der Wikipedia-Seite gespeichert und dann von mir compiliert und hochgeladen (kann natürlich jeder selber machen, ich habe halt ein paar Kniffe dazu).

Generell verwenden wir die Struktur einer Präsentation -- was dies im einzelnen heißt, steht unten.

Eine Lernkarte hat allgemein den Anfang

\begin{frame}{<title>}

wobei man der Karte mit <title> einen möglichst eingängigen Titel gibt: In der Überschrift sollte vorkommen, was genau man gerade beschreibt und ob es sich um ein Lemma, Satz, Definition etc. handelt. (bspw. \begin{frame}{Cauchy-Kriterium (Def)})

Man be'endet eine Lernkarte mit dem Befehl

\end{frame}

Aufzählungen realisiert man mit

\begin{itemize}
\item <text>
\item <text>
\end{itemize}

Formeln werden im "Fließtext" mit $<formel>$ geschrieben und wenn sie abgesetzt werden sollen mit $$<formel>$$.

Hinter jeder Überschrift, die eine Definition enthält, kann man einen Anker setzen:

\label{<name>}

An anderer Stelle kann man auf diesen Zurückgreifen.

Siehe auch Blatt \ref{<name>} 

Zusätzliche Anker setzten ist nie verkehrt -- man muss nur schauen, dass man keine mehrfach definierten Anker bekommt. Man kann auch einzelne Sätze oder was auch immer mit solchen Ankern ausstatten

Themenüberschriften realisiert man außerhalb der frame-Umgebungen. Dazu schreibt man

\section{<name>}
\subsection{<name>}
\subsubsection{<name>}

Diese Tauchen dann in der Inhaltsangabe der Lernkarten und in der Fließtextform als richtige Inhaltsangabe auf.

Hat man ein besonders interessantes Wort -- also einen wichtigen Schlüsselbegriff, so kann man diesen in den Index Aufnehmen, indem man hinter dem Begriff

\index{<begriff>}

schreibt und den Begriff dort nochmals wiederholt. Diese erscheinen dann im Fließtext auf einer Seite mit zugehörigen Seitenzahlen.

Wenn ihr einen Text editiert habt, sagt explizit, wer, was und wann

Schreibt außerden euren Namen mit in das \author{<manem>}-Tag rein.

Ach ja, schreibt bitte nur, wo ihr euch sicher seid!

Und macht ausreichend Leerzeilen Latex interpretiert mehrere Leerzeilen als einen Absatz, aber es erhöht die Lesbarkeit doch erheblich...

Abstände in LaTeX schreibt man mit ~. Verwendet aber nicht mehrere Tilden hintereinander. Sonst interpretiert Wikipedia das als Aufforderung, die eigene IP-Adresse einzutragen.

Bei all diesen Konventionen gilt, ich bin zwar root, ich habe das Sagen und mache die Regeln (meine Meinung: lieber ein schlechter Standard durchgehalten als ein gutes Chaos) d.h. ich nehme es mir raus, Sachen zu ändern, die ich so nicht für gut halte -- dabei lasse ich aber mit mir reden ;-) Ich will hier halt auf keinen Fall ein Kuddelmuddel.