NuWiki Installation

IMPORTANT: Always make a backup of your database and site before installing any products, mods or add-ons. NuWiki creates several new tables, and adds a couple of fields to vBulletin's forum, thread and postparsed tables.

It is also important to test the installation on a development or test server with a recent backup of your site.


This article describes the steps required to install NuWiki. After you have completed the installation, you can check how to configure NuWiki in NuWiki Admin CP, how to create and configure NuWiki Forums in NuWiki Forum Manager Settings, or how to allow or restrict editing rights in NuWiki Usergroup Permissions page.

Answers to common questions can be found in NuWiki FAQ, and a list of the NuWiki Syntax can be found in the NuWiki Syntax page.

 
 

• 1NuWiki Installation
  • 1.1System Requirements
  • 1.2Installing NuWiki
    • 1.2.1Forum Headers
  • 1.3Upgrading NuWiki
  • 1.4Configuring NuWiki
• 2NuWiki Admin CP
• 3NuWiki Usergroup Permissions
• 4NuWiki Syntax
• 5NuWiki Auto-Links
• 6NuWiki Templates
• 7NuWiki Books
• 8NuWiki Forum Manager Settings
• 9NuWiki FAQ
• 10NuWiki Forum Headers
• 11NuWiki CSS Styles
• 12NuWiki Changelog
• 13Main Page

System Requirements

- vBulletin 3.6.x
- PHP 4.4+ or 5.x

Installing NuWiki

1) Extract the content of NuWiki's installation package on a local directory.

2) Upload the contents of the upload directory to your forums directory in the server.

3) Import NuWiki's product XML:

• Log into your Admin CP
• Go to Plugins & Products > Manage Products and click on [Add/Import Product]
• Enter the path to product-nuhit_nuWiki.xml (found in the local directory used in stop #1)
• Set 'Allow Overwrite' to 'Yes'
• Click Import

4) NuWiki requires a forum to be used as the repository for Articles.

• You can create a new forum or use an existing forum.
• Notice that this forum must be used exclusively for NuWiki. If in doubt, create a new forum.

5) edit the selected forum, and change the setting 'NuWiki Mode for this Forum' to either 'Wiki' or 'Articles'.

• This will convert this forum into a 'NuWiki Forum'
• You can have as many NuWiki Forums as you would like.
• You can have forums and subforums marked as NuWiki Forums.
• You can set a NuWiki Forum to contain either Wiki Pages (can be edited by multiple authors) or Articles (can be edited by the creator only).

6) Go to Admin CP's Usergroup Manager, and verify that the different usergroups have the correct NuWiki permissions (edit, rollback, etc)

7) Go to Admin CP's vBulletin Options > NuWiki Settings, and configure NuWiki.
IMPORTANT: If your site is running a MySQL version earlier than v4.1.x, set "Enable the use of SQL Sub-Queries?" to 'No'.

8) Go to Admin CP's Styles & Templates > Style Manager and edit the template named navbar.

• Find the following lines:
  
  PHP Code:

               <if condition="$show['member']">
                <td class="vbmenu_control"><a href="usercp.php$session[sessionurl_q]">$vbphrase[user_cp]</a></td>
            </if> 

• And insert right before:
  
  PHP Code:

              <td id="nuwiki_links" class="vbmenu_control">
                <a href="#">NuWiki</a>
                <script type="text/javascript">
                    vbmenu_register("nuwiki_links");
                </script>
            </td> 

• At the end of the navbar template, add the following line:
  
  PHP Code:

              $GLOBALS[nuwiki_links_popup] 


9) If you would like to change the appearance of any element displayed by NuWiki, go to nuwiki.css, copy the corresponding class styles, and paste them in the nuwiki_headinclude template, between . Change the style as required. (Do not edit nuwiki.css, since it may be overwritten in a later upgrade).

10) Go to the newly created NuWiki Forum, depending on the settings selected in the Admin CP, you may need to create a new page to be used as the Main Page for your wiki.

Forum Headers

If you would like to use forum headers, you need to follow these steps:

1) NuWiki requires a NuWiki Forum to store Forum Header articles.

• This forum can be the same one used to store other NuWiki articles/wiki, or it can be a forum created solely for this purpose.
• This forum can be hidden from the Forum Home list by setting its 'Forum Is Active' setting to 'No'.
• This forum has to be a 'NuWiki Forum' in Wiki Mode.

2) Go to vBulletin Options > NuWiki Settings, and enter this forum's id into the setting titled 'Forum Id where Forum Headers will be stored?' (In this example, 239 is the Forum Id, change this to the Id of the forum you choose).



3) Then configure Forum Header options. You can show Forum Headers in the FORUMDISPLAY, or in addition, in the SHOWTHREAD page. This can be configured by changing the NuWiki setting labeled 'Enable NuWiki Forum Headers in SHOWTHREAD?'. If set to 'Yes', Forum Headers will be shown in both FORUMDISPLAY and SHOWTHREAD. If set to 'No', Forum Headers will be shown in FORUMDISPLAY only.



4) If you configure NuWiki to show Forum Headers in both FORUMDISPLAY and SHOWTHREAD, you can have one Forum Header per Forum, which will be shown in both places. In some cases you may want to have a somewhat detailed Forum Header in FORUMDISPLAY, and a less verbose Forum Header, with different content, in SHOWTHREAD. To accomplish this, you need to tell NuWiki to store SHOWTHREAD Forum Headers with a different name.



5) Finally, we need to make some small changes to the FORUMDISPLAY template (optionally to SHOWTHREAD as well):[list][*]Go to Styles & Templates > Style Manager[*]In the style that you would like to change, find and edit the FORUMDISPLAY template.[*]Find this line:

PHP Code:

<table class="tborder" cellpadding="$stylevar[cellpadding]" cellspacing="$stylevar[cellspacing]" border="0" width="100%" align="center" id="threadslist">
<tbody>
$announcebits 


[*]And right before, insert the following line:

PHP Code:

$GLOBALS[nuwiki_forum_header] 


[*]Click save.[*]If you would like to show Forum Headers in the SHOWTHREAD template, find the following lines in the SHOWTHREAD template:

PHP Code:

<if condition="$show['inlinemod'] AND $show['popups']">
    <div class="vbmenu_popup" id="imod_menu" style="display:none" align="$stylevar[left]">
        $threadadmin_imod_menu_post 


</div>[*]And right before, insert the following:

PHP Code:

$GLOBALS[nuwiki_forum_header] 


[*]Click save. And test the forum headers.[*]You can change the default yellow background for the Forum Headers by editing the template named nuWiki_headinclude, and changing the corresponding color.
6) And finally, we turn Forum Headers on by setting 'Enable NuWiki Forum Headers' to 'Yes':

Upgrading NuWiki

If you are upgrading an existing installation of NuWiki, follow these steps:

1) Go to Plugins & Products > Manage Products and next to the NuWiki product select 'Disable' to disable the NuWiki Product.

2) Follow all the steps listed in the Installation section above.

3) Go to Plugins & Products > Manage Products and verify that the NuWiki product is enabled (enable it, if this is not the case).

Configuring NuWiki

After you have installed NuWiki, you should proceed to configure it:

• NuWiki Admin CP
• NuWiki Forum Manager Settings
• NuWiki Usergroup Permissions