Submit Article
Syntax Help
No Title
TikiWiki Syntax Format Parser To view syntax help, please visit TikiWikiSyntax.For more information, please visit www.bitweaver.org
Data Plugin Help
Plugin: AddTabs
- Syntax: {ADDTABS tab1= tab2= tab3= . . . tab99= }
- Description: Will join the contents from several sources in a Tabbed Interface.
- Online Help: DataPluginAddTabs
| 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. |
Plugin: Adsense
- Syntax: {ADSENSE}
- Description: This plugin adds Adsense Code to page.
- Online Help: DataPluginAdsense
NO HELP WRITTEN FOR {ADSENSE} YET. You can set: client, width, height, format, type and channel.
Plugin: AgentInfo
- Syntax: {AGENTINFO info= }
- Description: This plugin will display the viewer's IP address, the Browser they are using, or the info about the site's Server software.
- Online Help: DataPluginAgentInfo
| 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 |
Plugin: Articles
- Syntax: {ARTICLES max= topic= type= }
- Description: This plugin will display several Articles.
- Online Help: DataPluginArticles
| 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 type='some_type'}
Plugin: Attachment
- Syntax: {attachment id= size= align= }
- Description: Display attachment in content
- Online Help: DataPluginAttachment
| 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) |
| 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 |
| output | keyword (optional) | If you are attaching a file and you only want to display the description and not the image that goes with it, use: output=desc |
| styling | string (optional) | Multiple styling options available: padding, margin, background, border, text-align, color, font, font-size, font-weight, font-family, align. Please view CSS guidelines on what values these settings take. |
Plugin: bitweaver Icon
- Syntax: {biticon ipackage= iname= iexplain}
- Description: Display any bitweaver icon
- Online Help: DataPluginBiticon
| Key | Type | Comments |
|---|---|---|
| ipackage | key-words (required) | Package the icon is taken from. The icon style icons take the value 'icons'. |
| iname | key-words (required) | Name of the icon to be displayed |
| ixplain | string (optional) | Explanation of the icon - visible when hovering over the icon. |
Plugin: Blog
- Syntax: {BLOG id= user= max= format= }
- Description: This plugin will display several posts from a blog.
- Online Help: DataPluginBlog
| Key | Type | Comments |
|---|---|---|
| id | numeric (optional) | Filters for the specified Blog by id |
| user | string (optional) | The login name of the user who's posts are to be displayed. (Default = 3) |
| 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=5 format='list'}
Plugin: Code
- Syntax: {CODE source= num= }Sorce Code Snippet{/code}
- Description: Displays the Source Code Snippet between {Code} blocks.
- Online Help: DataPluginCode
| 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 |
| title | string (optional) | Give the codelisting a title. |
| 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. |
Plugin: Comment
- Syntax: {COMMENT}Data Not Displayed{/COMMENT}
- Description: This plugin allows Comments (Text that will not be displayed) to be added to a page.
- Online Help: DataPluginComment
Plugin: CountDown
- Syntax: {COUNTDOWN enddate= localtime= class= punct= text=}
- Description: 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).
- Online Help: DataPluginCountDown
| Key | Type | Comments |
|---|---|---|
| enddate | string (mandatory) | 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 |
| class | string (optional) | Classname of the SPAN surrounding the countdown. The date/time segments are each wrapped in a VAR-Tag. Default = countdown |
| punct | string (optional) | Any kind of punctuation to divide the date/time segments from each other, a comma, a colon, a pipe ... Default = space. To put a non breaking space, use HTML: |
| text | string (optional) | Text to be displayed after the date/time string. It's wrapped in <em>. |
Example 1:
Example 2:
Plugin: Creation Time
- Syntax: {CREATIONTIME}
- Description: This plugin will display the creation time of a page.
- Online Help: DataPluginCreationTime
Example: {CREATIONTIME}
Plugin: Div
- Syntax: {div border='3px solid blue'}
- Description: This plugin allows you to easily create a div with a number of optional CSS parameters.
- Online Help: DataPluginDiv
| 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. |
Plugin: DropDown
- Syntax: {DD title= width= }Text in the Drop-Down box.{DD}
- Description: This plugin creates a expandable box of text. All text should be entered between the {DD} blocks.
- Online Help: DataPluginDropDown
| 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 title='Explaining the Lines #1 #3 & #7'} Text in the Drop-Down box{DD}
Plugin: Flash Video
- Syntax: {flashvideo id= size= align= }
- Description: Display flashvideo in content. This requires videos
- Online Help: DataPluginAttachment
| Key | Type | Comments |
|---|---|---|
| id | numeric (required) | Id number of Flashvideo to display inline. |
| size | key-words (optional) | You can change the display size of the video here. This will not influence the download size of the video itself. Possible values are: small, medium, large, huge |
| view | key-words (optional) | If you are including a small version of the video, you can easily link to the large version of this film. Possible values are: small, medium, large, huge, original |
| width | numeric (optional) | Manually set the width of the video in pixels. |
| height | numeric (optional) | Manually set the height of the video in pixels. The hight will be calculated automatically if not set. |
| styling | string (optional) | Multiple styling options available: padding, margin, background, border, text-align, color, font, font-size, font-weight, font-family, align. Please view CSS guidelines on what values these settings take. |
Plugin: FreeMind - Mind Map
- Syntax: {MM src= height= width= }
- Description: Displays a Freemind mindmap
- Online Help: DataPluginFreeMind
| 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. |
Plugin: Gauge
- Syntax: {GAUGE color= bgcolor= max= value= size= perc= height= }Description{GAUGE}
- Description: This plugin displays a graphical GAUGE.
- Online Help: DataPluginGauge
| 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 Gauge 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: {GAUGE} ). If present the text will be displayed below the Gauge. |
Note: Browser Safe Colornames are available on the BitWeaver Web Site Another useful site for obtaining HTML colors is The Color Picker II
Plugin: GeshiData
- Syntax: {GESHIDATA doall= lang= info= }
- Description: This plugin is a documentation tool for the bitweaver site. It will display some of information defined in the GeSHi (Generic Syntax Highlighter) package.
- Online Help: DataPluginGeshiData
| Key | Type | Comments |
|---|---|---|
| doall | boolean (optional) | Provided to display the information for Every Language. Default = False - So only specific information is Displayed. |
| lang | string (optional) | Specifies the Language to gather the information from. Possible values are: ActionScript / Ada / Apache Log File=Apache / ASM (NASM based)= Asm / ASP / Bash / C / C for Macs=C_Mac / AutoCAD DCL=CadDcl / AutoCAD LISP=CadLisp / C++=Cpp / C#=CSharp / CSS / D / Delphi / Diff Output=Diff / HTML (4.0.1)=Html4Strict / Java / JavaScript / Lisp / Lua / MatLab / MpAsm / NullSoft Installer=Nsis / Objective C=ObjC / OpenOffice.org Basic=OoBas / Oracle8 / Pascal / Perl / Php / Php-Brief / Python / QuickBasic=QBasic / Smarty / SQL / VisualBasic=Vb / VB.NET=VbNet / VHDL / VisualFoxPro / XML. The Default = PHP |
| info | key-word (optional) | Determines the information to be displayed. The Key-words are: Comment / Comment1 / Comment2 Note: With the Comment Key-words - the difference is Comment returns the Line Comment Character / while Comment1 returns the starting Block Comment Character and Comment2 returns the ending Block Comment Character. There is No Default for this parameter. |
Example: {GESHIDATA lang='XML' info='Comment' }
Plugin: Hit Counter
- Syntax: {HITCOUNTER}
- Description: This plugin will display the hit count for a page.
- Online Help: DataPluginHitCounter
Example: {HITCOUNTER}
Plugin: Image
- Syntax: {img src=http://www.google.at/logos/olympics06_ski_jump.gif}
- Description: Allows you to insert an image into your page with little effort and a multitude of styling options.
- Online Help: DataPluginImg
| Key | Type | Comments |
|---|---|---|
| src | string (required) | Specify where the path to the image. |
| link | string (optional) | If you want your image to link to a web address, use link='link/to/page'. |
| styling | string (optional) | Multiple styling options available: padding, margin, background, border, text-align, color, font, font-size, font-weight, font-family, align. Please view CSS guidelines on what values these settings take. |
Plugin: Include
- Syntax: {INCLUDE content_id= }
- Description: This plugin is used to include the contents of one Wiki page in another Wiki page.
- Online Help: DataPluginInclude
| 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 appropriate numeric content id. This can include blog posts, images, wiki texts... Avaliable content can be viewed here |
Plugin: MapQuest
- Syntax: {MAPQUEST icon= myicon= text= address= city= state= zip= country= title= style= }
- Description: Creates an Icon link to MapQuest and/or a link to a Specific Map based on an Address.
- Online Help: DataPluginMapQuest
| 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) |
Plugin: MapQuest Directions
- Syntax: {MQDIR icon= myicon= text= address= city= state= zip= country= }
- Description: Creates an Icon link to MapQuest with a form to get Directions from MapQuest based on a Destination Address.
- Online Help: DataPluginMapQuestDirections
| 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 |
Plugin: Page Table of Contents
- Syntax: {MAKETOC}
- Description: Will create a table of contents of the WikiPage based on the headings below.
- Online Help: DataPluginMakeTOC
| 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. |
| width | string (optional) |
Override the width of the maketoc div. |
| type | key words (optional) |
Setting this to dropdown will create a dropdown instead of the default nested list of headings. |
Plugin: Quote
- Syntax: {quote format_guid= user= comment_id= }.. content ..{/quote}
- Description: This plugin will render the given content as discribed by the content_type given
- Online Help: DataPluginQuote
| Key | Type | Comments |
|---|---|---|
| comment_id | comment_id (optional) |
specify the comment_id of the comment being quoted |
| user | user (optional) |
specify the user whose comemnt is being quoted |
| format_guid | string (required) |
Specify what renderer should be used to render the contents |
Plugin: Renderer
- Syntax: {renderer class= format_guid= }.. content ..{/renderer}
- Description: This plugin will render the given content as discribed by the contnet_type given
- Online Help: DataPluginRenderer
| Key | Type | Comments |
|---|---|---|
| id | div id (optional) |
specify the id of the outputed div |
| class | div class (optional) |
specify the class of the outputed div |
| format_guid | string (required) |
Specify what renderer should be used to render the contents |
Plugin: RSS Feed
- Syntax: {RSS id= max= }
- Description: Display RSS Feeds
- Online Help: DataPluginRSS
| Key | Type | Comments |
|---|---|---|
| id | string (mandatory) | ID of the RSS-feed to process. |
| max | integer (optional) | Number of entries to be displayed from given RSS Feed, prefixed with publication date. |
Plugin: SourceForge
- Syntax: {SF tag= aid= groupid= atid= }
- Description: Creates a link to SourceForge. Can link to the Bugs / RFEs / Patches / Support Index pages or individual items on those pages.
- Online Help: DataPluginSourceForge
| 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 aid=1226624 } - Link to a BitWeaver Bug
Example: {SF groupid=141358 atid=749176 aid=1226624 } - Same as Last Example only done the hard way
Plugin: Span
- Syntax: {span border='3px solid blue'}
- Description: This plugin allows you to easily create a span with a number of optional CSS parameters.
- Online Help: DataPluginspan
| Key | Type | Comments |
|---|---|---|
| CSS rules or class | string (optional) | This can be any CSS style rule. e.g.: font='small-caps 250% serif' |
| preset | string (optional) | There are a few presets, which you can use to style with. Presets include: caps, smallcaps, big, small, strikethrough, overline, spaced, nodecor. |
Plugin: Spy Text
- Syntax: {SPYTEXT spy= agency= sender= to= hidden= title= width= icon= alert= }
- Description: 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.
- Online Help: DataPluginSpyText
| Key | Type | Comments |
|---|---|---|
| spy | UserName(s) (optional) | A List of Spy(s) who can see the Message. Each Spy must be separated 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 separated 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 separated 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 separate 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. |