How Annotations Work: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
(fixed <nowiki> (Imported from MoinMoin))
 
(Redirecting to Annotation)
 
(23 intermediate revisions by 6 users not shown)
Line 1: Line 1:
#REDIRECT [[Annotation]]
This page describes a feature currently in [[MusicBrainz Development|MusicBrainzDevelopment]].

=General Principles=

Annotations can be attached to artists and albums. From now on I'll stick to describing artists only; everything said below also applies to albums.

Each artist can have up to one annotation attached. As the annotation is edited, new versions are created. Only the most recent version is shown on the artist page, but all versions can be examined on a separate "Show History" page.

If there is no annotation, a link is shown (at the bottom of the artist page) inviting you to add an annotation (if you're logged in); if there is an annotation, it is shown, with links to edit it, or to see its history.

Adding a new annotation where there was none before uses exactly the same mechanism as editing an existing annotation to create a new version; in both cases the "Add Artist Annotation" is used. For a new annotation, the text starts off blank. For editing an existing annotation, the text starts off as a copy of the previous annotation, and when you save, a new version of the annotation is created. If you like you can choose to edit a version other than the most recent, in which case you still end up creating a new, most-recent version, just using different text as your starting point.

=Moderation=

When editing / adding an annotation, you can optionally also enter a one-line change log; if provided, this is shown both on the annotation's "Show History" page, and also in the details of the moderation (e.g. on the "show moderation detail" page).

Currently all annotation moderations are always auto-moderated.

It is not possible to delete annotations, except by deleting the host artist.

=Merging and Deleting=

When an artist is deleted, all versions of the annotation attached to it are lost.

When artist "A" is merged into artist "B", creating artist "BA", the behaviour is as follows:
* if neither A nor B had an annotation, then nor will BA.
* if A had an annotation but B did not, then that annotation will get moved to artist BA.
* if B had an annotation but A did not, then that annotation will get moved to artist BA.
* if both A and B had annotations, then the behaviour is as follows:
** all versions of A's annotation and all versions of B's annotation are attached to BA.
** this effectively merges the two annotations together, with an intertwined "history".
** then, a new annotation version is created:
*** where the text is: the text of B's most recent annotation, plus some space, plus the text of A's most recent annotation
*** the change log is: "Result of artist merge"
*** the [[ModBot]] enters an Add Artist Annotation moderation accordingly.

=Albums=

Everything said above also applies to albums.

=Exceptions=

Annotations cannot be attached to:
* Various Artists
* the Deleted Artist

We should probably also disallow annotations for "Non-Album Tracks" albums.
<ul><li style="list-style-type:none">''but'' annotations should be allowed for ''individual'' "Non-Album Tracks" this would be an excellent way of adding information like 'this is a live rare demo recorded at Fillmore 12-6-90, and only available at <code><nowiki>http://artisthomepage.com/downloads/1.html</nowiki></code>' --[[User:mo|mo]]
<ul><li style="list-style-type:none">''The problem with this is that there is no per-track annotation, only per-album. I agree that non-album tracks are probably more needy of annotations than many albums, so it's probably best to just allow annotations for [non-album tracks] and have moderators call out which track a note applies to.'' [[User:Dupuy|@alex]]
</ul>In that case the /real/ answer is to allow track annotations too. But the simple work-around for now is to re-allow annotations for the N-A-T album, like you say, and annotate the tracks when a future release of the server software supports it.
</ul>

=Changes - 2004-10-23=

==Showing the "Short" Version==

The album/artist page now shows a short version of the annotation if the annotation in full is too long. You can suggest where the short version should end by using a paragraph containing simply "-", like this:
<ul><li style="list-style-type:none">Para one, etc etc more of para one. - more stuff....
</ul>

The exact rules for where the short version will break are a bit hazy; it's based mainly on an estimated line count. Basically it just tries to do The Right Thing.

==Diffs==

When editing an annotation you can now preview it before saving. Unless you're creating a new annotation, the preview also shows the diffs from the version you started with.

On the annotation "history" page, you can now compare each annotation to the version before via a "Diff" link. When annotation mods are shown on the moderation pages, a "Diff" link appears there too.

==Editing the not-most-recent version==

If you go to edit a version that's not the most recent version, a warning is displayed. If you preview, you'll be seeing the diffs against the not-most-recent version you started with, ''not'' diffs against the most recent version.

==Locking==

The warnings that "someone else is editing this" have been fixed.

[[Category:To Be Reviewed]] [[Category:Documentation]]

Latest revision as of 16:17, 24 July 2011

Redirect to: