DocBasicSyntax in 'raw' format
Here is information about basic syntax for TBWiki:
{{TableOfContents}}
= General markup =
* a blank line = a paragraph break
* 4 or more dashes alone on line = a horizontal rule
* number of dashes = thickness of line
(below this is a thin line, formed with ----)
----
(below this is a thick line, formed with ----------)
----------
* ''italic'' = surround text by two single-quotes
{{HTML(''italic'')}} = ''italic''
* '''bold''' = surround text by three single-quotes
{{HTML('''bold''')}} = '''bold'''
* ``code (monospaced font)`` = surround text by two backticks
{{HTML(``code``)}} = ``code``
= Headings =
* leading and trailing '=' at start of line => headings
* number of '=' = heading level
== 2nd level heading ==
was made with {{HTML(== 2nd level heading ==)}}
=== 3rd level heading ===
was made with {{HTML(=== 3rd level heading ===)}}
==== 4th level heading ====
was made with {{HTML(==== 4th level heading ====)}}
= Bullet Lists =
You uses '*' or '-' with indentation, to create bullet lists:
{{{#!YellowBox
color=lightgrey
* space and '*' = bullet
* indentation = bullet level
* indentation back to previous level does the right thing
- you can use multiple lines for the content on
the same bullet level, by indenting them the same level
as the starting text
- this is indented for a second-level bullet
item, with multi-line text
}}}
Produces this:
* space and '*' = bullet
* indentation = bullet level
* indentation back to previous level does the right thing
- you can use multiple lines for the words on
the same bullet level, by indenting them the same level
as the starting text
- this is indented for a second-level bullet
item, with multi-line text
= Definition lists =
You can create definition lists with the following syntax:
{{{; word: definition
}}}
example:
; Red Baron: a very good pilot in world war I
; Snoopy: a dog from the ''Peanuts'' cartoon
Definition lists should end with a blank line.
= Images =
You can add inline images on a page with the syntax:
* [''''''[image:image-name.jpg]]
or
* [''''''[image:ht''''''tp://server/remote-image.jpg]
The image name can refer to a local file or a remote file. If the image name
starts with 'http', it is treated as a full URL to a remote site.
A local file refers to a filename in this wiki's files area area
(where uploaded files reside).
== image options ==
You can optionally add options to control image display and handling,
by placing a vertical bar after the image filename, followed by image options. The following options are supported:
* width="xxx"
* height="yyy"
* alt="alternate text"
If multiple attributes are used, they should be separated by a spaces.
Note that this is the same syntax as used for HTML <img> tags.
Example:
* [''''''[image:image-name.jpg|height="200" alt="This is neat"]]
= Links =
Links are either interpreted from plain text, when the part before the colon
is a recognized URL prefix (ht''''''tp: or ht''''''ttps:), or are specified with surrounding double square brackets.
* https:/server/page - automatically converted to link
* double-square bracket - link to local page e.g. [''''''[FrontPage]] => [[FrontPage]]
* double-square bracket with remote url - [ [ht''''''tp://google.com/]] => [[http://google.com/]]
* vertical bar inside brackets = separates link from cover text
* [''''''[FrontPage|go to the Front Page]] => [[FrontPage|go to the Front Page]]
* [ [ht''''''tp://google.com|Google search engine]] => [[http://google.com|Google search engine]]
* link to local files: [''''''[file:filename.doc]] => [[file:filename.doc]]
* link from image: [''''''[image:image-name.jpg|FrontPage]]
* link from remote image to local page: [''''''[image:ht''''''tp://server/image-name.jpg|FrontPage]]
* link from local image to remote page: [''''''[image:image-name.jpg|ht''''''tp://server/other-page.html]]
= Special marks =
The following special mark is supported:
* caret-slash
{{{
^/ shows a green checkmark
}}}
Here is an example:
^/ green checkmark supported!
= Preformatted text =
Use triple braces to indicate text that should be output in
pre-formatted format. That is, the word wrappings and leading
spaces will be preserved.
{{{
{{{
this
is
preformatted
text
} }}
}}}
Will display as this:
{{{
this
is
preformatted
text
}}}
Note that markup will not be processed inside a block of preformatted text:
{{{
{{{
Here's a [[link]]
} }}
}}}
Yields:
{{{
Here's a [[link]]
}}}
= Blocks =
* preformatted text - use triple braces, and no name
* named block - use triple braces and a name on the top line
* hidden block - use triple braces and a leading '#' in the name
* processor block - put the processor name after #! on the top line
* named table block - put the table name after the #!Table processor directive
named block
{{{
{{{MyData
<put data here>
}} }
}}}
hidden block
{{{
{{{#HyHiddenData
<this data won't display on the page
}} }
}}}
processor
{{{
{{{#!PigLatin
This will display as pig latin!
}} }
}}}
named table block
{{{
{{{#!Table:BlockName
<table spec and data>
}} }
}}}
= Macros and processors =
Macros are invoked with double braces. Processors use triple braces, and #! preceding the processor name.
== Macros ==
=== Common Macros ===
* {''''''{BR}} - forced line break
* {''''''{TableOfContents}} - insert a table of contents
* {''''''{HTML(text)}} - insert raw text unprocessed in HTML output
* {''''''{Include(page)}} - include another page in this one
=== System Macros ===
* {''''''{RecentChanges}} - show the list of recent edits
* {''''''{SystemInfo}} - show information about the tbwiki system
* {''''''{TitleIndex}} - show the list of pages on this site
== Processors ==
Processors can invoke plugins to produce output calculated at runtime (that is, at the time of page access).
=== Useful processors ===
Some useful processors:
* #!Table - table processor
* #!WebSed - page scraping processor
* #!SlideShow - show a page as a slide show
* #!bc - calculator processor (see 'man bc')
* #!RegEx - do interactive RegEx testing
* #!RunningChart - show running chart from table data
* #!YellowBlock - show text inside a yellow block
=== Demonstration processors ===
* #!FooReplace - replace 'foo' with 'bar' in content
* #!PigLatin - change text to pig latin
* #!UserChoice - show how to use sub-actions
=== In-progress processors ===
* #!Transcriber - used to transcribe videos
* #!User - used for user account administration
=== Testing processors ===
* #!GetBlock - test for internal get_block() routines
* #!RegressionCheck - test for markup-to-html conversion correctness