Annotation FAQ: Difference between revisions
((Imported from MoinMoin)) |
((Imported from MoinMoin)) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 11: | Line 11: | ||
===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. |
|||
<ul><li style="list-style-type:none">It's a new feature, it enables anyone, even you, to add a note to an artist's page, or any individual album. Unlike most other [[Metadata|MetaData]] at [[MusicBrainz]], where you should only enter factual, categorical data, such as title, artist name date etc. annotations can be used to add information; like miniature artist biographies, links to sites, information about [[Box Set|BoxSet]]s, if this is a vinyl-release or a Remaster.. etc, the ideas are limitless. |
|||
</ul> |
|||
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. |
|||
===Ok, but what should I and what should I not use it for?=== |
|||
===How do I add an Annotation?=== |
|||
''(might be unnecessary question, but I wanted to give a brief description of some examples of do's and don'ts ~[[User:mo|mo]])'' |
|||
* You can for example put links there. links to websites, official or fanbased. Discographies, to track listings (in the case of [[Album Annotation|AlbumAnnotation]]s). Links to [http://Wikipedia.org Wikipedia] articles, other [[MusicBrainz]] albums and artists etc. |
|||
| ⚫ | |||
* What differentiates an album from an (seemingly identical) other. |
|||
| ⚫ | |||
* A reminder that so and so should be linked to so and so artist/album once [[Advanced Relationships|AdvancedRelationships]] is in action. |
|||
* If a release looks dodgey but what you want is confirmation and information about it before you actually initiating any moderations. |
|||
<ul><li style="list-style-type:none">'''However''', Annotations should ''not'' be used for discussing any moderation or release, this is what [[Moderation Notes|ModerationNotes]] are for. |
|||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
On every artist or album page, there is a textbox that says: |
|||
| ⚫ | |||
</ul> |
</ul> |
||
Just click '''Add an annotation''' and start editing. |
|||
''these are proliminary examples and forming tests. feel free to change/add, move them about or to even put them on another page. ~[[User:mo|mo]]'' |
|||
=== |
===What can I use it for?=== |
||
| ⚫ | |||
| ⚫ | |||
* why releases that seem identical are not. |
|||
</ul> |
|||
| ⚫ | |||
* conformation requests for albums, that seem erroneous |
|||
* currently we also add information to identify specific releases (see [[Release Annotation Style|ReleaseAnnotationStyle]] for more information) |
|||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
===What should be avoided in annotations?=== |
|||
* 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. |
|||
* 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. |
|||
<ul><li style="list-style-type:none">Currently you can add a new paragraph by creating two new lines, (i.e., press [enter] twice) Secondly, you can (and ''should'' if the annotation gets long) add a 'read more' break. You do this by simply adding a new line, a hyphen, and a new line again (i.e. [enter] - [enter]). Otherwise, if the entry is more than a certain length, one will be added automatically, perhaps not at the best point. |
|||
</ul> |
|||
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. |
|||
===Can I use links to other websites or MB albums or artists?=== |
===Can I use links to other websites or MB albums 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. |
|||
</ul> |
|||
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. |
|||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
</ul> |
|||
| ⚫ | |||
| ⚫ | |||
</ul> |
|||
| ⚫ | |||
===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. |
|||
</ul> |
|||
===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. |
|||
</ul> |
|||
Notice that the first initial Annotation does not have a 'diff' link. |
|||
</ul> |
|||
===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. |
|||
</ul> |
|||
===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? |
||
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. |
|||
</ul> |
|||
That way you can easily undo spam. |
|||
</ul> |
|||
===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. |
|||
<ul><li style="list-style-type:none">Because somewhere out there in the world, within the last 20 minutes, someone else was editing this annotation. |
|||
</ul> |
|||
<ul><li style="list-style-type:none">You'll expect to see this a lot with really popular artists or albums. |
|||
</ul> |
|||
===In what form should I write Annotations in?=== |
===In what form should I write Annotations in?=== |
||
There is no style guideline for annotations. |
|||
<ul><li style="list-style-type:none">This is still up for discussion. |
|||
</ul> |
|||
----Authors: [[Mo]], [[User:DonRedman|DonRedman]], [[User:Dupuy|Dupuy]] |
----Authors: [[Mo]], [[User:DonRedman|DonRedman]], [[User:Dupuy|Dupuy]] |
||
Revision as of 10:51, 6 March 2006
Frequently Asked Questions about Annotations
This page answers some basic questions about AlbumAnnotations and ArtistAnnotations. If you need more in-depth information you might want to check HowAnnotationsWork.
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.
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 album page, there is a textbox that says:
- This artist/album doesn't yet have an annotation. Add an annotation >>
Just click Add an annotation and start editing.
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.
- 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 AddAnnotation-query)
- conformation requests for albums, that seem erroneous
- currently we also add information to identify specific releases (see ReleaseAnnotationStyle for more information)
- link translated albums to their their original entry, like for example:
- This is the transliterated/translated version of AlbumTitle (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?
- discussions of any kind, use ModerationNotes for discussions about edits, MailingList
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
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 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.
Can I use links to other websites or MB albums 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 album/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 an AlbumAnnotation.
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.
