Introduction

The XPages Documentation Wiki was created for the community to contribute articles and for a writing team to publish documentation. The XPages Documentation Wiki is based on the XPages Wiki template available on OpenNTF and it has been expanded to add more features, many of which to support publishing documentation. The future of these two templates is being discussed but for now both templates will be available on OpenNTF.

Base features

This wiki template includes the following base set of features:

• Notes and Web based editing (using Notes/Web Rich text, HTML or wiki markup)
• Version history and control (Notes only so far for rollback)
• Wiki Markup
• Forward Linking (if page does not exist it can be generated, enabled through wiki markup)
• Automatic Table of Contents (enabled through wiki markup)
• RSS Feeds for recently added and edited content and for comments
• Tags and tag cloud
• Categories (and ability to format each category page differently)
• Comments section on each wiki page

Additional features

This wiki template includes the following additional features:

Web application features

Banner

• Includes logos and title of wiki.
• Includes User name, Log on, Register, and help link.
• Uses a tabbed user interface that connects to specific categories in the wiki: Home, Product Documentation, and Learning Center.
• Includes various views of all articles in the wiki, including Recently added, Recently edited, Alphabetical, and By author.
• Includes Simple Search.
• Includes Advanced search with the ability to scope by category or tag.
• See Modify wiki banner and footer to customize this.

Left column

• Includes quick way to access the Media Gallery from the left column of the site. This also shows the total number of documents in the Media Gallery category.
• Includes standard catetgory list on the Home tab.
• Provides ability to create a custom navigation for the Product Documentation tab.
• Includes standard category list on the Learning Center tab.
• See Creating documentation navigation to create the custom navigation for the Product Documentation tab.

Home page

• Includes a dismissible welcome / learn more box. This can be brought back by deleting the wikiBlueBox cookie.


• Includes a standard home page that includes an areas for welcome text and a four column layout for grouping different types of key information.
• Includes Spotlight articles feature, in the first column, which lets you highlight important articles that you want to point out to users.
  
• Includes an actions toolbar at the top of all pages to group actions such as Add an article.

Footer

• Includes five columns for links including Featured communities.
• See Modify wiki banner and footer to customize this.

Views

• Includes contributor icon feature that can be customized in your implementation.
• Includes ability for users to select different views on home page and category pages for recently added, recently edited, by author, and more.
• Includes ability to change the number of articles that appear in a view. Users can choose from 10, 25, 50, or 100.
  

Articles

• Includes an actions toolbar at the top of all pages to group actions such as Add an article, Edit article, and Print.
  
• Includes Current editable edition and Original noneditable edition toggle labels for articles with content type of Product Documentation.
• Includes an abstract field for authors to summarize the article. This shows in the views. If no abstract is entered the first characters of the body appear in views.
• Includes Article information section and it is always expanded and shows the version, date, time, and author of the original and latest version of the article.
  
• Includes message stating attachments are limited to 10MB and the following file types: jpeg, gif, png, pdf. This is a server setting but there is text in the user interface to guide users to these limitations.
• Includes Versions section and shifted the logic to show the date the article version was saved. Also updated layout to be easier to read.
  
• Includes a field for users to add a summary of the changes they made. This is saved and shown in the Versions section.

Notes client features

• Includes article preview feature.
• Includes article drafting where articles can be created and saved in draft and not published on the web site.
• Includes form to configure the home page content and navigation for the Product Documentation tab.
• Includes ability to view all versions of an article, found at the bottom of the article.
• Includes views, such as Recently Added by Category and Recently Edited by Category.
• Includes metrics views to see the numbers of creates, edits, and comments as well as who is contributing.

Differences between XPages Documentation Wiki and Lotus Product Wikis

This wiki template is based on the Lotus product wikis. However, this template does not include all of the features you might find in the Lotus Product wikis. Some features will be shared in the future and other features are IBM confidential. Here is a list of some of the features that are in the Lotus product wikis but not in the XPages Documentation Wiki:

• Re-sizable navigation (future)
• User profiles (future)
• Mobile interface (future)
• Ratings (reviewing for future inclusion)
• Version comparison (reviewing for future inclusion)
• Share articles on social network sites (reviewing for future inclusion)
• Custom home page and Learning Center navigation (reviewing for future inclusion)
• Machine Translation