Use wiki articles to store information for project documentation, knowledge bases, policies, and procedures. Wiki articles often contain information that is not dependent on the time it was published and act as reliable reference points for your users.
Wiki articles live in wiki channels and can be aggregated using a Wiki Index widget.
Sections in this article:
Considerations and caveats
If you are creating articles on a channel that follow a consistent structure, consider setting up channel templates to pre-populate the body of new articles with the recurring elements to save time. For more information, see Templating channel contents.
Whenever you make updates to a wiki article, the saved changes are stored in a new version of the wiki article. You can then make comparisons between versions, or revert back to a previous version. For more information, see Version control.
Creating wiki articles
You can start creating a wiki article in a couple of different ways (you require at least write access to a wiki channel to be able to add content to it):
- Go to a wiki channel and select + Add an article.
- On the Userbar, select Add Content followed by Wiki Article.
- On a Wiki Index widget configured to show an add link, select + Add an article followed by a channel that you want to post on.
- On an Add Button widget configured to post to a wiki channel, select + Add an article.
- Email content to the wiki channel. The channel must be configured to allow emailed content. For more information, see Add Content via email.
Except for the email method, the different options above will bring you to the Add Article page, where you can craft your wiki article. You can find more information about the various fields and settings in the Options section of this article.
After you have finished crafting your article and configuring its various options, you can select:
- Save as Draft: By saving the article as a draft, you can return to editing it later or add additional authors. For more information, see Drafts and Ghostwriting content.
- Publish / Send to Moderator: Add the article to the selected channel. If the channel has moderation enabled, the article will only get posted after being approved by a moderator. For more information, see Moderation.
Enter a name for the article. This name will appear above the article and will also be used to generate a unique URL. This field is required.
Select which channel you want to publish to. When you start the content creation process from a widget or channel, the Channel field defaults to the channel you selected or were on. In contrast, creating content using the add button on the Userbar results in the Channel field being blank. In all cases, you have the option to select a different channel. This field is required.
To select a channel:
- Select the Channel drop-down.
- Search for a channel by its name or the name of its parent page or space. This search will return up to 100 results. You will only see channels to which you have at least Write access and their parent page or space (regardless of access level).
- Select a channel from the list.
Enter an overview of the article. This will be displayed in plain text above the main body of the wiki article. Summaries have a maximum size of 2048 characters.
Enter the body of your article. For more information about the available tools, see WYSIWYG Editor.
Drag files from your computer into the attachments field, or select Select files from your computer to browse your computer. Attachments will appear directly below the body of your published article and will be available for download. For more information, see Attachments.
Select what labels to apply to your article. You may be required to select a label depending on how the channel is configured.
To add a label, select the label drop-down and search for the label that you want to add. Once you have found it, select it to apply it to your article.
For more information, see Labels.
Search for content to add as related. For more information, see Related content.
Select what groups to broadcast the article to. Which groups you can select, if any, is determined by roles. For more information, see Broadcasting and Roles.
Toggle whether users can post comments on the article. For more information, see Comments.
Schedule your article to be published at a future time. For more information, see Scheduled content.
Select an archiving policy for your article. For more information, see Archiving.
Select whether your article has read tracking enabled and customize the text of this button. For more information, see Read tracking.
Languages & Translation
Select to change which language version of the article you are looking at. For more information, see Languages and Translation.
Select a language to Translate from and a language to Translate to, and then select Translate. The title, summary, and body of the initial language will be translated into the selected language. The language you are currently viewing will change to the one that you translated to.
Translated fields will have a verify checkbox appear under them. Check this box after having read the translated content and verified its accuracy. This can be used as a method of auditing whether the translated text was reviewed.