History of TikiWikiSyntax

Comparing versions
Version 2Current version
General Description

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



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


Key Function and sub-features

Related Links

Typical Uses

For more information
http://doc.tikiwiki.org has good pages about WikiSyntax.
 
Here, you see a list of Tikiwiki syntax markup options. If the content format of your site or of a single page is set to Tikiwiki format you can style and structure your content like described here. Apart from the wiki syntax called Tikiwiki, Bitweaver offers various other content formats. For any content format, data plugins let you include images, attachments, tabs, modules and loads of other functionality. To see a listing of the formatting options available on bitweaver.org, consult the tab titled "Format Help", available when editing a page.

Emphasis

DescriptionExampleResultNotes
Headings
! text
!! text

text

text

Number of ! correponds to heading level.
Italicstexttext
Underlinetexttext
Coloured backgroundtexttext
Coloured texttexttext
Boldtexttext
Center Text
text
textcenters text relative to its container
Combinations of the above
text
text


Lists

DescriptionExampleResultNotes
Unordered Lists
* item 1
** item 2
  • item 1
    • item 2
Ordered Lists
# item 1
## item 2
  1. item 1
    1. item 2
Definition Lists; item 1 : item 2
item 1
item 2


Wiki References

DescriptionExampleResultNotes
Automatic link to wiki pageCamelCapsCamelCaps
Automatic link to wiki pageunder_scoresunder_scores
Double BracketsPage NameDescriptionIf you leave out the Description, it will display the Page Name.
Avoid Link CreationPageNamePageName


External Links

DescriptionExampleResultNotes
External LinkDescriptionDescriptionIf you leave out the Description, it will display the URL.


Miscellaneous

DescriptionExampleResultNotes
Horizontal Rule---
Highlighted Bar
highlighted bar
highlighted bar
Highlighted Box
highlighted box
highlighted box



Why use wiki syntax?

Wiki syntax is a way to add word-processor like formatting to content in the website. Consisting of special characters that you enter along with the text, wiki syntax is designed for non-programmers be easy to use. E.g., typing __bold text__ with underscores creates bold text. Typing ((Wiki Syntax|link)) creates a Wiki Syntax to the page Wiki Syntax.

Quicklinks

Eventually many users memorize the wiki syntax they use, but you don't have to. It the QuicklinksPackage package is enabled, the quicklink buttons above the edit window will apply the chosen formatting to any selected text.

Plugins

If you are looking for a way to include CODE (with highlighting for various languages) or DIV or IMG and ATTACHMENT please refer to the list of data plugins.
Page History
Date/CommentUserIPVersion
14 May 2009 (17:48 UTC)
Will69.203.72.16131
Current • Source
laetzer85.178.10.6229
View • Compare • Difference • Source
mlpvolt206.248.132.10926
View • Compare • Difference • Source
mlpvolt206.248.132.10925
View • Compare • Difference • Source
dspt213.184.224.324
View • Compare • Difference • Source
dspt213.184.224.319
View • Compare • Difference • Source
Sean Lee71.254.3.12818
View • Compare • Difference • Source
xing194.152.164.4517
View • Compare • Difference • Source
xing194.152.164.4516
View • Compare • Difference • Source
xing194.152.164.4515
View • Compare • Difference • Source
Edog69.145.86.25414
View • Compare • Difference • Source
xing194.152.164.4512
View • Compare • Difference • Source
xing194.152.164.4511
View • Compare • Difference • Source
xing194.152.164.4510
View • Compare • Difference • Source
xing194.152.164.459
View • Compare • Difference • Source
xing194.152.164.458
View • Compare • Difference • Source
Francisco68.23.41.617
View • Compare • Difference • Source
spiderr66.93.240.2044
View • Compare • Difference • Source
Wickie80.134.11.2153
View • Compare • Difference • Source
Wickie80.134.17.172
View • Compare • Difference • Source