VaultWiki Options
This is an old revision of this page, as edited February 7, 2009, 4:21 PM by pegasus(contribs). It may differ significantly from the current revision.
You can access VaultWiki Options by opening the vBulletin Options nav group in the AdminCP, clicking "vBulletin Options," then double-clicking the "CES VaultWiki" setting group on the next page. An alternative method is opening the CES VaultWiki nav group and clicking "Wiki Settings."
This article will provide an explanation of each of VaultWiki's global settings.
Turn on the Wiki
Turning off the wiki would prevent users from visiting any wiki articles. Instead they will receive a message explaining that the wiki is currently unavailable.
Users who are members of the Administrators group will still be able to access the wiki to perform testing and maintenance.
The Namespace ID of the Default Namespace
The Default Namespace contains many of a site's content articles and is the default location (unless otherwise specified) for any new articles in the wiki.
By default, this is set to Namespace #6. While the Default Namespace can be set to any Namespace that exists in the Namespace Manager, you should never set it to a value lower than 6. You should not really modify this value except through the Wiki Domain Manager.
File Name of the Wiki PHP Script
The wiki file name is configurable to allow customization of the wiki to fit any theme all the way down to the file system level. When Simplify Wiki Links is active, the file name value will be used to form the subdirectory name.
By default, this is set to "showwiki." While you can change this as you please, it is not recommended to physically change the file name of showwiki.php in the file system. You should use .htaccess to accomplish the same effect. See Configuring .HTACCESS for more information.
$_REQUEST Title Variable
The Title Variable is configurable to allow customization of the query string contained in an unsimplified wiki URL to fit any theme. When Simplify Wiki Links is active, this value will not be visible to a normal user, but it is still required for PHP to perform certain backend operations.
Activate Navbits Compression
The Navbits Compressor removes repetitive text from the breadcrumbs in your forum's navbar. If two consecutive breadcrumbs contain the same text, the first of those breadcrumbs would be removed. This is mostly useful for handling articles that have been placed in forums of the same name.
Additional Navbits Compressor Phrases
The Navbits Compressor will attempt to remove repetitive text from the breadcrumbs. Normally, the compressor will only remove text where the entire breadcrumbs match. However, by specifying particular phrases, the compressor will remove any appearances of the phrase beyond the first appearance in your forum's navbar.
Enable Legacy Hooks
The wiki's showwiki.php file is based on a number of default vBulletin files, like showthread.php, editpost.php, and newthread.php, but many of the hook locations have been changed or renamed for code efficiency.
An existing product installation may expect certain vBulletin hooks from the original files to exist when viewing articles, but instead the plugin code will break. You can map the new hooks to their old names by clicking the checkbox next to the hooks you need.
Enable Auto-Links to VaultWiki Articles
When posting throughout the forum, users may not consider linking to articles relevant to their discussions. The Auto Link system automatically converts phrases in posts that match existing article titles in the default namespace into links to those articles.
While Auto Links make the article creation process easier in this way as well, wiki editors should make every effort to manually create links. This will help VaultWiki to better track links to articles that have not been created, which Auto Links do not consider.
Set Edit Time Limit for VaultWiki Articles
This is the time in minutes after the article was created. If a user created an article at 1:00 PM and this setting is set to 5, then a user will not be able to edit that article after 1:05 PM.
This setting is meant to override the global Edit Time Limit when editing articles. Entering a value of 0 here will use the default setting for Edit Time Limit.
Enable Support for Legacy Wiki Markup
When importing a wiki from an existing database of another wiki product, it is likely that the existing Wiki Code tags are not the same as in VaultWiki.
Legacy Wiki Code support adds another complex process to the Wiki Code Parser. To reduce server load, this feature should only be active during the conversion process or a grace period given to wiki editors to get used to the new Wiki Codes.
For specific instructions on importing existing wikis, see Wiki Importer.
For a list of supported Legacy Codes and their replacements, see Legacy Code.
Display Book Navigation Links
When viewing chapters of a Book article, three navigation links are inserted into the Chapter article to move between chapters or return to the Book Index. These navigation links can be configured to appear at the top of the chapter, at the bottom, or at both the top and bottom.
For specific instructions on setting up the Book Indexes, see Using Books.
Show Book Table of Contents in Chapters
The Book Table of Contents contains links to each of the chapters contained in that Book and appears at the bottom of the Book Index. Enabling this setting, will insert this list in the Table of Contents for each of the Book's individual chapters.
It is possible to achieve a similar effect using the TOC Wiki Code. See Wiki Code List for more information.
Enable AJAX Wiki Tabs
The tabbed style of VaultWiki articles allows loading each tab via AJAX, rather than loading a new browser page.
Some forum styles may or may not fit well with a fully AJAX article post. With AJAX enabled, the browser's Back button doesn't take users to the previously visited tab, but rather to the last page that was not loaded via AJAX.
For more information on these tabs, see AJAX Wiki Tabs.
Enable AJAX Previews of Wiki Articles
The AJAX Article Preview appears when hovering the mouse pointer over a Wiki Link. A small box will pop up containing a portion of the fully parsed text from the link's target.
Simplify Wiki Links
Simple Wiki Links, also referred to as .PHP-less URLs, create a cleaner looking URL format for Wiki Links. A simple wiki link excludes the .php extension and title variable from the visible URL, and it implies that the article is in a subdirectory with the same name as the Wiki PHP File Name.
Even while this feature is enabled, the wiki is still accessible from unsimplified URLs.
You will need to use .htaccess to accomplish this effect. See Configuring .HTACCESS for more information.
Enable Navbar Wiki Menu
VaultWiki inserts a new drop-down menu into the Navbar. Some sites have custom Navbar menus that may conflict. In this case, the default Wiki menu should be disabled and any links should be added manually.
Require Edit Reason for Wiki Articles
In general, many members overlook the "Reason" field when editing posts. This option will force users to enter a Reason when editing the first post of an article in a VaultWiki-enabled forum.
This information can be useful for admins who are planning to moderate edits to articles. The Reason is also displayed on the article's History tab, as well as Special:Recentchanges and Special:Contributions.