Aus PISACORE
Wechseln zu: Navigation, Suche

Allgemeines

Fehler.png

  • Schaue Dir den Quellcode von bestehenden Dateien/Artikel an, bevor Du Deine ersten Änderungen vornimmst.
  • Nutze die Vorschau, bevor Du eine Seite endgültig veränderst oder erstellst.
  • Wenn ein und derselbe Text mehrfach verwendet werden kann, erstelle eine Vorlage und nutze diese!
  • Denke vorausschauend, z.B. an die Multilingualität (Mehrsprachigkeit), bevor Du neue Seiten erstellst.
  • Benutze HTML nur, wenn der Wiki-Code nicht ausreicht!
  • Verwende keine absoluten Links innerhalb des Wikis, wenn Wiki-Links verwendet werden können!


Warnung.png:

  • Beachte auch Kleinigkeiten wie Absätze, Leerzeilen und Leerzeichen.
  • Verwende Leerzeichen anstatt Tabs, wenn Du eine Seite in einem externen Editor bearbeitest.


Schlecht! Gut! Kommentar
= Überschrift 1 = Die Ebene 1 ist für den Seitentitel reserviert und innerhalb von Artikeln unerwünscht.

Beginne also immer mit Ebene 2 und verwende Ebene 1 so gut wie nie.

==Überschrift== == Überschrift == Achte auf die Leerzeichen, auch wenn beides funkioniert.
== '''Überschrift 2''' == == Überschrift 2 == Es ist doch eine Überschrift, also verzichte bitte auf weitere Formatierungen.

== Überschrift 2 ==

=== Überschrift 3 ===

== Überschrift 2 ==
=== Überschrift 3 ===

Überschriften, oder Texte nach einer Überschrift, können direkt danach folgen, also ohne Absatz.
[http://www.domain.irgendwo/wiki/index.php/Hauptseite] [[Hauptseite]] Links innerhalb eines Wikis sollten nicht absolut angegeben werden!

Denk nur mal daran, wenn das Wiki die Domain wechselt...


Wiki formatieren

Textgestaltung

Hier wird erklärt wie man verschieden Darstellungen von Texten im Wiki beeinflussen kann/sollte. Es handelt sich hier um ein MediaWiki-System, das dieselben Formatierungsmöglichkeiten bietet wie Wikipedia.

Ergebnis Code Kommentar
kursiv ''kursiv'' z.B. für Dateinamen
fett '''fett''' z.B. für wichtige Hinweise
fett und kursiv '''''fett und kursiv''''' z.B. für wichtige Dateinamen
Wiki-Sonderzeichen, zB.: < > '' [ ] == <nowiki>Wiki-Sonderzeichen, zB.: < > '' [ ] ==</nowiki> z.B. für Code Schnipsel, damit vorkommende Zeichen vom Wiki nicht als Formatierung interpretiert werden
wichtiger Hinweis
Zeile 2

Zeile 4
<LEERZEICHEN>wichtiger Hinweis
<LEERZEICHEN>Zeile 2
<LEERZEICHEN>
<LEERZEICHEN>Zeile 4
Einfügen von Code, Kommandos oder wichtigen Hinweisen in einem Kasten werden per Leerzeichen am Zeilenanfang eingeleitet.

Mit <LEERZEICHEN> im Code-Beispiel ist ein echtes Leerzeichen gemeint, hierbei handelt es sich nicht um "Wiki-Code" ;)

  • eins
  • zwei
    • zwei-eins
    • zwei-zwei
  • drei

* eins
* zwei
** zwei-eins
** zwei-zwei
* drei

Aufzählungen, z.B. benötigte Pakete
  1. erster schritt
  2. zweiter schritt
  3. dritter schritt

# erster schritt
# zweiter schritt
# dritter schritt

Punktweise Aufzählungen, z.B. Installationsvorgang
Überschriften == Überschrift Ebene 2 ==

====== Überschrift Ebene 6 ======

Die Ebene 1 ist für den Seitentitel reserviert und innerhalb von Artikeln unerwünscht.
ich bin normaler text

ich bin nach absatz noch mehr text

<source lang="text">
ich bin normaler text

ich bin nach absatz noch mehr text
</source>

Syntaxhervorhebung für text mit absätzen
<?php
# ich bin ein Kommentar
echo 'ich bin PHP Code';
?>

<source lang="php">
<?php
# ich bin ein Kommentar
echo 'ich bin PHP Code';
?>
</source>

Syntaxhervorhebung in PHP
# ich bin ein Kommentar
echo 'ich bin Bash Code'

<source lang="bash">
# ich bin ein Kommentar
echo 'ich bin Bash Code'
</source>

Syntaxhervorhebung in Bash

Supported Languages

Yes.png {{Ja}} Diese einfache Vorlage kann in To-Do-Listen, Abstimmungen (für eine einfachere Organisation von gelösten und ungelösten Fragen) und Tabellen verwendet werden.
No.png {{Nein}} Diese einfache Vorlage kann in To-Do-Listen, Abstimmungen (für eine einfachere Organisation von gelösten und ungelösten Fragen) und Tabellen verwendet werden.

Show Spoiler Hide Spoiler

spoiler text
<spoiler>spoiler text</spoiler>

show_message Hide Spoiler

spoiler_text
<spoiler show="show_message">spoiler_text</spoiler> Um ähnlich wie in Foren einen Spoiler zu verwenden um darin einen aufklappbaren Text abzugrenzen

show_message hide_message

spoiler_text
<spoiler show="show_message" hide="hide_message">spoiler_text</spoiler>

Manuelle Zeilenumbrüche können mit <br /> erzwungen werden. Damit sollte aber sparsam umgegangen werden!

BBCodes

Die sogenannten BBCodes, wie man sie aus Foren kennt, können ebenfalls verwenden werden.
supported tags:

  • [b] - bold
  • [i] - italics
  • [o] - overline
  • [u] - underline
  • [tt] - typewriter text
  • [sup] - superscript
  • [sub] - subscripts
  • [pre] - same as <pre>
  • [code] - same as <pre> but ignores wiki/bbcode markup
  • [color=color name|#hexcode] - sets text color
  • [bgcolor=color name|#hexcode] - sets text background color
  • [font=font family, font name] - sets font name/family
  • [font=normal] (use font inherited from DOM parent object)
  • [font=cursive] (cursive font)
  • [mono] and [font=mono|monospace|monospaced] (monospaced font)

  • and
    - horizontal rule
  • [hr=PERCENT%|PIXELSpx] and [line=PERCENT%|PIXELSpx] - horizontal rule with restrictions
  • [float=left|right|top|bottom] - floats text to the left, right, top or bottom of the DOM parent object


examples:

  • [b] bold [/b]
  • [i] italics [/i]
  • [o] overline [/o] (cannot show in wiki markup)
  • [u] underline [/u]
  • [s] strikethrough] [/s]
  • [sup] superscript [/sup]
  • [sub] subscript [/sub]
  • [tt] typewriter text [/tt]
  • [color=red] red text [/color]
  • [color=#FF0000] red text [/color]
  • [bgcolor=yellow] yellow background [/bgcolor]
  • [bgcolor=#FFFF00] yellow background [/bgcolor]
  • (cannot show in wiki markup) [h1] through [h6] uses headers just like <h1> through <h6>
  • [br] make a line break just like <br /> does

  • [hr] and [line] make a horizontal rule just like <hr /> does

  • (cannot show in wiki markup) [hr=300px] and [line=300px] make a 300 pixel wide horizontal rule just like <hr width="300px" /> does
  • (cannot show in wiki markup) [hr=50%] and [line=50%] make a horizontal rule that is 50% the width of the window just like <hr width="50%" /> does
  • (cannot show in wiki markup) float text in an html direction like that → [float=right] float text right [/float]
  • (cannot show in wiki markup) [font=Courier, monospace] custom font family [/font]
    please use fonts that work on all platforms or one of the shortcuts below.
  • (cannot show in wiki markup) [font=mono] monospaced font shortcut [/font]
  • (cannot show in wiki markup) [font=cursive] cursive font shortcut [/font]
  • (cannot show in wiki markup) [font=normal] normal font shortcut [/font] is useful inside [pre] tags
  • the [pre] tag allows  you    to      have        preformatted      text    in  a spiffy box 
  • the [code] tag is like [pre] but all wiki markup is disabled and most bbcode is hidden.  '''not bold'''


Farbige Texte

Ergebnis Code
ÄNDERUNG - CHANGE {{BGColor|Blue;color:White;padding:0 5px|ÄNDERUNG - CHANGE}}
NEU - NEW {{BGColor|Green;color:White;padding:0 5px|NEU - NEW}}
HINWEIS - TIP {{BGColor|Yellow;padding:0 5px|HINWEIS - TIP}}
VERALTET - OBSOLETE {{BGColor|Red;color:White;padding:0 5px|VERALTET - OBSOLETE}}
roter text {{Color|red|roter text}}
text der ein Vorlage:= Zeichen enthält {{Color|blue|text der ein {{=}} Zeichen enthält}}
html farb codes es können auch reguläre html farbcodes verwendet werden: {{Color|#33CC99|html farb codes}}


Status-Meldungen

Ergebnis Code
Hilfe.png: {{help|Hilfe}}:
Info.png: {{info|Info}}:
Warnung.png: {{attention|Achtung}}:
Fehler.png: {{error|Fehler}}:
UnderConstruction.jpg: {{UnderConstruction|Baustelle}}:
Unsicher.gif: {{unsure|Unsicher}}:
Veraltet.jpg {{obsolet|Nicht mehr verwendet!}}

Kategorien

Jeder Artikel sollte in der dafür passenden Kategorie erstellt werden.

Neue Kategorien erstellt man, indem über die Adressleiste z.B. /wiki/index.php/Beispiel aufgerufen wird. Diese wiederum in der Haupt-Kategorie zu verlinken wird so erreicht:

[[Beispiel|Link Name]]

Neue Artikel werden ebenfalls unter der Haupt-Kategorie erstellt indem man in der Adressleiste z.B. /wiki/index.php/Beispiel/Subcat aufgeruft. Verlinkt wird das wiederum indem man

[[Beispiel/Subcat|Link Name]]

verwendet.

Unter-Artikel/-Seiten sind nur der Kategorie der übergeordneten Seite zuzuordnen.


Vorlagen

Eine Vorlage ist ein (Wiki-)Text (mit Tabellen, Bildern und Code), der in anderen Seiten eingebunden werden kann. Dies erlaubt, den Text an einer Stelle zu bearbeiten und dann die automatische Aktualisierung auf allen anderen Seiten abzuwarten.

Eine Vorlage ist technisch eine jede Seite im Vorlagennamensraum, also jede Seite, die mit „Vorlage:“ beginnt.

Welche Vorlagen gibt es bereits?

Eine Liste mit den bereits vorhandenen Vorlangen könnt ihr euch links über Werkzeuge -> Spezialseiten -> Alle Seiten -> Namensraum: Vorlagen anzeigen lassen.

Wie kann ich eine Vorlage erstellen?

Erstelle eine Seite im Vorlagennamensraum, wie zum Beispiel "Vorlage:Name_der_Vorlage". Der Vorlagenname kann Symbole und Abstände enthalten, sollte jedoch möglichst einfach bleiben, da du dich sonst nur schwer an ihn erinnern kannst.

Wie kann ich die Kategorisierung bei Vorlagenverwendung verhindern/bedingen?

Mittels der <noinclude></noinclude>-Tags kann man Text markieren, der nicht beim Einbinden angezeigt werden soll. Dies ist hilfreich, um die Vorlage zu kategorisieren, ohne dass eine Seite, welche die Vorlage verwendet, kategorisiert würde.

Als Alternative kann man den Text, der beim Einbinden angezeigt werden soll, mit <onlyinclude></onlyinclude>-Tags umschließen.

Um Text nur beim Einbinden anzuzeigen (etwa eine Kategorie), ist dieser mit <includeonly></includeonly>-Tags zu versehen.

Wie kann ich Parser-Funktionen in Vorlagen verwenden?

Parser Funktionen erlauben eine kleine Einbindung von logischen Ausdrücken und Funktionen, wie in der Programmiersprache. Dies sind zum Beispiel die if-Ausdrücke sowie grundlegende mathematische Funktionen. Du kannst mit Parser Funktionen zum Beispiel auch nicht verwendete Parameter in Tabellen auslassen und somit wird eine Zeile in einer Tabelle ausgeblendet:

{{#if: {{{input|}}} | {{!}}-
{{!}} {{{input}}} }}

Produziert folgenden Code, jedoch nur wenn input definiert ist.

|-
| input

{{!}} wird in der oben liegenden Funktion anstatt von | verwendet. {{!}} ist eine Vorlage (Vorlage:!), welche das Symbol | erstellt, nachdem die Parser-Funktion bestätigt worden ist.

Wie kann ich Vorlagen im Artikel verwenden?

Vorlagen (im Vorlagennamensraum) können genutzt werden, indem man ihren Namen (ohne den Namenszusatz „Vorlage:“) in geschweifte Klammern setzt:

{{Name}}

Spezielle Vorlagen als Variablen der Wiki-Software

Die MediaWiki-Software verfügt über vordefinierte Vorlagen als Variablen. Eine Liste findest du bei Help:Magic Words (auf englisch). Hier ein kleiner Auszug:

Vorlagenname Aktueller Wert Erklärung der Variable
{{PAGENAME}} HowTo/Wiki Beiträge Der aktuelle Seitenname als Zeichenkette
{{NUMBEROFARTICLES}} 7 Anzahl aller Wiki-Seiten
{{CURRENTDAY}} 16 Aktueller Tag innerhalb des Monats
{{CURRENTDAYNAME}} Samstag Wochentag
{{CURRENTMONTH}} 02 Aktueller Monat als Nummerndarstellung
{{CURRENTMONTHNAME}} Februar Aktueller Monat in lesbarer Form
{{CURRENTYEAR}} 2019
{{CURRENTTIME}} 07:48
Hinweis:
Die Zeitvariablen mit CURRENT liefern die UTC-Zeit. Möchtest du die aktuelle Zeit angeben lassen, ersetze CURRENT durch LOCAL, also beispielsweise statt CURRENTTIME LOCALTIME.

Verwendung von Parametern in Vorlagen

Vorlage:Hl2 colspan="2" align="center" |Vorlage mit nummerierten Parametern
 
'''A little thank you...'''<br>
<small>for {{{1}}}.<br>
hugs, {{{2}}}</small>
Vorlage:Hl2|Du schreibst Vorlage:Hl2|Du bekommst
{{Thankyou|all|Joe}}

Vorlage:Thankyou

Vorlage:Hl2 colspan="2" align="center" |mit benannten Parametern
 
'''A little thank you...'''<br>
<small>for {{{reason}}}.<br>
hugs, {{{signature}}}</small>
Vorlage:Hl2|Du schreibst Vorlage:Hl2|Du bekommst
{{Thankyou
|reason=all
|signature=Joe}}

Vorlage:Thankyou

Du kannst Parameter in Vorlagen entweder als nummeriert, wie {{{1}}}, oder als benannt {{{param}}} definieren. Beispiel: Du möchtest eine kleine Danknotiz, die du auf die Gesprächsseite mit anderen Nutzern setzen kannst. Sie soll den Grund und deine Signatur enthalten. Du kannst Vorlage:Thankyou erstellen, um deinen Text wie im Beispiel in der Tabelle einzugeben.

Wenn du die Vorlage auf einer Seite verwendest, füllst du die, durch ein Pipezeichen (|) getrennten, Parameterwerte: {{Thankyou|all|Joe}}. Für benannte Parameter verwendest du "name=wert"-Paare, welche auch wieder durch ein Pipezeichen voneinander getrennt werden: {{Thankyou|reason=all|signature=Joe}}. Der Vorteil bei der Verwendung benannter Parameter in deiner Vorlage ist, dass die Reihenfolge flexibel ist. Außerdem ist die Vorlage damit leichter verständlich, wenn du viele Parameter hast. Falls du die Reihenfolge der nummerierten Parameter ändern möchtest, musst du das explizit vermerken: {{Thankyou|2=Joe|1=all}}.

Organisation von Vorlagen

Damit Vorlagen effektiv sein können, müssen Nutzer sie schnell finden können und dazu in der Lage sein, sie zu nutzen. Eine einfache Technik ist die Integration eines Beispiels auf der Vorlagenseite. Zum Beispiel:

<noinclude>

== Verwendung ==
Erlaubt das Setzen eines Verweises zu einem Thema:
{{NameDerVorlage|Term1+Term2+Term3}}
</noinclude>

Ein Redakteur kann einfach das Beispiel kopieren und einfügen, um eine ähnliche Seite zu erzeugen. Das Beispiel ist trivial, doch ein funktionstüchtiges Beispiel, das demonstriert, wie Vorlagen verwendet werden können, spart in aufwändigen Umgebungen zu speziellen Themen leichter Zeit.

Auch das Erstellen einer Kategorie:Vorlage in deinem Wiki, um deine Vorlagen zusammenzustellen, könnte, neben Links auf diese Seite, für Autoren nützlich sein, um ihnen ein produktiveres Arbeiten zu ermöglichen.

Kategorien innerhalb von Vorlagen einbinden

includeonly

Will man eine Kategorie einer Buchseite automatisch über eine Vorlage einfügen (beispielsweise über eine Buch-eigene Navigationsleiste), dann möchte man meist nicht, dass die Vorlage selbst in der Kategorie auftaucht. Dieses kann man mit "includeonly" unterbinden.

  • <includeonly>[[Kategorie: MeinBuch|{{PAGENAME}}]]</includeonly>

Je nach dem ob es für das Buchprojekt günstiger ist, kann man {{PAGENAME}} auch durch eine beliebige Zeichenkette ersetzen oder ergänzen, unter die entsprechende Buchseite abgespeichert wird. (Dieses empfiehlt sich bei einem Buchprojekt mit mehreren Bänden, oder bei größeren Kapiteln).

noinclude

Andererseits kann es möglich sein, dass man verschiedene Vorlagen einer Kategorie zuordnen möchte, jedoch verhindern will, dass auch alle Seiten, in die eine Vorlage eingefügt werden, ebenfalls unter die Kategorie fallen. Dazu bindet man die Kategorie innerhalb "noinclude" ein, also dort, wo man auch allgemeine Kommentare zum Gebrauch der Vorlage aufschreiben kann, die aber nicht mit in die Seiten kopiert werden.

  • <noinclude>[[Kategorie: MeinBuch/_Navigationsvorlage|{{PAGENAME}}]]</noinclude>
onlyinclude

Normalerweise wird das, was in einer Vorlage eingetragen wurde, beim Anschauen der Vorlage auch angezeigt. Mitunter kann es aber sinnvoll sein, dass man dieses unterbindet. Um nur ein Beispiel zu nennen: Wenn mit der Vorlage nur einem unvollständiger Teil einer Tabelle in eine bestehenden Tabellenrahmen eingefügt werden soll, dann könnte es bei dem Anzeigen dieses unvollständigen Tabellenteils zu Darstellungsfehlern kommen.

  • <onlyinclude> ... Inhalt ... </onlyinclude>

Vorlagen testen

Um Vorlagen zu testen, kannst du die dafür vorgesehene Vorlage:Spielwiesenvorlage benutzen. Bitte denke daran, bei längeren Tests {{Bitte nicht ändern}} einzufügen und nach dem Spielen wieder zu entfernen.


Emoticons

Es können auch Smileys genutzt werden

Vorlage:Smiley/doc


Sonstiges

Es gibt ebenfals die Möglichkeit über Vorlagen umfangreiche Parser Funktionen zu nutzen. Siehe dazu: http://www.mediawiki.org/wiki/Help:Extension:ParserFunctions/de

Wenn es darum geht, Tasten die gedrückt werden sollen, darzustellen kann die Vorlage Taste genutzt werden, zB so: {{Taste|Strg}}+{{Taste|X}} was dann Strg+X ergibt


Links