HowTo - Wiki Formatierungen: Unterschied zwischen den Versionen

Aus Streamboard Wiki
Zur Navigation springen Zur Suche springen
Zeile 97: Zeile 97:
<tt><nowiki>====== Überschrift Ebene 6 ======</nowiki></tt>
<tt><nowiki>====== Überschrift Ebene 6 ======</nowiki></tt>
| Die '''Ebene 1''' ist für den Seitentitel reserviert und innerhalb von Artikeln '''unerwünscht'''.
| Die '''Ebene 1''' ist für den Seitentitel reserviert und innerhalb von Artikeln '''unerwünscht'''.
|-
|
<syntaxhighlight lang="php">
<?php
# ich bin ein Kommentar
echo 'ich bin PHP Code';
?>
</syntaxhighlight>
|
<tt>
<nowiki><syntaxhighlight lang="php"></nowiki><br />
<nowiki><?php</nowiki><br />
<nowiki># ich bin ein Kommentar</nowiki><br />
<nowiki>echo 'ich bin PHP Code';</nowiki><br />
<nowiki>?></nowiki><br />
<nowiki></syntaxhighlight></nowiki><br />
</tt>
| Syntaxhervorhebung in PHP
|-
|
<syntaxhighlight lang="bash">
# ich bin ein Kommentar
echo 'ich bin Bash Code'
</syntaxhighlight>
|
<tt>
<nowiki><syntaxhighlight lang="bash"></nowiki><br />
<nowiki># ich bin ein Kommentar</nowiki><br />
<nowiki>echo 'ich bin Bash Code'</nowiki><br />
<nowiki></syntaxhighlight></nowiki><br />
</tt>
| Syntaxhervorhebung in Bash
|}
|}



Version vom 30. Jänner 2011, 17:16 Uhr

Wiki bearbeiten Wiki editing Wiki modifier

Teufelchen und Engelchen

Wichtig!

  • 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! (Siehe nachfolgende Tabelle)


Hinweise:

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


Schlecht! - Bad! - Mauvais! Gut! - Good! - Bon! Kommentar - Comment - Commentaire
= Ü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...

HowTo - 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
Überschriften == Überschrift Ebene 2 ==

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

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

<syntaxhighlight lang="php"> <?php

  1. ich bin ein Kommentar

echo 'ich bin PHP Code'; ?> </syntaxhighlight>

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

Syntaxhervorhebung in PHP

<syntaxhighlight lang="bash">

  1. ich bin ein Kommentar

echo 'ich bin Bash Code' </syntaxhighlight>

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

Syntaxhervorhebung in Bash

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


Kategorien

Jeder Artikel sollte kategorisiert werden und somit z.B. wie folgt beginnen:

[[Kategorie:OSCam]]

Die "Haupt"-Artikel/-Seiten dürfen auch mehreren Kategorien zugeordnet werden, z.B.:

[[Kategorie:HowTo]]
[[Kategorie:Cardserver]]
[[Kategorie:OSCam]]

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


Farbige Texte

Ergebnis Code
ÄNDERUNG - CHANGE - MODIFICATIONS <span style="background-color:Blue;color:White;padding:0 5px;">ÄNDERUNG - CHANGE - MODIFICATIONS</span>
NEU - NEW - NOUVEAU <span style="background-color:Green;color:White;padding:0 5px;">NEU - NEW - NOUVEAU</span>
HINWEIS - TIP - CONSEIL <span style="background-color:Yellow;padding:0 5px;">HINWEIS - TIP - CONSEIL</span>
VERALTET - OBSOLETE - OBSOLÈTE <span style="background-color:Red;color:White;padding:0 5px;">VERALTET - OBSOLETE - OBSOLÈTE</span>


Farbige Hinweise (Vorlagen)

Ergebnis Code
Parameter ist optional
{{Optional}}
Parameter wird benötigt
{{Mandatory}}
Parameter wird abhängig vom Setup/Programmversion benötigt.
{{Depends}}
parameter is required
{{required}}
parameter is optional
{{Optional/en}}
parameter depends on setup/programversion
{{Depends/en}}

Status-Meldungen

Ergebnis Code
Hilfe: [[Datei:HelpS.png|text-bottom]] '''Hilfe:''' oder "Help" für englisch, oder "Aide" für französisch
Info: [[Datei:MessageS.png|text-bottom]] '''Info:'''
Achtung: [[Datei:WarningS.png|text-bottom]] '''Achtung:''' oder "Attention" für englisch und französisch
Fehler: [[Datei:ErrorS.png|text-bottom]] '''Fehler:''' oder "Error" für englisch, oder "Erreur" für französisch
Baustelle [[Datei:UnderConstruction.jpg|text-bottom]] '''Baustelle''' oder "Under Construction" für englisch, oder "En cours d'élaboration" für französisch
Unsicher [[Datei:Unsicher.gif|text-bottom]] '''Unsicher''' oder "Unsure" für englisch, oder "incertain" für französisch
Nicht mehr verwendet! [[Datei:Obsolet.jpg|text-bottom]] '''Nicht mehr verwendet''' oder "Obsolet!" für englisch, oder "Obsolète" für französisch

Spezielle Vereinbarungen für den Artikel "Vom Auschecken bis zum Image"

Allgemeines zum System

  • Linux USER ist sb
  • Linux HOSTNAME ist build

Vereinbarungen zum Compilieren

  • build-prefix ist --prefix=/dbox2
  • cvsdir ist --with-cvsdir=/tuxbox-cvs
  • maintainer-mode ist --enable-maintainer-mode
  • targetrules ist --with-targetruleset=flash