Support/Kitsune/Wiki

< Support‎ | Kitsune

This is a Wiki PRD as part of the SUMO Kitsune project.

Contents

Functionality

This section summarizes the functionality we wish to have on the Wiki VS what we discard from what we currently have.

  • Viewing an article
    • OS & Firefox version specific content (SHOWFOR equivalent)
    • Actions box / admin UI when logged in
    • Comments / Link to discussion page?
    • Summary of other linked to articles (on hover)
    • Rejection/Approval + notifications -- bug 446082
    • Footer language box for switching between different translations of same article
  • Editing an article
    • Content area
    • Categories / Templates
      • Different categories have different templates (currently mozkb, mozad, mozgn, etc)
      • Staging process -- needed for other categories bug 470930
    • Language (omit languages which already have translations of article)
    • Description of changes (Edit summary)
    • Images/screencasts
      • Upload
      • Remove
      • List
    • Plugins: see plugins section below
  • History / Version control
    • view previous version
    • rollback to a version
    • show approver vs editor
    • diff -- which diff options to show?
      • side by side VS inline/unified
    • what is remembered, just content? what about categories, language?
  • Tags (taxonomy)?
  • Keywords field (used for search)
  • Renaming article title
  • Remove article
  • Watch/Monitor article
  • Translate article
    • Automatically attach translated article to original
    • Disallow translations of same article in same language
    • Freely attach/un-attach articles together? (needs admin)
  • Related articles
    • How would this be implemented? Manual with suggestions? Automatic?
  • [Localization] dashboard

Discarding:

  • Lock/unlock link
  • Per article permissions

Suggestions

  • RSS feed/notifications of updates to watchers
    • Similar to bugzilla preferences
  • Select URL/permalink for article (like WordPress)

Open Questions

  • Markup? Do we want to use Mediawiki, something lighter like Markdown, or a WYSIWYG editor with filtered HTML?
    • Decision to use MediaWiki

Plugins

Need to check which of these are actually valid and used

This list was built using PHP's preg_match() with the regex /{[^{]+?[ (}]/, and some cleanup. Sorted in order of frequency:

PLUGIN ARTICLE_COUNT
--------------------
DIV 4829
SHOWFOR 4673
PATH 3605
maketoc 3428
img 3270
content 3161
MENU 2992
FILE 2680
label 2471
PREF 2427
TAG 1900
ANAME 1600
CODE 743
FLASH 471
~np~ 367
SCREENCAST 342
VERSIONS 274
GROUP 233
MODULE 217
REDIRECT 180
ELSE 111
rss 92
ALINK 59
DYNVARS 39
PAGELIST 27
r2l 18
LISTPROGRESS 18
TRACKER 6
TRACKERSTAT 4
TRACKERLIST 1
EDITNOTE 1
l2r 1

James asks: With DIV and PATH, it's important to understand why those are being used. DIV is often used as part of SHOWFOR, right?