How to Add a Wiki to a Category
All How-To Guides
Overview
A wiki page is used for documentation that is not procedural (think text-heavy). Use wikis to convey general information in a flexible format, like a troubleshooting page or a Material Safety Data Sheet.
Below is an example of what a typical wiki page might look like:
Creating a Wiki Page
To create a wiki page, go to the New Page Creator and select Wiki. You will be prompted to enter a title for the wiki.
Once you select a name, click Next to open the editing interface for the wiki page .
Parts of a Wiki Page
Title
The title is the name by which a wiki is known, and it is the way that people find a wiki in a search.
The following special characters cannot be used in a wiki title: # < > [ ] | { } , + ? & / \ % : ; $ ^ * and tab.
Title Nickname
The Title Nickname field is automatically filled with the name that was provided when the page was first created. You can change the title nickname to update the page title that appears when users see the wiki on the site. However, changing the title nickname will not change the title in the URL for the wiki page.
Summary
Summaries provide a brief idea of the wiki's content and purpose. They show up on searches and underneath the wiki image. They are very useful for identifying a wiki.
Typical content in a summary includes the date of release, important specifications, and possibly an ID number.
Header Image
Images help users recognize the topic of a wiki. Since the image will often be viewed as a thumbnail, it should be simple and free of clutter.
Attaching the wiki Header Image is quite simple. Once an image is Uploaded to the Media Manager, click on the thumbnail of the image, and it appears where the gray image placeholder had been.
Body Images
Images can also be put in the Additional Information text box on the wiki page.
Change the size and alignment of the images by using Wiki Syntax
Wiki Image Dimensions
Like guides, wikis automatically scale images up or down to fit within page formatting. Unlike guides, wikis do not default to an 800x600 frame, so images within a wiki can be different dimensions.
For example, here is the same 800x442 image, uploaded without resizing, in both a guide and a wiki.
Permissions Manager
| This section is only applicable to sites with public editing enabled. |
If the user attempting to edit a wiki has a substandard reputation, the Permissions Manager prohibits automatic acceptance of edits to pages. Use the slider in this field to set the amount of reputation required to edit the wiki page. Check out these other pages for complete breakdowns on Reputation and the Permission Manager.
Tags
Tags act similarly to any other tags; they increase search popularity by including extra words that many would think of in relation to that wiki, even though they may not be a part of the title.
To add a tag, locate the Tags field in the wiki editing interface. Type in the tag that you want to add, and then click Add. Once you are finished, click Save Tags, and those tags will be applied to your page.
Additional Information
Wiki pages are free-format, which means that you need to know a little bit of code (Wiki Syntax) to edit your page. All of the information on this page will be entered in the Additional Information text box.
The image below is an example of an Additional Information text box in a wiki that conveys safety information.
Refer to the wiki below for all the information that you will need to get started.
You can also embed other forms of media right onto your wiki page, including videos, Google Docs, and LucidChart presentations.
Naming Wiki Pages
Wiki titles in the Dozuki platform function as persistent, unique identifiers. When you create a wiki in Dozuki, the wiki title also generates the URL for the wiki page. The title and URL remain consistent—no matter how many times authors edit the page. This title and URL consistency allows users to find the correct document.
Since wiki titles function as unique identifiers, we recommend making wiki titles as specific as possible. For example, if you want to create a "Troubleshooting" wiki for both your ACME forklift and ACME pallet jack, consider creating a wiki titled "ACME Forklift Troubleshooting" and one titled "ACME Pallet Jack Troubleshooting." This specificity helps to ensure that individual users can find the most relevant content to their department and role. If you want to create shorter titles or multiple wikis with the same title, use a display title. Display titles allow you to create an alias for that wiki without changing the URL or original title.
Creating Aliases With Title Nicknames
Dozuki allows users to create aliases for categories and wikis. We call these aliases Title Nicknames. Authors and Admins can use display titles to show users an alternate title for a given category or wiki. The title nickname will show up on the header, breadcrumbs, and thumbnail, but the official title and URL for the page will remain unchanged. This flexibility allows Authors to use persistent, unique identifiers for each category and wiki while providing the option to use shorter titles, alternate titles, or even duplicate titles in the title nickname.
Editing a Wiki Page
To edit a wiki page, click on the Edit tab in the upper-right of the page. The edit page for that particular wiki appears, and all of the text, pictures, and formatting can be edited and arranged on this page.
Wiki Page History
A wiki's history shows you the entire timeline of changes to that wiki. To see the history of a wiki, click on the Options three dot menu in the upper-right corner of the wiki. Select History from the drop-down menu. From here, you can view all of the recent editing activity on a specific page.
History
The main section of this page is the recent history; it lists all of the recent edits that have been made to the page.
- You can click on any of the edits in blue, and it will link to a page showing exactly what was changed.
- The name to the right of the edit tells who made it.
- Clicking their name sends you to their profile page.
- Profiles with diamonds to the right of their names are Administrators.
- Some edits have lines through them and say "denied" in parentheses. The lines indicate edits that were made and then denied using the Permissions Manager.
Organizing Wikis
To organize a wiki page, go to the Related Category field in the editing interface, type in the name of the category under which the wiki should be organized, and click Save.
Note: This section appears only after you have saved the page once. The wiki page will appear under the Related Pages section of the chosen category.
