Annotation FAQ: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
((Imported from MoinMoin))
(fixing link (Imported from MoinMoin))
Line 19: 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 and track pages.
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.
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 46: Line 46:
* 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_'
* 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.
* 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 [[Add Annotation|AddAnnotation]]-query)
* 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
* confirm information for releases that otherwise seem erroneous
* be used to identify specific releases (see [[Release Annotation Style|ReleaseAnnotationStyle]] for more information)
* be used to identify specific releases (see [[Release Annotation Style|ReleaseAnnotationStyle]] for more information)

Revision as of 02:58, 3 April 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?

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