OpenSolarisWiki

From Genunix

It may seem strange to write up a list of requirements for an OpenSolaris Wiki on a Wiki site dedicated to OpenSolaris. Get over it. :-)

Some emails were written recently discussing the requirements for an "official" OpenSolaris wiki attached to opensolaris.org.

Eric Boutilier and Michelle Olson each posted a list. We should first try to combine them together here without pruning anything.

OpenSolaris website project

The OpenSolaris organization has a "project" called "website" which is responsible for infrastructure improvements to opensolaris.org. Alan Burlison is involved in that project. Here are some resources related to the "website project":

Eric's list

OSI approved license
Easy to build/install/deploy
Easily indexed by the opensolaris.org search facility
Flexible look-and-feel (custom styles?)
Unicode support
Extensibility (APIs, etc.)
- Allow easy use of local text editor (e.g. vi or emacs)
- ...
Authentication and spam-prevention
- Authentication and authorization should utilize the opensolaris.org registration database
- LDAP
- ACL
- Page permission
Community Support
- Large, active online community (mailing list(s), IRC)
- Bug tracking
Usability
- Page history and revision diffs
- Tool bar
- RSS and Atom feeds
- File attachments
- Footnotes
- Page redirection
- Categories
- Name spaces
- Interwiki links
- Internal links (free links)

Michelle's list

Easy-to-use syntax for client interface
Must be 508-ready for accessibility
Spam filters
Wiki should allow rich formatting:
- TOCs, bulleted and numbered lists,
- code listings, definition lists, external
- and internal links, graphics, headings,
- procedures, tables.
Wiki should produce valid HTML or XHTML.
Wiki should make checking for broken links easy.
Wiki should allow for preview/validation of authors' work.
Development should still be active: new features, bug fixes
Wiki should have versioning for each update and for each article with unique, persistent links.
Wiki should include facilities for multiple, overlapping product releases. How can we tag changes per release?
Wiki should run on Solaris
Searchability
Wiki should look good.
Wiki should fit in 256 MB of RAM
Page history and stored revisions
Doc attachments, such as PDF
GUI-based content entry
Customizable view
Bugzilla/Bugster interface
Java-based
Doc Plans
Copyright attribution concerns should be fully addressed
Wiki should allow us to export a subset (for offline viewing of docs)
Wiki content should work for localization
Wiki should be easy to rebrand.
Wiki should report unlinked content.
Client must support all versions of all browsers
Flagging information, hierarchical ranking for importance, determines notification type and frequency
Wiki should be easy for occasional authors and for regular authors.
Notification of milestones, such as design reviews, chapter reviews, docs posted to builds
Page change suscription mechanism/Daily version report to show added and changed articles.
Wiki should be easy to extend, ideally in Java
Attachments, particularly PDF, should be searchable/filterable.
Wiki should export to Open Document format.
Wiki should export to DocBook
Extensibility (scripts, languages: JavaScript, Python)

Christopher's List Additions

Mature Wiki Engine -No beta (Added by CSF)
Domain Hosted (Added by CSF)
File/Raw Export (Added by CSF)

Paul's List Additions

Ability to provide comments on pages (must have)
Ability to export multiple pages to PDF (nice to have)
Wiki integrated into the OpenSolaris site structure (must have); I would like to see the Project and Community sites be their own wikis.
Ability to set up roles and permissions (must have)

I don't have anything else to add beyond the current list.

Consolidated Listing

I figured we could start by breaking down the list into a few helpful groups, please feel free to add things where you feel they belong, and perhaps leave your initials in () beside whatever you place in/agree with. If you don't agree with something, please copy it elsewhere with your initials (leaving the other in place with it's initials) Hopefully this will help things go a little smoother. (CSF = Christopher Frost,)

Must Have

Mature Wiki Engine -No beta (Added by CSF)
Self Hosted, within community (Added by CSF)
File/Raw Export (Added by CSF)
OSI approved license (CSF,) -IF OpenSource
Unicode support (CSF, SCH,)
Page history and revision diffs (CSF,)
Page permission (CSF,)
Wiki should look good. (CSF,)
Authentication and authorization should utilize the opensolaris.org registration database (SCH,)
XML-RPC or other remote update API (SCH,)
Open Source software (SCH,)
Java/J2EE based (Alan Burlison)

Alan makes the case that the sun-internal infrastructure around opensolaris.org needs to be streamlined, and they are shooting for a J2EE based approach. Integrating with other opensolaris features will be much easier if the Wiki can plug-n-play in that environment.

Should Have

Authentication and authorization should utilize the opensolaris.org registration database (CSF,)
Community Support (CSF, SCH,)
- Large, active online community (mailing list(s), IRC)
- Bug tracking
RSS and Atom feeds (CSF, SCH,)
Extensibility (APIs, etc.) (CSF, SCH,)
Page redirection (CSF,)
File attachments (CSF,)
Spam filters (CSF,)
Wiki should allow rich formatting: (CSF,)
- TOCs, bulleted and numbered lists,
- code listings, definition lists, external
- and internal links, graphics, headings,
- procedures, tables.
Wiki should be easy for occasional authors and for regular authors. (CSF,)
Easy-to-use syntax for client interface (CSF,)

- Internal links (free links) (CSF,)

May Have

Bugzilla/Bugster interface (CSF,)

Wiki Choices

Must Have Possibilites

bitweaver
Confluence
DekiWiki
DokuWiki
Giki
ikiwiki
Instiki
JSPWiki
KeheiWiki
LunaWiki
MediaWiki
Midgard-Wiki
MoinMoin
MoniWiki
Oddmuse
PhpWiki
PmWiki
ProjectForum
ProWiki
PukiWiki
SnipSnap
TikiWiki
TWiki
VQWiki
Wiclear
Wiki-Toolkit
WikkaWiki
XWiki
yawiki
Zwiki

Should Have Possibilities

Confluence
DekiWiki
JSPWiki
MediaWiki
Midgard-Wiki
MoinMoin
MoniWiki
Oddmuse
PhpWiki
PmWiki
ProWiki
TikiWiki
TWiki
VQWiki
WikkaWiki
XWiki
Zwiki

OpenSource Should Have Possibilities (option)

DekiWiki
JSPWiki
MediaWiki
Midgard-Wiki
MoinMoin
MoniWiki
Oddmuse
PhpWiki
PmWiki
ProWiki
TikiWiki
TWiki
VQWiki
WikkaWiki
XWiki
Zwiki

Elimination

Incentive - Windows Only
Perspective - Windows Only

Must Have Elimination

Beta Stage Wiki's (non-mature)
- Flex Wiki
- IkeWiki
- JaWiki (discontinued)
- MicKi
- MiniWiki
- OpenWikiNG
- PAUX
- Riki
- SubWiki
- TracWiki
- UniWakka
- WikiASP
- WikiSH
- Metadot

No Page Permissions
- CanvasWiki
- DidiWiki
- Friki
- Nexdo
- Kwiki
- Pimki
- Qwik
- TiddlyWiki
- Wala Wiki

No External Hosting (own domain)
- @wiki
- BrainKeeper
- CentralDesktop
- ClearWiki
- Cospire
- EditMe
- Netcipia
- PBwiki
- SamePage
- SeedWiki
- SocialText
- StikiPad
- WikiDot
- WikiSpaces
- WetPaint
- Wikia

No Unicode Support
- ErfurtWiki
- GeboGebo
- Pier
- PodWiki
- ProntoWiki
- WackoWiki
- WikiDoc
- wxWikiServer

No Page History
- telepark.Wiki
- WikePage

No File/Raw Export
- Clearspace
- Corendal Wiki
- JAMWiki
- Screwturn Wiki
- UseMod
- WikyBlog

Should Have Elimination

No File Attachments
- Instiki
- Wiki-Toolkit

No RSS OR ATOM feed
- Giki
- KeheiWiki
- LunaWiki

No Page Redirection
- bitweaver
- Dokuwiki
- ProjectForum
- PukiWiki
- SnipSnap
- WiClear
- yawiki