Use wiki articles to store information for project documentation, knowledge bases, policies, and procedures. Wiki articles often contain information independent of when 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:
Wiki articles consist of the following components:
- Title section: Displays the title of the article and breadcrumb navigational links.
- Space navigation: If the wiki is part of a space, it displays links to locations at the root of the space.
Wiki header: Contains the following information and tools:
- Links to the Wiki Home and Title Index.
- Parent channel link and channel follow button.
- When the article was published.
- The author of the article. Users can select the author's name to go to their profile.
- The number of views on the article.
- The number of followers. Administrators and users with at least Edit access to the article can select the number of followers to view who is following.
- The current version of the article. Users with at least Write access to the article can select this number to view and compare past versions.
- When the article was last updated, and by who. Users with Write access can select Last Updated to view a comparison of the two most recent article versions. Any user can select the updater's name to go to their profile.
- The article's Actions button. Only visible to administrators and users who have at least Write access.
- The + Add an article button that users can select to create a new article. Only visible to administrators and users who have at least Write access to the parent wiki channel.
- Any labels applied to the article. Select a label to search for other content with that label.
Content section: Contains the following:
- The body of the article.
- If enabled, a Read Tracking prompt.
- A Like button.
- A Follow button.
- A Copy link button that copies the URL of the article so that it can be pasted elsewhere.
- Article attachments
- Comments and Related Content tabs: Users can alternate between these tabs to view and interact with their content.
- Tasks: If enabled, users can create tasks on the article.
Trailer bar: Contains the following:
- A view count.
- A Follow button that allows the selection of notification frequency.
- An Email Link button that creates an email containing a link to the article.
- A Broadcast button (for users in groups with the role), that allows users to send a notification to specific groups.
- A Feedback button that sends a message to all workplace administrators.
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 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.
These options are available when creating or editing a wiki article:
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 or move content 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:
|Summary||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.
|Related Content||Search for content to add as related. For more information, see Related content.|
|Broadcasting||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.|
|Commenting||Toggle whether users can post comments on the article. For more information, see Comments.|
|Future publishing||Schedule your article to be published at a future time. For more information, see Scheduled content.|
|Archiving||Select an archiving policy for your article. For more information, see Archiving.|
|Read tracking||Select whether your article has read tracking enabled and customize the text of this button. For more information, see Read tracking.|
|Current language||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.