- VW3
- VaultWiki: Server Settings
Return to current revision
General Differences
modified the section 'Replace Spaces in URLs'
Differences in Content
-
This page is about the "VaultWiki: Server Settings" group located in [color="DimGray"]vBulletin Options > vBulletin Options[/color] ([color="DimGray"]Settings > Options[/color] in vBulletin 4). This group will allow the Administrator to change important configuration settings for VaultWiki.
[template]Warning Box | Note | Some "VaultWiki: Server Settings" require you to make changes to your server's [book]Mod Rewrite Configuration[/book]. If your server or host does not support this, do not make changes to those settings.[/template]
[H="3"]Turn on the Wiki[/H]
From time to time, you may want to turn your wiki off to the public while you perform maintenance, update versions, etc.
Selecting 'Yes' will show the wiki to your visitors.
Selecting 'No' will hide the wiki from your visitors.
When the wiki is Disabled, users in the Administrator usergroup will still be able to browse the wiki. Other visitors will see an error message stating that the wiki is temporarily unavailable.
[H="3"]Wiki Base URL[/H]
Even though VaultWiki's files must stored in your forum directory, VaultWiki allows Administrators to change the URL to the wiki that your visitors will see.
For example, normally your wiki URL may look like:
[i][noparse]http://www.example.com/forums/wiki[/noparse][/i]
But you might instead want the following URL:
[i][noparse]http://www.example.com/wiki[/noparse][/i]
To achieve this, you would enter a base URL of:
[i][noparse]http://www.example.com[/noparse][/i]
However, the setting value shouldn't have a trailing slash ([i][noparse]http://www.example.com/[/noparse][/i]) or include parts like [I]/wiki[/I], because both will automatically be added by the script.
[template] Warning Box | Note | This setting only affects the HTML output of pages containing wiki URLs. In order for your server to recognize these URLs, you will still need to make changes to your server's [book]Mod Rewrite Configuration[/book].[/template]
[H="3"]Filename of the Wiki PHP File[/H]
Even though the file that serves VaultWiki pages is called [I]showwiki.php[/I], the file name can be changed using this setting.
When the Simplify Wiki Links option is also enabled, this setting value will be used as the wiki directory name.
[template]Warning Box | Important | Never physically rename the [I]showwiki.php[/I] file in your forum directory. Instead, when this setting value changes, you should update your server's [book]Mod Rewrite Configuration[/book].[/template]
[H="3"]REQUEST Title Variable[/H]
The REQUEST Title Variable is the part of the URL that points to the wiki page a visitor is trying to view.
Consider the URL: [noparse]http://www.example.com/showwiki.php?title=page[/noparse]
In this case, 'title' is the REQUEST variable that points to a specific page. This setting allows Administrators to change 'title' to something else.
When the Simplify Wiki Links option is also enabled, this part of the URL will not be visible to users.
[template]Warning Box | Note | When this setting value changes, you should update your server's [book]Mod Rewrite Configuration[/book].[/template]
[H="3"]Replace Spaces in URLs[/H]
VaultWiki encodes whitespace characters when creating URLs to wiki pages. This setting allows you to select what character will replace whitespace characters: +, -, or _.
-
-
[template]Warning Box | Note | If you have already created some articles and you change this value, you will need to visit [COLOR="DimGray"]VaultWiki > Wiki URL Manager[/COLOR] and click '[Rebuild Page URLs]'.[/template] -
+
[template]Warning Box | Note | If you have already created some articles and you change this value, you will need to visit [COLOR="DimGray"]VaultWiki > Wiki URL Manager[/COLOR] and click '[Rebuild Page URLs]'.
You should update your server's [book]Mod Rewrite Configuration[/book] if:
[list][*]Your Default Namespace's Title (or its Translations) has spaces in it (optional)
[*]Any Namespace's Custom Path (or its Translations) has spaces in it (required)[/list]
See [help]Adding and Editing Namespaces[/help] for more information on the Namespace settings.[/template] -
[h="3"]Simplify Wiki URLs[/h]
Enabling this will leave out the .php extension and title variable from VaultWiki's URLs. Instead URLs will look like: [noparse]http://www.example.com/wiki/Title[/noparse]
[template]Warning Box | Note | When this setting value changes, you should update your server's [BOOK]Mod Rewrite Configuration[/BOOK].[/template]
[h="3"]Enable UTF-8 Support for URLs[/h]
VaultWiki usually attempts to remove foreign language characters from URLs. However, if your board is non-English speaking and already uses UTF-8 encoding, you may opt to allow your language's characters in wiki URLs by turning this feature on.
[template]Warning Box | Note | If you change this value and you have already created some articles that have titles containing foreign language characters, you will need to visit [COLOR="DimGray"]VaultWiki > Wiki URL Manager[/COLOR] and click '[Rebuild Page URLs]'.[/template]
[H="3"]Enable Link Caching[/H]
VaultWiki attempts to track certain links between wiki pages, like redirects and template inclusions. When this setting is enabled, VaultWiki will track all wiki-related links throughout your forum.
When link caching is disabled, certain Special pages, like [I]Special:Whatlinkshere[/I], will not be available.
The more posts your forum has, the more intensive tracking this information can be. If you have a forum with a lot of posts, you may consider turning link caching off.
[h="3"]Enable Multi-Language Support[/h]
Multi-Language Support allows your users to post articles in different languages. Users can assign pages to each other as translations.
For example, you might have different versions of a page in English, German, and Russian. If you were reading the English page, you could easily select to view the page in German or Russian.
When Multi-Language Support is enabled, you can also translate certain Namespace fields for each forum language. For more information about editing namespaces, see [help]Adding and Editing Namespaces[/help].