|
|

HelpHTML HTML Syntax Format Parser Tiki Wiki Syntax TikiWiki Syntax Format Parser To view syntax help, please visit TikiWikiSyntax. Plugin HelpComment This plugin allows Comments (Text that will not be displayed) to be added to a page. Syntax: {COMMENT}Data Not Displayed{/COMMENT} for additional information about this plugin, see DataPluginComment. AddTabs Will join the contents from several sources in a Tabbed Interface. Syntax: {ADDTABS tab1= tab2= tab3= . . . tab99= } Display Extended Help| 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 Numeric Content Id. This allows blog posts, images, wiki pages . . . (and more) to be added. Note 1: A listing of Content Id's can be found Here Note 2: The order used when the tabs are specified does not matter. The Tabname does - Tab1 is always first and Tab99 will always be last. |
Example: {ADDTABS tab1=15 tab2=12 tab3=11} for additional information about this plugin, see DataPluginAddTabs. AgentInfo This plugin will display the viewer's IP address, the Browser they are using, or the info about the site's Server software. Syntax: {AGENTINFO info= } Display Extended Help| 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'} for additional information about this plugin, see DataPluginAgentInfo. Articles This plugin will display several Articles. Syntax: {ARTICLES max= topic= type= } Display Extended Help| Key | Type | Comments |
|---|
| max | numeric (optional) | The number of Articles to be displayed. (Default = 3) | | topic | topic name (optional) | Filters the Articles so that only the Topic specified is displayed | | type | type name (optional) | Filters the Articles so that only the Type specified is displayed | | format | string (optional) | Specify format for article display - options: full, list (default) |
Example: {ARTICLES max=5 topic='some_topic'} Example: {ARTICLES max=5 type='some_type'} for additional information about this plugin, see DataPluginArticles. Attachment Display attachment in content Syntax: {ATTACHMENT id= size= align= } Display Extended Help| 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, original (Default = medium) | | link | string (optional) | Allows you to specify a relative or absolute URL the image will link to if clicked. If set to false, no link is inserted.(Default = link to source image) | | align | key-words (optional) | Specifies how the Image / Attachment is to be alligned on the page. Possible values are: left, center, right (Default = none - attachment is shown inline) | | float | key-words (optional) | Specifies how the Image / Attachment is to float on the page. Behaviour of float is different to align. Possible values are: left, right (Default = none - attachment is shown inline) |
Example: {ATTACHMENT id='13' size='small' align='center' link='http://www.google.com'} for additional information about this plugin, see DataPluginAttachment. Blog This plugin will display several posts from a blog. Syntax: {BLOG id= max= format= } Display Extended Help| Key | Type | Comments |
|---|
| id | topic name (optional) | Filters for the specified Blog by id | | max | numeric (optional) | The number of posts to be displayed. (Default = 3) | | format | string (optional) | Specify format for posts display - options: full, list (default) |
Example: {BLOG id=2 max=5 format='full'} Example: {BLOG id=5 format='list'} for additional information about this plugin, see DataPluginBlog. Code Displays the Source Code Snippet between {Code} blocks. Syntax: {CODE source= num= }Sorce Code Snippet{/code} Display Extended Help| Key | Type | Comments |
|---|
| source | key-word (optional) | Defines the format of the Source Code Snippet. Possible values are: ActionScript • Ada • Apache Log File = Apache • AppleScript • ASM (NASM based) = Asm • ASP • AutoCAD DCL = CadDcl • AutoCAD LISP = CadLisp • Bash • BLITZ BASIC • C • C++ = Cpp • C# = CSharp • C for Macs = C_Mac • CSS • D • Delphi • Diff Output = Diff • DIV • DOS • Eiffel • FreeBasic • GML • HTML (4.0.1) = Html4Strict • ini • Inno • Java • JavaScript • Lisp • Lua • MatLab • MpAsm • MySQL • NullSoft Installer = Niss • Objective C = ObjC • OCaml • OpenOffice.org Basic = OoBas • Oracle8 • Pascal • Perl • Php • Php_Brief • Python • QuickBasic = QBasic • Ruby • Scheme • Smarty • SQL • VB.NET = VbNet • VHDL • Visual Basic • VisualBasic = Vb • VisualFoxPro • XML The Default = PHP | | num | boolean/number (optional) | Determins if Line Numbers are displayed with the code. Specifing:TRUE / ON / YES / or a Number will turn Line Numbering On. When a Number is specified - the Number is used for the first line instead of 1. Any other value will turn Line Numbering OFF and only the Code will be displayed. The Default = FALSE Line Numbers are Not displayed. |
Example: {CODE source='php' num='on' }Sorce Code Snippet{/code} for additional information about this plugin, see DataPluginCode. CountDown Displays a Count-Down until a date:time is reached - then - negative numbers indicate how long it has been since that date. The Count-Down is displayed in the format of (X days, X hours, X minutes and X seconds). Syntax: {COUNTDOWN enddate= localtime= }Text{countdown} Display Extended Help| Key | Type | Comments |
|---|
| enddate | string (Manditory) | A date used to compare to the present date. Several date formats are accepted, but spelling it out like this: May 10 2004 is probably the simplest. A time can be include with the date like this: 20:02:00 or 8:02pm . There is NO Default. | | localtime | boolean (optional) | Determins if Local Time is displayed or not. Passing any value in this parameter will make it TRUE. The Default = FALSE so Local Time will not be displayed |
Example: {COUNTDOWN enddate='8:02pm May 10 2004' localtime='on'} - Time Passes So Slowly{countdown} Displays: 82 days, 23 hours, 37 minutes and 31 seconds - Time Passes So Slowlyfor additional information about this plugin, see DataPluginCountDown. Div (DIV) This plugin allows you to easily create a div with a number of optional CSS parameters. Syntax: {div border='3px solid blue'} Display Extended Help| Key | Type | Comments |
|---|
| CSS rules | string (optional) | This can be any CSS style rule. e.g.: border='3px solid blue' | | preset | string (optional) | There are a few presets, which you can use to style with. Presets include: dark, orange, red, blue, centered. |
Example: {div preset=centered border='3px solid blue'} for additional information about this plugin, see DataPluginDiv. FreeMind (Mind Map) Displays a Freemind mindmap Syntax: {MM src= height= width= } Display Extended Help| Key | Type | Comments |
|---|
| src | string (manditory) | Location where the Mindmap MM file can be found. This can be any URL or a site value. See Examples. | | width | number or percentage (optional) | The width of the Mindmap window. This value can be given in pixels or as a percentage of available area. A pixel value is assumed so only a numeric value is needed. To specify a percentage - the character % MUST follow the value. The Default is taken from the Mindmap file if this parameter is not defined. | | height | number or percentage (optional) | The height of the Mindmap window. This value can be given in pixels or as a percentage. A pixel value is assumed so only a numeric value is needed. To specify a percentage - the character % MUST follow the value. When a percentage is given - the value is defined by the Mindmap file with a maximum of 100%. Note: The Default is taken from the Mindmap file if this parameter is not defined. |
Example: {MM src='http://www.bitweaver.org/examples/bitweaver.mm' width='100%' height='600' } for additional information about this plugin, see DataPluginFreeMind. Gauge This plugin displays a graphical GAUGE. Syntax: {GAUGE color= bgcolor= max= value= size= perc= height= }Description{GAUGE} Display Extended Help| Key | Type | Comments |
|---|
| color | colorname or hex color (optional) | Specifies the color of the of the Bar in the Gauge. Colornames or HTML colors can be used. To specify HTML color the # character MUST be included like this: ( #RRGGBB ). If not specified - the Current Text Color will be used. See Note below for Colornames & HTML Colors Sources. | | bgcolor | colorname or hex color (optional) | Specifies the color of the Gauges Background. Colornames or HTML colors can be used. To specify HTML color the # character MUST be included like this: ( #RRGGBB ). If not specified - the Current Background Color will be used. See Note below for Colornames & HTML Colors Sources. | | max | numeric (optional) | The maximum possible value to be displayed. The Gauge was designed to be used with percentages - so the Default = 100 | | value | numeric (Required) | The current value that the Guage will display. There is NO Default value. | | size | numeric (optional) | The width of the Bar in pixels. The Default = 150 | | height | numeric (optional) | The height of the Bar in pixels. The Default = 14 | | perc | boolean (optional) | Determines if the % character is displayed after the value. Passing any value in this parameter will make it TRUE. The Default = FALSE so the % character will not be displayed | | Description | boolean (optional) | This is NOT a Parameter. Text can be place between the 2 code blocks ( in this case: {GUAGE} ). If present the text will be displayed below the Guage. |
Example: {GAUGE color='red' bgcolor='blue' value='25' perc='True' }A Simple Gauge{GAUGE} Note: Browser Safe Colornames are available on the BitWeaver Web Site Another useful site for obtaining HTML colors is The Color Picker IIfor additional information about this plugin, see DataPluginGauge. Include This plugin is used to include the contents of one Wiki page in another Wiki page. Syntax: {INCLUDE content_id= } Display Extended Help
| 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 bitweaver 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} for additional information about this plugin, see DataPluginInclude. MakeTOC Will create a table of contents of the WikiPage based on the headings below. Syntax: {MAKETOC} Display Extended Help
| Key |
Type |
Comments |
| maxdepth |
numeric (optional) |
If you specify 3 here, MakeTOC will only parse headings to the h3 level. |
| include |
string (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. |
| class |
string (optional) |
Override the class of the maketoc div. |
Example: {MAKETOC maxdepth=3 include=all backtotop=true} for additional information about this plugin, see DataPluginMakeTOC. MapQuest Creates an Icon link to MapQuest and/or a link to a Specific Map based on an Address. Syntax: {MAPQUEST icon= myicon= text= address= city= state= zip= country= title= style= } Display Extended Help| Key | Type | Comments |
|---|
| icon | key-word (optional) | Creates an Icon Link to MapQuests primary URL. The size of the Icon can be: sm = Small, med = Medium, lg = Large or none = The primary URL to MapQuest is NOT Displayed) The Default = sm The Small MapQuest Icon is displayed. | | myicon | string (optional) | Address of an icon used for a link to a Specific Map. The Default = NONE NOTE: The primary URL to MapQuest is not displayed when using this parameter. | | text | string (optional) | The Text used for the link to the Specific Map The Default = Get Map | | address | string (optional) | The Street Address The Default = NONE | | city | string (optional) | The City The Default = NONE | | state | string (optional) | The State or Province The Default = NONE | | zip | string (optional) | The Zip or Postal Code The Default = NONE | | country | string (optional) | The Country (Uses 2-digit ISO Codes) The Default = US Note: 2-Digit ISO Country Codes are available from ISO Country Codes | | title | string (optional) | MapQuest labels each Map with the Address, City, State, & Zip Code. This parameter overwrites that label when defined. The Default = NONE | | style | key-word (optional) | Specifies the Map's Colors. Possible values are: 0 (Gray Scale), 1 (Neutrals), 2 (Yellows), 3 (European Style) The Default = 1 (Neutrals) |
Example: {MAPQUEST icon=sm address='1730 Blake St' city=Denver state=CO zip=80202 } for additional information about this plugin, see DataPluginMapQuest. MapQuest Directions Creates an Icon link to MapQuest with a form to get Directions from MapQuest based on a Destination Address. Syntax: {MQDIR icon= myicon= text= address= city= state= zip= country= } Display Extended Help| Key | Type | Comments |
|---|
| icon | key-word (optional) | Creates an Icon Link to MapQuests primary URL. The size of the Icon can be: sm = Small, med = Medium, lg = Large or The Default = sm The Small MapQuest Icon is displayed. | | address | string (optional) | The Street Address The Default = NONE | | city | string (optional) | The City The Default = NONE | | state | string (optional) | The State or Province The Default = NONE | | zip | string (optional) | The Zip or Postal Code The Default = NONE | | country | string (optional) | The Country (Uses 2-digit ISO Codes) The Default = US Note: 2-Digit ISO Country Codes are available from ISO Country Codes |
Example: {MQDIR icon=sm address='1730 Blake St' city=Denver state=CO zip=80202 } for additional information about this plugin, see DataPluginMapQuestDirections. Object This plugin displays a Flash, Tcl or Java applet/object. Syntax: {OBJECT type= src= width= height=} Display Extended Help| Key | Type | Comments |
|---|
| type | key-word (manditory) | The type of object being displayed. Possible values are: tcl, flash, java. | | src | string (manditory) | The location of the file used for the object. This can be any URL or a site value. See Examples. | | param_name | string (optional) | Can be used to specify custom object parameters. Currently only available for Tcl applets. Replace "name" with the name of the parameter. | | width | number or percentage (optional) | The width of the object. This value can be given in pixels or as a percentage of available area. A pixel value is assumed so only a numeric value is needed. To specify a percentage - the character % MUST follow the value. | | height | number or percentage (optional) | The height of the object. This value can be given in pixels or as a percentage. A pixel value is assumed so only a numeric value is needed. To specify a percentage - the character % MUST follow the value. | | float | key-words (optional) | Specifies how the object is to float on the page. Floating elements are positioned on the side specified, with content flowing around. Possible values are: left, right, none. (Default = none - object is shown inline) | | clear | key-words (optional) | Specifies which horizontal sides of the object can not have other content flowing around. Possible values are: left, right, both, none. (Default = none - content is allowed to flow around object) |
Flash specific parameters| Key | Type | Comments |
|---|
| quality | key-word (optional) | The quality at which to display a Flash applet. Possible values are unknown - except: high and probably low. | Java specific parameters| Key | Type | Comments |
|---|
| vmversion | version number (optional) | The version of Java required for the applet. Should be in the form of X.x, eg: 1.3. | | pagescript | boolean (optional) | Specifies if the applet can access Javascript features on the web page. Possible values are: true, false. | | appletscript | boolean (optional) | Specifies whether the applet is scriptable from the web page using JavaScript or VBScript. Possible values are: true, false. | | srcbase | string (optional) | The base location of the Java applet. | | archive | string (optional) | Specifies the name of the Java archive. | Example: {OBJECT type=flash src=../liberty/icons/Mind-Reader.swf} Example: {OBJECT type=flash src=http://www.bitweaver.org/liberty/icons/Mind-Reader.swf width='100%' height='600' quality='high'} Both of these examples display "The Flash Mind Reader" by Andy Naughton. The first example is on your site and is not very large. The second example is located on the bitweaver.org site and takes the width of the center column with an appropriate height. for additional information about this plugin, see DataPluginObject. Poll This plugin will display the selected Poll and allow users with permission to vote. Syntax: {POLL id= } Display Extended Help^__Parameter Syntax:__ ~np~{PLUGINHELP(key=> )}~/np~
||__::key: ::__ | __::value::__ | __::Comments::__
::plugin:: | ::plugin name:: | the name of a plugin. Will display the Help and Extended Help - fairly much as they are seen here.||^^__Example:__ ~np~{PLUGINHELP(plugin=>pluginhelp)}{PLUGINHELP}~/np~^ for additional information about this plugin, see DataPluginPoll. SourceForge (SF) Creates a link to SourceForge. Can link to the Bugs / RFEs / Patches / Support Index pages or individual items on those pages. Syntax: {SF tag= aid= groupid= atid= } Display Extended Help| Key | Type | Comments |
|---|
| tag | string (optional) | The tag is a short-cut that allows you to use this plugin without having to look up the SourceForge groupid or adit numbers for specific projects. Possible values for BitWeaver are:bugs / rfe / patches / support Possible values for TikiWiki are:twbugs / twrfe / twpatches / twsupport Possible values for JGraph are:jgbugs / jgrfe / jgsupport Possible values for PhpBB are:pbbrfe | | aid | string (optional) | By supplying an aid value - the link will be to a specific Bug/RFE/Patch/ or /Support item. If not given - the link will be to the index page for the project in question. | | groupid | string (optional) | Every SourceForge project has an groupid . This number can be aquired by looking at the URLwhen looking at the project. | | atid | string (optional) | Only Tracker pages on SourceForge used a adit number. These pages are: Bugs / RFE / Patches / and 3 |
Example: {SF tag=bugs } - Link to BitWeaver's Bug Index Page Example: {SF tag=bugs aid=1226624 } - Link to a BitWeaver Bug Example: {SF groupid=141358 atid=749176 aid=1226624 } - Same as Last Example only done the hard way for additional information about this plugin, see DataPluginSourceForge. Table Of Contents (TOC) Display a Table Of Contents for Structures Syntax: {TOC sturcture_id= } Display Extended Help| Key | Type | Comments |
|---|
| display | string (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 Numeric Content Id. This allows blog posts, images, wiki pages . . . (and more) to be added. |
Example: {toc structure_id=8 display=full_toc} for additional information about this plugin, see DataPluginTOC. DropDown (DD) This plugin creates a expandable box of text.. All text should be entered between the {DD} blocks. Syntax: {DD title= width= }Text in the Drop-Down box.{DD} Display Extended Help| Key | Type | Comments |
|---|
| title | string (optional) | String used as the link to Expand / Contract the text box. The Default = "For More Information" | | width | numeric (optional) | Controls the width of the title area in pixels. This is a percentage value but the % character should not be added. The Default = 20 |
Example: {DD}Text in the Drop-Down box.{DD} Example: {DD title='Explaining the Lines #1 #3 & #7'} Text in the Drop-Down box{DD} for additional information about this plugin, see DataPluginDropDown. Spy Text (SPYTEXT) Allows text to be stored that is only visible to a List of Spys or to a Spy Agency (Group). To anyone else (except an Admin) the text is not be visible. Syntax: {SPYTEXT spy= agency= sender= to= hidden= title= width= icon= alert= } Display Extended Help| Key | Type | Comments |
|---|
| spy | UserName(s) (optional) | A List of Spy(s) who can see the Message. Each Spy must be seperated with the | character like this: spy='Fire|Spider|Lester|Xing' The Message will ONLY be displayed to Spys. HINT: The Admin is a Spy! | | agency | GroupName(s) (optional) | A List of Spy Agency(s) (Groups) that will be allowed to see the Messages. Each Agency must be seperated with the | character like this: agency='Devellopers|Editors' The Message will ONLY be displayed to Spys. HINT: The Admin is a Spy! | | sender | UserName (optional) | A List of Spy(s) who wrote the Message. Each Author must be seperated with the | character like this: sender='StarRider|Wolffy' | | to | boolean/string (optional) | Determines if an Address Box will be displayed before the Message. The Address Box is always in it's own DropDown box which contains 3 lines where the spy(s) / agency(s) / & sender(s) are identified. These lines are only displayed if a valid UserName / GroupName is found for that line. The Default Header for each line is: Line 1 for Spy (Users) = "To the Spy:" Line 2 for Agency (Groups) = "To the Agency:" Line 3 for Sender (Users) = "From Your Source(s):" The Address Box is NOT displayed by Default. Specifing to='TRUE' will enable the Address Box with the Default Headers. The Address Headers can be redefined by using the the | character to seperate the headers like this: to='To My Friends:|To My Colleagues In:|Your Friend:'The * character can also be used to say "Use This Default" but Replace this one. - Like this: to='*|*|From the Sexiest Spy Ever:' | | hidden | boolean (optional) | Determines if the message is in a Stationary or DropDown Box. By Default: Every SpyText Message is encased in a Stationary Box. Passing Any value in this parameter will cause the Message to become a DropDown Box. The link that Expands/Contracts the DropDown Box is supplied by the parameters title or icon. | | title | string (optional) | The Title Bar is something like a Horizontal Rule with the Text Centered on it. It is used as a link to Expand/Contract a hidden Message Box. The Title Bar is only visible when the Message Box is hidden By Default Title used by the Title Bar is "A Hidden Message". Specifying any value in this parameter will change the Default Title. | | width | numeric (optional) | Controls the width of the text area on the Title Bar. The value is a percentage of available space but Do Not include the % character. The Default = 20 | | icon | URL/Content Id # (optional) | An Icon can be used as the link to display the Message Box if desired. When activated, the Title becomes part of the hidden Message Box. By Default - an Icon is Not displayed. Specifing : icon='TRUE' will cause the Default Icon to be displayed. Any Image stored on the site can be used by specifing it's Content Id Number like this: icon='#125' Please Note: the # character Must be included.Any other value specified in this parameter is assumed to be a Valid URL. Note: - a listing of Content Id's can be found Here | | alert | boolean/string (optional) | Determines if an Alert Box is attached to the page. This is intended to provide the Less-Than-Swift Spy with a Subtle Hint that there just might be something for them to look at. The Alert Box is Never displayed by Default. Specifing: alert='TRUE' will enable the Alert Box with the Default Headers. The Default Headers is: "Wake Up Charlie! There is a message on this page for you. Use your Secret Decoder Ring!" In this instance - Charlie is the UserName of the user viewing the page. The string: *UserName* is replaced with name of the spy viewing the page every place it is found.Passing ANY other value will replace Default Message. Note: The Administrator is a Spy and will be Alerted - with a slightly different message. |
for additional information about this plugin, see DataPluginSpyText. |
Server Statistics - Execution time: 1.90s
- Memory usage:
- Database queries: 14
- GZIP: Enabled
- Server load: ?
|