Potential Documentation Platforms

The Fluid community is planning to move the Infusion documentation out of Confluence to a new platform. This page is a worksheet for summarizing evaluations of the various options being considered.

This table is a work in progress.

 

Confluence

MediaWiki

MindTouch Deki

Drupal

WordPress

DocBook/ DITA

Markdown (or similar)

Sphinx

Description

wiki

wiki

wiki

CMS

XSLT transformation of XML

XSLT transformation of XML, very structured

structured mark-up, very simple

reStructuredText & DocUtils, more structured

Used by

Infusion

Handbook

MDN

Drupal

jQuery

php.net

 

Django, Python

Must-Have Requirements

Confluence

MediaWiki

MindTouch Deki

Drupal

WordPress

DocBook/ DITA

Markdown (or similar)

Sphinx

documentation must be accessible and transformable (output should be HTML styled using CSS)

(error)

(tick)

(warning)
Cursory Jaws test ok

(tick)

(tick)

(tick)

(tick)

(tick)

anyone (on the core team or in the community) can contribute to the documentation

(tick)

(tick)

(tick)

(tick)

(tick)

(warning)
source in Git: XML schemas

(warning)
source in Git: wiki-style markup

(warning)
source in Git: wiki-style markup

the authoring interface must be accessible

 

 

(warning)
uses FCKEditor? cursory Jaws test NOT ok

 

(warning)
cursory Jaws test ok

(warning)
can use any editor, but actual XML editor might be best

(tick)

(tick)

we can embed components/JS in the documentation to allow working examples

(tick)

 

 

(warning)
using <script> tags in the head

(warning)
using <script> tags in the head

(warning)
using <script> tags in the head

(tick)

(tick)
can embed raw HTML in page

there must be a means to have a "staging area" where docs can be written, updated etc. before becoming publicly available

(warning)
entire space can be cloned

(error)

 

(warning)
entire copy of drupal site can be cloned

(tick)
staged in WordPress, converted to HTML for "publication"

(tick)
source in Git, public docs would be generated from source

(tick)
source in Git, public docs would be generated from source

(tick)
source in Git, public docs would be generated from source

Would-be-nice Requirements

Confluence

MediaWiki

MindTouch Deki

Drupal

WordPress

DocBook/ DITA

Markdown (or similar)

Sphinx

the platform should be open source

(error)

(tick)

(tick)
GPL & LGPL

 

(tick)
GPLv2

(tick)
MIT-style

(tick)
BSD-style

(tick)
Python license

documentation can be versioned to match numbered releases

(warning)
using separate spaces

(warning)
maybe using namespaces?

 

(error)

(tick)

(tick)

(tick)

(tick)

anyone can comment on or discuss the documentation (e.g. comments on Confluence pages, "discuss" pages in wikipedia)

(tick)

(tick)

(tick)

(tick)

(tick)

(error)

(error)

(error)

pages can be tagged

(tick)

(tick)

(tick)

(tick)

(tick)
using a plugin

(error)

(error)

(error)

documentation can be made available in PDF

(warning)
export possible, but annoying

(warning)
possible, don't know quality of output yet

(warning)
possible, don't know quality of output yet

 

 

(tick)

 

(warning)
export to LaTeX, or using rst2pdf