To Get Started:
Start by reading the Installing Plugins section in our comprehensive WordPress and WordPress Multisite Manual if you are new to WordPress.
- Download the plugin file.
- Unzip the file into a folder on your hard drive.
- Upload the /wiki/ folder and all its contents to the /wp-content/plugins/ folder on your site.
- Login to your admin panel for WordPress or Multisite and activate the plugin:
- On regular WordPress installs – visit Plugins and Activate the plugin.
- For WordPress Multisite installs – Activate it site-by-site in Plugins in the site admin dashboard (say if you wanted to make it a Pro Sites premium plugin), or visit Network Admin » Plugins and Network Activate the plugin.
Please note that default permalinks will not work if you are upgrading from Lite to the Full version. You will need to enable Pretty Permalinks.
Configuring the Settings
Once installed and activated, you will see a new Wikis menu item in your site’s dashboard.
Go ahead and click on the Wiki Settings sub-menu now to configure the general settings of the plugin.
1. Customize the wiki slug.
2. Enter the number of breadcrumbs you wish to have displayed.
3. Customize the labels for your wikis.
4. Select how your wikis should be ordered.
5. Set the user permissions.
The Wiki Slug is what appears in the URL of the users browser. You can change this to whatever best suits the content of your site’s wiki.
The Breadcrumbs setting allows you to customize the appearance of the breadcrumb trail that displays beneath the wiki title.
The What do want to call wikis and What do want to call sub-wikis settings adjust the labels that appear in the breadcrumb trail, and the list of sub-wikis that displays beneath every wiki.
The How should Sub-Wikis be ordered setting has 3 options to select from:
- Menu Order/Order Created will display the sub-wikis exactly as they appear in your wp-admin. You can fine-tune this just like you can with your WordPress pages by entering a numerical value in the Order attribute field when creating/editing a wiki or via Quick Edit.
- Title will display your wikis alphabetically according to their title.
- Random is, well, random :)
What order should Sub-Wikis be ordered enables you to set the order as Ascending or Descending depending on what you had selected in the previous setting, and if you create a numerical order for them in the attributes. Note that this will have no effect if you had previously selected the Random option.
The Wiki privileges setting is so that you can select the user roles who are allowed to set editing privileges. Note that this only affects the front-end setting; if your users have access to your site’s dashboard to create wikis, they can change the editing setting there.
That is it for settings, honestly we are set to go!
In the admin you can find a list of already created Wikis, if you have none yet then of course it would be empty for now but I’m sure it will not take long for your to fill it up ;-)
Wikis > Wiki
As you can see from the screenshot, when hovering over an item you get further options to edit, quick edit, trash and view. Those are standard WordPress standard features so we won’t go over them again. :-)
Adding A Wiki
You can either click on Add Wiki from the page just mentioned or directly from the Wikis Menu:
Adding a new wiki is as simple as going to Wikis –> Add Wiki
You should be use to this part by now, its all WordPress baby! :-)
Here’s a quick overview of the Wiki Editor inside the dashboard
Just like WordPress, do you want to allow comments? This allows your users to discuss wiki articles.
Wiki privileges are about who you want to be able to edit your wikis.
There are 4 options:
- Anyone – Regardless of whether they are registered or not. (front end editor)
- Network Users – Anyone within your WordPress Multisite installation if enabled (front end editor)
- Sites Users – Only people with a role on the given website. (front end editor)
- Users who can edit posts – This restricts the permissions to only those with a role which would permit them to edit a normal WordPress post. (front end editor and advanced editor)
Not sure about roles? No worries, check out our article here.
Wiki E-mail Notifications
This allows people to subscribe for notifications of any changes to a given wiki article.
Allows you to change who the author is. (Yup another standard WordPress feature built right in!).
Lets you select its status, if its public or not and when the article should be published.
Just add and check which categories are relevant to the the particular wiki article you are writing or editing.
Add the relevant tags for your wiki or select tags that have been used previously.
You can select whether the article is a child of another published previously. You can also set the order.
Just like WordPress posts you can also set a featured image. (How this displays is down to your theme)
Wiki categories are the same as managing categories on posts
You can manage and edit wiki categories from Wiki –> Wiki Categories
Just like all the other sections so far these should be real familiar to you (They exist in normal posts).
In here you can edit existing categories for the Wiki as well as add new ones:
You can add a full category name, slug and description in addition to setting a category as a parent or a child of another category. When done just click the Add New Wiki Category button
Very similar to the category section, except for tags.
You can manage and edit wiki from Wiki –> Wiki Tags
You can add, edit and view existing tags as well as popular tags:
As well as view popular tags:
The Front End Wiki Editor.
This was the test Wiki article I made earlier, its simple nothing complex but hey you could be adding images or anything you need really.
Here’s an overview of the front end wiki editor
This is of course the main page content you created.
The Discussion Tab
This will only show if you enable comments on this specific wiki article. This utilises the WordPress comments system to enable discussions so all those same rules apply here too.
The Discussion Form:
The discussion form uses the comment form.
The History tab allows you to see the revisions and also compare them just like in a wiki normally.
As you can see, you are able to restore or compare versions so that changes maybe reverted later.
Clicking on Edit allows you to edit the wiki article on the front end including options of who can edit it, whether or not email notifications are enabled along with the main body, category and tags.
Here’s other options you’ll see in Edit mode.
Clicking on the Advanced tab takes you directly to the admin area where you can edit the wiki inside your dashboard.
Create New Tab
Clicking on Create New allows you to create a wiki article from the front end.
There are four wiki widgets you can add by going to Appearance > Widgets:
The Wiki widget will display all your wikis according to your settings.
The Wiki Categories widget displays a list of all active wiki categories (categories with no wikis in them yet will not display).
The Wiki Tags widget simply displays a list of tags used in your wikis.
The Wiki Tag Cloud widget will display wiki tags in the ever-popular cloud format.
Here are some excellent examples of people using our Wiki plugin
You can find those members right here:
As always, jump on the forums start a new thread for you questions or issues and one of our support guys or gals will be right along! :)