Installing VaultWiki Lite
This is an old revision of this page, as edited August 28, 2008, 11:58 PM by pegasus(contribs). It may differ significantly from the current revision.
These are the official instructions for the Installation of CES VaultWiki Lite. These instructions are subject to change over time.
IMPORTANT! Always back up your files and your MySQL database before attempting to install a modification.
Installation
The Lite version has fully integrated file edits into the product file, so that simply importing the product will intelligently and automatically make any changes you need, and save you the time and the trouble of doing it yourself.
In the event that you replace any of these edited files during another product's upgrade (e.g. vBulletin), this mod's plugins will attempt to update the files again automatically.
Pre-Install Checklist
If you are installing this on a live forum, it is recommended that you schedule some forum down time and notify your members in advance, because the last few steps can use a lot of server resources and you may want to turn off your forum entirely until they are complete.
File Uploads
Extract the contents of ces_nwsp_spec.zip to a local directory. Upload the files contained in the /upload directory to your server.
Install the Product
The install script will need file access in order to perform automatic file edits. The following should be CHMOD 0777:
- ./includes/functions.php
Log into vBulletin's AdminCP and import the product-ces_nwsp_spec.xml file. Your browser should display text output of the install steps as they occur in real time. It is likely that the installation will finish before you can review most of this information. This means there were only minor problems, if any.
Create Namespaces
In order to create a namespace, you must create a forum with Parent Forum set to "No One" and with Enable Wiki in this forum? set to "Wiki."
Upon creating a namespace, make a note of the corresponding forum ID. You will need this later.
Forums that are child forums of a namespace count as part of the namespace. If you had any existing wiki forums (from another wiki product), note that they will not be accessible via Wiki BB-Codes unless they are child forums of a namespace. Remember that any wiki-enabled forum acts as a namespace if it has no selected Parent Forum. You may not need to make any changes.
Modification Settings
BB-Code Options
Each namespace uses a separate BB-Code for its links. If you use the mod Advanced BB-Code Permissions, you will have to use vBulletin's Custom BB-Code manager to create a dummy BB-Code for any content namespaces.
In general, the tag would be the forum title of the namespace, if it is one word. If the title is more than 1 word, the mod uses a BB-Code that ignores the first word (and the first word only) and strips any remaining spaces. If you ever plan on upgrading to the commercial version, the tags "special", "template", "book", "help", "category", and "image" are reserved. You should also avoid making namespace titles that would conflict with any of your existing BB-Codes.
General Options
Set all the options for CES VaultWiki. Values that cannot be left blank are:
- The forum id of the default namespace
- Filename of the Wiki PHP file
- $_REQUEST Title Variable
- Filename of the CSS File
The forum ID you noted earlier should be entered here.
If any of these options listed above are overlooked, errors are likely to occur in the next step or you will lose major functionality when the wiki is enabled.
It is also recommended that you list the title of the content namespace in Constant Title Namespaces, for aesthetic reasons.
Run Article Maintenance
At this point, it is recommended that you turn off your vBulletin. Maintenance cross references every thread and/or post in the forum system, and these processes can use a lot of server resources, depending on the size of your database.
In the AdminCP, go to the Threads and Posts group, and select Wiki Article Tools.
Rebuilt Article List
Rebuild Article List. This will check for existing threads in Wiki-enabled forums and map them to the appropriate namespaces. If any namespaces are damaged, this will attempt to repair them.
Rebuild Link Table
If you have not implemented a [wiki] BB-Code in your forum before, you probably do not need to complete this step at this time.
This builds a cache for links in existing posts, not just those contained in Wiki namespaces. In the Lite version, this is mainly for linkback usage. This step re-parses every post in the forum, and runs several queries for each post processed. It is recommended that you set the Posts processed per cycle to a relatively low amount, because this is the most intensive part of the installation. You should not have to run this again, because new posts will be processed automatically.
Update Permissions
A new permissions group was added: CES VaultWiki Permissions. These permissions control who can edit articles.
Installation Complete
CES VaultWiki Lite has been successfully installed. You can now enable your wiki.
Handling Support and Bugs
Except in the event of a serious error, the Lite version is not supported. Please purchase [arsenal=CES VaultWiki]the commercial product[/arsenal] if you need individual support.