|
|

Format
Text Color Changing the color of text is easy. Before the text you want colored - insert 2 tildie (~) characters with the colors name followed by a colon. 2 additional tildie characters need to be added at the end of the colored text.
Example: ~~blue:Text to be colored~~ will produce Text to be colored
HTML Colors can also be specified by placing a # character with the HTML Color where the color name should be.
Example: ~~#FF0060:Text to be colored~~ will produce Text to be colored.
For Web-Safe Color Names see TikiPro or for HTML Color numbers see The Color Picker II
Italics To italicize a word or phrase using Wiki syntax, simply surround it with two single quotes (apostrophes), like ''this''. If you wish to italicize an entire phrase, just ''surround the entire phrase''.
Note: insert note about italics not carrying over line breaks.
Syntax: ''italics''
Example: "My friend Jane was ''very'' excited to get her new car."
Displayed: "My friend Jane was very excited to get her new car."
Underlining Underlining text is similar to italicizing text.
You can underline an entire phrase by ===surrounding it with three equals signs on either side===,
or just a single ===word===.
Syntax: ===underlined===
Example: "My friend Scott is ===very=== nervous about his date on Friday."
Displayed: "My friend Scott is very nervous about his date on Friday."
Bold Bolding text is very similiar to italicizing & underlining. To make text bold, surround the __word__ or phrase with __two underscores on either side__.
Syntax: __bold__
Example: "__When__ are we going to the movies?"
Displayed: "When are we going to the movies?"
Combinations of Tags Tikipro gives you even more choices by allowing you to simply combine tags to form different formatting combinations. For example, ''__this text is both italicized & bold__''. __===This text is both bold & underlined===__. ''__This text is both italicized & underlined__''.
Images
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 alignment 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
Links
WikiLinks ((WikiPageName)) would automatically link to the wiki page called "WikiPageName" with the text of the link displayed as, "WikiPageName"
((WikiPageName|description)) would automatically create the link for the page called "WikiPageName"for wiki references
))SomeName(( prevents referencing
External links use square brackets for an external link: [URL]
[URL|link_description]
[URL|description|nocache]
Miscellaneous
Lists * for bullet lists,
# for numbered lists,
;term:definition for definiton lists
Tables "||row1-col1|row1-col2|row1-col3 row2-col1|row2-col2col3||" creates a table
Simple box ^Box content^ Creates a box
Other "!", "!!", "!!!" makes headings
"---" makes a horizontal rule
"-=title=-" creates a title bar
use ...page... to separate pages
Non parsed sections: "~np~ data ~/np~" Prevents parsing data
Dynamic Tags RSS feeds: rss id=n max=m displays rss feed with id=n maximum=m items
Dynamic variables: "%name%" Inserts an editable variable
Dynamic content: content id=n Will be replaced by the actual value of the dynamic content block with id=n
Plugins
FreeMind Displays a Freemind Mindmaps Example Syntax:{mm src= height= width= } AddTabs Will join the contents from several sources in a Tabbed Interface. Example Syntax:{addtabs tab1= tab2= tab3= . . . tab99= } More details
| Key | Type | Comments |
|---|
| tab1 - tab99 | numeric (optional) | Will create a Tab interface on a page. The name on each tab is the name given to the imported page.The value sent with the TabX parameter is a TikiPro Numeric Content Id. This allows blog posts, images, wiki pages...and more to be added Note: The order used when the tabs are specified does not matter. The Tabname does - Tab1 is always first and Tab99 will always be last. Avaliable content can be viewed here |
Example: {addtabs tab1=15 tab2=12 tab3=11} AgentInfo This plugin will display the viewer's IP address, the Browser they are using, or the info about the site's Server software. Example Syntax:{agentinfo info= } More details
| Key | Type | Comments |
|---|
| info | string (optional) | Show information about the Browser being used. ip: To get the client\'s IP address (default) browser: To get the clients Browser infromation. server: To get the site\'s server software
|
Example: {agentinfo info='browser'} Attachment Display attachment in content Example Syntax:{attachment id= size= align= } More details
| Key | Type | Comments |
|---|
| id | numeric (required) | Id number of Attachment to display inline. | | size | key-words (optional) | If the Attachment is an image, you can specify the size of the thumbnail displayed. Possible values are: avatar, small, medium, large (Default = medium) | | align | key-words (optional) | Specifies how the Image / Attachment is to be alligned on the page.. Possible values are: left, center, right (Default = left) |
Example: {attachment id='13' size='small' align='center'} Avatar This plugin Example Syntax:{avatar user= page= float= } More details
| Key | Type | Comments |
|---|
| user | numeric (optional) | Name of the user who's avatar should be shown (Default = avatar of user accessing page). | | page | page name (optional) | Used to make the Avatar a link to a specified page. (Default = Homepage of the Avatar's owner) | | float | key-words (optional) | Specifies how the Avatar is to be alligned on the page. If NOT defined - the text will not wrap around the Avatar. Possible values are: left or right (Default = NOT SET) |
Example: {include user='admin' page='home' float='right'} BackLinks This plugin will list all Wiki pages which contains a link to the specified page. Example Syntax:{backlinks page= info= exclude= self= header= } More details
| Key | Type | Comments |
|---|
| page | page name (optional) | Can be any wiki page. (Default = the current page) | | info | key-words (optional) | Defines what is to be displayed. Multiple columns can be displayed if joined with the character |. Available choices are: hits, lastmodif, user, ip, len, comment, creator, version, flag, versions, links, backlinks. (Default = EVERYTHING) | | exclude | page name(s) (optional) | Can be any wiki page. Multiple pagenames will be excluded if joined with the character |. Like this: HomePage|SandBox (Default = EVERYTHING is displayed) | | self | boolean (optional) | Determins if the page currently viewed is listed. Any value results in TRUE. (Default = FALSE) | | header | boolean (optional) | Causes a heading to be displayed above the list. Any value results in TRUE. (Default = FALSE) |
Example: {backlinks page='MyHomePage' info='hits|user' exclude='HomePage|SandBox'} Example: {backlinks page='MyHomePage' info='hits|user' exclude='HomePage|SandBox' self='Yes' header='Yes'} Dl This plugin creates a definition list. Example Syntax:~np~{DL()}term:definition{DL}~/np~ - only one definition per line More details
^__Parameter Syntax:__ ~np~{DL(key=>value)}~/np~
||__::key: ::__ | __::value::__ | __::Comments::__
::term:: | ::definition:: | this plugin accepts any term / definition string seperated with a colon (:) as parameters.||^^__Example:__ ~np~{DL(Aardvark:A very strange animal)}{DL}~/np~^ Gauge This plugin displays a graphical GAUGE. Example Syntax:~np~{GAUGE(color=> ,bgcolor=> ,max=> ,value=> ,size=> ,perc=> ,height=> )}Description{GAUGE}~/np~ More details
^__Parameter Syntax:__ ~np~{DL(key=>value)}~/np~
||__::key: ::__ | __::value::__ | __::Comments::__
::term:: | ::definition:: | this plugin accepts any term / definition string seperated with a colon (:) as parameters.||^^__Example:__ ~np~{DL(Aardvark:A very strange animal)}{DL}~/np~^ Include This plugin is used to include the contents of one Wiki page in another Wiki page. Example Syntax:{include content_id=} More details
| key |
type |
comments |
| page_name |
string (optional) |
To include any wiki page you can use it's page name (this has to be a unique name. if it's not unique, use the page_id instead) (this method is deprecated). |
| page_id |
numeric (optional) |
To include any wiki page you can use it's page_id number. |
| content_id |
numeric (optional) |
To include any content from tikipro insert the apprpropriate numeric content id. This can include blog posts, images, wiki texts...
Avaliable content can be viewed here |
Example: {include page_name=15}
Example: {include page_id=15}
Example: {include content_id=15} Lang This plugin will attempt to translate the text between the ~np~{LANG}~/np~ blocks to the current language. If the translation fails - nothing is displayed. Example Syntax:~np~{LANG(lang=> )}Text to be translated{LANG}~/np~ More details
| key |
type |
comments |
| page_name |
string (optional) |
To include any wiki page you can use it's page name (this has to be a unique name. if it's not unique, use the page_id instead) (this method is deprecated). |
| page_id |
numeric (optional) |
To include any wiki page you can use it's page_id number. |
| content_id |
numeric (optional) |
To include any content from tikipro insert the apprpropriate numeric content id. This can include blog posts, images, wiki texts...
Avaliable content can be viewed here |
Example: {include page_name=15}
Example: {include page_id=15}
Example: {include content_id=15} Module Display a module block in content Example Syntax:{module module= align="right"}~/np~ More details
^__Parameter Syntax:__ ~np~{MODULE(key=>value)}~/np~
||__::key::__ | __::value::__ | __::Comments::__
::module:: | ::name:: | the name of the module to be displayed. __Required__
::align:: | ::alignment:: | orientation of the module to the page. Can be left / center / right. There default is __left__.
::max:: | ::number:: | number of rows the module will be display in. There default is __10__.
::np:: | ::boolean:: | if True (any value = True) the content will not be parsed. There default is __No__.
::args:: | ::value:: | this depends on module - some modules require additional arguments passed to them.||^^__Example:__ ~np~{MODULE(module=>last_modified_pages,align=>left,max=>3,maxlen=>22)}{/MODULE}~/np~^^__Note:__ Plugin's are __case sensitive__. The Name of the plugin __MUST__ be UPPERCASE. The Key(s) are __always__ lowercase. Some Values are mixed-case but most require lowercase. When in doubt - look at the Example.^ PluginHelp This plugin will display the Help and Extended Help for a Plugin. Example Syntax:~np~{PLUGINHELP(plugin=>)}~/np~ More details
^__Parameter Syntax:__ ~np~{MODULE(key=>value)}~/np~
||__::key::__ | __::value::__ | __::Comments::__
::module:: | ::name:: | the name of the module to be displayed. __Required__
::align:: | ::alignment:: | orientation of the module to the page. Can be left / center / right. There default is __left__.
::max:: | ::number:: | number of rows the module will be display in. There default is __10__.
::np:: | ::boolean:: | if True (any value = True) the content will not be parsed. There default is __No__.
::args:: | ::value:: | this depends on module - some modules require additional arguments passed to them.||^^__Example:__ ~np~{MODULE(module=>last_modified_pages,align=>left,max=>3,maxlen=>22)}{/MODULE}~/np~^^__Note:__ Plugin's are __case sensitive__. The Name of the plugin __MUST__ be UPPERCASE. The Key(s) are __always__ lowercase. Some Values are mixed-case but most require lowercase. When in doubt - look at the Example.^ RSS Feed Display RSS Feeds Example Syntax:~np~{rss id= max=}~/np~ More details
Sf This plugin automatically creates a link to the appropriate ))SourceForge(( object for ))TikiPro((. Example Syntax:~np~{SF(groupid=> ,adit=> ,aid=> ,tag=> )}~/np~ More details
NO HELP WRITTEN FOR {rss} sort This plugin sorts operates on lines of text - not the text in the lines. Every line between the ~np~{SORT}~/np~ blocks - including the lines the blocks are on - is sorted. Example Syntax:~np~{SORT(sort=> )}Lines to be sorted{SORT}~/np~ More details
NO HELP WRITTEN FOR {rss} Split This plugin is used to split a page in two or more columns using __-~045~-__ as a seperator. Example Syntax:__Syntax:__ ~np~{SPLIT(joincols=> ,fixedsize=> )}{SPLIT}~/np~ More details
NO HELP WRITTEN FOR {rss} TitleSearch This plugin search the titles of all pages in this wiki. Example Syntax:~np~{TITLESEARCH(search=> ,info=> ,exclude=> ,noheader=> )}~/np~ More details
NO HELP WRITTEN FOR {rss} TOC Display a Table Of Contents for Structures Example Syntax:{toc sturcture_id=} More details
NO HELP WRITTEN FOR {toc} TestParms This plugin will display the parameters passed to it. Example Syntax:~np~{TP(p1= ,p2= ,p3= )}~/np~ More details
^__Parameter Syntax:__ ~np~{TP(Key=value)}~/np~
||__::key::__ | __::value::__ | __::Comments::__
::p1:: | ::Anything:: | Any parameter.
::p2:: | ::Anything:: | Any parameter.
::p3:: | ::Anything:: | Any parameter.
^__Example:__ ~np~{TP(p1=AAAA, p2=BBBB, p3=CCCC)}~/np~^ Translated This plugin does not translate anything. It is used to create a link to a page that does contain a translation. The link can be shown as an Icon for the country or as an abreviation for the language. Example Syntax:~np~{TRANSLATED(page=> ,lang=> ,flag=> )}~/np~ More details
^__Parameter Syntax:__ ~np~{TP(Key=value)}~/np~
||__::key::__ | __::value::__ | __::Comments::__
::p1:: | ::Anything:: | Any parameter.
::p2:: | ::Anything:: | Any parameter.
::p3:: | ::Anything:: | Any parameter.
^__Example:__ ~np~{TP(p1=AAAA, p2=BBBB, p3=CCCC)}~/np~^ UserCount This plugin will display the number of users. If a Groups Name is included between the __~np~{USERCOUNT}~/np~__ blocks, the number returned will be the number of users in that Group. Example Syntax:~np~{USERCOUNT()}{USERCOUNT}~/np~ More details
^__Parameter Syntax:__ ~np~{TP(Key=value)}~/np~
||__::key::__ | __::value::__ | __::Comments::__
::p1:: | ::Anything:: | Any parameter.
::p2:: | ::Anything:: | Any parameter.
::p3:: | ::Anything:: | Any parameter.
^__Example:__ ~np~{TP(p1=AAAA, p2=BBBB, p3=CCCC)}~/np~^ UserList This plugin will displays an alphabetically sorted list of registered users. If a Groups Name is included between the __~np~{USERLIST}~/np~__ blocks, only the users in that Group will be listed. Example Syntax:~np~{USERLIST(num=> ,userspage=> ,alpha=> ,total=> , email=> )}GroupName{USERLIST}~/np~ More details
^__Parameter Syntax:__ ~np~{TP(Key=value)}~/np~
||__::key::__ | __::value::__ | __::Comments::__
::p1:: | ::Anything:: | Any parameter.
::p2:: | ::Anything:: | Any parameter.
::p3:: | ::Anything:: | Any parameter.
^__Example:__ ~np~{TP(p1=AAAA, p2=BBBB, p3=CCCC)}~/np~^ WikiList Displays an alphabetically sorted list of WikiPages Example Syntax:~np~{WIKILIST(num=> ,alpha=> ,total=> ,list=>)}GroupName{WIKILIST}~/np~ More details
^__Parameter Syntax:__ ~np~{TP(Key=value)}~/np~
||__::key::__ | __::value::__ | __::Comments::__
::p1:: | ::Anything:: | Any parameter.
::p2:: | ::Anything:: | Any parameter.
::p3:: | ::Anything:: | Any parameter.
^__Example:__ ~np~{TP(p1=AAAA, p2=BBBB, p3=CCCC)}~/np~^ MakeTOC Will create a table of contents of the WikiPage based on the headings below. Example Syntax:{maketoc} More details
| Key | Type | Comments |
|---|
| maxdepth | numeric (optional) | if you specify 3 here, MakeTOC will only parse headings to the h3 level. | | include | value (optional) | if you include all, it will print a list of the full list of contents, regardless of where in the page {maketoc} is. | | backtotop | boolean (optional) | if you set backtotop true, it will insert a "back to the top" link. |
Example: {maketoc maxdepth=3 include=all backtotop=true}
|