Lade...
 

Formatierungs Standards

Formatierungs Standards


in den folgenden Zeilen wird beschrieben nach welchen Regeln die Dokumentation aufgebaut ist (stark angelehnt an die englischsprachige Dokumentation). Wenn jemand Seiten ändert oder ergänzt, bitte versucht Euch an diese Regel zu halten, damit wir eine Einheitlichkeit bewahren können.

Also erst lesen, dann ändern, erweitern, ergänzen!

  • Überschriften
    • Großschreibung
    • Zeilenabstand
    • Seitenüberschrift
    • Hauptüberschriften
    • Unterüberschriften

  • Links
    • Keine WikiWörter
    • Wiki Seitenbezeichnung
    • externe Links
    • Wiki intern

  • Listen
    • numerierte Listen
    • gegliederte Listen

  • Grafiken
    • Speicherung
    • Dateinamen
    • Tags
    • Formate

  • Icons
    • Wann sollten Sie diese benutzten!
    • Beispiele

  • Fußnoten
    • gemeinsame Zusammenarbeit
    • Hinweise für Dich oder andere

in anderen Worten
  • Benutzer kein HTML.
  • Verberge keine URLs, damit die Dokumentation sowohl Online als auch als Druckversion zur Verfügung steht.
  • Bitte keine Nachrichten, Informationen oder Erinnerungen für Dich oder andere (wie bspw. hilfe - ist das korrekt) innerhalb einer Seite. Benutze dafür die Fussnoten!
  • Versuche die Beispiele!

Originalseite

http://doc.tikiwiki.org/tiki-index.php?page_ref_id=260

Wer arbeitet hier?

DereDior: http://de.tikiwiki.org/tiki-user_information.php?view_user=DereDior

...page... Wiki page pagination has not been enabled.

Überschriften

Großschreibung

In Überschriften sollte jeweils der erste Buchstabe und Substanive (Hauptworte) groß geschrieben werden, Punkte sollen nicht in Überschriften enthalten sein, da Überschriften keine Sätze sind. Zwischen dem Überschriften-Tag (!) und dem ersten Buchstaben soll immer ein Leerzeichen stehen, damit das erste Wort über einen einfachen Doppelklick markiert werden kann.

Falsch
! Neuen benutzer hinzufügen
Korrekt
! Neuen Benutzer hinzufügen

Linienabstand

Mit Ausnahme von Seitennamen sollte immer VOR einer Überschrift ein Leerzeichen gesetzt werden, nicht aber NACH Überschriften.

Falsch
! Neuen Benutzer hinzufügen
!!Formular ausfüllen

Ausfüllen und bestätigen.

!!Berechtigungen prüfen
Admin-Bereich aufrufen.
Korrekt
! Neuen Benutzer hinzufügen

!! Formular ausfüllen
Ausfüllen und bestätigen.

!! Berechtigungen prüfen
Admin-Bereich aufrufen.

Seiten Überschriften

Am Anfang einer Seite sollte immer mit einer (!) begonnen werden, folgend mit einem anständigen Titel der Wiki Seite die bearbeitet wird. Dieser Titel kann von dem Wiki Seitennamen abweichen, um mehr Informationen zu geben, dies sollte nach Möglichkeit eine Ausnahme bleiben, da normalerweise der Wiki Seitenname und die erste Überschrift identisch sind.

Haupt Überschriften

Mit !! wird eine Hauptüberschrift erstellt.

Unter Überschriften

Mit !!! wird eine Unterüberschrift erstellt.

Mehr als dieser 3 Ebenen (Seiten-, Haupt, Unterüberschrift) sollte in der Dokumentation nicht benutzt werden, da diese für bestimmte Tiki-Tags (maketoc, toc) benutzt werden.

...page... Wiki page pagination has not been enabled.

Akzente in Texten und Textpassagen

Fett

Fett-Schrift sollte sparsam eingesetzt werden. Fett-Schrift muss benutzt werden, um sich auf Texte/Beschreibungen einer Seite zu beziehen, bspw. die Bezeichnungen von Konfigurationsoptionen. Beispiel: "In Blogs, klicke wysiwyg Editor benutzen um den Eintrag in einem leicht zu benutzenden what-you-see-is-what-you-get Formatierungsfenster bearbeiten zu können".

Kursiv

Kursivschrift wird benutzt, um Zitate, Kommentare oder eigene Einschätzungen/Meinungen hervorzuheben.

Quellcode

Um Quellcodes, egal ob HTML, Smarty, Php, Javascript oder irgend eine andere Programmiersprache anzuzeigen, wird grundsätzlich das CODE-Plugin eingesetzt. Es sollte dabei immer versucht werden, Quellcode eindeutig, von den Textpassagen optisch zu trennen, wie bspw. eine Abbildung.

...page... Wiki page pagination has not been enabled.

Immer daran erinnern, dass die Dokumentation (Wiki Seiten) auch ausgedruckt werden könnten! URLs oder Wiki Seiten sollten nicht versteckt werden.

)) Keine WikiWords ((

Wenn auf eine neue Wiki Seite erstellt oder auf eine Seite verwiesen wird, benutze keine ))WikiWords((!
Um auf eine Wiki Seite zu verweisen, sollte eine korrekte Schreibweise und Großschreibung benutzt werden und diese Bezeichnung in doppelte Klammern eingebettet werden. Beispiel: ((Formatting Standards)) ).

Bezeichnungen der Wiki Seiten

Seitennamen sollten nicht durch Labels verdeckt werden.

Falsch Read the ((Formatting Standards |rules)) !
Richtig Read the rules, which you'll find in ((Formatting Standards)) .

Externe Links: Position

Wichtige, relevante externe Links sollten am Ende einer Seite aufgeführt werden und benutze dabei die -=Wiki Titlebar Style=-. Füge externe Links nicht nur in den Text einer Wiki Seite.
Um die Links aufzulisten sollte eine bulleted (*) Liste mit einer Bezeichnung in der ersten Zeile und einer oder mehrerer URLS darunter genutzt werden. eine auf jeweils einer Zeile. Diese URLs können über eine erweiterbare Liste (+) verdeckt werden. Siehe auch Blogs.

Externe Links: Schreibweise

Niemals sollte eine externe URL durch eine Beschreibung versteckt werden.

    • Falsch:
      Für mehr Informationen, siehe 
      [http://www.computer.org/author/style/capitals.htm|IEEE Style Guide].
    • Korrekt:
      Für mehr Informationen, siehe auch den IEEE Style Guide unter
      [http://www.computer.org/author/style/capitals.htm].

  • InterWiki Links Um auf eine externe Wiki-Seite auf tikiwiki.org zu verweisen, sollte das Prefix tw: benutzt werden.


...page... Wiki page pagination has not been enabled.

Listen

Wann immer möglich, benutze Nummerierungen (#) oder Aufzählungen (*).

Nummerierungen

Eine Nummerierung sollte immer dann benutzt werden, wenn eine Folge von Schritten, die in der entsprechenden Reihenfolge angewandt werden sollte, beschrieben wird.

Aufzählungen

Aufzählungen sollten, der Übersicht halber, reichlich benutzt werden.

...page... Wiki page pagination has not been enabled.

Grafiken

  • Speicherung Benutzte angehängte Grafiken eher als die Benutzergallerien. Um eine Grafik anzuhängen, benutzte Bild hochladen (Eine Option die erscheint, wenn eine Wiki Seite geändert wird.)
  • Dateinamen Der Dateiname der Grafik sollte nach der Wiki Seite benannt werden (ohne Leerzeichen), numeriert in der Reihenfolge innerhalb der WikiSeite, beispielsweise: WikiUser1.png, WikiUser2.png, etc .. für Grafiken der Seite Wiki User
  • Tag Grafiken sollen mit dem Wiki Tag No image specified. One of the following parameters must be set: fileId, randomGalleryId, fgalId, attId, id, or src. eingebunden werden, nicht mit dem HTML-Tag.
  • Ränder Um eine Grafik vom Text besser differenzieren zu können, soll eine Grafik innerhalb einer Box plaziert werden. Beispiel: ^{img}^).
  • Größe Maximale Breite ist 600 pixel.
  • Format GIF ist verboten!. True color (16 or 24 bit) PNG liefert leider keine gite kompression bei größeren Grafiken. Wenn die Grafik kein Icon oder eine kleinere Grafik ist, dann benutzte bitte nur JPG als Dateiformat.
  • Position Grafiken sollten nach dem entsprechenden Text plaziert werden (nicht vorher).
  • In-Text Referenzen Innerhalb eines Textes solte immer auf die Grafik verwiesen werden (Beispiel: Siehe folgende Illustration).


...page... Wiki page pagination has not been enabled.

Icons

  • Benutze Icons nur in Ausnahme Situationen, und beachte, dass diese nicht immer angezeigt werden (aus welchen Gründen auch immer). Um spezielle Absätze mit Icons hervorzuheben, sollte dies auch mit Formattierungen erreicht werden.
  • Image {picture file=img/icons/cool.gif} wird eingesetzt, um einen Tipp, Hinweis oder besonderes Zitat hervorzuheben.
  • Image {picture file=img/icons2/alert.gif} wird als Warnung benutzt.


...page... Wiki page pagination has not been enabled.

Fussnoten

  • Der Fussnoten Bereich ist sinnvoll für gemeinschaftliche Kommunikation. Da der Content-Bereich nur für einen Bearbeiter sichtbar ist, ist es sinnvoller die Fussnoten für persönliche Kommentare über die Seite einzusetzen. Niemals sollte innerhalb der Seite eine Frage oder Bemerkung für andere eingearbeitet werden. Benutzte dafür Fussnoten! Dies macht eine Überarbeitung leichter.
  • Wenn eine Seite von tikiwiki.org übersetzt wird, dann muss am Ende der Seite ein Verweise (Link) auf die Originalseite angeführt werden.


...page... Wiki page pagination has not been enabled.

Verweise auf Originale

  • Bei einer Übersetzung einer Seite von doc.tikiwiki.org muss am Ende der Seite ein Verweis (in Form eines Titelbalken

-= Originalseite =- ) auf die Originalseite eingefügt werden.

* Nach einem Verweis auf eine Originalseite kann mit einem weiterem Titelbalken (beispiel: ~np~
Wer arbeitet hier?
~/np ~ auf die Homepages, Benutzerseiten der Bearbeiter verwiesen werden.

Zu dieser Seite haben beigesteuert: DereDior und system .
Seite zuletzt geändert: am 25.08.04 01:39 von DereDior.