MusicBrainz Documentation

From MusicBrainz Wiki
Revision as of 17:16, 16 May 2009 by PavanChander (talk | contribs) (→‎Developer Documentation: More formatting changes.)
Jump to navigationJump to search

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 MusicBrainz Development. --User:DonRedman

Software

Client HOWTO
Describes the use of libmusicbrainz, and the Client Examples programs.

Discs

Disc Submission
An overview of the highly technical content of Disc ID Calculation. (from cd_submission.html and disc.html)

Tagging

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

ID3v2.4.0
Useful links for people wanting to use ID3v2 tags in applications.
ID3v2 Tags
A list of some TXXX tags for ID3v2 to toss about and try to "standardize".
Disc IDs and Tagging
A short exposé on various tagging standards and their handling of DiscIDs.
MusicBrainz Tag
Standardization for MusicBrainz-specific tags. (from metadata_tags.html)
MusicBrainz Identifier
As used in standardized MusicBrainzTags. (from id-intro.html)

Server

Auto-Insert From FreeDB
Explains how data is automatically entered as FreeDBModerations .
Server Access Paths
Explains the various "fixed" ways into the MusicBrainz Server.
Release Editor Arguments
Explains the arguments to pre-populate the fields in the release editor.

Various Bug Reports and FeaturePages and the like:

Database

MusicBrainz Database
Start page for documentation about the database.
Panther DB Installation
Steps to intall PostgreSQL and import MusicBrainz data on Mac OS X 10.3 aka Panther.
Debian VMWare Database
HOWTO install the database under Debian running under VMWare.

Other Documentation