Annotation FAQ: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
(Labels (Imported from MoinMoin))
 
(+cards +introducing tracks +intertwingling +tweaks (Imported from MoinMoin))
Line 1: Line 1:
{{LabelsStatus}}
{{AnnotationStatus}}


=Annotations FAQ=
=Annotations FAQ=

{{AnnotationNavigation}}

==Table of contents==


Line 7: Line 11:
==Purpose==
==Purpose==


This page answers some basic questions about [[Release Annotation|ReleaseAnnotation]]<code><nowiki></nowiki></code>s, [[Artist Annotation|ArtistAnnotation]]<code><nowiki></nowiki></code>s and [[Label Annotation|LabelAnnotation]]<code><nowiki></nowiki></code>s. If you need more in-depth information you might want to check [[How Annotations Work|HowAnnotationsWork]].
This page answers some basic questions about [[Release Annotation|ReleaseAnnotation]]<code><nowiki></nowiki></code>s, [[Artist Annotation|ArtistAnnotation]]<code><nowiki></nowiki></code>s, [[Label Annotation|LabelAnnotation]]<code><nowiki></nowiki></code>s and [[Track Annotation|TrackAnnotation]]<code><nowiki></nowiki></code>s. If you need more in-depth information you might want to read [[How Annotations Work|HowAnnotationsWork]].


If that still doesn't help, please find us in one of the [[MusicBrainz Forum|MusicBrainzForum]]<code><nowiki></nowiki></code>s or via the [http://www.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.
If that still doesn't help, please find us in one of the [[MusicBrainz Forum|MusicBrainzForum]]<code><nowiki></nowiki></code>s, [[IRC]], one of the [[Mailing List|MailingList]], or via the [http://www.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 rather want to use [http://wiki.musicbrainz.org/AnnotationDiscussion http://wiki.musicbrainz.org/AnnotationDiscussion] for that).


==FAQ==
==FAQ==
Line 15: Line 19:
====What ''is'' an annotation?====
====What ''is'' an annotation?====


The Annotations are textboxes 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 pages.
The Annotations are textboxes 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|BoxSet]]<code><nowiki></nowiki></code>s, media type such as vinyl or release info such as Remaster... etc, the ideas are limitless.


{i} <small>You can find out more starting with [[Annotation|Annotation overview]]. </small>
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|BoxSet]]<code><nowiki></nowiki></code>s, media type such as vinyl or release info such as Remaster.. etc, the ideas are limitless.
----
----


Line 24: Line 30:
====How do I add an annotation?====
====How do I add an annotation?====


On every artist, label or release page, there is a textbox that says:
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 doesn't yet have an annotation. Add an annotation >>''
<ul><li style="list-style-type:none">''This artist/label/release/track doesn't yet have an annotation. Add an annotation >>''
</ul>
</ul>


Just click '''Add an annotation''' and start editing.
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>
----
----


Line 45: Line 53:
** ''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.''
** ''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>
----
----


Line 53: Line 62:
Annotations must avoid:
Annotations must avoid:
* copy/paste of copyrighted content (especially from commercial databases)
* copy/paste of copyrighted content (especially from commercial databases)
* links to sites that illegally distribute copyrighted material


Annotations should avoid:
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.
* 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.
* links to sites that illegally distribute copyrighted material

Annotations may avoid:
* copy/paste of material coming from resources that could be linked to using relationships (like [http://www.wikipedia.org wikipedia])
* copy/paste of material coming from resources that could be linked to using relationships (like [http://www.wikipedia.org wikipedia])
* copy/paste in general...
* 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>
----
----


Line 70: Line 78:
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.
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>
You might have noticed, that some annotations aren't shown in full length on the release or artist page, and a ''Read more...'' link is appended to the end. You can specify where this link should "break" the annotation in the short view. Simply insert an empty line, a line with a singular hyphen (-) and another empty line.
----
----


Line 77: Line 85:
====Can I use links to other websites or MB releases or artists?====
====Can I use links to other websites or MB releases or artists?====


Yes and no, most links should be use [[Advanced Relationships|AdvancedRelationships]], but if a [[MusicBrainz]] link is put in an annotation, remember to use the 'permanent link', as merging and deleting can change the 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.
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]].
----
----




====This release/label/artist already ''has'' an Annotation, what should I do?====
====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 like usual but this has contents of the current annotation, simply edit (or just add) the necessary things.
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>
----
----


Line 115: Line 124:


====What does "Warning: this is not the most recent annotation for this artist/label/release." mean?====
====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?
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?
Line 135: Line 144:
====In what form should I write annotations in?====
====In what form should I write annotations in?====


There is no style guideline for annotations, but please consult the specific pages ([[Release Annotation|ReleaseAnnotation]]<code><nowiki></nowiki></code>s, [[Artist Annotation|ArtistAnnotation]]<code><nowiki></nowiki></code>s and [[Label Annotation|LabelAnnotation]]<code><nowiki></nowiki></code>s) for more information and style suggestions.
There is no official style guideline for annotations, but please consult the specific pages [[Release Annotation|ReleaseAnnotation]]<code><nowiki></nowiki></code>s, [[Artist Annotation|ArtistAnnotation]]<code><nowiki></nowiki></code>s, [[Label Annotation|LabelAnnotation]]<code><nowiki></nowiki></code>s, [[Track Annotation|TrackAnnotation]]<code><nowiki></nowiki></code>s for more information and style suggestions.

{{AnnotationIntertwingling}}


[[Category:To Be Reviewed]] [[Category:FAQ]] [[Category:WikiDocs Page]]
[[Category:To Be Reviewed]] [[Category:FAQ]] [[Category:WikiDocs Page]]

Revision as of 09:36, 28 March 2007

Template:AnnotationStatus

Annotations FAQ

Template:AnnotationNavigation

Table of contents

Purpose

This page answers some basic questions about ReleaseAnnotations, ArtistAnnotations, LabelAnnotations and TrackAnnotations. If you need more in-depth information you might want to read HowAnnotationsWork.

If that still doesn't help, please find us in one of the MusicBrainzForums, IRC, one of the MailingList, 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 rather want to use http://wiki.musicbrainz.org/AnnotationDiscussion for that).

FAQ

What is an annotation?

The Annotations are textboxes 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 BoxSets, media type such as vinyl or release info such as Remaster... etc, the ideas are limitless.

{i} 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 textbox that says:

  • This artist/label/release/track doesn't yet have an annotation. Add an annotation >>

Just click Add an annotation and start editing.

{i} HowAnnotationsWork 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 in the AddAnnotation-query)
  • confirm information for releases that otherwise seem erroneous
  • be used to identify specific releases (see ReleaseAnnotationStyle for more information)
  • link translated releases to their their original entry, for example:
    • This is the transliterated/translated version of 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} Depending on the context, ArtistAnnotation, ReleaseAnnotation, LabelAnnotation and TrackAnnotation 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 EditNotes for discussions about edits, MailingLists 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...

{i} You can also use either AnnotationDiscussion or AnnotationFuture 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.

{i} HowAnnotationsWork also has a summary



Can I use links to other websites or MB releases or artists?

Yes and no, most links should use AdvancedRelationships: links to specific pages like wikipedia, musicmoz discogs.com, official artist pages and others should be added using 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 like usual but this has contents of the current annotation, simply edit (or just add) the necessary things.

{i} 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 ReleaseAnnotations, ArtistAnnotations, LabelAnnotations, TrackAnnotations for more information and style suggestions.

Template:AnnotationIntertwingling