Difference between revisions of "WikiDocs"

From MusicBrainz Wiki
m (Reverted edits by Domtheo (talk) to last revision by Mpontes)
m (simplify language)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
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/.
+
Most of MusicBrainz's documentation is located at https://wiki.musicbrainz.org/ and transcluded at https://musicbrainz.org/doc/.
  
This "WikiDocs" system works by:
+
This WikiDocs system works because:
# Leaving the wiki (and by extension, the documentation) open for mass collaboration.
+
# It leaves the wiki (and by extension, the documentation) open for mass collaboration.
# Providing [[Transclusion Editor|transclusion editors]] with the means to control what is viewable on the main site.
+
# It lets [[Transclusion Editor|transclusion editors]] control what can be seen on the main site.
  
 
== WikiDocs Structure ==
 
== WikiDocs Structure ==
 
+
[[Image:WikiDocs_System_v1.png|right|350px|WikiDocs components]]  
{| class="wikitable" style="float: right; margin: 0 0 10px 10px"
 
| [[Image:WikiDocs_System_v1.png|350px|WikiDocs components]]  
 
|}
 
  
 
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.
+
# The content resides in the wiki, and anyone can edit and maintain it.
# [[Transclusion Editor]]s add and update entries in the [http://musicbrainz.org/admin/wikidoc transclusion table] for all official documentation pages.
+
# [[Transclusion Editor|Transclusion editor]]s add and update entries in the [[mb:admin/wikidoc|transclusion table]] for 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.
  
Pages served via transclusion are not editable on the website.
+
Pages served via transclusion cannot be edited on the website.
  
 
==How To Transclude a WikiDocs Page==
 
==How To Transclude a WikiDocs Page==
  
'''Only transclusion editors are able to do this.'''
+
'''Only transclusion editors can do this.'''
  
: [[Image:Attention.png]] ''Please be very careful to enter the correct page name and revision number, they are '''not''' checked for correctness.''  
+
: [[Image:Attention.png]] ''Please be very careful to enter the correct page name and revision number, because they are '''not''' checked for correctness.''  
  
Go to the [http://musicbrainz.org/edit/wikitransclusion/transclusion.html wiki transclusion table]. Each page will have its 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.  
+
Go to the [[mb:admin/wikidoc|wiki transclusion table]]. Each page has its own row, which can be edited or removed. New rows 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.
 
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]]

Latest revision as of 13:36, 23 January 2021

Most of MusicBrainz's documentation is located at https://wiki.musicbrainz.org/ and transcluded at https://musicbrainz.org/doc/.

This WikiDocs system works because:

  1. It leaves the wiki (and by extension, the documentation) open for mass collaboration.
  2. It lets transclusion editors control what can be seen on the main site.

WikiDocs Structure

WikiDocs components

The structure of the WikiDocs system looks like this:

  1. The content resides in the wiki, and anyone can edit and maintain it.
  2. Transclusion editors add and update entries in the transclusion table for 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 cannot be edited on the website.

How To Transclude a WikiDocs Page

Only transclusion editors can do this.

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

Go to the wiki transclusion table. Each page has its own row, which can be edited or removed. New rows 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.