NuWiki Syntax

NuWiki extends vBulletin's "BBCode", input via the WYSIWYG editor, for creating and editing wiki content.

NuWiki adds some new tags to the standard vB BBCode to support the features of the wiki. The NuWiki BBCode tags work as follows:

 

• 1NuWiki Installation
• 2NuWiki Admin CP
• 3NuWiki Usergroup Permissions
• 4NuWiki Syntax
  • 4.1Creating links to NuWiki Articles
  • 4.2Adding Headlines
  • 4.3Table of Content
  • 4.4Controlling the Table of Content location and visibility
  • 4.5AUTOLINK
    • 4.5.1use NOPARSE to control AUTOLINK
  • 4.6BOOK
  • 4.7SHOWTHREADS
  • 4.8TEMPLATE
  • 4.9TABLE
  • 4.10DIV
  • 4.11SPAN
  • 4.12FOOTNOTE
  • 4.13KEYWORDS
  • 4.14#REDIRECT
  • 4.15FIELD
• 5NuWiki Auto-Links
• 6NuWiki Templates
• 7NuWiki Books
• 8NuWiki Forum Manager Settings
• 9NuWiki FAQ
• 10NuWiki Forum Headers
• 11NuWiki CSS Styles
• 12NuWiki Changelog
• 13Main Page

Creating links to NuWiki Articles

You can create links to NuWiki Articles through the use of the WIKI bbcode. The following example will create a link to a NuWiki Article named 'NuWiki FAQ'.
[wiki]NuWiki FAQ[/wiki]

If the article to which the link points does not exist, the link is shown in red color.

In addition there is a 'short-hand' notation that can be used to create wiki links:

Adding Headlines

You can add headlines (headers) to a wiki article by using the following NuWiki BBCodes:


[h1]headline text[/h1]
[h2]headline text[/h2]
[h3]headline text[/h3]
[h4]headline text[/h4]
[h5]headline text[/h5]
[h6]headline text[/h6]
[h7]headline text[/h7]
Alternatively, you can enclose headline text with "=" sign for headlines; incrementing amount of the sings will give you sub-headline:

==headline==
===sub-headline===

Table of Content

If an article has 4 or more headlines, a table of content with links to the different sections is added at the top of the article.

Controlling the Table of Content location and visibility

NuWiki will add a Table of Content to an article whenever there are at least 4 headlines present. However, there are a couple of 'magic words' that can alter this default behavior:

The following magic word will hide the Table of Content regardless of the number of headlines present in the article.



The following magic word will instruct NuWiki to show the Table of Content if at least there is one headline in the article.



If you want to change the default location of the Table of Content, use the following magic word to indicate its new location.

AUTOLINK

Similarly to the WIKI BBCode, the AUTOLINK BBCode can be used to create links to existing or yet to be created NuWiki Articles. The difference is that the AUTOLINK BBCode produces a NuWiki Auto-Link with all the corresponding functionality (e.g. NuWiki Auto-Link Previews, with "read more" links, etc).

use NOPARSE to control AUTOLINK

AUTOLINK will skip over anything inside "NOPARSE" bbcode tags.

It may be useful to have autolink skip over a matching word or phrase; for example, to preserve the visual formatting in an article title or section heading. For example:

Use [noparse]around a phrase[/noparse] to hide it from AUTOLINK.

BOOK

The BOOK BBCode creates a link to a NuWiki Book. If the book doesn't exist, a link to the 'All Books' page is created.

The syntax for BOOK is as follows:


[book]book title[/book]

SHOWTHREADS

Using the SHOWTHREADS BBCode will add a list of the latest thread from a forum into a NuWiki Article.

The syntax for SHOWTHREADS is as follows:

PHP Code:

[showthreads=count]forumid[/showthreads] 


Where:

• count is the number of threads to list, if not specified, 10 threads are shown.
• forumid is the forum id from where to list threads, if not specified, the latest thread in the forum are shown.

Here is an example:

PHP Code:

[showthreads=5]236[/showthreads] 


Will produce:
 

 

TEMPLATE

NuWiki Templates use the following syntax:

PHP Code:

[template]Template Name[/template] 


More information can be found in the NuWiki Templates Article.

TABLE

The TABLE BBCode enables the creation of style rich tables in your NuWiki Articles.

The syntax is as follows:

[table]
[tr]
[td]first cell[/td]
[td]second cell[/td]
[/tr]
[/table]


Each of the opening elements can have a combination of standard NuWiki CSS Styles.

For instance

[table=class:tborder]
[tr]
[td=class:alt2]first cell[/td]
[td=class:alt1]second cell[/td]
[/tr]
[/table]


Will produce:

first cell

DIV

The DIV BBCode allows greater flexibility in editing NuWiki Articles.

The syntax is as follows:

PHP Code:

[div=css styles]content[/div] 


Where css styles is a semi-colon ( separated list of CSS Styles. Refer to the NuWiki CSS Styles article for more information.

For instance:

[div=color: red; font-weight: bold; border: 2px dashed blue; background: #FFFFC0; float: right; width:50%; text-align:center]This is some text[/div]


Will produce: 

This is some text

SPAN

The SPAN BBCode complements the DIV BBcode for inline elements.

The syntax is as follows:

PHP Code:

[span=css styles]content[/div]
[/span] 


[span=color: red; font-weight: bold; border: 2px dashed blue; background: #FFFFC0; text-align:center]This is some text[span=css styles]Where [b][i]css styles[/i][/b] is a semi-colon (;) separated list of CSS Styles. Refer to the [wiki]NuWiki CSS Styles[/wiki] article for more information.

For instance:
[/span]


Will produce: This is some text

FOOTNOTE

The FOOTNOTE BBCode is used to add footnotes to a NuWiki Article. Whenever a FOOTNOTE BBCode is found, it is replaced by a footnote index enclosed in square brackets (e.g. [3]), which links to the corresponding footnote that is listed at the end of the article.

The Syntax for the FOOTNOTE BBCode is:


[footnote]footnote text[/footnote]

KEYWORDS

The KEYWORDS BBCode can be used to specify extra keywords related to a NuWiki Article. These keywords are displayed in a smaller font, and somewhat grayed out. You can customize the look of keywords by changing the CSS styles for the class .nuwiki_keywords


[keywords]keyword list[/keywords]

#REDIRECT

NuWiki supports the concept of Article Redirects. Having an article which contains a #REDIRECT followed with a wiki link, will instruct NuWiki to redirect to the viewer to the new article.

The syntax is as follows:

PHP Code:

#REDIRECT [wiki]article title[/wiki] 


FIELD

The FIELD BBCode allows the use of custom thread fields within the text of a NuWiki Article. Only the fields specified in the NuWiki's Admin CP Setting named 'NuWiki Custom Fields Map' can be used.

The syntax for the FIELD BBCode is:


[field]field friendly name[/field]


Notice that the setting 'NuWiki Custom Fields Map' contains a mapping between database field names, and the friendly names that are used with the FIELD BBCode.