MusicBrainz Documentation: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
m (→‎Developer Documentation: More formatting changes.)
m (Yet more formatting changes.)
Line 5: Line 5:
==User Documentation==
==User Documentation==


;[[How To|HowTo]]s
;[[How To]]s
: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.


;[[How Editing Works|HowEditingWorks]] and the different [[Edit Type|EditType]]s
;[[How Editing Works]] and the different [[Edit Type]]s
: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.


;[[Advanced Relationships|AdvancedRelationships]]
;[[Advanced Relationships]]
:The [[Advanced Relationships|AdvancedRelationships]] documentation and the list of [[Advanced Relationship Type|AdvancedRelationshipType]]s.
:The [[Advanced Relationships]] documentation and the list of [[Advanced Relationship Type]]s.


;[[Advanced Search|AdvancedSearch]]
;[[Advanced Search]]
:Describes the server-based search (also used by the [[MusicBrainz Tagger|MusicBrainzTagger]]).
:Describes the server-based search (also used by the [[MusicBrainz Tagger]]).


;[[MusicBrainz Terminology|MusicBrainzTerminology]]
;[[MusicBrainz Terminology]]
: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.


;[[Release Language|ReleaseLanguage]]
;[[Release Language]]
:Describes the assignement of the language and script attribute to releases.
:Describes the assignement of the language and script attribute to releases.


;[[Picard Documentation|PicardDocumentation]]
;[[Picard Documentation]]
:Documentation of the [[Picard Tagger|PicardTagger]], the next generation tagger in development.
:Documentation of the [[Picard Tagger]], the next generation tagger in development.


;[[How Annotations Work|HowAnnotationsWork]]
;[[How Annotations Work]]
:A rudimentary page that explains the [[Artist Annotation|ArtistAnnotation]] and [[Release Annotation|ReleaseAnnotation]].
:A rudimentary page that explains the [[Artist Annotation]] and [[Release Annotation]].


;[[How Voting Works|HowVotingWorks]]
;[[How Voting Works]]
:Also quite rudimentary. It explains the decision mechanism of the [[ModBot]].
:Also quite rudimentary. It explains the decision mechanism of the [[ModBot]].


;[[Editor Privacy|EditorPrivacy]]
;[[Editor Privacy]]
:Privacy implications of being a [[MusicBrainz]] editor.
:Privacy implications of being a [[MusicBrainz]] editor.


;[[Text Search Syntax|TextSearchSyntax]]
;[[Text Search Syntax]]
:How to use the powerful text search features in [[MusicBrainz]]
:How to use the powerful text search features in [[MusicBrainz]]


;[[Flickr Machine Tag|FlickrMachineTag]]
;[[Flickr Machine Tag]]
: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.


Line 102: Line 102:


* [http://solution.itagent.ne.jp/sw/voca10.html Japanese documentation for MusicBrainz Metadata Initiative 2.1]
* [http://solution.itagent.ne.jp/sw/voca10.html Japanese documentation for MusicBrainz Metadata Initiative 2.1]
* [[Other Databases|OtherDatabases]] -- Other music databases which we might try to work with
* [[Other Databases]] -- Other music databases which we might try to work with
* [[Links To Free Creative Commons License Music|LinksToFreeCreativeCommonsLicenseMusic]]
* [[Links To Free Creative Commons License Music]]
* [[MusicBrainz Summit|MusicBrainzSummit]]<code><nowiki></nowiki></code>s
* [[MusicBrainz Summit]]s


[[Category:To Be Reviewed]] [[Category:Documentation Something]]
[[Category:To Be Reviewed]] [[Category:Documentation Something]]

Revision as of 17:20, 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

How Tos
A collection of tutorials. Lightweight, short and user-orientated step by step instructions.
How Editing Works and the different Edit Types
A general introduction and detailed descriptions of each type of edit that you can possibly make to MusicBrainz data.
Advanced Relationships
The Advanced Relationships documentation and the list of Advanced Relationship Types.
Advanced Search
Describes the server-based search (also used by the MusicBrainz Tagger).
MusicBrainz Terminology
A collection of all terms the MusicBrainz community uses, what they mean, and wheter there is a wiki page explaining them.
Release Language
Describes the assignement of the language and script attribute to releases.
Picard Documentation
Documentation of the Picard Tagger, the next generation tagger in development.
How Annotations Work
A rudimentary page that explains the Artist Annotation and Release Annotation.
How Voting Works
Also quite rudimentary. It explains the decision mechanism of the ModBot.
Editor Privacy
Privacy implications of being a MusicBrainz editor.
Text Search Syntax
How to use the powerful text search features in MusicBrainz
Flickr Machine Tag
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

Retrieved from "https://wiki.musicbrainz.org/index.php?title=MusicBrainz_Documentation&oldid=29961"