Wiki Index widget

The Wiki Index widget is like a table of contents for wiki channels – it displays a list of the wiki articles in the channel. The articles are displayed alphabetically, and an index bar at the top allows you to quickly jump to a section of the index, by letter.

The Wiki Index widget is used to display the contents of a wiki channel, or multiple wiki channels in a way that’s easy for members to navigate. For example, you can house a variety of “How-to” wiki articles in one place, categorized alphabetically, so members can easily find the answers they are looking for.

A Wiki Index widget displaying a list of articles from an Employee Policies wiki.

Sections in this article:

Set up

Follow these steps to set up this widget:

  1. Place a Wiki Index widget on a page, space, or dashboard. For more information, see Placing and setting up a widget
  2. Select the placed widget's Edit button.
  3. Review and make changes to the settings on the Options, Layout, and Appearance tabs. You can find details about the widget's settings in the Settings section below.
  4. In the widget editor, select Update to apply your changes or Cancel to discard them.  
  5. At the bottom of your page, space, or dashboard, select Publish or Save as Draft to save your changes.

Settings

Setting Description
Title Enter a title for the widget. The title appears as a heading above the widget's contents. You should use the title to provide context to the widget and better structure a page's content by clearly denoting different sections.

When entering a title, you do so only for your currently selected language. If your digital workplace supports multiple languages, you should select  Translation and enter a title for each supported language.  

This field can contain a maximum of 140 characters.
Title Link

Enter the URL of a location in your digital workplace. Users who select the widget's title, if it has one, will go to this location. Whether you enter the link as a relative URL or an absolute URL does not matter, it will convert to an absolute URL the next time you edit the widget.

Description

Enter a description for the widget. The description appears between the title and the widget's contents. You can use this text to provide information to users about the widget.

When entering a description, you do so only for your currently selected language. If your digital workplace supports multiple languages, you should select  Translation and enter a description for each supported language.

Source(s)

Select which wiki channels to display. 

Access Rules determine what users will see when configuring and viewing the widget: 

  • Users who are configuring this widget will only see channels to which they have at least Read Access. Users can still select wiki channels that they don't have access to by selecting groups of wiki channels (see step 4 of "To add sources" below).
  • Users who view the published widget will only see content from a wiki channel if they have at least Read Access to that content.

To add sources:

  1. Select add source(s).
  2. Select the Wikis tab.
  3. Search for a wiki channel by its name or a portion of its URL. This search will return up to 100 results and include the pages and spaces that contain a wiki channel that matches the search query.
  4. Select a wiki channel from the list of search results. In addition to selecting sources individually, you can select groups of wiki channels:
    • Select the All option to select all wiki channels in your digital workplace.
    • Select pages or spaces to select all wiki channels that are nested below this location.
  5. Repeat this process until you have added all your sources, and then select Done.

To remove sources:

  1. Select add source(s).
  2. While on the Selected tab, unselect the source(s) that you want to remove.
  3. Select Done.
Show add link Select to add an Add Article button to the widget. Only users with at least Write Access to any of the connected wiki channels can see this button. Users can click this button to add content to wiki channels to which they have at least Write Access.
Options tab
Setting Description
Layout

Select how the widget displays wiki articles. Options include:

  • Standard: Displays a letter index followed by all wiki articles in alphabetical order. Selecting an index letter will take the user to that section of articles in the widget.
  • Letter Index: Displays a letter index. Selecting an index letter will display a dropdown of articles in that section.
Actions Button

This option is only available if the Layout setting is set to Standard.

Select to display an Action Button for each article. Users with the appropriate access can use this button to quickly make changes to an article from the widget.

Channel

This option is only available if the Layout setting is set to Standard.

Select to display the name of and link to the channel where a wiki article resides.

Modified by

This option is only available if the Layout setting is set to Standard.

Select to display when a wiki article was last updated.

Version

This option is only available if the Layout setting is set to Standard.

Select to display wiki articles version number and link to compare the two most recent versions.

Space

This option is only available if the Layout setting is set to Standard.

Select to display the name of and link to the space where a wiki article resides.

Body

This option is only available if the Layout setting is set to Standard.

Select how much of an article's body is shown. Options include:

  • Don't show body text(leftmost slider position)
  • Between 50 to 650 characters in increments of 50 characters.
  • Show full body text (rightmost slider position)
Read More

This option is only available if the Layout setting is set to Standard.

Select whether a Read More link displays on articles. When a user selects Read More they will go to the related article. Display options include:

  • Off: The leftmost slider position. Don't display the Read More button.
  • Contextual: The middle slider position. Display the Read More button only when there is additional body text.
  • Always on: The rightmost slider position. Always display the Read More button.
Comments

This option is only available if the Layout setting is set to Standard.

Select to display the number of comments on a wiki article. Users can select this to go to the comments section of the associated article.

Views

This option is only available if the Layout setting is set to Standard.

Select to display the number of views on a wiki article.

Layout tab
Setting Description
Class Enter CSS class selectors to provide additional styling to the widget. For more information, see Applying custom CSS to widgets.
Height Select the height of the widget. Options include:
  • Auto:The leftmost slider position. The height of the widget will increase and decrease to contain what it is displaying.
  • Fixed: Select a fixed height between 50px to 600px in increments of 50px. A vertical scrollbar will appear on the widget if the content exceeds this fixed value.
Appearance tab

Note

Your digital workplace's theme overwrites many of the settings on the Appearance tab. However, the settings listed above are usable.