Difference between revisions of "History:Official Style Guideline"

From MusicBrainz Wiki
m (21 revision(s))
m (Cleaned some of the formatting up.)
Line 1: Line 1:
=Official MusicBrainz Style Guidelines=
 
 
 
The following style guidelines outline how the data in [[MusicBrainz]] should be formatted and organized. If you would like to participate in the editing process, please take a moment to review these guidelines. Please take a look at the [[Users Mailing List|UsersMailingList]] if you require assistance.  
 
The following style guidelines outline how the data in [[MusicBrainz]] should be formatted and organized. If you would like to participate in the editing process, please take a moment to review these guidelines. Please take a look at the [[Users Mailing List|UsersMailingList]] if you require assistance.  
  
Line 7: Line 5:
 
The following are those [[Style Guidelines|StyleGuidelines]] that are officially sanctioned by the [[Style Council|StyleCouncil]].  There are currently two places to find these guidelines:  
 
The following are those [[Style Guidelines|StyleGuidelines]] that are officially sanctioned by the [[Style Council|StyleCouncil]].  There are currently two places to find these guidelines:  
 
* [http://musicbrainz.org/doc/OfficialStyleGuideline musicbrainz.org/doc/OfficialStyleGuideline]  
 
* [http://musicbrainz.org/doc/OfficialStyleGuideline musicbrainz.org/doc/OfficialStyleGuideline]  
<ul><li style="list-style-type:none">The [[WikiDocs]] version of this page.  
+
:The [[WikiDocs]] version of this page.  
</ul>
 
 
* [http://wiki.musicbrainz.org/OfficialStyleGuideline wiki.musicbrainz.org/OfficialStyleGuideline]  
 
* [http://wiki.musicbrainz.org/OfficialStyleGuideline wiki.musicbrainz.org/OfficialStyleGuideline]  
<ul><li style="list-style-type:none">The wiki version of the style guidelines. These might include discussions or changes which are not official yet.  
+
:The wiki version of the style guidelines. These might include discussions or changes which are not official yet.  
</ul>
 
  
Please ''do not change the guidelines themselves'', unless you are a member of the [[Style Council|StyleCouncil]], or you really know what you are doing. If you have ideas for new style guidelines or changes, please send them to the [[Style Mailing List|StyleMailingList]] (if you are new to [[MusicBrainz]], ask on the [[Users Mailing List|UsersMailingList]] first). They might then be added to  [[Proposed Style Guideline|ProposedStyleGuideline]]<code><nowiki></nowiki></code>s and eventually be made an OfficialStyleGuideline by the [[Style Council|StyleCouncil]].  
+
Please ''do not change the guidelines themselves'', unless you are a member of the [[Style Council|StyleCouncil]], or you really know what you are doing. If you have ideas for new style guidelines or changes, please send them to the [[Style Mailing List|StyleMailingList]] (if you are new to [[MusicBrainz]], ask on the [[Users Mailing List|UsersMailingList]] first). They might then be added to  [[Proposed Style Guideline|ProposedStyleGuideline]]s and eventually be made an OfficialStyleGuideline by the [[Style Council|StyleCouncil]].  
  
 
==The Guidelines==
 
==The Guidelines==
Line 22: Line 18:
  
 
The following guidelines apply to the [[Release Title|ReleaseTitle]] field:  
 
The following guidelines apply to the [[Release Title|ReleaseTitle]] field:  
* [[Subtitle Style|SubTitleStyle]]:
+
; [[Subtitle Style|SubTitleStyle]]
<ul><li style="list-style-type:none">Use a colon (:) to separate parts of a title: "''[[Main Title|MainTitle]]: [[Subtitle|SubTitle]]''".  
+
: Use a colon (:) to separate parts of a title: "''[[Main Title|MainTitle]]: [[Subtitle|SubTitle]]''".  
</ul>
+
 
* [[Disc Number Style|DiscNumberStyle]]:  
+
; [[Disc Number Style|DiscNumberStyle]]
** Indicate [[Disc Number|DiscNumber]]<code><nowiki></nowiki></code>s like this: "''[[Main Title|MainTitle]] (disc 2)''".  
+
: Indicate [[Disc Number|DiscNumber]]s like this: "''[[Main Title|MainTitle]] (disc 2)''".  
** If each disc has an extra title do it like this: "''[[Main Title|MainTitle]] (disc 2: [[Disc Title|DiscTitle]])''".  
+
: If each disc has an extra title do it like this: "''[[Main Title|MainTitle]] (disc 2: [[Disc Title|DiscTitle]])''".  
** For bonus discs add "'' (bonus disc)''" to the end.  
+
: For bonus discs add "'' (bonus disc)''" to the end.  
** Individual singles released with a disc number appended to the title should be standardised as "''[[Main Title|MainTitle]] (disc 2)''".  
+
: Individual singles released with a disc number appended to the title should be standardised as "''[[Main Title|MainTitle]] (disc 2)''".
 +
 
 +
; [[Series Number Style|SeriesNumberStyle]]
 +
: [[Volume Number|VolumeNumber]]s are special: append them with a comma like this: "''[[Main Title|MainTitle]], [[Volume Number|VolumeNumber]]''". See [[Volume Number Style|VolumeNumberStyle]] for specific details.
 +
 
 +
; [[Box Set Name Style|BoxSetNameStyle]]
 +
: Box sets are done like this: "''(box 5, disc 2)''".  
  
* [[Series Number Style|SeriesNumberStyle]]:
+
; [[Untitled Bootleg Style|UntitledBootlegStyle]]
<ul><li style="list-style-type:none">[[Volume Number|VolumeNumber]]<code><nowiki></nowiki></code>s are special: append them with a comma like this: "''[[Main Title|MainTitle]], [[Volume Number|VolumeNumber]]''". See [[Volume Number Style|VolumeNumberStyle]] for specific details.
+
: Untitled bootlegs should be labelled like this: "''2000-10-22: Las Vegas, NV, USA''".  
</ul>
+
 
* [[Box Set Name Style|BoxSetNameStyle]]:
+
; [[Multiple Title Style|MultipleTitleStyle]]
<ul><li style="list-style-type:none">Box sets are done like this: "''(box 5, disc 2)''".
+
: Multiple releases on one disc and multiple songs on one track are separated by " / ". Yes, that's ''space, forward slash, space''.  
</ul>
+
 
* [[Untitled Bootleg Style|UntitledBootlegStyle]]:
+
; [[EP Style|EPStyle]]
<ul><li style="list-style-type:none">untitled bootlegs should be labelled like this: "''2000-10-22: Las Vegas, NV, USA''".  
+
: If the word "''EP''" or "''E.P.''" is part of a title, it should be retained.  
</ul>
+
 
* [[Multiple Title Style|MultipleTitleStyle]]:
+
; [[Soundtrack Title Style|SoundtrackTitleStyle]]
<ul><li style="list-style-type:none">Multiple releases on one disc and multiple songs on one track are separated by " / ". Yes, that's ''space, forward slash, space''.  
+
: A soundtrack should be given the same title as the film, and should not include extra detail such as "Original Motion Picture Soundtrack" or similar descriptive information. Set the [[Release Attribute|ReleaseAttribute]] to "Soundtrack".  
</ul>
 
* [[EP Style|EPStyle]]:
 
<ul><li style="list-style-type:none">If the word "''EP''" or "''E.P.''" is part of a title, it should be retained.  
 
</ul>
 
* [[Soundtrack Title Style|SoundtrackTitleStyle]]:
 
<ul><li style="list-style-type:none">A soundtrack should be given the same title as the film, and should not include extra detail such as "Original Motion Picture Soundtrack" or similar descriptive information. Set the [[Release Attribute|ReleaseAttribute]] to "Soundtrack".  
 
</ul>
 
  
 
===Track Titles===
 
===Track Titles===
  
* [[Versus Style|VersusStyle]]:
+
; [[Versus Style|VersusStyle]]
<ul><li style="list-style-type:none">About the uses of "versus" and how we deal with them.  
+
: About the uses of "versus" and how we deal with them.  
</ul>
+
 
* [[Remix Style|RemixStyle]]:
+
; [[Remix Style|RemixStyle]]
<ul><li style="list-style-type:none">How we deal with remixes and other versions of tracks (such as demo versions, etc).  
+
: How we deal with remixes and other versions of tracks (such as demo versions, etc).  
</ul>
+
 
* [[Data Track Style|DataTrackStyle]]:
+
; [[Data Track Style|DataTrackStyle]]
<ul><li style="list-style-type:none">[[Data Track|DataTrack]]s are named "''[data track]''".  
+
: [[Data Track|DataTrack]]s are named "''[data track]''".  
</ul>
+
 
* [[Untitled Track Style|UntitledTrackStyle]]:  
+
; [[Untitled Track Style|UntitledTrackStyle]]
** Untitled tracks are named "''[untitled]''".  
+
: Untitled tracks are named "''[untitled]''".  
** Silence tracks are named "''[silence]''".  
+
: Silence tracks are named "''[silence]''".  
** Unknown tracks are named "''[unknown]''".  
+
: Unknown tracks are named "''[unknown]''".
 +
 
 +
; [[Series Number Style|SeriesNumberStyle]]
 +
: [[Part Number|PartNumber]]<code><nowiki></nowiki></code>s are special: append them with a comma like this: "''Title, [[Part Number|PartNumber]]''". See [[Part Number Style|PartNumberStyle]] for specific details.
 +
 
 +
; [[Extra Title Information Style|ExtraTitleInformationStyle]]
 +
: This is a list of information that should be omitted from [[Release Title|ReleaseTitle]]s and [[Track Title|TrackTitle]]s.  
  
* [[Series Number Style|SeriesNumberStyle]]:
+
; [[Track Attribute Style|TrackAttributeStyle]] (could be merged into the above [[Extra Title Information Style|ExtraTitleInformationStyle]])
<ul><li style="list-style-type:none">[[Part Number|PartNumber]]<code><nowiki></nowiki></code>s are special: append them with a comma like this: "''Title, [[Part Number|PartNumber]]''". See [[Part Number Style|PartNumberStyle]] for specific details.
+
: Enter mix names and other track attributes in parentheses after the title.  
</ul>
 
* [[Extra Title Information Style|ExtraTitleInformationStyle]]:
 
<ul><li style="list-style-type:none">This is a list of information that should be omitted from [[Release Title|ReleaseTitle]]<code><nowiki></nowiki></code>s and [[Track Title|TrackTitle]]<code><nowiki></nowiki></code>s.
 
</ul>
 
* [[Track Attribute Style|TrackAttributeStyle]] (could be merged into the above [[Extra Title Information Style|ExtraTitleInformationStyle]]):
 
<ul><li style="list-style-type:none">Enter mix names and other track attributes in parentheses after the title.  
 
</ul>
 
  
 
===Artists===
 
===Artists===
  
* [[Featuring Artist Style|FeaturingArtistStyle]]:
+
; [[Featuring Artist Style|FeaturingArtistStyle]]
<ul><li style="list-style-type:none">When two artists collaborate, file the track under the [[Primary Artist|PrimaryArtist]], and append the name of the [[Secondary Artist|SecondaryArtist]] to the [[Track Title|TrackTitle]] like this "''(feat. Everlast)''".  
+
: When two artists collaborate, file the track under the [[Primary Artist|PrimaryArtist]], and append the name of the [[Secondary Artist|SecondaryArtist]] to the [[Track Title|TrackTitle]] like this "''(feat. Everlast)''".  
</ul>
+
 
* [[Release Artist Style|ReleaseArtistStyle]]:
+
; [[Release Artist Style|ReleaseArtistStyle]]  
<ul><li style="list-style-type:none">This covers when to use one [[Primary Artist|PrimaryArtist]] and when to use [[Various Artists|VariousArtists]] as [[Release Artist|ReleaseArtist]] for a release. Note that the [[Classical Release Artist Style|ClassicalReleaseArtistStyle]] spells out different rules for classical music.  
+
: This covers when to use one [[Primary Artist|PrimaryArtist]] and when to use [[Various Artists|VariousArtists]] as [[Release Artist|ReleaseArtist]] for a release. Note that the [[Classical Release Artist Style|ClassicalReleaseArtistStyle]] spells out different rules for classical music.  
</ul>
+
 
* [[Unknown Artist Style|UnknownArtistStyle]]:
+
; [[Unknown Artist Style|UnknownArtistStyle]]
<ul><li style="list-style-type:none">If the artist is unknown, file the release/track under the ''[unknown]'' artist.  
+
: If the artist is unknown, file the release/track under the ''[unknown]'' artist.  
</ul>
+
 
* [[No Artist Style|NoArtistStyle]]:
+
; [[No Artist Style|NoArtistStyle]]
<ul><li style="list-style-type:none">Recordings that have no artist should be filed under ''[no artist]''. This would be appropriate for silence, bird song etc.  
+
: Recordings that have no artist should be filed under ''[no artist]''. This would be appropriate for silence, bird song etc.  
</ul>
+
 
* [[Sortname Style|SortNameStyle]]:
+
; [[Sortname Style|SortNameStyle]]
<ul><li style="list-style-type:none">Discusses how [[Artist Sort Name|ArtistSortName]]<code><nowiki></nowiki></code>s should be used.  
+
: Discusses how [[Artist Sort Name|ArtistSortName]]s should be used.  
</ul>
 
  
 
===General Guidelines===
 
===General Guidelines===
  
* [[Capitalization Standard|CapitalizationStandard]]:
+
; [[Capitalization Standard|CapitalizationStandard]]
<ul><li style="list-style-type:none">Discusses how titles should be capitalized in various languages.  
+
: Discusses how titles should be capitalized in various languages.  
</ul>
+
 
* [[Classical Style Guide|ClassicalStyleGuide]]:
+
; [[Classical Style Guide|ClassicalStyleGuide]]
<ul><li style="list-style-type:none">Discusses how details relating to classical music should be stored (also can be applied to musicals). More specific details on [[Classical Release Artist Style|ClassicalReleaseArtistStyle]].  
+
: Discusses how details relating to classical music should be stored (also can be applied to musicals). More specific details on [[Classical Release Artist Style|ClassicalReleaseArtistStyle]].  
</ul>
+
 
* [[Miscellaneous Guideline|MiscellaneousGuideline]]<code><nowiki></nowiki></code>s:
+
; [[Miscellaneous Guideline|MiscellaneousGuideline]]s
<ul><li style="list-style-type:none">Covers the little guidelines that aren't worthy of a whole wiki page all to themselves.  
+
: Covers the little guidelines that aren't worthy of a whole wiki page all to themselves.  
</ul>
+
 
* [[Abbreviation Style|AbbreviationStyle]]:
+
; [[Abbreviation Style|AbbreviationStyle]]
<ul><li style="list-style-type:none">Discusses our policy on abbreviations.  
+
: Discusses our policy on abbreviations.  
</ul>
 
  
 
===Advanced Relationships===
 
===Advanced Relationships===
  
* [[Member Of Band Relationship Style|MemberOfBandRelationshipStyle]]:  
+
; [[Member Of Band Relationship Style|MemberOfBandRelationshipStyle]]:  
<ul><li style="list-style-type:none">If a [[Band Member|BandMember]] is usually known by a particular [[Performance Name|PerformanceName]], use this to link them to the band instead of their [[Legal Name|LegalName]].  
+
: If a [[Band Member|BandMember]] is usually known by a particular [[Performance Name|PerformanceName]], use this to link them to the band instead of their [[Legal Name|LegalName]].  
</ul>
 
  
 
===Release Attributes===
 
===Release Attributes===
  
[[Release Attribute|ReleaseAttribute]]<code><nowiki></nowiki></code>s define the type and status of an audio release and provide information about the contents of the release. Release attributes should apply to most of the tracks on the release. It's OK to have a couple of tracks that do not fit the release attribute, as long as the attribute applies to the release overall.  
+
[[Release Attribute|ReleaseAttribute]]s define the type and status of an audio release and provide information about the contents of the release. Release attributes should apply to most of the tracks on the release. It's OK to have a couple of tracks that do not fit the release attribute, as long as the attribute applies to the release overall.  
* [[Release Type|ReleaseType]]:
+
 
<ul><li style="list-style-type:none">The Type of a release can be: Album, Single, EP, Compilation, Soundtrack, Spokenword, Interview, Audiobook, Live, Remix, or Other. See [[Release Attribute|ReleaseAttribute]] for a short summary and [[Release Type|ReleaseType]] for details.  
+
; [[Release Type|ReleaseType]]
</ul>
+
: The Type of a release can be: Album, Single, EP, Compilation, Soundtrack, Spokenword, Interview, Audiobook, Live, Remix, or Other. See [[Release Attribute|ReleaseAttribute]] for a short summary and [[Release Type|ReleaseType]] for details.  
* [[Release Language|ReleaseLanguage]]:
+
 
<ul><li style="list-style-type:none">The Language used in the [[Release Title|ReleaseTitle]] and [[Track Title|TrackTitle]]s.  
+
; [[Release Language|ReleaseLanguage]]
</ul>
+
: The Language used in the [[Release Title|ReleaseTitle]] and [[Track Title|TrackTitle]]s.  
* [[Release Status|ReleaseStatus]]:
+
 
<ul><li style="list-style-type:none">The Status of a release can be: Official, Promotion, or Bootleg. See [[Release Attribute|ReleaseAttribute]] for a short summary and [[Release Status|ReleaseStatus]] for details.  
+
; [[Release Status|ReleaseStatus]]
</ul>
+
: The Status of a release can be: Official, Promotion, or Bootleg. See [[Release Attribute|ReleaseAttribute]] for a short summary and [[Release Status|ReleaseStatus]] for details.  
  
[[Category:To Be Reviewed]] [[Category:Style]] [[Category:Official Style]] [[Category:WikiDocs Page]]
+
[[Category:Style]] [[Category:Official Style]] [[Category:WikiDocs Page]]

Revision as of 14:11, 25 May 2009

The following style guidelines outline how the data in MusicBrainz should be formatted and organized. If you would like to participate in the editing process, please take a moment to review these guidelines. Please take a look at the UsersMailingList if you require assistance.

About the Style Guidelines

The following are those StyleGuidelines that are officially sanctioned by the StyleCouncil. There are currently two places to find these guidelines:

The WikiDocs version of this page.
The wiki version of the style guidelines. These might include discussions or changes which are not official yet.

Please do not change the guidelines themselves, unless you are a member of the StyleCouncil, or you really know what you are doing. If you have ideas for new style guidelines or changes, please send them to the StyleMailingList (if you are new to MusicBrainz, ask on the UsersMailingList first). They might then be added to ProposedStyleGuidelines and eventually be made an OfficialStyleGuideline by the StyleCouncil.

The Guidelines

It's important to know that these are guidelines, not strict rules. The StylePrinciples explain when guidelines should be applied and when they should not. There are also officially sanctioned ExceptionsToTheStyleGuidelines.

Release Titles

The following guidelines apply to the ReleaseTitle field:

SubTitleStyle
Use a colon (:) to separate parts of a title: "MainTitle: SubTitle".
DiscNumberStyle
Indicate DiscNumbers like this: "MainTitle (disc 2)".
If each disc has an extra title do it like this: "MainTitle (disc 2: DiscTitle)".
For bonus discs add " (bonus disc)" to the end.
Individual singles released with a disc number appended to the title should be standardised as "MainTitle (disc 2)".
SeriesNumberStyle
VolumeNumbers are special: append them with a comma like this: "MainTitle, VolumeNumber". See VolumeNumberStyle for specific details.
BoxSetNameStyle
Box sets are done like this: "(box 5, disc 2)".
UntitledBootlegStyle
Untitled bootlegs should be labelled like this: "2000-10-22: Las Vegas, NV, USA".
MultipleTitleStyle
Multiple releases on one disc and multiple songs on one track are separated by " / ". Yes, that's space, forward slash, space.
EPStyle
If the word "EP" or "E.P." is part of a title, it should be retained.
SoundtrackTitleStyle
A soundtrack should be given the same title as the film, and should not include extra detail such as "Original Motion Picture Soundtrack" or similar descriptive information. Set the ReleaseAttribute to "Soundtrack".

Track Titles

VersusStyle
About the uses of "versus" and how we deal with them.
RemixStyle
How we deal with remixes and other versions of tracks (such as demo versions, etc).
DataTrackStyle
DataTracks are named "[data track]".
UntitledTrackStyle
Untitled tracks are named "[untitled]".
Silence tracks are named "[silence]".
Unknown tracks are named "[unknown]".
SeriesNumberStyle
PartNumbers are special: append them with a comma like this: "Title, PartNumber". See PartNumberStyle for specific details.
ExtraTitleInformationStyle
This is a list of information that should be omitted from ReleaseTitles and TrackTitles.
TrackAttributeStyle (could be merged into the above ExtraTitleInformationStyle)
Enter mix names and other track attributes in parentheses after the title.

Artists

FeaturingArtistStyle
When two artists collaborate, file the track under the PrimaryArtist, and append the name of the SecondaryArtist to the TrackTitle like this "(feat. Everlast)".
ReleaseArtistStyle
This covers when to use one PrimaryArtist and when to use VariousArtists as ReleaseArtist for a release. Note that the ClassicalReleaseArtistStyle spells out different rules for classical music.
UnknownArtistStyle
If the artist is unknown, file the release/track under the [unknown] artist.
NoArtistStyle
Recordings that have no artist should be filed under [no artist]. This would be appropriate for silence, bird song etc.
SortNameStyle
Discusses how ArtistSortNames should be used.

General Guidelines

CapitalizationStandard
Discusses how titles should be capitalized in various languages.
ClassicalStyleGuide
Discusses how details relating to classical music should be stored (also can be applied to musicals). More specific details on ClassicalReleaseArtistStyle.
MiscellaneousGuidelines
Covers the little guidelines that aren't worthy of a whole wiki page all to themselves.
AbbreviationStyle
Discusses our policy on abbreviations.

Advanced Relationships

MemberOfBandRelationshipStyle
If a BandMember is usually known by a particular PerformanceName, use this to link them to the band instead of their LegalName.

Release Attributes

ReleaseAttributes define the type and status of an audio release and provide information about the contents of the release. Release attributes should apply to most of the tracks on the release. It's OK to have a couple of tracks that do not fit the release attribute, as long as the attribute applies to the release overall.

ReleaseType
The Type of a release can be: Album, Single, EP, Compilation, Soundtrack, Spokenword, Interview, Audiobook, Live, Remix, or Other. See ReleaseAttribute for a short summary and ReleaseType for details.
ReleaseLanguage
The Language used in the ReleaseTitle and TrackTitles.
ReleaseStatus
The Status of a release can be: Official, Promotion, or Bootleg. See ReleaseAttribute for a short summary and ReleaseStatus for details.