Wiki Web Service: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
(fixed <nowiki> (Imported from MoinMoin))
 
(Relevant content moved to WikiDocs.)
 
(15 intermediate revisions by 6 users not shown)
Line 1: Line 1:
#REDIRECT [[WikiDocs]]
The WikiWebService is a component of the planned [[WikiDocs]]. This component will display pages from either the [[Moderated Wiki Mirror|ModeratedWikiMirror]] or the [[MusicBrainz Wiki|MusicBrainzWiki]] as uneditable webpages within the normal header, footer, menubar etc. of the [[Main Site|MainSite]].

===Current "Webservice" Mechanism===

[[User:MatthiasFriedrich|MatthiasFriedrich]] explained me how the content of a [[Moin Moin|MoinMoin]] wiki page is displayed on the [[MusicBrainz]] [[Main Site|MainSite]]:
* When you request a page like [http://www.musicbrainz.org/wd/AboutMusicBrainz http://www.musicbrainz.org/wd/AboutMusicBrainz], the <code><nowiki>wd/AboutMusicBrainz</nowiki></code> is rewritten to a different URL: <code><nowiki>/docs.html?id=AboutMusicBrainz</nowiki></code>.
* The code inside of docs.html calls a mason component. This mason component loads a page via HTTP-GET from the [[Moin Moin|MoinMoin]] wiki that is located at [http://wikidocs.musicbrainz.org http://wikidocs.musicbrainz.org] (Note that this is the old and deprectated [[WikiDocs]], that can be edited at [http://wikidocs.musicbrainz.org/write/ http://wikidocs.musicbrainz.org/write/] (restricted access)).
* The mason component reads the wiki via the URL [http://wikidocs.musicbrainz.org/read/AboutMusicBrainz?action=content http://wikidocs.musicbrainz.org/read/AboutMusicBrainz?action=content] (restricted as well).
* some link rewriting is done with the requested content to fix problems with relative links. The the wiki returns some links like '[http:/page.html http:/page.html]' (relative links). These are rewritten to absolute links ([http://www.musicbrainz.org/page.html http://www.musicbrainz.org/page.html])
* Finally the page is displayed on the website, inside ouf our usual framework (header, sidebar, footer).

==Changes / Future Requirements==

* The webservice must somehow differentiate between pages that are in the [[Shadow Wiki|ShadowWiki]] and those that are only in the [[MusicBrainz Wiki|MusicBrainzWiki]], and serve the appropriate page.
* The url should be changed so something more meaningful, since most mb urls will have that form. I suggest [http://www.musicbrainz.org/docs/AboutMusicBrainz http://www.musicbrainz.org/docs/AboutMusicBrainz] .

[[Category:To Be Reviewed]]

Latest revision as of 04:18, 25 October 2009

Redirect to: