MusicBrainz Documentation: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
m (→‎Database: PostgreSQL has been deleted.)
m (→‎User Documentation: Minor formatting changes.)
Line 5: Line 5:
==User Documentation==
==User Documentation==


* [[How To|HowTo]]<code><nowiki></nowiki></code>s:
;[[How To|HowTo]]s
<ul><li style="list-style-type:none">A collection of tutorials. Lightweight, short and user-orientated step by step instructions.
:A collection of tutorials. Lightweight, short and user-orientated step by step instructions.

</ul>
* [[How Editing Works|HowEditingWorks]] and the different [[Edit Type|EditType]]<code><nowiki></nowiki></code>s:
;[[How Editing Works|HowEditingWorks]] and the different [[Edit Type|EditType]]s
<ul><li style="list-style-type:none">A general introduction and detailed descriptions of each type of edit that you can possibly make to [[MusicBrainz]] data.
:A general introduction and detailed descriptions of each type of edit that you can possibly make to [[MusicBrainz]] data.

</ul>
* [[Advanced Relationships|AdvancedRelationships]]:
;[[Advanced Relationships|AdvancedRelationships]]
<ul><li style="list-style-type:none">The [[Advanced Relationships|AdvancedRelationships]] documentation and the list of [[Advanced Relationship Type|AdvancedRelationshipType]]<code><nowiki></nowiki></code>s.
:The [[Advanced Relationships|AdvancedRelationships]] documentation and the list of [[Advanced Relationship Type|AdvancedRelationshipType]]s.

</ul>
* [[Advanced Search|AdvancedSearch]]:
;[[Advanced Search|AdvancedSearch]]
<ul><li style="list-style-type:none">Describes the server-based search (also used by the [[MusicBrainz Tagger|MusicBrainzTagger]]).
:Describes the server-based search (also used by the [[MusicBrainz Tagger|MusicBrainzTagger]]).

</ul>
* [[MusicBrainz Terminology|MusicBrainzTerminology]]:
;[[MusicBrainz Terminology|MusicBrainzTerminology]]
<ul><li style="list-style-type:none">A collection of all terms the [[MusicBrainz]] community uses, what they mean, and wheter there is a wiki page explaining them.
:A collection of all terms the [[MusicBrainz]] community uses, what they mean, and wheter there is a wiki page explaining them.

</ul>
* [[Release Language|ReleaseLanguage]]:
;[[Release Language|ReleaseLanguage]]
<ul><li style="list-style-type:none">Describes the assignement of the language and script attribute to releases.
:Describes the assignement of the language and script attribute to releases.

</ul>
* [[Picard Documentation|PicardDocumentation]]:
;[[Picard Documentation|PicardDocumentation]]
<ul><li style="list-style-type:none">Documentation of the [[Picard Tagger|PicardTagger]], the next generation tagger in development.
:Documentation of the [[Picard Tagger|PicardTagger]], the next generation tagger in development.

</ul>
* [[How Annotations Work|HowAnnotationsWork]]:
;[[How Annotations Work|HowAnnotationsWork]]
<ul><li style="list-style-type:none">A rudimentary page that explains the [[Artist Annotation|ArtistAnnotation]] and [[Release Annotation|ReleaseAnnotation]].
:A rudimentary page that explains the [[Artist Annotation|ArtistAnnotation]] and [[Release Annotation|ReleaseAnnotation]].

</ul>
* [[How Voting Works|HowVotingWorks]]:
;[[How Voting Works|HowVotingWorks]]
<ul><li style="list-style-type:none">Also quite rudimentary. It explains the decision mechanism of the [[ModBot]].
:Also quite rudimentary. It explains the decision mechanism of the [[ModBot]].

</ul>
* [[Editor Privacy|EditorPrivacy]]:
;[[Editor Privacy|EditorPrivacy]]
<ul><li style="list-style-type:none">Privacy implications of being a [[MusicBrainz]] editor.
:Privacy implications of being a [[MusicBrainz]] editor.

</ul>
* [[Text Search Syntax|TextSearchSyntax]]:
;[[Text Search Syntax|TextSearchSyntax]]
<ul><li style="list-style-type:none">How to use the powerful text search features in [[MusicBrainz]]
:How to use the powerful text search features in [[MusicBrainz]]

</ul>
* [[Flickr Machine Tag|FlickrMachineTag]]:
;[[Flickr Machine Tag|FlickrMachineTag]]
<ul><li style="list-style-type:none">How to use flickr tags to refer to [[MusicBrainz]] artists, releases, tracks or labels.
:How to use flickr tags to refer to [[MusicBrainz]] artists, releases, tracks or labels.
</ul>


==Developer Documentation==
==Developer Documentation==

Revision as of 17:07, 16 May 2009

Status: We (well mostly Dupuy) are currently RestructuringTheDocumentation; i.e. moving the MusicBrainzDocumentation from the main server into the Wiki. The docs on the homepage are often quite dated, so we will try to update and intertwingle them here. But this is work in progress, so beware and read the status notices!

Right now this page is roughly structured into docs for users, for developers and other. It would probably be better to have different structures that present the documentation. So I hereby invite everyone to invent and add categories likefor the following pages. Just go ahead and create some! We can sort it out later --DonRedman

User Documentation

HowTos
A collection of tutorials. Lightweight, short and user-orientated step by step instructions.
HowEditingWorks and the different EditTypes
A general introduction and detailed descriptions of each type of edit that you can possibly make to MusicBrainz data.
AdvancedRelationships
The AdvancedRelationships documentation and the list of AdvancedRelationshipTypes.
AdvancedSearch
Describes the server-based search (also used by the MusicBrainzTagger).
MusicBrainzTerminology
A collection of all terms the MusicBrainz community uses, what they mean, and wheter there is a wiki page explaining them.
ReleaseLanguage
Describes the assignement of the language and script attribute to releases.
PicardDocumentation
Documentation of the PicardTagger, the next generation tagger in development.
HowAnnotationsWork
A rudimentary page that explains the ArtistAnnotation and ReleaseAnnotation.
HowVotingWorks
Also quite rudimentary. It explains the decision mechanism of the ModBot.
EditorPrivacy
Privacy implications of being a MusicBrainz editor.
TextSearchSyntax
How to use the powerful text search features in MusicBrainz
FlickrMachineTag
How to use flickr tags to refer to MusicBrainz artists, releases, tracks or labels.

Developer Documentation

I am not sure how much of this stuff really belongs here. Some of it is probably better of in MusicBrainzDevelopment. --DonRedman

Software

Discs

Tagging

The following pages are pretty messy, partially outdated, and make extensive use of BadWikiNames.

Server

Database

Other Documentation