Version [14418]
Dies ist eine alte Version von FormattingRules erstellt von ChristianeUri am 2012-03-05 01:19:51.
Wikka Formatierungsleitfaden
Bei dem hier dargestellten Wikka Formatierungsleitfaden handelt es sich um eine 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.
Allgemeine Hinweise
Wenn Sie ein Markup (Zeichencode) verwenden, der nicht in diesem Leitfaden abgebildet ist, wird dieser auch nicht offiziell unterstützt. Seien Sie vorsichtig bei der Verwendung von nicht offiziellen Markups, da diese zwar unter Umständen funktionieren, jedoch nach einem Versions-Update fehlerhaft sein können.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:
**zwei fett geschriebene ""**"" Sterne**
zwei fett geschriebene ** Sterne
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:
Dieses ""WikiWord"" wird nicht als Link erkannt.
Dieses WikiWord wird nicht als Link erkannt.
1. Text Formatting
**Ich bin ein fett geschriebener Text!**
Ich bin ein fett geschriebener Text!
//Ich bin ein kursiv geschriebner Text!//
Ich bin ein kursiv geschriebener Text!
__Und ich bin ein unterstrichener Text!__
Und ich bin ein unterstrichener Text!
##monospace text##
monospace text
''Highlighttext'' (mit zwei einfachen Anführungszeichen)
Highlighttext
++Durchgestrichener Text++
Durchgestrichener Text
££Neuer Text eingefügt££
Neuer Text eingefügt
¥¥Text gelöscht¥¥
Drücken einer #%beliebigen Taste#%
Drücken einer beliebigen Taste
@@Text zentrieren@@
Text zentrieren
/* Elided content (eliminates trailing ws) */
<--there was a comment here followed by ws in the markup
Elides (hides) content from displaying. Eliminates trailing whitespace so there are no unsightly gaps in output. Useful for commenting Wikka markup.
`` Elided content (preserves trailing ws) ``
Elides (hides) content from displaying. Preserves trailing whitespace.
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
---- (vier Bindestriche)
4. Erzwungener Zeilenumbruch
--- (drei Bindestriche)
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.
~Dieser Text ist eingerückt.
~~Dieser Text ist doppelt eingerückt.
Dieser Text ist auch eingerückt.
Dieser Text ist eingerückt.
Dieser Text ist doppelt eingerückt.
Dieser Text ist auch eingerückt.
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
~- Aufzählung eins
~- Aufzählung zwei
- Aufzählung eins
- Aufzählung zwei
Nummerierte Listen
~1) Zeile eins
~1) Zeile zwei
- Zeile eins
- Zeile zwei
Geordnete Listen mit großen Buchstaben
~A) Zeile eins
~A) Zeile zwei
- Zeile eins
- Zeile zwei
Geordnete Listen mit kleinen Buchstaben
~a) Zeile eins
~a) Zeile zwei
- Zeile eins
- Zeile zwei
Geordnete Listen mit römischen Ziffern
~I) Zeile eins
~I) Zeile zwei
- Zeile eins
- Zeile zwei
Geordnete Listen mit kleinen römischen Ziffern
~i) Zeile eins
~i) Zeile zwei
- Zeile eins
- Zeile zwei
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 &.
~& Kommentar
~~& Anmerkung zum Kommentar
~~~& Äußerung zur Anmerkung des Kommentars
- Kommentar
- Anmerkung zum Kommentar
- Äußerung zur Anmerkung des Kommentars
7. Bilder einfügen
To place images on a Wiki page, you can use the image action.
{{image class="center" alt="DVD logo" title="An Image Link" url="images/dvdvideo.gif" link="RecentChanges"}}
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:
- type a WikiName (works only for page names with no whitespace):
FormattingRules
FormattingRules
- 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|沙箱]]
沙箱
- add an image with a link (see instructions above).
To link to external pages, you can do any of the following:
- type a URL inside the page:
http://blog.wikkawiki.org
http://blog.wikkawiki.org
- 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
- add an image with a link (see instructions above);
- 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
Colored text can be created using the color action:
{{color c="blue" text="This is a test."}}
This is a test.
You can also use hex values:
{{color hex="#DD0000" text="This is another test."}}
This is another test.
Alternatively, you can specify a foreground and background color using the fg and bg parameters (they accept both named and hex values):
{{color fg="#FF0000" bg="#000000" text="This is colored text on colored background"}}
This is colored text on colored background
{{color fg="yellow" bg="black" text="This is colored text on colored background"}}
This is colored text on colored background
11. Floats
To create a left floated box, use two < characters before and after the block.
Example:
<<Some text in a left-floated box hanging around<< Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler.
Some text in a left-floated box hanging around
Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler.Example:
>>Some text in a right-floated box hanging around>> Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler.
Some text in a right-floated box hanging around
Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler.12. Code formatters
You can easily embed code blocks in a wiki page using a simple markup. Anything within a code block is displayed literally.
To create a generic code block you can use the following markup:
%% This is a code block %%.
This is a code block
To create a code block with syntax highlighting, you need to specify a code formatter (see below for a list of available code formatters).
%%(php)
<?php
echo "Hello, World!";
?>
%%
<?php
echo "Hello, World!";
?>
%%
<?php
echo "Hello, World!";
?>
echo "Hello, World!";
?>
You can also specify an optional starting line number.
%%(php;15)
<?php
echo "Hello, World!";
?>
%%
<?php
echo "Hello, World!";
?>
%%
- <?php
- echo "Hello, World!";
- ?>
If you specify a filename, this will be used for downloading the code.
%%(php;15;test.php)
<?php
echo "Hello, World!";
?>
%%
<?php
echo "Hello, World!";
?>
%%
test.php (line 15)
- <?php
- echo "Hello, World!";
- ?>
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.
""[html code]""
""y = x<sup>n+1</sup>""
y = xn+1
""<acronym title="Cascade Style Sheet">CSS</acronym>""
CSS
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