History of TikiWikiSyntax
Version 3
Please enter a valid 'page_name', 'page_id' or 'content_id' to include in this page.
Please enter a valid 'page_name', 'page_id' or 'content_id' to include in this page.
For more detailed information, see the following:
- WikiCharacterFormattingDoc: bold, italic, underlining, colored text, and monospace (preformatted) text
- WikiListDoc: bulleted, numbered, and definition lists
- WikiTables: simple tables
- WikiPageLayoutDoc: titles, headings, boxes, rules, centered text, and page breaks
- WikiLinkingDoc: links to Wiki and Web pages
TIP: Also see PluginsList; several Wiki plugins provide advanced text formatting capabilities.
Quick Reference
The following is the same information you see when you click Wiki Quick Help while you're editing a Wiki page.Text Formatting Rules:
Emphasis: '' for italics, __ for bold, ''__ for both
Lists: * for bullet lists, # for numbered lists, ;term:definition for definiton lists
Wiki References: JoinCapitalizedWords or use ((page)) or ((page|desc)) for wiki references ))SomeName(( prevents referencing
External links: use square brackets for an external link: [URL] or [URL|link_description] or [URL|description|nocache] (that last form prevents the local Wiki from caching the page; please use that form for large pages!).
Multi-page pages: use ..<!-- this tag is broken inside of "np"; I've fixed this in HEAD. -- rlpowell, 24 May 2004 -->.page... to separate pages.
Misc: "!", "!!", "!!!" make_headings, "----" makes a horizontal rule "===text===" underlines text
Title bar: "-=title=-" creates a title bar.
Images: "{img src=http://example.com/foo.jpg width=200 height=100 align=center link=http://www.yahoo.com desc=foo}" displays an image height width desc link and align are optional
Non cacheable images: "{img src=http://example.com/foo.jpg?nocache=1 width=200 height=100 align=center link=http://www.yahoo.com desc=foo}" displays an image height width desc link and align are optional
Drawings: {draw name=foo} creates an editable drawing named "foo".
Tables: "||row1-col1|row1-col2|row1-col3
row2-col1|row2-col2col3||" creates a table
RSS feeds: "{rss id=n max=m}" displays rss feed with id=n maximum=m items
Simple box: "^Box content^" Creates a box with the data
Dynamic content: "{content id=n}" Will be replaced by the actual value of the dynamic content block with id=n
Colored text: "~~#FFEE33:some text~~" Will display using the indicated HTML color
Center: "::some text::" Will display the text centered
Non parsed sections: "~np~ data ~/np~" Prevents wiki parsing of the enclosed data.
Preformated sections: "~pp~ data ~/pp~" Displays preformated text/code; no Wiki processing is done inside these sections (as with np), and the spacing is fixed (no word wrapping is done).
Square Brackets: Use [[foo] to show [foo] (in the latest CVS version only).
Block Preformatting: Indent text with any number of spaces to turn it into a monospaced block that still follows other Wiki formatting instructions. It will be indended with the same number of spaces that you used. Note that this mode does not ppreserve exact spacing and line breaks; use "~pp~ data ~/pp~" for that.
Dynamic variables: "%name%" Inserts an editable variable
Insert Module Output: {MODULE(module=>some_module)}text{MODULE} can be used to insert the output of module "some_module" into your Wiki page. See PluginModule for more information.
Rendering Program Code: {CODE()}some code{CODE} will render "some code" as program code. This plugin has other options; see PluginCode.
Direction: "{r2l}", "{l2r}", "{rm}", "{lm}" — Someone who understands these, please elaborate, and also update templates/tiki-edit_help.tpl — rlpowell
Misc: "{toc}", "{maketoc}" prints out a table of contents for the current page based on ! headings, "{cookie}" — Someone who understands these, please elaborate, and also update templates/tiki-edit_help.tpl — rlpowell
In addition, here is a guide to the plug-in syntax, which is displayed when you click Show Plugins Help in the Wiki quick help screen. More information on plug-ins is available: PluginsList.
AVATAR | Displays the user Avatar |
BOX | Insert theme styled box on wiki page |
CATEGORY | Insert list of items for the current/given category into wiki page |
CATORPHANS | Display Tiki objects that have not been categorized |
CATPATH | Insert the full category path for each category that this wiki page belongs to |
CENTER | Centers the plugin content in the wiki page |
CODE | Displays a snippet of code. Set optional paramater ln to 1 if you need line numbering feature. |
COPYRIGHT | Insert copyright notices |
DL | No description available |
EXAMPLE | No description available |
FANCYTABLE | Displays the data using the TikiWiki? odd/even table style |
GAUGE | Displays a graphical GAUGE |
MODULE | Displays a module inlined in page |
MONO | Displays the data using a monospace font |
SORT | Sorts the plugin content in the wiki page |
SPLIT | No description available |
SQL | No description available |
WIKIGRAPH | Renders a graph |
Check if all these are on the wiki pages and in tiki-edit_help.tpl:
- Please note that where I say "Done" below I am not claiming to have written everything, but merely to have verified it. --rlpowell
-=titlebar=- -- Done. --rlpowell
box: ^^ -- Done. --rlpowell
~~color:text~~ -- Done. --rlpowell
__bold__ -- Done. --rlpowell
-+monospaced+-
''italic'' -- Done. --rlpowell
===underline=== -- Done. --rlpowell
::center:: -- Done. --rlpowell
~ pp ~ ~ / pp ~ -- Done. --rlpowell
~ np ~ ~ / np ~ -- Done. --rlpowell
Link
[link|desc|nocache] -- Done. --rlpowell
Wiki
((Wiki)) -- Done. --rlpowell
((Wiki|desc)) -- Done. --rlpowell
((Wiki|desc|timeout))
))NoWiki(( -- Done. --rlpowell
{draw name=[string] } -- Done. --rlpowell
{picture file=[filename]}
{content id=[id]} -- Done. --rlpowell
{rcontent id=[id]}
Table
||ta|ble|s|| -- Done. --rlpowell
line
---
...page... -- Done. -- rlpowell
List:
*bla-- Done. -- rlpowell
**bla-1
++continue-bla-1
***bla-2
++continue-bla-1
*bla
+continue-bla
#bla
** tra-la-la
+continue-bla
#bla
Headlines:
!bla -- Done. -- rlpowell
!-bla
!+bla
!! -- Done. -- rlpowell
!!! -- Done. -- rlpowell
{rss id=[id]) max=[number] } -- Done. -- rlpowell
Definition lists
;blablabla:blablablab blablablabla blabalablablabalba
;blablabla:blablablab blablablabla blabalablablabalba
oft-used characters (case insensitive)
~bs~
~hs~
~amp~
~ldq~
~rdq~
~lsq~
~rsq~
~c~
~--~
~lt~
~gt~
[[
~[number 0-255]~
{cookie}
{toc}
{maketoc} -- Done. -- rlpowell
Bidi markers:
{l2r}
{r2l}
{rm}
http://doc.tikiwiki.org has good pages about WikiSyntax.
{WIKIGRAPH()}{WIKIGRAPH}