Annotation FAQ: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
((Imported from MoinMoin))
((Imported from MoinMoin))
(4 intermediate revisions by the same user not shown)
Line 15: Line 15:
==Purpose==
==Purpose==


This page answers some basic questions about [[Album Annotation|AlbumAnnotation]]<code><nowiki></nowiki></code>s and [[Artist Annotation|ArtistAnnotation]]<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 and [[Artist Annotation|ArtistAnnotation]]<code><nowiki></nowiki></code>s. If you need more in-depth information you might want to check [[How Annotations Work|HowAnnotationsWork]].


==Table of Contents==
==Table of Contents==
Line 25: Line 25:


===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, and individual album 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, and individual release 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.
----


===How do I add an annotation?===


====How do I add an annotation?====
On every artist or album page, there is a textbox that says:

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


===What can I use it for?===


====What can I use it for?====
* 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_'

* why releases that seem identical are not.
Annotations can:
* that an album 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)
* 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_'
* conformation requests for albums, that seem erroneous
* explain why releases that seem identical are not.
* currently we also add information to identify specific releases (see [[Release Annotation Style|ReleaseAnnotationStyle]] for more information)
* convey that an 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)
* link translated albums to their their original entry, like for example:
* confirm information for releases that otherwise seem erroneous
** ''This is the transliterated/translated version of [[Album Title|AlbumTitle]] ('''link''')''
* be used toidentify 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.''
** ''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.''


----
===What should be avoided in annotations?===


====What should be avoided in annotations?====


Annotations should avoid:
* discussions of any kind, use [[Moderation Notes|ModerationNotes]] 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 [[Moderation Note|ModerationNote]]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 illegaly distribute copyrighted material
* links to sites that illegaly distribute copyrighted material


----
===What text formatting can I use in an annotation?===


====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.
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 might have noticed, that some annotations aren't shown in full length on the album 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.
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.
----


===Can I use links to other websites or MB albums or artists?===


====Can I use links to other websites or MB releases or artists?====
Yes and no, most links should be use [[Advanced Relationship|AdvancedRelationship]]<code><nowiki></nowiki></code>s, 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 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.
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 Relationship|AdvancedRelationship]]<code><nowiki></nowiki></code>s.


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 album/artist already ''has'' an ArtistAnnotation, what should I do?===
----


====This release/artist already ''has'' an ArtistAnnotation, 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.


This works exactly the same way if a release already has an [[Album Annotation|AlbumAnnotation]].
This works exactly the same way if a release already has a [[Release Annotation|ReleaseAnnotation]].
----


===What is this 'Show history' thing? How does it work?===

====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.
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?===
====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.
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.
Notice that the first initial annotation does not have a 'diff' link.
----


===How do I delete an annotation?===

====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." mean?===
====What does "Warning: this is not the most recent annotation for this artist." 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." 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." what does that ''really'' mean?
Line 94: Line 128:


That way you can easily undo spam.
That way you can easily undo spam.
----


===Why does it say that someone else is editing this annotation?===

====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.
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 style guideline for annotations.
====In what form should I write annotations in?====


There is no style guideline for annotations.
----


[[Category:To Be Reviewed]] [[Category:FAQ]] [[Category:WikiDocs Page]]
Authors: [[Mo]], [[User:DonRedman|DonRedman]], [[User:Dupuy|Dupuy]]
[[Category:To Be Reviewed]] [[Category:WikiDocs Page]] [[Category:FAQ]]

Revision as of 14:05, 9 June 2006

Annotations FAQ


NOTE: We are currently standardizing the terminology used in our documentation. In some the following terms used interchangeably. 
  • Album and Release
  • Moderate and Edit

Release and Edit are now standard.

You can update the content of this page on the wiki but please do not add questions without answers. If your question has not been answered here, ask on the MailingLists instead.



Purpose

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

Table of Contents



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, and individual release 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.



How do I add an annotation?

On every artist or release page, there is a textbox that says:

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

Just click Add an annotation and start editing.



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 an 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 toidentify 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.


What should be avoided in annotations?

Annotations should avoid:

  • discussions of any kind, use ModerationNotes 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.
  • links to sites that illegaly distribute copyrighted material


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.

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.



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

Yes and no, most links should be use 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.

Links to specific pages like wikipedia, musicmoz discogs.com, official artist pages and others should be added using AdvancedRelationships.



This release/artist already has an ArtistAnnotation, 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.

This works exactly the same way if a release already has a ReleaseAnnotation.



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." 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." 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 style guideline for annotations.