History:Style Guideline: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
(link to email thread (Imported from MoinMoin))
(small update (Imported from MoinMoin))
Line 1: Line 1:
=Style Guidelines=
=Style Guidelines=


[[MusicBrainz]] has a lot of formalized data. But in all these formalized fields you still type plain text. In order for the database to be in a good consistent shape, we have agreed on a certain ''style'' in which to write this text.
[[MusicBrainz]] has a lot of relational data. But you still have to type plain text in all the database fields. In order for the database to be in a good consistent shape, the [[Style Council|StyleCouncil]] has agreed on a certain ''style'' according to which enter such text should be entered.


'''Note that the [[Style Principle|StylePrinciple]]s of [[MusicBrainz]] state:'''
'''Note that the [[Style Principle|StylePrinciple]]s of [[MusicBrainz]] state:'''
Line 7: Line 7:
# '''If 1 is not applicable, use [[Consistent Original Data|ConsistentOriginalData]].'''
# '''If 1 is not applicable, use [[Consistent Original Data|ConsistentOriginalData]].'''
# '''If both 1 and 2 are not applicable, follow the StyleGuideline<code><nowiki></nowiki></code>s.'''
# '''If both 1 and 2 are not applicable, follow the StyleGuideline<code><nowiki></nowiki></code>s.'''

==Principal Guidelines==


The following guidelines are available:
The following guidelines are available:
Line 22: Line 24:
</ul>
</ul>


==Other Guidelines and Help==
==More==


* If you have a question regarding an [[Odd Release|OddRelease]] you might want to look for it in [[Additional Metadata|AdditionalMetadata]]. If you find it there your question might already been answered. If you do not find it, you can ask on the [[Users Mailing List|UsersMailingList]]. When your problem has been solved, please list your solution there to help others that come after you.
* If you have a question regarding an [[Odd Release|OddRelease]] you might want to look for it in [[Additional Metadata|AdditionalMetadata]]. If you find it there your question might already been answered. If you do not find it, you can ask on the [[Users Mailing List|UsersMailingList]]. When your problem has been solved, please list your solution there to help others that come after you.
Line 32: Line 34:
The style guidelines form a very balanced set of rules. Changing them is a slow and careful process. Since 2005-12 a new process [[How To Change Style Guidelines|HowToChangeStyleGuidelines]] is emerging. See [http://www.nabble.com/forum/Search.jtp?forum=2885&local=y&query=style+council+thoughts these email threads] for details.
The style guidelines form a very balanced set of rules. Changing them is a slow and careful process. Since 2005-12 a new process [[How To Change Style Guidelines|HowToChangeStyleGuidelines]] is emerging. See [http://www.nabble.com/forum/Search.jtp?forum=2885&local=y&query=style+council+thoughts these email threads] for details.


The [[Migration Guideline|MigrationGuideline]] requires that major changes to the StyleGuideline be tested by [[Beta Editing|BetaEditing]] on the [[Test Server|TestServer]], to figure out if it entails any major [[Soft Structure|SoftStructure]] changes.
The [[Migration Guideline|MigrationGuideline]] requires that major changes to the StyleGuideline be tested by [[Beta Editing|BetaEditing]] on the [[Test Server|TestServer]], to figure out if it entails any major [[Soft Structure|SoftStructure]] changes.


[[Category:To Be Reviewed]] [[Category:Style]] [[Category:Index]]
[[Category:To Be Reviewed]] [[Category:Style]] [[Category:Index]]

Revision as of 00:27, 31 January 2006

Style Guidelines

MusicBrainz has a lot of relational data. But you still have to type plain text in all the database fields. In order for the database to be in a good consistent shape, the StyleCouncil has agreed on a certain style according to which enter such text should be entered.

Note that the StylePrinciples of MusicBrainz state:

  1. Follow ArtistIntent.
  2. If 1 is not applicable, use ConsistentOriginalData.
  3. If both 1 and 2 are not applicable, follow the StyleGuidelines.

Principal Guidelines

The following guidelines are available:

  • This is a Wiki version of the OfficialStyleGuidelines on the website which outline how the data in MusicBrainz should be formatted and organized. Being a WikiPage it is more detailed and contains discussion, questions (and answers :-). It is also more up to date than the version on the website.
  • How to capitalize album and track titles. Since June 2004 we are working towards InterNationalization. This will give us language specific standards. CapitalizationStandard lists all available standards for different languages.
  • This is a place for new style guidelines to be proposed and discussed.

Other Guidelines and Help

  • If you have a question regarding an OddRelease you might want to look for it in AdditionalMetadata. If you find it there your question might already been answered. If you do not find it, you can ask on the UsersMailingList. When your problem has been solved, please list your solution there to help others that come after you.
  • You might also want to look at the EditingGuidelines and at InformationOnEditing which explains how different edits work etc.
  • The MisencodingFAQ deals with data where something went wrong with the CharacterEncodings and what to do about it.

Changing Guidelines

The style guidelines form a very balanced set of rules. Changing them is a slow and careful process. Since 2005-12 a new process HowToChangeStyleGuidelines is emerging. See these email threads for details.

The MigrationGuideline requires that major changes to the StyleGuideline be tested by BetaEditing on the TestServer, to figure out if it entails any major SoftStructure changes.