You can 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 members.
Wiki articles live in wiki channels and can be aggregated using a Wiki Index widget.
Sections in this article:
Article layout
Wiki articles consist of the following components:
Area 1: Title section
The title section contains the following features:
- Breadcrumbs: Select links to go to a location.
- Wiki title: The wiki title.
Area 2: Space navigation
If the wiki is part of a space, this area contains the following features:
- Space navigation links: Select links to go to locations at the root of the space.
Area 3: Wiki header
The wiki header contains the following information and tools:
- Channel link: Select to go to the parent channel.
-
Follow: Select to subscribe or unsubscribe from email notifications about new articles being added to the parent channel.
- Article's last update: Displays the date the article was last updated and the author of the last edit. Members can select the author's name to go to their profile.
- Current Version: Displays the current version of the article. Members with at least Write access to the article can select this number to view and compare past versions.
- View Count: Displays the number of views on the article.
- Followers: Displays the number of followers. Administrators and members with at least Edit access to the article can select the number of followers to view who is following.
-
Actions: Only visible to administrators and members who have at least Write access. Actions button.
- Publication details: Displays the article's original author and publish date. Members can select the updater's name to go to their profile.
- + Add an article: Select to create a new article. Only visible to administrators and members who have at least Write access to the parent wiki channel.
- Labels: Displays any labels applied to the article. Select a label to search for other content with that label.
Area 4: Content section
The content section contains:
- Table of contents: If turned on, displays an automatically generated table of contents from the H2 HTML elements in the article. This option is not available for the home article.
-
Body: Displays the article's description. If the table of contents is turned on, the
Top of Article button will redirect members to the top of the article.
- Read Tracking: If turned on, select to respond to a Read Tracking prompt.
- Follow: Select to subscribe or unsubscribe from instant notifications about comments and edits to the article.
- Copy link: Select to copy the article's URL so that it can be pasted elsewhere.
- Article attachments: Select to open an attached file.
Area 5: Comments and Related Content tabs
You can alternate between these tabs to view and interact with their content. See Comments and Related Content.
Area 6: Tasks
If turned on, you can create tasks on the article, see Tasks.
Area 7: Trailer bar
The Trailer bar contains the following:
- View count: Displays the number of views on the current location.
-
Follow: Select to subscribe or unsubscribe from email notifications about new articles being added to the current location and set the frequency of these notifications.
- Email Link: Select to draft an email that contains a link to the current location.
- Broadcast: If turned on in the workplace, select to send, schedule or cancel a broadcast to this location to selected workplace groups. See Broadcast.
- Feedback: If turned on in the workplace, select to send a feedback message to workplace administrators. See Feedback.
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 display 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 or Send to Moderator: Add the article to the selected channel. If the channel has moderation turned on, the article will only get posted after being approved by a moderator. For more information, see Moderation.
Options
These options are available when creating or editing a wiki article:
| Option | Description |
|---|---|
| Title | 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. |
| Add Table of Contents |
Turn this feature on to automatically generate a table of contents featuring Header 2 or H2 sections. The Table of Contents will appear above the content section in the wiki. Beside each H2 section, the To mark items as "Header 2" in the WYSIWYG editor:
This option is not supported for the home wiki article. |
| Channel |
Select which channel you want to publish or move content to. When the content creation process starts 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. |
| Description | Enter the body of your article. For more information about the available tools, see WYSIWYG Editor. This field is required. |
| Attachments |
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. When attaching files, a security scan will automatically run to ensure the safety of your content. After the scan is complete, you will see a color-coded text indicating the file's status:
Ensure your files are safe and readable before uploading to avoid any issues. For more information, see Attachments. |
| Labels |
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:
For more information, see Labels. |
| Option | Description |
|---|---|
| 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. |
| Broadcasting: Text | Enter the content to be included in the broadcast notification. |
| Commenting | Toggle whether members 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 turned on and customize the text of this button. For more information, see Read tracking. |
| Option | Description |
|---|---|
| Current language | Select to change which language version of the article you are looking at. See Languages and Translation. |
| Translate |
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. |