Surgical Planning Laboratory - Brigham & Women's Hospital - Boston, Massachusetts USA - a teaching affiliate of Harvard Medical School

Surgical Planning Laboratory

Wiki 2 Web

Introduction

This page is in an early stage of development. Wiki2Web (W2W) is a content management system for small and medium sized websites developed by Kitware under contract with the SPL and some of its affiliated programs and projects. The software is based on Media Wiki and leverages the sophisticated revision control capabilities of that software. It consists of a number of php programs running on top of a generic media wiki installation.

From the end users point of view, w2w provides ease of use of editing a wiki in combination with sophisticated appearance based on specialized skins that lend the appearance of conventional webpages to the final product. The content creation is based on a self service model with a curation step built in.

SPL W2W converter interface
The SPL hosted w2w infrastructure
The SPL hosted w2w converter interface with multi-level hierarchy.


WikiToWeb Help for End-users

Overview

WikiToWeb allows you to create a read-only web page from the content of a normal, editable wiki. If you are unfamiliar with the concept of a wiki, see this site. WikiToWeb was created to provide users with an easy way to manage the contents of a web site. The pages created in WikiToWeb tend to be more static and permanent than normal wiki pages, since only a select group of people can commit changes. Many people are more comfortable creating and updating wiki documents as opposed to maintaining a website consisting of HTML files. For those individuals, the WikiToWeb format is ideal.

Terminology:

  • Wiki Pages - Pages from a normal (editable) wiki that we want to copy into a static, read-only web site.
  • Web Pages - Final destination for the data copied from the editable Wiki. Like Wiki Pages, this is also an installation of mediawiki, but the permissions have been stripped down so that pages can only be edited through the WikiToWeb interface.

Editing help

Links

As articles are committed to the web, page prefixes are automatically converted in wiki links. For example, let's say that all your wiki pages have a prefix of "Web:", and your web pages use a prefix of "Pages:". If you created a link from "Web:Page One" to "Web:Page Two" on the wiki pages, the link would be changed to point to "Pages:Page Two" when you committed page one to the web.

  • An example for the splweb wiki pages: all splweb wiki pages use a prefix of "". To create the link to the "Visiting" page, you need to type [[Visiting]]. When this is committed to the web, the link will automatically be updated to use the prefix that is in place on the web side.
  • An example for the nac wiki pages: all nac wiki pages use a prefix of "Projects/NACWeb:". To create the link to the "Overview" page, you need to type [[Projects/NACWeb:Overview]]. When this is committed to the web, the link will automatically be updated to use the prefix that is in place on the web side.
  • An example for the slicer wiki pages: all slicer wiki pages use a prefix of "Projects/slicerWeb:". To create the link to the "Introduction" page, you need to type [[Projects/slicerWeb:Introduction]]. When this is committed to the web, the link will automatically be updated to use the prefix that is in place on the web side.

Images

If you create a page with images, it will be represented by a folder icon under "List All Pages". Clicking on the folder will open it up, showing the image file(s) that are on the page. Click the "commit to web" checkboxes for both the article and the image, and then click the commit button. This will upload the image into the web page and create a link to it. The resulting web page will have the same layout and content as the wiki page you just created.

Inserting a reference to a paper in the publications database

  • The link in the sidebar should be:
    • xxx/Special:Publications/filter
    • Where where "xxx" is the url and "filter" is the word you want to search.
  • To reference a specific paper on a page or in a figure caption
    • Special:PubDB_View?dspaceid=yyy
    • Where yyy is the dspace id number of that paper
  • To reference the gallery with a filter use xxx/Special:PubDB_Gallery?sponsors=xxx
    • e.g. Special:PubDB_Gallery?sponsors=005149 will filter for NA-MIC

Wiki Page features

  • Show Page - This will bring you to the "main page" of the content section of the editable wiki. For example, if WikiToWeb has been configured to copy all pages with a prefix of "Web:", then Show Pages will bring you to the wiki page entitled "Web:".
  • Login - This brings you to the login form for the wiki pages. Some wikis are setup so that you must be logged in to edit pages. If this is the case with your wiki, you should login before attempting to make any changes to the wiki pages.
  • Add New Page - This link will first ask you for a new page's title, and then bring you to a form where you can create this new page in the wiki. Remember to login first if your wiki requires this.

Web Page features

  • Show Page - Similar to "Show Page" in the Wiki Pages section, this link will take you to the main page of the Web Pages that you're copying content into. For example, if you're copying content into a section called "Pages:", then Show Page will bring you to the page titled "Pages:" in the Web Pages.
  • Edit Side Bar - This link brings you to a form where you can edit the appearance of the side bar of the Web Pages. The Side Bar is a list of links that appears on the left of every page in the Web Pages.

List All Pages

This link will show you a table comparing all relevant articles in the Wiki Pages and the Web Pages. Based on the state of your Wiki Pages and your Web Pages, List All Pages will report a different status for each individual article.

  • new: This means that the article exists as a Wiki Page, but it hasn't yet been created as a Web Page. List All Pages presents you with an option to commit this page to the web in this case.
  • diff: This means that the article exists in both the Wiki Pages and the Web Pages, but that their contents do not match. Again, List All Pages will present you with an option to commit your changes to the Web Page.
  • same: This means that the article exists in both the Wiki Pages and the Web Pages, and that their contents are identical. Unless you make further edits to the Wiki Page, no further action is necessary for this article.

List All Pages also presents you with a couple more options.

  • Show all pages / Show edited pages - Clicking on Show all pages will cause all pages to be displayed, even those whose contents are up-to-date. Clicking on Show edited pages will make it so the only pages that are displayed are those whose contents have not yet been committed to the web.
  • Commit to Web - Update the Web Page for a given article so that its contents match the corresponding article in the Wiki Pages.
  • Difference - Show the difference between the Wiki Page version and the Web Page version for a given article.
  • Edit Page - This link allows you to make changes to the Wiki Page version of an article.
  • Show Wiki Page - This will show you the current Wiki Page version of a given article.
  • Show Web Page - This will show you the current Web Page version of a given article.

Provisoning a Webserver with W2W infrastructure

Bob can add more to this if it seems incomplete.

To use Wiki 2 Web you need to be able to successfully install MediaWiki. See this page for more information:

http://www.mediawiki.org/wiki/Install

In addition, you also need to install the following software:

Wiki2Web architecture

  • The system consists of
    • An instance of MediaWiki which allows editing and managing content using MediaWiki infrastructure. This wiki is typically not visible to the outside world.
    • A second wiki with a special skin that does not allow editing in general and mimicks the appearance of a regular website.
    • A set of scripts to allow review and curation of edited pages and editing of the sidebar. Approved changes can be committed to the external website.

Where to get the software

Warning: this software is currently unsupported and provided as is with no guarantees or help.

Here's how you can download the source code:

svn co https://www.kitware.com:8443/svn/BWSoftware/trunk/AdminScripts

After that run Setup.py, ignore any questions about MailMan & Subversion, and then run MakeWikiWeb.py.

Retrieved from "/pages/Wiki2Web"