Bedienung von DokuForge

Nach dem Einloggen kannst du deine Akademie auswählen, danach deinen Kurs. Dafür klickst du auf den Namen der Akademie, und dann auf den entsprechenden Kurstitel. Jetzt kannst du bestehende Texte in dieser Kursdoku anschauen, editieren oder neue Seiten hinzufügen.

Textverarbeitungsprogramme wie Word und OpenOffice haben die unangenehme Eigenschaft, beim Einfügen von Texten in DokuForge mittels Copy&Paste Sonderzeichen in mehr oder weniger unvorhersehbarer Art und Weise zu benutzen. Das betrifft vor allem Anführungszeichen, Gedankenstriche und Ellipsen.

Wir empfehlen dir daher dringend, zum Vorschreiben der Texte das Programm Notepad bzw. einen anderen Texteditor im Plain-Text-Modus zu verwenden. Ansonsten müssen die eingegebenen Texte unbedingt von Hand an die allgemein gültigen Standards angepasst werden.

Bist du fertig mit deiner Eingabe, lies den Text bitte noch einmal Korrektur und gib dann dem für dich zuständigen Eingabekontrolleur Bescheid.

Bei Problemen und Fragen kannst und sollst du dich an deinen Eingabekontrolleur wenden oder einfach eine E-Mail an doku (at) lists.cde-ev.de schreiben. Wir helfen dir gerne weiter und sind auch für die Weiterentwicklung von DokuForge auf dein Feedback angewiesen.

• Absätze
• Überschriften
• Autoren
• Hervorhebungen
• Schlagworte
• Aufzählungen
• Auslasspunkte (Ellipse)
• Anführungszeichen
• Bindestrich
• Einheiten
• Zahlen
• Exponenten
• Brüche
• Chemische Formeln
• Abkürzungen
• Eigennamen
• CdE-Vokabular
• Gendern
• Ednotes
• URLs
• Code

Absätze

Absätze werden in DokuForge durch Leerzeilen getrennt. Wenn du einen neuen Absatz anfangen willst, musst du also zweimal Enter drücken. Einmal reicht nicht!

Ein einfacher
Zeilenumbruch wird von DokuForge
nicht als Absatz erkannt.

Erst eine Leerzeile erzeugt einen neuen Absatz.

Überschriften

Eine Überschrift steht am Anfang einer Zeile und wird in eckige Klammern gesetzt. Sie wird dabei nicht nummeriert – dies geschieht später automatisch. Deshalb bitte nicht auf eine Kapitelnummer verweisen, sondern auf den Titel. Beispiel: "Wie in der Einleitung dargestellt."

Es gibt nur eine Überschriftenebene! Also keine Unterüberschriften (weder kursiv noch als Schlagwort oder noch anders).

Autoren

Direkt unter eine Überschrift (und nur da) kann nach einem einfachen Zeilenumbruch eine Autorenangabe gesetzt werden. Autorenangaben gehören in runde Klammern.

Bitte setze kein "von" an den Beginn, nenne die Autoren mit Komma getrennt sowie mit einem "und" vor dem letzten Autorennamen.

[Überschrift]
(Vorname Nachname)

[Überschrift]
(Vorname Nachname, Vorname Nachname und Vorname Nachname)

Hervorhebungen

Möchte man etwas im Text hervorheben, kann man es zwischen _Unterstriche_ setzen.

Schlagworte

Am Anfang eines Absatzes (und nur dort!) gibt es die Möglichkeit, ein Wort als Schlagwort auszuzeichnen, indem man es in *Sternchen* einschließt.

Aufzählungen

Aufzählungen funktionieren denkbar einfach: Ein einzelner Bindestrich bzw. eine Zahl mit einem Punkt dahinter am Anfang einer Zeile führt zum gewünschten Ergebnis.

- erster Punkt
- zweiter Punkt
- noch ein .
- viele Punkte: ...

1. erster Punkt
2. zweiter Punkt
3. noch ein .
4. viele Punkte: ...

Auslasspunkte (Ellipse)

Eine Ellipse (drei Punkte zur Kennzeichnung einer Auslassung, …) werden in DokuForge mit drei Punkten und einem Leerzeichen davor gesetzt: ...

Anführungszeichen

Anführungszeichen sollten als " (Shift-2 auf der deutschen Tastatur) eingegeben werden. Wir machen daraus später »schöne« Anführungszeichen. Einfache Anführungszeichen für Zitate innerhalb wörtlicher Rede sowie Apostrophe wie in "So geht's" werden als ' (Shift-# auf der deutschen Tastatur) eingegeben.

Bindestrich

Der Bindestrich wird wie üblich verwendet. Gedankenstriche und Zahlenbereiche werden mit einem längeren Strich gesetzt. Wir verwenden hier zur Eingabe zwei Bindestriche: --. Wichtig ist, dass Gedankenstriche auf beiden Seiten je ein Leerzeichen Abstand bekommen, während Bereichsstriche ohne Leerzeichen eingegeben werden.

Einheiten

Einheiten werden automatisch erkannt. Sie müssen dafür lediglich durch ein Leerzeichen getrennt hinter die zugehörige Zahl gesetzt werden. Im Gegensatz dazu gehört vor das Prozentzeichen und vor "°C" kein Leerzeichen! Dieses bitte direkt an die Zahl schreiben.

1 m ist noch nicht so viel.
1 m$^2$ ist schon mehr.
Es gibt aber auch so etwas wie 5 l, 12 kWh oder 300 eV.

Das Dollarzeichen "$" kann DokuForge übrigens nicht darstellen. Dieses ist nämlich für mathematische Formeln reserviert. Bitte entweder eine Ednote oder die Abkürzung USD verwenden.

Zahlen

Große Zahlen bitte ohne Leerzeichen oder Punkte eingeben, da DokuForge sie nur dann automatisch formatieren kann.

1000 und nicht 1.000
2349635 und nicht 2 349 635
300000 und nicht 300.000

Uhrzeiten bitte im Format 23:00 eingeben.

Exponenten

Wenn du Exponenten darstellen willst, setze diese bitte zwischen zwei Dollarzeichen (d.h. als mathematische Formel).

5 m$^2$
300 m$^3$
7 km$^{800}$ sind zwar relativ unsinnig, aber ein Beispiel.

Brüche

Bitte gebt Brüche in der Form 1/2 ein und nicht als ½.

Chemische Formeln

Chemische Formeln und Reaktionen werden mit dem Paket chemformula gesetzt, zum Beispiel $\ch{H3O+}$ oder die Gleichungen $\ch{A + B -> C}$ und

\begin{equation*}
  \ch{CO2 + H2O <=>[$k$] HCO3- + H+}.
\end{equation*}

Es ist empfehlenswert, zusätzlich ein z. B. handschriftliches Bild des gewünschten Ergebnisses hochzuladen.

Abkürzungen

Abkürzungen sind manchmal etwas problematisch. Daher gibt es eine Liste erlaubter Abkürzungen. Alles andere, was man versucht sein könnte abzukürzen, kann man meistens genauso gut ausschreiben oder sehr schön umformulieren.

Bitte also nur die folgenden Abkürzungen verwenden:

• bzw.
• ca.
• d.h.
• etc.
• f.
• ff.
• ggf.
• n.Chr.
• o.ä., o.Ä.
• s.o.
• s.u.
• sog.
• u.a.
• v.Chr.
• vgl.
• vs.
• z.B.

Eigennamen

Eigennamen bitte nicht in GROSSBUCHSTABEN setzen.

CdE-Vokabular

Einige Schreibweisen gewisser CdE-Begriffe:

• DokuForge / Ednote / "So geht's" / der exPuls
• der CdE (Genitiv: des CdE)
• ein CdEler, viele CdEler
• CdElokal, CdElokal-Gruppen / CdE Bonn, CdE Ruhr, CdE Dresden etc. (nicht Ruhr-CdE etc.)
• WinterAkademie, PfingstAkademie, SommerAkademie
• am Bunten Abend
• KüA (Plural: KüAs)
• Orga-Team, Orga-Büro, Orga-Treffen etc.

Gendern

Wenn du gendern willst, empfehlen wir geschlechtsneutrale Formulierungen (z.B. Dokuschreibende) zu verwenden, wenn möglich. Ansonsten empfehlen wir die Schreibweise mit Doppelpunkt (z.B. Schüler:innen). Diese Variante schließt das gesamte Genderspektrum ein und ist sowohl im Allgemeinen als auch von Screenreadern gut lesbar.

Ednotes

Falls du uns (denen, die die Doku endgültig setzen) etwas mitteilen oder Besonderheiten wie Tabellen oder Gedichte nutzen willst (siehe dazu die entsprechenden Abschnitte), kannst du es in einem separaten Absatz in geschweifte Klammern schreiben. Diese sogenannte Ednote sieht zum Beispiel so aus:

{ Im folgenden Absatz sind ganz viele
  Rechtschreibfehler. Diese sind absichtlich,
  also bitte stehen lassen! Da sie das Auge
  beleidigen, sind natuerlich schon ein paar
  Tafeln Schokolade zu euch unterwegs.  Danke!
                           -- silke 20050709 }

  Im folgenden Absatz sind ganz viele
  Rechtschreibfehler. Diese sind absichtlich,
  also bitte stehen lassen! Da sie das Auge
  beleidigen, sind natuerlich schon ein paar
  Tafeln Schokolade zu euch unterwegs.  Danke!
                           -- silke 20050709

In Ednotes gibt es keinen automatischen Zeilenumbruch. Es wäre also schön, wenn du jeweils nach einer geeigneten Zeilenlänge (z.B. der Breite des Eingabefeldes) selbst umbrichst.

Wenn du in den Ednotes geschweifte Klammern verwendest, genügt eine einfach geschweifte Klammer nicht, um eine Ednote auszuzeichnen. Du kannst die Ednote dann mit einer beliebigen Kombination von Klammern, aber beginnend mit einer geschweiften, öffnen und mit schließenden Klammern in umgekehrter Reihenfolge beenden:

{[(
\title{Beispieltitel}
)]}

\title{Beispieltitel}

URLs

URLs bitte in Ednotes eingeben.

Unter
{
http://www.google.de
}
erreicht man eine Suchmaschine.

http://www.google.de

Dabei bitte ignorieren, dass das scheinbar den Absatz zerhackt.

Code (Programmquelltext)

Zur Darstellung von kleinen Code-Schnippseln im Fließtext werden Pipes um den Code gesetzt. Eine mehrzeilige Eingabe von Code erfolgt in ednotes.

Möchte man eine |Class Klasse| im Text erklären, so kann man es einfach in |-Symbole einschließen. Schreibt man eine mehrzeilige Klassendefinition, so wird sie in eine Ednote eingebettet. Dabei bitte die ednote mit einer Klammerstruktur eingeben, die im Quellcode nicht vorkommt.

{[(
Class Klasse
    def __init__(self, realpart, imagpart):
    self.r = realpart
    self.i = imagpart
)]}