Difference between revisions of "MusicBrainz Documentation"

From MusicBrainz Wiki
m (Server: Removing ancient crud)
(fix links, remove outdated/EOL stuff)
 
(15 intermediate revisions by 9 users not shown)
Line 1: Line 1:
==User Documentation==
+
==User documentation==
  
; [[Frequently Asked Questions]]
+
;[[Frequently Asked Questions]]
 
: A set of community maintained FAQs.
 
: A set of community maintained FAQs.
 +
 +
===For the web interface===
 +
;[[About]] and [[Beginners Guide]]
 +
:A quick introduction to MusicBrainz and to its use, respectively.
  
 
;[[How To]]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.
 +
 
 +
;[[Introduction to Editing]]
 +
:A quick introduction to how changes to MusicBrainz data are made.
  
;[[How Editing Works]] and the different [[Edit Type]]s
+
;[[Introduction to Voting]]
:A general introduction and detailed descriptions of each type of edit that you can possibly make to [[MusicBrainz]] data.  
+
:A quick introduction to MusicBrainz's voting system and how edits are applied (or rejected).
  
;[[Advanced Relationships]]
+
;[[Style|Style guidelines]]
: Documentation about [[:Category:Advanced Relationships|Advanced Relationships]], as well as all [[:Category:Relationship Class|Relationship Classes]], [[:Category:Relationship Family|Relationship Families]], and [[:Category:Relationship Type|Relationship Types]].  
+
:All our official guidelines for editing.
  
;[[Advanced Search]]
+
;[[Search]]
:Describes the server-based search (also used by the [[MusicBrainz Tagger]]).  
+
:Describes the different kinds of search you can use to browse MusicBrainz. Also includes the [[Indexed Search Syntax|advanced search syntax]].
  
 
;[[MusicBrainz Terminology]]
 
;[[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 terms the MusicBrainz community uses, what they mean, and whether there is a wiki page explaining them.
 
 
;[[Release Language]]
 
:Describes the assignement of the language and script attribute to releases.
 
 
 
;[[Picard Documentation]]
 
:Documentation of [[MusicBrainz Picard]], MusicBrainz' official tagger.
 
 
 
;[[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]]
+
===For the software===
:Privacy implications of being a [[MusicBrainz]] editor.  
+
;[https://picard-docs.musicbrainz.org/ Picard Documentation]
 +
:Documentation of [[MusicBrainz Picard]], MusicBrainz' official tagger.
  
;[[Text Search Syntax]]  
+
===Other===
:How to use the powerful text search features in [[MusicBrainz]]
+
;[[meb:privacy|Privacy Policy]]
 +
:Privacy implications of being a MusicBrainz editor.
  
 
;[[Flickr Machine Tag]]
 
;[[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.
  
 
==Developer Documentation==
 
==Developer Documentation==
 +
 +
;[[Developer Resources]]
 +
:Catch-all page with a number of useful links for developers
  
 
===Metadata===
 
===Metadata===
  
;[[MusicBrainz_XML_Meta_Data]]
+
;[[MusicBrainz_API]]
:Describes the MusicBrainz XML Metadata Format
+
:Our web service, for use in applications
  
 
===Software===
 
===Software===
  
;[[Client HOWTO]]  
+
;[[libmusicbrainz]]
:Describes the use of [[libmusicbrainz]], and the [[Client Examples]] programs.  
+
:Describes the use of our official library for accessing the web service.
  
 
===Discs===
 
===Discs===
  
;[[Disc Submission]]  
+
;[[Disc ID Calculation]]
:An overview of the highly technical content of [[Disc ID Calculation]].
+
:An overview of the technical process of calculating [[Disc ID]]s.
 +
 
 +
;[[libdiscid]]
 +
:C library for creating MusicBrainz DiscIDs from audio CDs. Much better than implementing Disc IDs yourself.
  
 
===Tagging===
 
===Tagging===
  
;[[ID3v2.4.0]]
+
;[https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html Tag Mappings]
:Useful links for people wanting to use ID3v2 tags in applications.
+
:These are the tag mappings used by [[MusicBrainz Picard]], our official tagging application
 
 
;[[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 [[Disc ID|DiscID]]s.
 
 
 
;[[MusicBrainz Tag]]
 
:Standardization for [[MusicBrainz]]-specific tags.
 
 
 
;[[MusicBrainz Identifier]]
 
:As used in standardized [[MusicBrainz Tag|MusicBrainzTag]]s.
 
 
 
 
 
  
 
===Database===
 
===Database===
Line 81: Line 70:
 
:Start page for documentation about the database.
 
:Start page for documentation about the database.
  
;[[Panther DB Installation]]
+
;[[Database Schema]]
:Steps to intall PostgreSQL and import [[MusicBrainz]] data on Mac OS X 10.3 aka Panther.
+
:Description of our current schema and database structure.
  
;[[Debian VMWare Database]]
+
;[[Database Setup]]
:HOWTO install the database under Debian running under VMWare.
+
:Several ways of setting up and using our database.
  
 
==Other Documentation==
 
==Other Documentation==
  
* [http://solution.itagent.ne.jp/sw/voca10.html Japanese documentation for MusicBrainz Metadata Initiative 2.1]
+
;[[Other Databases]]
* [[Other Databases]] -- Other music databases which we might try to work with  
+
:Other music databases which we might try to work with
* [[Links To Free Creative Commons License Music]]
+
 
* [[MusicBrainz Summit]]s  
+
;[[MusicBrainz Summit]]s
  
[[Category:Documentation]]
+
[[Category:Documentation]] [[Category:To Be Reviewed]] [[Category:WikiDocs Page]]

Latest revision as of 09:59, 19 December 2020

User documentation

Frequently Asked Questions
A set of community maintained FAQs.

For the web interface

About and Beginners Guide
A quick introduction to MusicBrainz and to its use, respectively.
How Tos
A collection of tutorials. Lightweight, short and user-orientated step by step instructions.
Introduction to Editing
A quick introduction to how changes to MusicBrainz data are made.
Introduction to Voting
A quick introduction to MusicBrainz's voting system and how edits are applied (or rejected).
Style guidelines
All our official guidelines for editing.
Search
Describes the different kinds of search you can use to browse MusicBrainz. Also includes the advanced search syntax.
MusicBrainz Terminology
A collection of terms the MusicBrainz community uses, what they mean, and whether there is a wiki page explaining them.

For the software

Picard Documentation
Documentation of MusicBrainz Picard, MusicBrainz' official tagger.

Other

Privacy Policy
Privacy implications of being a MusicBrainz editor.
Flickr Machine Tag
How to use flickr tags to refer to MusicBrainz artists, releases, tracks or labels.

Developer Documentation

Developer Resources
Catch-all page with a number of useful links for developers

Metadata

MusicBrainz_API
Our web service, for use in applications

Software

libmusicbrainz
Describes the use of our official library for accessing the web service.

Discs

Disc ID Calculation
An overview of the technical process of calculating Disc IDs.
libdiscid
C library for creating MusicBrainz DiscIDs from audio CDs. Much better than implementing Disc IDs yourself.

Tagging

Tag Mappings
These are the tag mappings used by MusicBrainz Picard, our official tagging application

Database

MusicBrainz Database
Start page for documentation about the database.
Database Schema
Description of our current schema and database structure.
Database Setup
Several ways of setting up and using our database.

Other Documentation

Other Databases
Other music databases which we might try to work with
MusicBrainz Summits