| |
read source history
Syntax
This is the WeakWiki markup syntax spec. It is rather lengthly. For a more compact view try the quick reference.
The WeakWiki markup is based on the Creole 1.0 standard and extended with some extra tags.
Document Control Markup
Markup tags for document control.
Document Access Permissions
WeakWiki allows to specify access permissions for each wiki page. These may be set for each user type separately.
A permission string must be formatted: usertype = permission;
Values allowed for usertype:
unknown | unknow user, not logged in |
reader | user with reader permission level |
editor | user with editor permission level |
admin | user with administrative (superuser) permission level |
Values allowed for permission are combinations of:
0 | no permission | |
r | read permissions | |
w | write (edit) permission | |
d | delete permission | |
s | view source permission | |
h | view history permission | |
a | administrative permission | (ignored for wiki pages) |
See the permissions page for details.
Markup tags:
<<@lock: permissions>>
<<@perm: permissions>>
|
Remarks:
Administrator level (admin) permissions for a wiki page will be ignored.
<<@perm>> is alternate syntax.
|
Creole Implementation:
Specific to WeakWiki.
|
Document Relay
The relay tag allows to specify a page to be shown instead of the page called.
Markup tags:
=>> title
<<@relay: title>>
|
Remarks:
WeakWiki will always show the page relayed to. Thus it is no good plan to have content on such a page other than the relay link.
You can deactivate the automatic relay option in preferences to access relay pages.
<<@relay>> is alternate syntax.
|
Creole Implementation:
Specific to WeakWiki.
|
Suppress Pre-Parsing
Suppressing pre-parsing forces WeakWiki to always parse a page dynamically when pre-parsing is active.
Markup tags:
<<@dyn>>
<<@dynamic>>
|
Remarks:
<<@dynamic>> is alternate syntax.
|
Creole Implementation:
Specific to WeakWiki.
|
Comments
Comments (remarks) in wiki pages will be completely ignored.
Markup tags:
///*
...
*///
<<@rem>>
...
<<@/rem>>
|
Remarks:
<<@rem>>, <<@/rem>> is alternate syntax.
|
Creole Implementation:
Specific to WeakWiki.
|
Include Stylesheet
This tag can be used to include custom stylesheets.
Markup tags:
++CSS(path)
<<@css>>path<<@/css>>
|
Remarks:
<<@css>>, <<@/css>> is alternate syntax.
|
Creole Implementation:
Specific to WeakWiki.
|
Document Structure Markup
Markup tags for structureing a document.
Headings
Marks a paragraph heading.
Markup tags:
= text =
== text ==
=== text ===
==== text ====
===== text =====
====== text ======
|
HTML representation:
<h1>...</h1>
<h2>...</h2>
<h3>...</h3>
<h4>...</h4>
<h5>...</h5>
<h6>...</h6>
|
Remarks:
Only whitespaces are allowed before and after the heading tags.
Start and end tag must each contain a blank after and respectively before the equal signs.
|
Creole Implementation:
Complient with Creole 1.0.
The Creole spec does not require the tag to be closed correctly. This behavior is supported by WeakWiki but disencouraged.
|
Table of Contents
Shows a table of Contents.
Markup tags:
<<@toc>>
<<@toc|title>>
|
Creole Implementation:
This is a WeakWiki generic tag.
|
Horizontal Rule
Draws a horizontal rule.
HTML representation:
<hr/>
|
Paragraphs
With X_AUTO_LINEBREAKS is set to true, paragraphs will not be automatically generated. Instead, line breaks will occure in the parsed wiki page where they occur in source.
Paragraphs can be forced using the <<@p>>...<<@/p>> tags.
Markup tags:
<<@p>>text<<@/p>>
|
HTML representation:
<p>text</p>
|
Example:
<<@p>>text<<@/p>>
|
Creole Implementation:
When X_AUTO_LINEBREAKS is set to false, paragraphs will be automatically created. An empty line starts a new paragraph.
This behavior is fully complient with Creole 1.0.
<<@p>>... <<@/p>> is specific to WeakWiki.
|
Line Breaks
If the option X_AUTO_LINEBREAKS is set to true, WeakWiki will generate line breaks as found in source. Otherwise, #paragraphs will be used.
The \\ tag can always be used to force a line break.
HTML representation:
text<br/>
|
Creole Implementation:
Complient with Creole 1.0 with X_AUTO_LINEBREAKS set to false.
|
Text Decoration Markup
Markup tags for formatting text.
Bold
Makes a text area bold.
HTML representation:
<strong>text</strong>
|
Italics
Makes a text area italic.
HTML representation:
<em>text</em>
|
Underline
Makes a text area underlined.
HTML representation:
<u>text</u>
|
Monospace
Makes a text area monospaced.
HTML representation:
<tt>text</tt>
|
Superscript
Makes a text area superscript.
HTML representation:
<sup>text</sup>
|
Subscript
Makes a text area subscript.
HTML representation:
<sub>text</sub>
|
Strikethrough
Makes a text area striked through.
HTML representation:
<strike>text</strike>
|
Area Format Markup
Markup tags formatting areas of text.
Indented Areas
These tags allow to define indented areas.
Markup tags:
-->
...
<--
<<@indent>>
...
<<@/indent>>
|
HTML representation:
<div class="indented">
...
</div>
|
Remarks:
<<@indent>>, <<@/indent>> is alternate syntax.
|
Creole Implementation:
Specific to WeakWiki.
|
Right Aligned Areas
These tags allow to define right aligned areas.
Markup tags:
>>>
...
<<<
<<@right>>
...
<<@/right>>
|
HTML representation:
<div class="ralign">
...
</div>
|
Remarks:
<<@right>>, <<@/right>> is alternate syntax.
|
Creole Implementation:
Specific to WeakWiki.
|
Left Aligned Areas
These tags allow to define left aligned areas.
Markup tags:
<<@left>>
...
<<@/left>>
|
HTML representation:
<div class="lalign">
...
</div>
|
Example:
<<@left>>
text
<<@/left>>
|
Creole Implementation:
Specific to WeakWiki.
|
Centered Areas
These tags allow to define centered areas.
Markup tags:
<<@center>>
...
<<@/center>>
|
HTML representation:
<div class="calign">
...
</div>
|
Example:
<<@center>>
text
<<@/center>>
|
Creole Implementation:
Specific to WeakWiki.
|
Justified Areas
These tags allow to define justified areas.
Markup tags:
<<@justify>>
...
<<@/justify>>
|
HTML representation:
<div class="jalign">
...
</div>
|
Example:
<<@justify>>
text
<<@/justify>>
|
Creole Implementation:
Specific to WeakWiki.
|
Format Classes
WeakWiki allows to define the CSS class for a text area.
Markup tags:
++(class)> ... <++
<<@f: class>> ... <<@/f>>
|
HTML representation:
<span class="class">...</span>
|
Remarks:
<<@f>>, <<@/f>> is alternate syntax.
|
Link Markup
Markup tags for hyperlinks.
Raw Links
Raw links will be automatically generated for URIs identified by the parser.
HTML representation:
<a href="http://weakwiki.robnet.wmweb.at/">http://weakwiki.robnet.wmweb.at/</a>
|
Intra-Wiki Links
Intra-wiki links link to a wiki page. An intra-wiki link only require the title of the target wiki page. A link text may be provided additionally.
Markup tags:
[[target]]
[[target|text]]
|
HTML representation:
<a href="./wiki.php?title=target">target</a>
<a href="./wiki.php?title=target">text</a>
|
Intra-Page Links
Intra-page links link to an anchor within the same wiki page. They will be made using the #-sign which is pretty intuitive.
Markup tags:
[[#target]]
[[#target|text]]
|
HTML representation:
<a href="#target">target</a>
<a href="#target">text</a>
|
External Links
External links need a target URI. A link text may be provided additionally.
Markup tags:
[[target]]
[[target|text]]
|
HTML representation:
<a href="target">target</a>
<a href="target">text</a>
|
Special Links
Special links are used to refer to WeakWiki functionality from wiki pages. There are some built-in special links, many modules also use special links.
A link text may be provided additionally.
Markup tags:
[[@function]]
[[@function|text]]
|
HTML representation:
<a href="function URL">function</a>
<a href="function URL">text</a>
|
Creole Implementation:
Specific to WeakWiki.
|
Anchors
Anchors define linking points within a document.
WeakWiki will automatically create anchors for each heading by its name. You may also add anchors using the anchor tag.
Markup tags:
<<#name>>
<<@#:name>>
|
HTML representation:
<a name="name"/>
|
Remarks:
<<@#:>> is alternate syntax.
|
Creole Implementation:
Specific to WeakWiki.
|
Image Markup
Markup tag to embed images in wiki pages. Alternative image text may be provided additionally.
Markup tags:
{{image}}
{{image|text}}
|
HTML representation:
<img src="image">
<img src="image" alt="text"/>
|
List Markup
Markup tags for lists.
Unordered Lists
Unordered lists will be marked with bullets.
Markup tags:
* text
** text
*** text
**** text
***** text
****** text
|
HTML representation:
<ul><li>text</li></ul>
<ul><li>text
<ul><li>text...</li></ul></ul>
|
Remarks:
Only whitespaces are allowed before the list tag.
|
Ordered Lists
Unordered lists will be marked with nublers.
Markup tags:
# text
## text
### text
#### text
##### text
###### text
|
HTML representation:
<ol><li>text</li></ol>
<ol><li>text
<ol><li>text...</li></ol></ol>
|
Remarks:
Only whitespaces are allowed before the list tag.
|
Example:
- level 1
- level 2
- level 3
- level 3
- level 2
- level 1
- level 2
|
Table Markup
Tables can be created by separating the cells with |.
WeakWiki allows to use flags on each cell..
Markup tags:
~| text | text...
...
~|@flags text | text...
...
|
HTML representation:
<table><tr><td> text </td><td> text ...
...</td></tr></table>
|
Remarks:
Cell spanning is not supported.
|
Flags:
Flags must directly follow the table ( |) tag. The flags scopes are:
@t... | table |
@r... | row |
@c... | cell |
See table flags for details.
|
Example:
cell 1 | cell 2 | cell 3 |
cell 4 | cell 5 | cell 6 |
|
Creole Implementation:
Fully complient with Creole 1.0.
Flags are WeakWiki-specific.
|
Preformatted Area Markup
Markup tags for preformatted areas.
Preformatted Nonwiki Areas
These are preformatted nonwiki areas.
Markup tags:
{{{
...
}}}
<<@pre>>
...
<<@/pre>>
|
HTML representation:
<pre>
...
</pre>
|
Remarks:
The nonwiki tags must be put in a separate line. Only whitespaces are allowed in the same line.
<<@pre>>, <<@/pre>> is alternate syntax.
|
Creole Implementation:
Fully complient with Creole 1.0.
<<@pre>>, <<@/pre>> is specific to WeakWiki.
|
Nonwiki Areas
These are nonwiki areas that use a deufferent style so they can be customized via CSS. The HTML pre tag will not be used. No parsing will be done.
Markup tags:
{~(~(
...
)~)}
<<@nonwiki>>
...
<<@/nonwiki>>
|
HTML representation:
<div class="nonwiki">
...
</div>
|
Remarks:
The nonwiki tags must be put in a separate line. Only whitespaces are allowed in the same line.
<<@nonwiki>>, <<@/nonwiki>> is alternate syntax.
|
Example:
{((
Preformatted text.
))}
|
Creole Implementation:
Specific to WeakWiki.
|
HTML Enabled Areas
These Areas allow the use of HTML that will be masked everywhere else in wiki pages.
Markup tags:
...
<<@html>>
...
<<@/html>>
|
Remarks:
X_ENABLE_HTML must be set to true to allow HTML enabled areas.
<<@html>>, <<@/html>> is alternate syntax.
|
Creole Implementation:
Specific to WeakWiki.
|
home | quick reference | manual
*
...
<<@html>>
...
<<@/html>>
|