MusicBrainz Documentation: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
(standardized product wiki names (Imported from MoinMoin))
 
m (Typo)
(37 intermediate revisions by 11 users not shown)
Line 1: Line 1:
==User documentation==
'''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!''


;[[Frequently Asked Questions]]
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]]
: A set of community maintained FAQs.


===For the web interface===
==User Documentation==
;[[About]] and [[Beginners Guide]]
:A quick introduction to MusicBrainz and to its use, respectively.


* [[How To|HowTo]]'s:
;[[How To]]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>
;[[Introduction to Editing]]
* [[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 quick introduction to how changes to MusicBrainz data are made.

</ul>
;[[Introduction to Voting]]
* [[Advanced Relationships|AdvancedRelationships]]:
:A quick introduction to MusicBrainz's voting system and how edits are applied (or rejected).
<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.

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

</ul>
;[[Search]]
* [[MusicBrainz Terminology|MusicBrainzTerminology]]:
:Describes the different kinds of search you can use to browse MusicBrainz. Also includes the [[Indexed Search Syntax|advanced search syntax]].
<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.

</ul>
;[[MusicBrainz Terminology]]
* [[Release Language|ReleaseLanguage]]:
:A collection of terms the MusicBrainz community uses, what they mean, and whether there is a wiki page explaining them.
<ul><li style="list-style-type:none">Describes the assignement of the language and script attribute to releases.

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

* [[How Annotations Work|HowAnnotationsWork]]:
===Other===
<ul><li style="list-style-type:none">A rudimentary page that explains the [[Artist Annotation|ArtistAnnotation]] and [[Release Annotation|ReleaseAnnotation]].
;[[About/Privacy Policy|Privacy Policy]]
</ul>
:Privacy implications of being a MusicBrainz editor.
* [[How Voting Works|HowVotingWorks]]:

<ul><li style="list-style-type:none">Also quite rudimentary. It explains the decision mechanism of the [[ModBot]].
;[[Flickr Machine Tag]]
</ul>
:How to use flickr tags to refer to MusicBrainz artists, releases, tracks or labels.
* [[Moderator Privacy|ModeratorPrivacy]]:
<ul><li style="list-style-type:none">Privacy implications of being a [[MusicBrainz]] moderator
</ul>
* [[Text Search Syntax|TextSearchSyntax]]:
<ul><li style="list-style-type:none">How to use the powerful text search features in [[MusicBrainz]]
</ul>


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


;[[Developer Resources]]
''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]]
:Catch-all page with a number of useful links for developers

===Metadata===

;[[XML Web Service/Version 2]]
:Our current-version web service, for use in applications

;[[XML Web Service/Version 1]]
:Our old web service, still in common use, e.g. by [[python-musicbrainz2]]


===Software===
===Software===


;[[libmusicbrainz]]
* The [[Client HOWTO|ClientHOWTO]] (from client_howto.html) describes the use of the [[MusicBrainz]] [[Client Library|ClientLibrary]], and the [[Client Examples|ClientExamples]] programs.
:Describes the use of our official library for accessing the web service. 4.x uses version 2, 3.x uses version 1.

;[[python-musicbrainz2]]
:Our now-somewhat-outdated official python library, see [http://python-musicbrainzngs.readthedocs.org/ python-musicbrainzngs] for a newer library.


===Discs===
===Discs===


;[[Disc ID Calculation]]
* [[Disc Submission|DiscSubmission]] is an overview of the highly technical content of [[Disc ID Calculation|DiscIDCalculation]]. (from cd_submission.html and disc.html)
: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===


;[[MusicBrainz Picard/Tags/Mapping|Tag Mappings]]
''The following pages are pretty messy, partially outdated, and make extensive use of [[Bad WikiName|BadWikiName]]<code><nowiki></nowiki></code>s.''
:These are the tag mappings used by [[MusicBrainz Picard]], our official tagging application
* [[ID3v2.4.0|ID3v240]] -- Useful links for people wanting to use ID3v2 tags in applications
* [[ID3v2 Tags|ID3v2Tags]] -- A list of some TXXX tags for ID3v2 to toss about and try to "standardize".
* [[Disc IDs and Tagging|DiscIdsAndTagging]] -- A short exposé on various tagging standards and their handling of [[Disc ID|DiscID]]s
* [[MusicBrainz Tag|MusicBrainzTag]] -- Standardization for [[MusicBrainz]]-specific tags. (from metadata_tags.html)
* [[MusicBrainz Identifier|MusicBrainzIdentifier]] -- as used in standardized [[MusicBrainz Tag|MusicBrainzTag]]<code><nowiki></nowiki></code>s. (from id-intro.html)


===Server===
===Database===


;[[MusicBrainz Database]]
* AutoInsertFromFreeDB -- Explains how data is automatically entered as [[FreeDB Moderation|FreeDBModeration]]s
:Start page for documentation about the database.
* [[Server Access Paths|ServerAccessPaths]]


;[[Database Schema]]
* Various [[Bug Reports|BugReports]] and [[Feature Page|FeaturePage]]s and the like:
:Description of our current schema and database structure.
** [[Calculate Track Times|CalculateTrackTimes]] (was [[Track Times Proposal|TrackTimesProposal]])
** [[Multi-Session CD Bug|MultiSessionCDBug]]


===Database===
;[[Database Setup]]
:Several ways of setting up and using our database.

* [[MusicBrainz Database|MusicBrainzDatabase]]—Start page for documentation about the database
* [[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 Documentation==


;[[Other Databases]]
* [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 music databases which we might try to work with

* [[Links To Free Creative Commons License Music|LinksToFreeCreativeCommonsLicenseMusic]]
* [[MusicBrainz Summit|MusicBrainzSummit]]<code><nowiki></nowiki></code>s
;[[MusicBrainz Summit]]s


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

Revision as of 15:55, 27 September 2019

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

XML Web Service/Version 2
Our current-version web service, for use in applications
XML Web Service/Version 1
Our old web service, still in common use, e.g. by python-musicbrainz2

Software

libmusicbrainz
Describes the use of our official library for accessing the web service. 4.x uses version 2, 3.x uses version 1.
python-musicbrainz2
Our now-somewhat-outdated official python library, see python-musicbrainzngs for a newer library.

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