Proposal for Documentation of Wiki Syntax#

Incomplete, errors, not easy to edit, German language - but i think the concept is clear.

Hier werden die Befehle gezeigt, die man beim Schreiben einer Intranet-Seite verwenden kann.
In der grauen Box steht der Text, so wie man ihn eingeben sollte.
Direkt darunter kann man das Ergebnis sehen.


----------------------------------------------------------------- ----------------------------------------------------------------- -----------------------------------------------------------------

-----------------------------------------------------------------

normal, __fett__, ''kursiv'', {{feste Zeichenbreite (Monospaced)}}
normal, fett, kursiv, feste Zeichenbreite (Monospaced)

-----------------------------------------------------------------

Die Hauptüberschrift (drei vorangestellte Ausrufezeichen) sollte immer am Seitenanfang stehen.
!!!Hauptüberschrift
!!Unterüberschrift
!Unter-Unterüberschrift

Hauptüberschrift#

Unterüberschrift#

Unter-Unterüberschrift#

-----------------------------------------------------------------

\

-----------------------------------------------------------------

Den Backslash (\) kann man eingeben, indem man bei gedrückter AltGr-Taste die ß-Taste drückt.
Zei-\\len-\\um-\\bruch

Aufeinanderfolgende
Zeilen
werden
zusammengefasst.

Eine Leerzeile

startet einen

neuen Absatz.
Zei-
len-
um-
bruch

Aufeinanderfolgende Zeilen werden zusammengefasst.

Eine Leerzeile

startet einen

neuen Absatz.

-----------------------------------------------------------------

-----------------------------------------------------------------

Bild [myProjectLogo.png] ist inline eingebunden!
Bild myProjectLogo.png ist inline eingebunden!
Bild\\[myProjectLogo.png]\\\ ist eingebunden!
Bild
myProjectLogo.png
ist eingebunden!

Das Image Plugin bietet viele Möglichkeiten:

[{Image src='myProjectLogo.png' caption='Mein Logo' style='color:green;'}]
Mein Logo

----------------------------------------------------------------- ----------------------------------------------------------------- -----------------------------------------------------------------

-----------------------------------------------------------------
||Überschrift1||Überschrift2
|a|b\\zweite Zeile
|c|d
Überschrift1Überschrift2
ab
zweite Zeile
cd
-----------------------------------------------------------------
%%sortable
||name||funker
|meyer|21
|müller|30
|huber|12
|wunner|40
%%
namefunker
meyer21
müller30
huber12
wunner40
----------------------------------------------------------------- ----------------------------------------------------------------- -----------------------------------------------------------------
-----------------------------------------------------------------
*Eins\\neue Zeile
*Zwei
**Unterpunkt Eins
**Unterpunkt Zwei
  • Eins
    neue Zeile
  • Zwei
    • Unterpunkt Eins
    • Unterpunkt Zwei
-----------------------------------------------------------------
#Eins\\neue Zeile
#Zwei
##Unterpunkt Eins
##Unterpunkt Zwei
  1. Eins
    neue Zeile
  2. Zwei
    1. Unterpunkt Eins
    2. Unterpunkt Zwei
-----------------------------------------------------------------
%%collapse
* Europe
** France
*** Paris
*** Nice
** South-Africa
** Belgium 
### Brussel (collapsed by default)
### Peulis
* Australia
**
*** Perth
* Australia
*** Sydney
**** Kangeroo
**** Huppeldepup
%%
  • Europe
    • France
      • Paris
      • Nice
    • South-Africa
    • Belgium
      1. Brussel (collapsed by default)
      2. Peulis
  • Australia
      • Perth
  • Australia
      • Sydney
        • Kangeroo
        • Huppeldepup
-----------------------------------------------------------------
;Ausdruck1:Definition1
;Ausdruck2:Definition2
Ausdruck1
Definition1
Ausdruck2
Definition2
-----------------------------------------------------------------
;:''Kommentar (eingerückt)''
Kommentar (eingerückt)
-----------------------------------------------------------------
Wir verweisen auf die Fußnoten[1] und [2].\\
[#1] Hier steht der Text der Fußnote 1.\\
[#2] Hier steht der Text der Fußnote 2.\\
Wir verweisen auf die Fußnoten[1] und [2].
[#1] Hier steht der Text der Fußnote 1.
[#2] Hier steht der Text der Fußnote 2.

----------------------------------------------------------------- ----------------------------------------------------------------- -----------------------------------------------------------------
-----------------------------------------------------------------
Achtung: in Wirklichkeit werden drei geschweifte Klammern verwendet, und nicht {({ bzw. })}
{({
Code-Block
Zeile 2
Zeile 3
})}
Code-Block
Zeile 2
Zeile 3
-----------------------------------------------------------------
%%wichtig
Das ist ganz wichtig!
%%
Das ist ganz wichtig!
(div.wichtig wird in jspwiki.css definiert)

-----------------------------------------------------------------

Mein Kommentar!
%%commentbox
Mein Kommentar!
%%

-----------------------------------------------------------------

%%collapsebox
!Die Überschrift
Hier steht der Inhalt des Kastens
*Punkt 1
*Punkt 2
%%

Die Überschrift#

Hier steht der Inhalt des Kastens
  • Punkt 1
  • Punkt 2

-----------------------------------------------------------------

%%tabbedSection
%%tab-ErsteKarte
Text auf der ersten Karte.
%%
%%tab-ZweiteKarte
Text auf der zweiten Karte.
%%
%%
Text auf der ersten Karte.
Text auf der zweiten Karte.

----------------------------------------------------------------- ----------------------------------------------------------------- -----------------------------------------------------------------

-----------------------------------------------------------------
[{org.jcpsim.plugin.Math align='center' fontsize='16'

2\sum_{i=1}^n a_i \;\int_a^b f_i(x)g_i(x)\,dx
}]
Plugin insertion failed: Could not find plugin org.jcpsim.plugin.MathPlugin insertion failed: Could not find plugin org.jcpsim.plugin.Math

Name Description Necessity
body or latex='..' mathematical term in latex syntax required
align center, left, right optional (none)
fontsize size of the base font optional (16?)
maxwidth maximum size of the produced gif (if it is smaller, the size will be adjusted) optional (600?)
maxheight maximum size of the produced gif (if it is smaller, the size will be adjusted) optional (200?)
bgcolor color of the background optional (white)
color color of the text optional (black)

vgl. Math Plugin

-----------------------------------------------------------------

[{TableOfContents title='Demo-Inhaltsverzeichnis'}]

-----------------------------------------------------------------

[{CurrentTime format='EEE, dd.MM.yyyy, HH:mm\'h\''}]
Plugin insertion failed: Could not find plugin CurrentTimePlugin insertion failed: Could not find plugin CurrentTime

-----------------------------------------------------------------

[{INSERT com.ecyrd.jspwiki.plugin.ReferringPages WHERE max=10, maxwidth=20}]
Plugin insertion failed: Could not find plugin com.ecyrd.jspwiki.plugin.ReferringPagesPlugin insertion failed: Could not find plugin com.ecyrd.jspwiki.plugin.ReferringPages

-----------------------------------------------------------------

Bei diesem Beispiel wird der Inhalt der Seite ListeBefehleSeiteZumEinfügen an der aktuellen Stelle wird eingefügt.

[{InsertPage page=ListeBefehleSeiteZumEinfügen}]
There is no page called 'ListeBefehleSeiteZumEinfügen'. Would you like to create it?

----------------------------------------------------------------- ----------------------------------------------------------------- -----------------------------------------------------------------

-----------------------------------------------------------------
[Eintrag für 'Blood' in der Wikipedia|Wikipedia:Blood]\\
[Suche 'Blood' in Google|Google:Blood]\\
[Editiere StartSeite|Edit:StartSeite]\\
[JSPWiki|JSPWiki:Main]\\
[JSPWiki (Doc)|Doc:Main]\\
Eintrag für 'Blood' in der Wikipedia
Suche 'Blood' in Google
Editiere StartSeite
JSPWiki
JSPWiki (Doc)
----------------------------------------------------------------- -----------------------------------------------------------------
%%(text-align:center)
Dieser Text ist zentriert!
%%
Dieser Text ist zentriert!
Dieses Wort sollte %%(color:red)rot%% sein.
Dieses Wort sollte rot sein.
|############################# |############################# |############################# 
|%%(text-align:left)links%% |%%(text-align:center)zentriert%% |%%(text-align:right)rechts%%
############################# ############################# #############################
links zentriert rechts
%%( display:none )
Dieser Text ist auskommentiert.
%%
Dieser Text ist auskommentiert.

-----------------------------------------------------------------

%%wichtig
Das ist wichtig!
%%
Das ist wichtig!
(div.wichtig wird in jspwiki.css definiert)

-----------------------------------------------------------------

|Sie lesen gerade folgende Seite|[{$pagename}]
|Wiki läuft seit                |[{$uptime}]
|Seitenzahl                     |[{$totalpages}]
|Benutzername                   |[{$username}]
|Login Status                   |[{$loginstatus}]
Sie lesen gerade folgende SeiteProposalWikiSyntax
Wiki läuft seit 1d, 0h 53m 46s
Seitenzahl 269
Benutzername 38.107.179.239
Login Status anonymous
[{SET myvar2='{$pagename}'}] myvar2 hat den Wert: [{$myvar2}]
myvar2 hat den Wert: ProposalWikiSyntax

-- Frank_Fischer


Comments#

Nice idea, but we do also need a simpler version for that for devices which do not have full JS/CSS support, such as mobile devices. It's also way faster to scan through a list than it is to hunt-n-click on tabs "where was that danged italic thingy again, aaargh!".

But using tabs on the pages is certainly a very, very good idea for a lot of uses. Let's just not overdo them :)

-- JanneJalkanen

Add new attachment

In order to upload a new attachment to this page, please use the following box to find the file, then click on “Upload”.
« This page (revision-36) was last changed on 16-Mar-2008 10:58 by JanneJalkanen  
G’day (anonymous guest) My Prefs
This is the left menu footer
JSPWiki v2.8.3-svn-4