WikiDocs: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
mNo edit summary
No edit summary
Line 18: Line 18:


Pages served via transclusion are not editable on the website.
Pages served via transclusion are not editable on the website.

==How To Transclude a WikiDocs Page==

'''Only transclusion editors are able to do this.'''

: [[Image:Attention.png]] ''Please be very careful to enter the correct page name and revision number, they are '''not''' checked for correctness.''

Go to the [http://musicbrainz.org/edit/wikitransclusion/transclusion.html wiki transclusion table]. Each page will have it's own row which can be edited or removed; new ones can also be added. When a [[WikiDocs]] page has been edited, and the change conforms with the style guidelines and other social aspects - and most importantly, makes the documentation better - the change should be reflected on the main server. To do this, find the latest revision number using the page history and update it in the transclusion table.

When adding a new page to the table, make sure to add it to the [[:Category:WikiDocs Page|WikiDocs page]] category.


[[Category:Wiki]] [[Category:WikiDocs Page]]
[[Category:Wiki]] [[Category:WikiDocs Page]]

Revision as of 23:52, 11 November 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.

How To Transclude a WikiDocs Page

Only transclusion editors are able to do this.

Attention.png Please be very careful to enter the correct page name and revision number, they are not checked for correctness.

Go to the wiki transclusion table. Each page will have it's own row which can be edited or removed; new ones can also be added. When a WikiDocs page has been edited, and the change conforms with the style guidelines and other social aspects - and most importantly, makes the documentation better - the change should be reflected on the main server. To do this, find the latest revision number using the page history and update it in the transclusion table.

When adding a new page to the table, make sure to add it to the WikiDocs page category.