Richtlinien zum Erstellen von Artikeln

 

1 Text

1.1 Allgemein

Die Artikel sind in HTML zu verfassen. Alle gängigen Befehle (Formatierung, Aufzählungen, Tabellen, …) können verwendet werden. Im Gegensatz zum reinen HTML müssen neue Zeilen dabei nicht mit <br> gekennzeichnet werden, Zeilenumbrüche werden automatisch erkannt.
Artikel-URLs düfen keine (insbesondere von Word erzeugte) Sonderzeichen enthalten. Es ist außerdem darauf zu achten, dass URLs Keywords enthalten und nicht durch unwichtige Wörter unnötig in die Länge gezogen werden.

Schlechte URL: http://me-lrt.de/07-ausblick-auf-die-theorie-der-optimalen-steuerung
Gute URL: http://me-lrt.de/optimale-steuerung

1.2 Ausdruck

Es sind möglichst einfache, kurze und ausdrucksstarke Sätze zu verwenden. Dabei ist auf grammatikalische Korrektheit zu achten. Begriffe wie “einfach”, “trivial”, “logischerweise” und “offensichtlich” sind zu vermeiden.

1.3 Überschriften und Gliederung

Die HTML-Überschrift <h1> ist der Artikelüberschrift vorbehalten und sollte nur in Ausnahmefällen innerhalb des Artikels verwendet werden. Zur Gliederung des Artikels können die HTML-Überschriften <h2> und <h3> verwendet werden. Noch kleinere Abschnitte sind mit fett gedruckten Überschriften zu trennen (HTML-Befehl <strong>). Es ist darauf zu achten, dass die Befehle <h2>, </h2> etc. mit der zugehörigen Überschrift in einer Zeile stehen.

1.4 Formatierung

Auf keinen Fall dürfen verwendet werden:

  • Abweichende Schriftarten oder -größen
  • Animierte Schrift
  • Zeichen außerhalb des 7 Bit ASCII-Standards (statt dessen HTML-Befehle nutzen, z.B. &alpha; für den griechischen Buchstaben Alpha)
  • Das “und”-Zeichen & außer bei HTML-Befehlen

In bestimmten Fällen dürfen verwendet werden:

  • Kursive Schrift (Hervorhebung wichtiger Ausdrücke)
  • Unterstrichene Schrift (nur in Hyperlinks, diese werden automatisch unterstrichen)
  • Fett gedruckte Schrift (Überschriften von Absätzen, sparsam auch einzelne Wörter)
  • Farbige Schrift (wenn es sinnvoll erscheint, nur Farben mit gutem Kontrast zu Weiß)

1.5 Hervorhebung von Absätzen

Wichtige Absätze, z.B. Zusammenfassungen oder Definitionen, können in farbig hervorgehobene abgerundete Boxen geschrieben werden. Hierfür dienen die Befehle <div class=”wbox”>Absatz</div> für eine blaue Box und <div class=”ebox”>Absatz</div> für eine Box mit weißem Hintergrund. Sinnvoll ist es, die Boxen mit einer fett gedruckten Überschrift innerhalb des Rahmens zu beginnen.

1.6 Hervorhebung von Programmtexten

Code-Beispiele müssen für den Syntax-Highlighter als solche kenntlich gemacht werden, indem sie in [code][/code]-Blöcke geschrieben werden. Beispiel: [code language='java']Java Programmtext[/code] oder [code language='matlab']Matlab Programmtext[/code].

2 Formeln

2.1 Allgemein

Formeln sind in den HTML-Artikel im LaTeX-Format einzufügen. Dabei beginnen und enden Formeln mit einem Dollarzeichen.

2.2 Formatierung

Bei Formeln innerhalb einer Textzeile steht vor und hinter jeder Formel ein Leerzeichen, es sei denn auf die Formel folgt ein Satzzeichen. Bei Formeln in einer eigenen Zeile befindet sich über und unter jeder Formel eine Leerzeile.

2.3 Zu beachten (LaTeX)

  • Klammern: “(” und “)” dürfen nicht verwendet werden. Stattdessen: “\left(” und “\right)”

    Das gleiche gilt für alle anderen Klammertypen.

    gut: a = \left[ {\frac{{\left( {b+{c^2}} \right)}}{\pi }} \right], schlecht: a = [\frac{{(b+{c^2})}}{\pi }]

  • Indizes: Gibt es Indizes oben und unten, stehen diese übereinander, nicht hintereinander. Doppelte Indizes sollten mit Kommata getrennt werden.

    gut: w_{12}^t,\;\;{c_{e,SRB,1}}, schlecht: {w_{12}}^t,\;\;{c_{{e_{SR{B_1}}}}}

  • Ableitungen: statt “‘” ist “^\prime” zu verwenden. Mehrere “\prime” stehen auf gleicher Höhe.
  • Sollen mehrere Zeilen durch eine geschweifte Klammer verbunden werden, müssen diese Zeilen in einem Vektor stehen.
  • Als Formatierung sollte immer “Math” und nur in Ausnahmefällen “Text” verwendet werden. Umlaute sind mit \ddot zu realisieren, Leerzeichen mit \; oder \quad für größere Abstände. Text sollte aber möglichst immer vor oder hinter die Formel gezogen werden.
  • Schräge Bruchstriche dürfen nicht verwendet werden.
  • Es dürfen keine Durchstreichungen verwendet werden.
  • Formeln sollten nicht zu breit sein und im Zweifelsfall lieber umgebrochen werden.
  • Im HTML-Code sollte der LaTeX-Code der Formeln frei von Zeilenumbrüchen sein.

3 Grafiken

3.1 Dateiformat

Bilder müssen verlustfrei als .png gespeichert werden. In Ausnahmefällen (Fotos) ist außerdem das .jpg Format erlaubt.

3.2 Abmessungen

Die Größe der Bilder ist so zu wählen, dass im Bild befindlicher Text etwa die gleiche Größe hat wie der Text des Artikels. Es ist darauf zu achten, dass Bilder nicht breiter als 550px sind, da sie sonst im LaTeX-Artikel über den Seitenrand hinausragen. Generell sollten die Abmessungen von Grafiken so klein wie möglich gehalten werden (hohe Informationsdichte).

3.3 Farben und Inhalt

Es sollten hauptsächlich Pastellfarben benutzt werden. Auf Signalfarben (grelles rot) ist möglichst zu verzichten.

3.4 Layout, Beschriftung, Dateinamen

Über und unter jeder Grafik ist im HTML-Code eine Leerzeile einzufügen. Es ist für die Suchmaschinenoptimierung wichtig, dass in den <img>-Tags der Bilder eine aussagekräftige Alternativbeschreibung eingefügt wird, die möglichst relevante Keywords enthält. Die Dateinamen müssen mit dem Kürzel der jeweiligen Vorlesung beginnen und ebenfalls relevante Keywords enthalten. Alle Wörter im Dateinamen sind klein zu schreiben und durch Bindestriche (nicht Tiefstriche oder Punkte) zu verbinden. Außer dem Punkt vor der Dateiendung darf kein weiterer Punkt im Dateinamen enthalten sein. Für die Dateiendung sind Kleinbuchstaben zu verwenden. Dateinamen dürfen keine Umlaute oder ß enthalten.

4 Vorgehen beim Erstellen eines Artikels

Es handelt sich hier um einen Vorschlag, an den sich niemand zu halten braucht. In der Praxis hat sich dieses Vorgehen allerdings bereits viele Jahre bewährt.

Artikel erstellen:

  1. Schreiben des Artikels in MS Word, Formeln mit MathType
  2. Exportieren der Bilder als .png mit dem Snipping-Tool
  3. Umwandlung von Aufzählungen und Überschriften ins HTML-Format (bisher per Hand)
  4. Umwandlung der Formeln in LaTeX-Code (über Java-Tool oder mit interner Funktion von MathType)
  5. Optimierung des gesamten Artikels mit Word-Makro
  6. Feinschliff im Texteditor (übersichtliche Zeilenumbrüche etc.)
  7. Einfügen in Online-Editor, Korrektur falsch dargestellter Formeln, Draft speichern
  8. Artikel noch ein mal im Browser durchlesen!
  9. Publish

Pdf-Version erstellen oder aktualisieren:

  1. Öffnen des Artikels im me-lrt Publisher (über URL oder ID)
  2. “optimize text” klicken
  3. “create Pdf file” klicken, geöffnetes Pdf überfliegen und prüfen
  4. “edit post online” klicken

Ähnliche Artikel

Kommentar verfassen