Difference between revisions of "MusicBrainz Documentation"

From MusicBrainz Wiki
((Imported from MoinMoin))
 
(fix links, remove outdated/EOL stuff)
 
(51 intermediate revisions by 18 users not shown)
Line 1: Line 1:
'''Status:''' ''We (well mostly [[User:Dupuy|Dupuy]]) are currently [[Restructuring The Documentation|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!''
+
==User documentation==
  
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 --[[User:DonRedman|DonRedman]]  
+
;[[Frequently Asked Questions]]
 +
: A set of community maintained FAQs.
  
==User Documentation==
+
===For the web interface===
 +
;[[About]] and [[Beginners Guide]]
 +
:A quick introduction to MusicBrainz and to its use, respectively.
  
* [[MusicBrainz Terminology|MusicBrainzTerminology]]:
+
;[[How To]]s
<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 tutorials. Lightweight, short and user-orientated step by step instructions.
</ul>
+
 
* [[Edit Type|EditType]]s:
+
;[[Introduction to Editing]]
<ul><li style="list-style-type:none">A description of each type of edit that you can possibly make to [[MusicBrainz]] data.  
+
:A quick introduction to how changes to MusicBrainz data are made.
</ul>
+
 
* [[Advanced Relationships|AdvancedRelationships]]:
+
;[[Introduction to Voting]]
<ul><li style="list-style-type:none">Then new [[Advanced Relationships|AdvancedRelationships]] are not well documented yet. There is some initial [[Advanced Relationships Documentation|AdvancedRelationshipsDocumentation]] and we are starting to document the [[Advanced Relationship Type|AdvancedRelationshipType]]s.  
+
:A quick introduction to MusicBrainz's voting system and how edits are applied (or rejected).
</ul>
+
 
* [[Advanced Search|AdvancedSearch]]:
+
;[[Style|Style guidelines]]
<ul><li style="list-style-type:none">Describes the server-based search (also used by the [[MusicBrainz Tagger|MusicBrainzTagger]]).  
+
:All our official guidelines for editing.
</ul>
+
 
* [[Album Language|AlbumLanguage]]:
+
;[[Search]]
<ul><li style="list-style-type:none">Describes the assignement of the language and script attribute to albums.  
+
:Describes the different kinds of search you can use to browse MusicBrainz. Also includes the [[Indexed Search Syntax|advanced search syntax]].
</ul>
+
 
* [[Picard Tagger Documentation|PicardTaggerDocumentation]]:
+
;[[MusicBrainz Terminology]]
<ul><li style="list-style-type:none">Documentation of the [[Picard Tagger|PicardTagger]], the next generation tagger in development.  
+
:A collection of terms the MusicBrainz community uses, what they mean, and whether there is a wiki page explaining them.
</ul>
+
 
* [[How Annotations Work|HowAnnotationsWork]]:
+
===For the software===
<ul><li style="list-style-type:none">A rudimentary page that explains the [[Artist Annotation|ArtistAnnotation]] and [[Album Annotation|AlbumAnnotation]].
+
;[https://picard-docs.musicbrainz.org/ Picard Documentation]
</ul>
+
:Documentation of [[MusicBrainz Picard]], MusicBrainz' official tagger.
* [[How Voting Works|HowVotingWorks]]:
+
 
<ul><li style="list-style-type:none">Also quite rudimentary. It explains the decision mechanism of the [[ModBot]].
+
===Other===
</ul>
+
;[[meb:privacy|Privacy Policy]]
* [[How Editing Works|HowEditingWorks]]:
+
:Privacy implications of being a MusicBrainz editor.
<ul><li style="list-style-type:none">That page should eventually replace [[Information On Editing|InformationOnEditing]], I believe --[[User:DonRedman|DonRedman]]
+
 
</ul>
+
;[[Flickr Machine Tag]]
* [[Moderator Privacy|ModeratorPrivacy]]:
+
:How to use flickr tags to refer to MusicBrainz artists, releases, tracks or labels.
<ul><li style="list-style-type:none">Privacy implications of being a [[MusicBrainz]] moderator
 
</ul>
 
  
 
==Developer Documentation==
 
==Developer Documentation==
  
''I am not sure how much of this stuff really belongs here. Some of it is probably better of in [[MusicBrainz Development|MusicBrainzDevelopment]]. --[[User:DonRedman|DonRedman]]  
+
;[[Developer Resources]]
 +
:Catch-all page with a number of useful links for developers
 +
 
 +
===Metadata===
 +
 
 +
;[[MusicBrainz_API]]
 +
:Our web service, for use in applications
  
 
===Software===
 
===Software===
  
* The [[Client HOWTO|ClientHOWTO]] (from client_howto.html) describes the use of the [[MusicBrainz]] [[Client Library|ClientLibrary]], and the [[Client Examples|ClientExamples]] programs.  
+
;[[libmusicbrainz]]
 +
:Describes the use of our official library for accessing the web service.
  
 
===Discs===
 
===Discs===
  
* [[Disc Submission|DiscSubmission]] is an overview of the highly technical content of [[Disc ID Calculation|DiscIDCalculation]]. (from cd_submission.html and disc.html)
+
;[[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|ID3v240]] -- Useful links for people wanting to use ID3v2 tags in applications
+
;[https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html Tag Mappings]
* [[ID3v2 Tags|ID3v2Tags]] -- A list of some TXXX tags for ID3v2 to toss about and try to "standardize".  
+
:These are the tag mappings used by [[MusicBrainz Picard]], our official tagging application
* [[Disc IDs and Tagging|DiscIdsAndTagging]] -- A short exposé on various tagging standards and their handling of [[Disc Ids|DiscIds]]  
 
* [[Metadata Tags|MetadataTags]] -- Standardization for [[MusicBrainz]]-specific tags. (from metadata_tags.html)
 
** MusicBrainzIDs -- as used in standardized MB-specific tags. (from id-intro.html)
 
  
===Server===
+
===Database===
  
* AutoInsertFromFreeDB -- Explains how data is automatically entered as [[FreeDB Moderation|FreeDBModeration]]
+
;[[MusicBrainz Database]]
* [[Server Access Paths|ServerAccessPaths]]
+
:Start page for documentation about the database.
  
* Various [[Bug Reports|BugReports]] and [[Feature Page|FeaturePage]]s and the like:
+
;[[Database Schema]]
** [[Calculate Track Times|CalculateTrackTimes]] (was [[Track Times Proposal|TrackTimesProposal]])
+
:Description of our current schema and database structure.
** MultiSessionCDBug
 
  
===Database===
+
;[[Database Setup]]
 +
:Several ways of setting up and using our database.
  
* [[MusicBrainz Database|MusicBrainzDatabase]]—Start page for documentation about the database
+
==Other Documentation==
* [[Windows DB Installation|WindowsDBInstallation]]—Brief tutorial on installing [[PostgreSQL]] under cygwin and some key tips
 
* [[Panther DB Installation|PantherDBInstallation]]—Steps to intall [[PostgreSQL]] and import [[MusicBrainz]] data on Mac OS X 10.3 aka Panther
 
* [[Debian VMWare Database|DebianVMWareDatabase]]—HOWTO install the database under Debian running under VMWare.
 
  
==Other Documentation==
+
;[[Other Databases]]
 +
:Other music databases which we might try to work with
  
* [http://solution.itagent.ne.jp/sw/voca10.html Japanese documentation for MusicBrainz Metadata Initiative 2.1]
+
;[[MusicBrainz Summit]]s
* [[Other Databases|OtherDatabases]] -- Other music databases which we might try to work with
 
* [[Links To Free Creative Commons License Music|LinksToFreeCreativeCommonsLicenseMusic]]
 
* [[Musicbrainz Summit5|MusicbrainzSummit5]]  
 
  
[[Category:To Be Reviewed]] [[Category:Deocumentation Something]]
+
[[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