5.Formatierungsleitfaden

Wikka Formatierungsleitfaden

Bei dem hier dargestellten Wikka Formatierungsleitfaden handelt es sich um eine gekürzte inoffizielle Übersetzung des Wikka Formatting Guide. Die englische Originalversion der finden Sie auf der WikkaWiki-Homepage unter http://docs.wikkawiki.org/FormattingRules#hn_Wikka_Formatting_Guide.

Formatierung von Texten mit Zeichencodes

Um Texte in der Wissensdatenbank formatieren zu können, müssen Sie sich mit einigen Zeichencodes vertraut machen. Sofern Sie einen bestimmten Zeichencode verwenden, wird der Text automatisch in der Wiki formatiert. Die automatische Formatierung unterdrücken Sie, indem Sie den Text, der unformatiert bleiben soll, in doppelte Anführungzeichen setzen:

In diesem Fall werden die zweiten ** vom System ignoriert, d.h. nicht automatisch als Zeichencode für "fette Schrift" erkannt.
Ferner können Sie auch doppelte Anführungszeichen verwenden, um eine automatische Verlinkung von CamelCase-Worten zu vermeiden. Beispiel:

1. Textformatierung

2. Überschriften

Verwenden Sie sechs = (für die größtmögliche Überschrift) bzw. zwei = (für die kleinste Überschrift) auf beiden Seiten des Textes, der als Überschrift formatiert werden soll. Die nachfolgenden Beispiele zeigen die mögliche Abstufungsvarianten:

3. Horizontale Trennlinie

---

4. Erzwungener Zeilenumbruch

5. Listen und eingerückte Textpassagen

Sie können Textpassagen einrücken, indem Sie entweder das Zeichen ~ verwenden, die Tabulatortaste (kurz „Tab“) betätigen oder vier Leerzeichen setzen, die automatisch in einen Tab konvertiert werden.


Um eine Aufzählung oder geordnete Liste zu erstellen, verwenden Sie die nachfolgenden dargestellten Zeichencodes. Anstelle des Zeichens ~ können Sie auch mit vier Leerzeichen arbeiten.
Aufzählungen


Nummerierte Listen


Geordnete Listen mit großen Buchstaben


Geordnete Listen mit kleinen Buchstaben


Geordnete Listen mit römischen Ziffern


Geordnete Listen mit kleinen römischen Ziffern

6. Inline-Kommentare

Um einen Text als Inline-Kommentar zu formatieren, müssen Sie zuerst einen Zeileneinzug vornehmen (mit dem Symbol ~, einem Tab oder vier Leerzeichen) gefolgt von einem &.

7. Grafiken einfügen (Kurzanleitung)

Um Grafiken auf einer Wiki-Seite zu platzieren, müssen Sie den Befehl image verwenden.
Beispiel:

Die eingestellten Grafiken können mit Verlinkungen zu externen Seiten oder internen Wiki-Seiten versehen werden. Darüber hinaus besteht die Möglichkeit, die Größe und Position der Grafiken anzupassen.
Eine detaillierte Beschreibung erhalten Sie in dem Artikel "Hochladen von Grafiken und anderen Dokumenten in die Wissensdatenbank".

8. Verlinkungen in der Wissensdatenbank

Eine ausführliche Anleitung wie Sie Seiten in der Wissensdatenbank verbinden können und externe Links setzen, erhalten Sie hier.

9. Tabellen

Tabellen werden mit zwei senkrechten Strichen (||, engl. vertical bar oder Pipe) erstellt. Text, der sich zwischen den Pipes befindet, wird als Tabellentext erkannt und wiedergegeben. Um solche Pipes einzufügen, drücken Sie entweder die Strg+Alt-Tasten und dann das >-Symbol oder Sie halten die Alt-Taste gedrückt und geben 124 auf dem Nummernblock ein.
Beispiel:
||Cell 1||Cell 2||
Sie können Zellen als Überschriften formatieren, indem Sie ein Gleichheitszeichen zwischen den Pipes einfügen.

Cell 1

Cell 2

Beispiel:
|=|Header 1|=|Header 2||
||Cell 1||Cell 2||
Zeilen und Spalten der Tabelle können Sie mit in Klammern gesetzten

Header 1	Header 2
Cell 1	Cell 2

x: und y: nach den Pipes beeinflussen.
Beispiel:
|=| |=|(x:2)Spalten||
|=|(y:2) Zeilen||Cell 1||Cell 2||
||Cell 3||Cell 4||
Viele zusätzliche Tabellenfunktionen finden Sie im

	Spalten
Zeilen	Cell 1	Cell 2
	Cell 3	Cell 4

Wikka Table Markup Guide.

10. Farbiger Text

Ein Text kann nach folgendem Schema (Colored text - Funktion) farbig gestaltet werden:

Sie können auch den Hex-Wert der Farbe angeben:

Alternativ kann auch eine Schrift- und Hintergrundfarbe mit dem Befehlen "fg" bzw. "bg" nach folgenden Schema bestimmt werden (beide Parameter akzeptieren sowohl den Namen als auch den Hex-Wert der Farbe):


Eine umfangreiche Farbtabelle finden Sie unter http://www.farb-tabelle.de/en/table-of-color.htm.

11. Schwimmende Positionierung von Elementen (Floats)

Mithilfe der "Float-Eigenschaft" lassen sich Texte innerhalb einer Box darstellen und auf der linken oder rechten Seite eines Artikels positionieren. Die nachfolgende Darstellung zeigt das Prinzip:
Um eine links "schwimmende" Box zu erstellen, müssen jeweils zwei Kleiner-als-Zeichen (<) vor und hinter den Text geschrieben werden.
Beispiel:

Um eine rechts "schwimmende" Box zu erstellen, müssen jeweils zwei Größer-als-Zeichen (>) vor und hinter den Text geschrieben werden.
Beispiel:

Mit dem Zeichencode ::c:: wird der "Float" beendet.

12. Quelltextformatierung

Code-Blöcke lassen sich problemlos durch einen einfachen Zeichencode (zwei %-Zeichen vor und nach dem Text) in einer Wiki-Seite einbetten. Alles was innerhalb eines Code-Block geschrieben wird, wird unverändert angezeigt.
Beispiel:

Diese Funktion eignet sich insbesondere dafür, um Quelltextformatierungen zum Download bereit zu stellen. Da es sich um eine durchaus spezielle Funktion handelt, wird zur weiteren Information auf die englische Originalversion der WikkaWiki FormattingRules verwiesen.

Liste möglicher Codeformatierungen

Language	Formatter	Language	Formatter	Language	Formatter
Actionscript	actionscript	ABAP	abap	ADA	ada
Apache Log	apache	AppleScript	applescript	ASM	asm
ASP	asp	AutoIT	autoit	Bash	bash
BlitzBasic	blitzbasic	Basic4GL	basic4gl	bnf	bnf
C	c	C for Macs	c_mac	C#	csharp
C++	cpp	C++ (+QT)	cpp-qt	CAD DCL	caddcl
CadLisp	cadlisp	CFDG	cfdg	ColdFusion	cfm
CSS	css	D	d	Delphi	delphi
Diff-Output	diff	DIV	div	DOS	dos
Dot	dot	Eiffel	eiffel	Fortran	fortran
FreeBasic	freebasic	FOURJ's Genero 4GL	genero	GML	gml
Groovy	groovy	Haskell	haskell	HTML	html4strict
INI	ini	Inno Script	inno	Io	io
Java 5	java5	Java	java	Javascript	javascript
LaTeX	latex	Lisp	lisp	Lua	lua
Matlab	matlab	mIRC Scripting	mirc	Microchip Assembler	mpasm
Microsoft Registry	reg	Motorola 68k Assembler	m68k	MySQL	mysql
NSIS	nsis	Objective C	objc	OpenOffice BASIC	oobas
Objective Caml	ocaml	Objective Caml (brief)	ocaml-brief	Oracle 8	oracle8
Pascal	pascal	Per (FOURJ's Genero 4GL)	per	Perl	perl
PHP	php	PHP (brief)	php-brief	PL/SQL	plsql
Python	phyton	Q(uick)BASIC	qbasic	robots.txt	robots
Ruby on Rails	rails	Ruby	ruby	SAS	sas
Scheme	scheme	sdlBasic	sdlbasic	Smarty	smarty
SQL	sql	TCL/iTCL	tcl	T-SQL	tsql
Text	text	thinBasic	thinbasic	Unoidl	idl
VB.NET	vbnet	VHDL	vhdl	Visual BASIC	vb
Visual Fox Pro	visualfoxpro	WinBatch	winbatch	XML	xml
X++	xpp	ZiLOG Z80 Assembler	z80

13. Mindmaps

Die WikkaWiki-Software unterstützt die Darstellung von Mindmaps. Es gibt zwei Möglichkeiten, um ein Mindmap in der Wissensdatenbank darzustellen:
1. Möglichkeit: Laden Sie eine FreeMind-Datei auf einem Webserver und kopieren dann den Link in Ihren Artikel auf der Wissensdatenbank. Einer besonderen Formatierung bedarf es hier nicht.
2. Möglichkeit: Fügen Sie die FreeMind-Daten direkt in die Seite der Wissensdatenbank ein:

14. HTML einbetten

Informationen, wie Sie die Hypertext Markup Language (kurz HTML; zu deutsch Hypertext-Auszeichnungssprache) in der Wissensdatenbank verwenden bzw. einbinden können, entnehmen Sie bitte der englischen Originalversion der WikkaWikki FormattingRules oder der Wikka Documentation: UsingHTML.

HS Schmalkalden Wiki Changes 2017

Es sind folgende Features neu hinzugekommen:

1.) Formeleditor zur Darstellung komplexer mathematischer Ausdrücke

• display engine: Math Jax

• Doku zur Formelsyntax: http://www.onemathematicalcat.org/MathJaxDocumentation/TeXSyntax.htm

• Beispiele:

2.) Vergrößerungsfunktion für Bilder in Artikeln

• Bild wird wie gewohnt im Editor eingefügt, die Bildbreite kann vom Redakteur frei definiert werden (width="...")

• Icon (Lupe) wird automatisch auf dem Bild angezeigt

• Beispiele:

3.) Navigation optimieren (Baumstruktur linke Spalte)

• lange Menüpunkte sind jetzt lesbar (Zeilenumbrüche zugelassen)

• weitere Ebene möglich (Navigationstiefe erweitert)

• Beispiel: hier klicken

4.) Darstellung von Fußnoten in Artikeln

• Fußnoten können an beliebigen Stellen im Text eingefügt werden

• im Text vorhandene Fußnoten werden mittels hochgestellter Nummer im Text repräsentiert und am Ende des Artikels aufsteigend nummeriert dargestellt

• mit Klick auf die Fußnote springt der Nutzer ans Seitenende

• im Editor sind innerhalb der Fußnote keine weiteren Tags ausser Hyperlinks erlaubt

• das neue Schaltfläche "Fußnote" ist angelegt und im Markdown Editor auswählbar

• Beispiel: Lorem ipsum

  fn_start

  Ich bin eine nicht verlinkte Fussnote

  fn_stop

  dolor sit amet

  fn_start

  Ich bin eine extern verlinkte Fussnote [http://Link]

  fn_stop

  , consectetuer adipiscing elit.

  fn_start

  Ich bin eine intern verlinkte Fussnote [CategoryArbRLiteratur]

  fn_stop

  Aenean commodo ligula eget dolor.

5.) Suchvorschläge

• Das Suchfeld bietet anhand der vom Nutzer eingegeben Buchstaben Vorschläge an.

• Die möglichen Vorschläge speisen sich aus einer Datei, die manuell gepflegt werden muss. Die Wortliste befindet sich unter: templates/fhs/js/search-suggestions-words.js

• Hinweis: die Vorschlagsfunktion kann konfiguriert werden, z.B.

• können Vorschläge erst gezeigt werden, wenn mehrere Buchstaben eigegeben werden

• kann die Anzahl der angezeigten Vorschläge begrenzt werden (Liste wird sonst schnell zu lang)

• Beispiel: Buchstaben "a" in die Suche eingeben

---

CategoryWiki;CategoryWiWiService;CategoryAnwenderservice