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. Bilder einfügen

To place images on a Wiki page, you can use the image action.



Image links can be external or internal Wiki links. You don't need to enter a link at all, and in that case just an image will be inserted. You can use the optional classes left and right to float images left and right. You don't need to use all those attributes, only url is required while alt is recommended for accessibility.

8. Links

To create a link to a wiki page you can use any of the following options:

1. type a WikiName (works only for page names with no whitespace):
   
   FormattingRules
   FormattingRules
   
   

1. add a forced link surrounding the page name by [[ and ]] (everything after the | will be shown as description):
   
   [[SandBox|Test your formatting skills]]
   Test your formatting skills
   
   [[SandBox|沙箱]]
   沙箱
   
   

1. add an image with a link (see instructions above).

To link to external pages, you can do any of the following:

1. type a URL inside the page:
   
   http://blog.wikkawiki.org
   http://blog.wikkawiki.org
   
   

1. add a forced link surrounding the URL by [[ and ]] (everything after the | will be shown as description):
   
   [[http://docs.wikkawiki.org|Wikka documentation]]
   Wikka documentation
   
   [[community@wikkawiki.org|Wikka community list]]
   Wikka community list
   
   

1. add an image with a link (see instructions above);

1. add an interwiki link (browse the list of available interwiki tags):
   
   WikiPedia:WikkaWiki
   WikiPedia:WikkaWiki
   
   Google:CSS
   Google:CSS
   
   Thesaurus:Happy
   Thesaurus:Happy
   
   

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||

Cell 1

Cell 2

Sie können Zellen als Überschriften formatieren, indem Sie ein Gleichheitszeichen zwischen den Pipes einfügen.

Beispiel:

|=|Header 1|=|Header 2||
||Cell 1||Cell 2||

Header 1	Header 2
Cell 1	Cell 2

Zeilen und Spalten der Tabelle können Sie mit in Klammern gesetzten x: und y: nach den Pipes beeinflussen.

Beispiel:

|=| |=|(x:2)Spalten||
|=|(y:2) Zeilen||Cell 1||Cell 2||
||Cell 3||Cell 4||

	Spalten
Zeilen	Cell 1	Cell 2
	Cell 3	Cell 4

Viele zusätzliche Tabellenfunktionen finden Sie im 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 Schmema bestimmt werden (beide Parameter akzeptireren sowohl den Namen als auch den Hex-Wert der Farbe):

11. Schwimmende Positionierung von Elementen (Floats)

Mit Hilfe 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 für die weitere Information auf die englische Originalversion der 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

Wikka has native support for mindmaps. There are two options for embedding a mindmap in a wiki page.

Option 1: Upload a FreeMind file to a webserver, and then place a link to it on a wikka page:
http://yourdomain.com/freemind/freemind.mm
No special formatting is necessary.

Option 2: Paste the FreeMind data directly into a wikka page:

• Open a FreeMind file with a text editor.

• Select all, and copy the data.

• Browse to your Wikka site and paste the Freemind data into a page.

14. Embedded HTML

You can easily paste HTML in a wiki page by wrapping it into two sets of doublequotes.





By default, some HTML tags are removed by the SafeHTML parser to protect against potentially dangerous code. The list of tags that are stripped can be found on the Wikka:SafeHTML page.

It is possible to allow all HTML tags to be used, see Wikka:UsingHTML for more information.

---

CategoryWiki