Annotation FAQ: Difference between revisions
From MusicBrainz Wiki
Jump to navigationJump to search
m (20 revision(s)) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{DocumentationHeader}} {{AnnotationHeader}} |
{{DocumentationHeader}} {{AnnotationHeader}} |
||
=Annotations FAQ= |
|||
==Table of contents== |
|||
==Purpose== |
==Purpose== |
||
This page answers some basic questions about [[Release Annotation |
This page answers some basic questions about [[Release Annotation]]s, [[Artist Annotation]]s, [[Label Annotation]]s and [[Track Annotation]]s. If you need more in-depth information you might want to read [[How Annotations Work]]. |
||
If that still doesn't help, please find us in one of the [[MusicBrainz Forum |
If that still doesn't help, please find us in one of the [[MusicBrainz Forum]]s, [[IRC]], one of the [[Mailing List]], or via the [http://musicbrainz.org/support/contact.html contact page]. If you would like to update the content of [http://wiki.musicbrainz.org/AnnotationFAQ this page] on the wiki, feel free to do so but please do not add questions without answers (you might want to use the [http://wiki.musicbrainz.org/Talk:Annotation annotations talk page] for that). |
||
==FAQ== |
==FAQ== |
||
===What ''is'' an annotation?=== |
|||
Annotations are |
Annotations are text boxes that function quite a lot like a miniature wiki. This feature enables anyone, to add and edit informational notes on artist pages, label pages, and individual release and track pages. |
||
Annotations can be used to add information that usually doesn't fit into the strict structural data schema of MusicBrainz. Examples are general information, miniature artist biographies, additional release data, information about [[Box Set |
Annotations can be used to add information that usually doesn't fit into the strict structural data schema of MusicBrainz. Examples are general information, miniature artist biographies, additional release data, information about [[Box Set]]s, media type such as vinyl or release info such as remaster... etc, the ideas are limitless. |
||
[[Image:info.png]] You can find out more starting with [[Annotation|annotation overview]]. |
|||
{i} <small>You can find out more starting with [[Annotation|Annotation overview]]. </small> |
|||
---- |
---- |
||
===How do I add an annotation?=== |
|||
On every artist, label, track or release page, there is a text box that says: |
|||
====How do I add an annotation?==== |
|||
* ''This artist/label/release/track doesn't yet have an annotation. Add an annotation >>'' |
|||
Just click '''Add an annotation''' and start editing. |
|||
On every artist, label, track or release page, there is a textbox that says: |
|||
<ul><li style="list-style-type:none">''This artist/label/release/track doesn't yet have an annotation. Add an annotation >>'' |
|||
</ul> |
|||
[[Image:info.png]] [[How Annotations Work]] has detailed explanations and screenshots about the annotations editing mechanism. |
|||
Just click '''Add an annotation''' and start editing. |
|||
{i} <small>[[How Annotations Work|HowAnnotationsWork]] has detailed explanations and screenshots about the annotations editing mechanism. </small> |
|||
---- |
---- |
||
===What can I use it for?=== |
|||
Annotations can: |
|||
====What can I use it for?==== |
|||
* provide information that is relevant to track times, bonus tracks, artist names; and you can combine this with links, for example 'the last three tracks on this release are bonus tracks, the original release is at _link_' |
|||
* explain why releases that seem identical are not. |
|||
* convey that a release needs to be worked on, (in which case it would be a good idea to use a change log text, as this is what people see when people search for annotation edits) |
|||
* confirm information for releases that otherwise seem erroneous |
|||
* be used to identify specific releases (see [[Release Annotation Style]] for more information) |
|||
* link translated releases to their their original entry, for example: |
|||
** ''This is the transliterated/translated version of [[Release Title]] ('''link''')'' |
|||
** ''This is the original version of '''link'''. please do not merge these two versions or change the capitalization or halfwidth etc. of this one. That is what the transliterated/translated version is for.'' |
|||
[[Image:info.png]] Depending on the context, [[Artist Annotation]], [[Release Annotation]], [[Label Annotation]] and [[Track Annotation]] all have further annotation content suggestion. |
|||
Annotations can: |
|||
* provide information that is relevant to track times, bonus tracks, artist names; and you can combine this with links, for example 'the last three tracks on this release are bonus tracks, the original release is at _link_' |
|||
* explain why releases that seem identical are not. |
|||
* convey that a release needs to be worked on, (in which case it would be a good idea to use a change log text, as this is what people see in the AddAnnotation-query) |
|||
* confirm information for releases that otherwise seem erroneous |
|||
* be used to identify specific releases (see [[Release Annotation Style|ReleaseAnnotationStyle]] for more information) |
|||
* link translated releases to their their original entry, for example: |
|||
** ''This is the transliterated/translated version of [[Release Title|ReleaseTitle]] ('''link''')'' |
|||
** ''This is the original version of '''link'''. please do not merge these two versions or change the capitalizations or halfwith etc. of this one. That is what the transliterated/translated version is for.'' |
|||
{i} <small>Depending on the context, [[Artist Annotation|ArtistAnnotation]], [[Release Annotation|ReleaseAnnotation]], [[Label Annotation|LabelAnnotation]] and [[Track Annotation|TrackAnnotation]] all have further annotation content suggestion </small> |
|||
---- |
---- |
||
===What should be avoided in annotations?=== |
|||
Annotations must avoid: |
|||
====What should be avoided in annotations?==== |
|||
* copy/paste of copyrighted content (especially from commercial databases) |
|||
* links to sites that illegally distribute copyrighted material |
|||
Annotations |
Annotations should avoid: |
||
* discussions of any kind, use [[Edit Note]]s for discussions about edits, [[Mailing List]]s for general questions and discussion, many pages in this wiki also have a section for discussion about the page topic, etc. |
|||
* copy/paste of copyrighted content (especially from commercial databases) |
|||
* copy/paste of material coming from resources that could be linked to using relationships (like [http://www.wikipedia.org Wikipedia]) |
|||
* links to sites that illegally distribute copyrighted material |
|||
* copy/paste in general... |
|||
[[Image:info.png]] You can also use either [[Talk:Annotation]] or [[Annotation Future]] for general questions/discussions about the annotation system. |
|||
Annotations should avoid: |
|||
* discussions of any kind, use [[Edit Note|EditNote]]s for discussions about edits, [[Mailing List|MailingList]]<code><nowiki></nowiki></code>s for general questions and discussion, many pages in this wiki also have a section for discussion about the page topic, etc. |
|||
* copy/paste of material coming from resources that could be linked to using relationships (like [http://www.wikipedia.org wikipedia]) |
|||
* copy/paste in general... |
|||
{i} <small>You can also use either [[Talk:Annotation|AnnotationDiscussion]] or [[Annotation Future|AnnotationFuture]] for general questions/discussions about the annotation system </small> |
|||
---- |
---- |
||
===What text formatting can I use in an annotation?=== |
|||
You can use a simple wiki style formatting, that supports links, lists and simple font styles. A short help on the syntax can be found below the annotation edit text field. |
|||
====What text formatting can I use in an annotation?==== |
|||
[[Image:info.png]] [[How Annotations Work|HowAnnotationsWork]] also has a summary. |
|||
You can use a simple wiki style formatting, that supports links, lists and simple font styles. A short help on the syntax can be found below the annotation edit text field. |
|||
{i} <small>[[How Annotations Work|HowAnnotationsWork]] also has a summary </small> |
|||
---- |
---- |
||
===Can I use links to other websites or MB releases or artists?=== |
|||
Yes and no, most links should use [[Advanced Relationships]]: links to specific pages like [http://www.wikipedia.org Wikipedia], [http://www.musicmoz.org MusicMoz], [http://discogs.com Discogs.com], official artist pages and others should be added using [[Advanced Relationships]]. |
|||
====Can I use links to other websites or MB releases or artists?==== |
|||
If a [[MusicBrainz]] link is put in an annotation, remember to use the 'permanent link', as merging and deleting can change other links. |
|||
Yes and no, most links should use [[Advanced Relationships|AdvancedRelationships]]: links to specific pages like [http://www.wikipedia.org wikipedia], [http://www.musicmoz.org musicmoz] [http://discogs.com discogs.com], official artist pages and others should be added using [[Advanced Relationships|AdvancedRelationships]]. |
|||
If a [[MusicBrainz]] link is put in an annotation, remember to use the 'permanent link', as merging and deleting can change the links. |
|||
---- |
---- |
||
===This release/label/artist/track already ''has'' an annotation, what should I do?=== |
|||
You can still edit this annotation! just click the 'Edit' link in the blue bar at the bottom. You will be presented with a textarea as usual but this has contents of the current annotation, simply edit (or just add) the necessary things. |
|||
====This release/label/artist/track already ''has'' an Annotation, what should I do?==== |
|||
[[Image:info.png]] For screenshots, see [[How Annotations Work|HowAnnotationsWork]] |
|||
You can still edit this Annotation! just click the 'Edit' link in the blue bar at the bottom. You will be presented with a textarea like usual but this has contents of the current annotation, simply edit (or just add) the necessary things. |
|||
{i} <small>For screenshots, see [[How Annotations Work|HowAnnotationsWork]] </small> |
|||
---- |
---- |
||
===What is this 'Show history' thing? How does it work?=== |
|||
Show History gives a detailed list of edits done to this specific annotation, from the first to the last (and current) this way spam or malicious edits (edits done to remove or destroy data) can be rectified easily. |
|||
====What is this 'Show history' thing? How does it work?==== |
|||
Show History gives a detailed list of edits done to this specific annotation, from the first to the last (and current) this way spam or malicious edits (edits done to remove or destroy data) can be rectified easily. |
|||
---- |
---- |
||
===What does clicking 'diff' do?=== |
|||
The 'diff' link shows differences between the current revision of the annotation and the last one in the history. It gives you a quick overview of the parts that have been changed with the last modification. |
|||
====What does clicking 'diff' do?==== |
|||
Notice that the first initial annotation does not have a 'diff' link. |
|||
The 'diff' link shows differences between the current revision of the annotation and the last one in the history. It gives you a quick overview of the parts that have been changed with the last modification. |
|||
Notice that the first initial annotation does not have a 'diff' link. |
|||
---- |
---- |
||
===How do I delete an annotation?=== |
|||
Currently, all you can do to delete an annotation is to delete all the text in it. |
|||
Currently, all you can do to delete an annotation is to delete all the text in it. |
|||
---- |
---- |
||
===What does "Warning: this is not the most recent annotation for this artist/label/release/track." mean?=== |
|||
I am editing an annotation but at the top of the page there is a warning in yellow that says "Warning: this is not the most recent annotation for this artist/label/release." what does that ''really'' mean? |
|||
Exactly what it says, you are editing one of the annotations on the history page. If you save your changes they will replace the current annotation. |
|||
I am editing an annotation but at the top of the page there is a warning in yellow that says "Warning: this is not the most recent annotation for this artist/label/release." what does that ''really'' mean? |
|||
That way you can easily undo spam. |
|||
Exactly what it says, you are editing one of the annotations on the history page. If you save your changes they will replace the current annotation. |
|||
That way you can easily undo spam. |
|||
---- |
---- |
||
===Why does it say that someone else is editing this annotation?=== |
|||
This message appears, when somebody else was editing the annotation within the last 20 minutes and it should help to avoid problems, when two people are trying to edit the text at the same time. |
|||
====Why does it say that someone else is editing this annotation?==== |
|||
This message appears, when somebody else was editing the annotation within the last 20 minutes and it should help to avoid problems, when two people are trying to edit the text at the same time. |
|||
---- |
---- |
||
===In what form should I write annotations in?=== |
|||
====In what form should I write annotations in?==== |
|||
There is no official style guideline for annotations, but please consult the specific pages [[Release Annotation |
There is no official style guideline for annotations, but please consult the specific pages [[Release Annotation]]s, [[Artist Annotation]]s, [[Label Annotation]]s, [[Track Annotation]]s for more information and style suggestions. |
||
{{AnnotationFooter}} |
{{AnnotationFooter}} |
||
{{DocumentationFooter|1.0|dmppanda}} |
|||
[[Category:To Be Reviewed]] [[Category:FAQ]] [[Category:Annotation]] [[Category:WikiDocs Page]] |
[[Category:To Be Reviewed]] [[Category:FAQ]] [[Category:Annotation]] [[Category:WikiDocs Page]] |
||
Revision as of 06:27, 31 March 2009
Template:DocumentationHeader Template:AnnotationHeader
Purpose
This page answers some basic questions about Release Annotations, Artist Annotations, Label Annotations and Track Annotations. If you need more in-depth information you might want to read How Annotations Work.
If that still doesn't help, please find us in one of the MusicBrainz Forums, IRC, one of the Mailing List, or via the contact page. If you would like to update the content of this page on the wiki, feel free to do so but please do not add questions without answers (you might want to use the annotations talk page for that).
FAQ
What is an annotation?
Annotations are text boxes that function quite a lot like a miniature wiki. This feature enables anyone, to add and edit informational notes on artist pages, label pages, and individual release and track pages.
Annotations can be used to add information that usually doesn't fit into the strict structural data schema of MusicBrainz. Examples are general information, miniature artist biographies, additional release data, information about Box Sets, media type such as vinyl or release info such as remaster... etc, the ideas are limitless.
You can find out more starting with annotation overview.
How do I add an annotation?
On every artist, label, track or release page, there is a text box that says:
- This artist/label/release/track doesn't yet have an annotation. Add an annotation >>
Just click Add an annotation and start editing.
How Annotations Work has detailed explanations and screenshots about the annotations editing mechanism.
What can I use it for?
Annotations can:
- provide information that is relevant to track times, bonus tracks, artist names; and you can combine this with links, for example 'the last three tracks on this release are bonus tracks, the original release is at _link_'
- explain why releases that seem identical are not.
- convey that a release needs to be worked on, (in which case it would be a good idea to use a change log text, as this is what people see when people search for annotation edits)
- confirm information for releases that otherwise seem erroneous
- be used to identify specific releases (see Release Annotation Style for more information)
- link translated releases to their their original entry, for example:
- This is the transliterated/translated version of Release Title (link)
- This is the original version of link. please do not merge these two versions or change the capitalization or halfwidth etc. of this one. That is what the transliterated/translated version is for.
Depending on the context, Artist Annotation, Release Annotation, Label Annotation and Track Annotation all have further annotation content suggestion.
What should be avoided in annotations?
Annotations must avoid:
- copy/paste of copyrighted content (especially from commercial databases)
- links to sites that illegally distribute copyrighted material
Annotations should avoid:
- discussions of any kind, use Edit Notes for discussions about edits, Mailing Lists for general questions and discussion, many pages in this wiki also have a section for discussion about the page topic, etc.
- copy/paste of material coming from resources that could be linked to using relationships (like Wikipedia)
- copy/paste in general...
You can also use either Talk:Annotation or Annotation Future for general questions/discussions about the annotation system.
What text formatting can I use in an annotation?
You can use a simple wiki style formatting, that supports links, lists and simple font styles. A short help on the syntax can be found below the annotation edit text field.
HowAnnotationsWork also has a summary.
Can I use links to other websites or MB releases or artists?
Yes and no, most links should use Advanced Relationships: links to specific pages like Wikipedia, MusicMoz, Discogs.com, official artist pages and others should be added using Advanced Relationships.
If a MusicBrainz link is put in an annotation, remember to use the 'permanent link', as merging and deleting can change other links.
This release/label/artist/track already has an annotation, what should I do?
You can still edit this annotation! just click the 'Edit' link in the blue bar at the bottom. You will be presented with a textarea as usual but this has contents of the current annotation, simply edit (or just add) the necessary things.
For screenshots, see HowAnnotationsWork
What is this 'Show history' thing? How does it work?
Show History gives a detailed list of edits done to this specific annotation, from the first to the last (and current) this way spam or malicious edits (edits done to remove or destroy data) can be rectified easily.
What does clicking 'diff' do?
The 'diff' link shows differences between the current revision of the annotation and the last one in the history. It gives you a quick overview of the parts that have been changed with the last modification.
Notice that the first initial annotation does not have a 'diff' link.
How do I delete an annotation?
Currently, all you can do to delete an annotation is to delete all the text in it.
What does "Warning: this is not the most recent annotation for this artist/label/release/track." mean?
I am editing an annotation but at the top of the page there is a warning in yellow that says "Warning: this is not the most recent annotation for this artist/label/release." what does that really mean?
Exactly what it says, you are editing one of the annotations on the history page. If you save your changes they will replace the current annotation.
That way you can easily undo spam.
Why does it say that someone else is editing this annotation?
This message appears, when somebody else was editing the annotation within the last 20 minutes and it should help to avoid problems, when two people are trying to edit the text at the same time.
In what form should I write annotations in?
There is no official style guideline for annotations, but please consult the specific pages Release Annotations, Artist Annotations, Label Annotations, Track Annotations for more information and style suggestions.
