MusicBrainz Documentation: Difference between revisions
PavanChander (talk | contribs) m (→Database: PostgreSQL has been deleted.) |
PavanChander (talk | contribs) m (→User Documentation: Minor formatting changes.) |
||
Line 5: | Line 5: | ||
==User Documentation== |
==User Documentation== |
||
;[[How To|HowTo]]s |
|||
:A collection of tutorials. Lightweight, short and user-orientated step by step instructions. |
|||
</ul> |
|||
;[[How Editing Works|HowEditingWorks]] and the different [[Edit Type|EditType]]s |
|||
:A general introduction and detailed descriptions of each type of edit that you can possibly make to [[MusicBrainz]] data. |
|||
</ul> |
|||
;[[Advanced Relationships|AdvancedRelationships]] |
|||
:The [[Advanced Relationships|AdvancedRelationships]] documentation and the list of [[Advanced Relationship Type|AdvancedRelationshipType]]s. |
|||
</ul> |
|||
;[[Advanced Search|AdvancedSearch]] |
|||
:Describes the server-based search (also used by the [[MusicBrainz Tagger|MusicBrainzTagger]]). |
|||
</ul> |
|||
;[[MusicBrainz Terminology|MusicBrainzTerminology]] |
|||
:A collection of all terms the [[MusicBrainz]] community uses, what they mean, and wheter there is a wiki page explaining them. |
|||
</ul> |
|||
;[[Release Language|ReleaseLanguage]] |
|||
:Describes the assignement of the language and script attribute to releases. |
|||
</ul> |
|||
;[[Picard Documentation|PicardDocumentation]] |
|||
:Documentation of the [[Picard Tagger|PicardTagger]], the next generation tagger in development. |
|||
</ul> |
|||
;[[How Annotations Work|HowAnnotationsWork]] |
|||
:A rudimentary page that explains the [[Artist Annotation|ArtistAnnotation]] and [[Release Annotation|ReleaseAnnotation]]. |
|||
</ul> |
|||
;[[How Voting Works|HowVotingWorks]] |
|||
:Also quite rudimentary. It explains the decision mechanism of the [[ModBot]]. |
|||
</ul> |
|||
;[[Editor Privacy|EditorPrivacy]] |
|||
:Privacy implications of being a [[MusicBrainz]] editor. |
|||
</ul> |
|||
;[[Text Search Syntax|TextSearchSyntax]] |
|||
:How to use the powerful text search features in [[MusicBrainz]] |
|||
</ul> |
|||
;[[Flickr Machine Tag|FlickrMachineTag]] |
|||
:How to use flickr tags to refer to [[MusicBrainz]] artists, releases, tracks or labels. |
|||
</ul> |
|||
==Developer Documentation== |
==Developer Documentation== |
Revision as of 17:07, 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
- 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 MusicBrainzDevelopment. --DonRedman
Software
- The ClientHOWTO describes the use of libmusicbrainz, and the ClientExamples programs.
Discs
- DiscSubmission is an overview of the highly technical content of DiscIDCalculation. (from cd_submission.html and disc.html)
Tagging
The following pages are pretty messy, partially outdated, and make extensive use of BadWikiNames.
- ID3v240 -- Useful links for people wanting to use ID3v2 tags in applications
- ID3v2Tags -- A list of some TXXX tags for ID3v2 to toss about and try to "standardize".
- DiscIdsAndTagging -- A short exposé on various tagging standards and their handling of DiscIDs
- MusicBrainzTag -- Standardization for MusicBrainz-specific tags. (from metadata_tags.html)
- MusicBrainzIdentifier -- as used in standardized MusicBrainzTag
s. (from id-intro.html)
Server
- AutoInsertFromFreeDB -- Explains how data is automatically entered as FreeDBModerations
- ServerAccessPaths
- ReleaseEditorArguments -- Explains the arguments to pre-populate the fields in the release editor
- Various BugReports and FeaturePages and the like:
Database
- MusicBrainzDatabase—Start page for documentation about the database
- PantherDBInstallation—Steps to intall PostgreSQL and import MusicBrainz data on Mac OS X 10.3 aka Panther
- DebianVMWareDatabase—HOWTO install the database under Debian running under VMWare.
Other Documentation
- Japanese documentation for MusicBrainz Metadata Initiative 2.1
- OtherDatabases -- Other music databases which we might try to work with
- LinksToFreeCreativeCommonsLicenseMusic
- MusicBrainzSummit
s