Difference between revisions of "WikiDocs"

From MusicBrainz Wiki
(May cleaning)
m (WikiDocs Structure: update url)
Line 13: Line 13:
 
The structure of the WikiDocs system looks like this:
 
The structure of the WikiDocs system looks like this:
 
# All the content resides in the wiki and is open for anyone and everyone to edit and maintain.
 
# All the content resides in the wiki and is open for anyone and everyone to edit and maintain.
# [[Transclusion Editor|Transclusion editors]] add and update entries in the [http://ngs.musicbrainz.org/admin/wikidoc transclusion table] for all official documentation pages.
+
# [[Transclusion Editor|Transclusion editors]] add and update entries in the [http://musicbrainz.org/admin/wikidoc transclusion table] for all official documentation pages.
 
# Users visiting a page on the wiki see no difference; they always see the most recent revision of every page.
 
# Users visiting a page on the wiki see no difference; they always see the most recent revision of every page.
 
# Users visiting that same page on the main website will be shown, via transclusion, only the latest reviewed revision of that page
 
# Users visiting that same page on the main website will be shown, via transclusion, only the latest reviewed revision of that page

Revision as of 07:18, 19 May 2011

With a few exceptions, all of MusicBrainz' documentation is obtained by transcluding content from http://wiki.musicbrainz.org/ and displaying it at http://musicbrainz.org/doc/.

This "WikiDocs" system works by:

  1. Leaving the wiki (and by extension, the documentation) open for mass collaboration.
  2. Providing transclusion editors with the means to control what is viewable on the main site.

WikiDocs Structure

WikiDocs components

The structure of the WikiDocs system looks like this:

  1. All the content resides in the wiki and is open for anyone and everyone to edit and maintain.
  2. Transclusion editors add and update entries in the transclusion table for all official documentation pages.
  3. Users visiting a page on the wiki see no difference; they always see the most recent revision of every page.
  4. Users visiting that same page on the main website will be shown, via transclusion, only the latest reviewed revision of that page

Pages served via transclusion are not editable on the website.