Edit Note: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
mNo edit summary
(Rewrote page; included edit note syntax.)
Line 1: Line 1:
{{DocumentationHeader|Editing|Communication}}
{{DocumentationHeader|Editing|Communication}}


Edit notes are comments left by users on an edit and are an important form of communication between users on the site. They can either be entered at the same time as an edit, or can be added to an existing edit.
EditNotes provide an important avenue for discussing specific changes to the [[MusicBrainz]] database.


'''Note:''' All users are expected to follow the [[Code Of Conduct|Code of Conduct]] when entering an edit note.
Whenever you make an edit you are prompted to enter an edit note, and any editor may enter a note on existing edits in addition to voting on them.


===How to do it===
== What to use them for ==


Common uses for edit notes are to:
[[Image:Alert.png]] All [[Editor]]s and [[Auto-Editor|AutoEditor]]s entering edit notes are expected to follow the [[Code Of Conduct|CodeOfConduct]]. [[How To Write Edit Notes|HowToWriteEditNotes]] explains what good edit notes look like.
* provide supplementary information (e.g. a URL that contains the source information)
* ask for clarification on an edit (e.g. if no source was provided)
* discuss the changes being made and/or whether they're appropriate changes (e.g. perhaps the change doesn't follow the [[Style Guidelines]])
* enable a more experienced user to help answer another user's questions (e.g. questions on how to correctly perform an edit)


Edit notes can be as long or as short as you like, but keep in mind that others will have to read and understand what you are saying. See [[How To Write Edit Notes|how to write edit notes]] for more information.
To enter a note on an existing edit, click on the "Add Note" link. These can be found at the "Show Edit" page, or any [http://musicbrainz.org/mod/search/results.html?artist_type=3&artist_id=36434&orderby=desc Edits List] page. Then enter your comment in the [http://musicbrainz.org/mod/addnote.html?modid=1686231 text box] and click Submit! HTML syntax is not supported, but URLs are automatically displayed as clickable links.


== Email notification ==
If you want to make a link to another edit, you can enter the full URL, or as a shortcut '''edit #editid''', with ''editid'' replaced with the edit number. Example: ''edit #123456''. See [[Edit Note Syntax|EditNoteSyntax]] for more info.


Any edit notes that are made will always be displayed when viewing the edit they're left on. Additionally, they will also be sent via email to:
===What it does===
⚫
* the user that made the edit
* others users who have entered a note on the edit
* any user who has voted on the edit


'''Note:''' Only "Yes" or "No" votes count for the purpose of receiving notes. Abstaining will not cause you to receive notes unless you have also entered a note of your own.
The edit note will be displayed with the edit, and sent by email to:
⚫
* The Editor who made the edit
* Anyone who has entered an edit note on the edit (whether they have voted or not) and who has selected the related option in their User Preferences.
* Anyone whose most recent vote is either ''Yes'' or ''No'' - not ''Abstain'' - and who has selected the related option in User Preferences.


⚫
== When to do it ==
This allows most interested parties to be included in the discussion. This is why it's important to provide a valid email address in your profile.


⚫
It is good practice to enter a note whenever you make a non-trivial edit, to explain the edit to other users. Entering a URL link to supporting information is particularly helpful. It is also important to enter a note if you are making a contentious edit such as adding a [[Non-Album Track|non-album track]] or removing anything from the database, otherwise users are likely to vote against the edit.
⚫
===When to do it===


⚫
If you are voting against an edit it is important to enter a note explaining why. Such a note serves several purposes: it explains to the editor why you believe their change to be incorrect (so that they won't make the same mistake again, and can even cancel the edit in question), it and warns other voters that they should not vote "Yes" to the edit. It also allows an editor to contact you to explain why they feel their edit is correct, and perhaps convince you to change your vote.
⚫
It is good practice to enter a note whenever you make a non-trivial edit, to explain the edit to other users. Entering a URL link to supporting information is particularly helpful. It is essential to enter a note if you are making a contentious edit such as adding a [[Non-Album Track|NonAlbumTrack]], doing a [[Remove Release Edit|RemoveReleaseEdit]] etc., otherwise users are likely to vote no.


== Edit note syntax ==
⚫
If you are voting 'no' on an edit, it is important to enter a note explaining why you are voting 'no'. Such a note serves several purposes: it explains to the editor why you believe their change to be incorrect (so that they won't make the same mistake again, and can even delete the edit in question) and warns other voters that they should not vote 'yes' to the edit. It also allows an editor to contact you to explain why they feel their edit is correct, and perhaps convince you to change your vote.


HTML syntax is not supported, but URLs are automatically displayed as clickable links and there is some basic wiki syntax markup available.
==Related==


{| border="1"
[[Commonly Used Edit Notes|CommonlyUsedEditNotes]]
! Description !! You type !! You get
|-
| Italic text || <nowiki>''italic''</nowiki> || ''italic''
|-
| Bold text || <nowiki>'''bold'''</nowiki> || '''bold'''
|-
| Linking to an edit || edit #123456<br /> edit:123456<br /> edit 123456 || [[Edit:123456|edit #123456]]
|-
| Linking to a WikiDoc page || doc:Edit_Note_Syntax<br /> [Edit_Note_Syntax] || [http://musicbrainz.org/doc/Edit_Note_Syntax Edit_Note_Syntax]
|-
| style="padding-right:20px" | Linking to artist/release group/release/track/label || colspan="2" align="center"| '''''Not available yet, see [[Ticket:1609|ticket #1609]].'''''
|}


; Notes
⚫
[[Category:To Be Reviewed]] [[Category:Editing]] [[Category:Communication Forum]] [[Category:Terminology]] [[Category:WikiDocs Page]]

* There is no syntax to use when entering in a URL, any entered URLs will turn into links automatically.
* URLs may break if there are special characters in the URL, but if this happens it is a simple matter to fix.
** Copy the URL (by right clicking on the link); paste this URL into a new window or tab; now copy the remaining portion of the URL that was left out of the clickable link.
* Long URLs will be shortened when displayed, don't worry the link will still work.

⚫
[[Category:Editing]] [[Category:Communication Forum]] [[Category:Terminology]] [[Category:WikiDocs Page]]

Revision as of 22:09, 16 May 2010

Template:DocumentationHeader

Edit notes are comments left by users on an edit and are an important form of communication between users on the site. They can either be entered at the same time as an edit, or can be added to an existing edit.

Note: All users are expected to follow the Code of Conduct when entering an edit note.

What to use them for

Common uses for edit notes are to:

  • provide supplementary information (e.g. a URL that contains the source information)
  • ask for clarification on an edit (e.g. if no source was provided)
  • discuss the changes being made and/or whether they're appropriate changes (e.g. perhaps the change doesn't follow the Style Guidelines)
  • enable a more experienced user to help answer another user's questions (e.g. questions on how to correctly perform an edit)

Edit notes can be as long or as short as you like, but keep in mind that others will have to read and understand what you are saying. See how to write edit notes for more information.

Email notification

Any edit notes that are made will always be displayed when viewing the edit they're left on. Additionally, they will also be sent via email to:

  • the user that made the edit
  • others users who have entered a note on the edit
  • any user who has voted on the edit

Note: Only "Yes" or "No" votes count for the purpose of receiving notes. Abstaining will not cause you to receive notes unless you have also entered a note of your own.

When to do it

It is good practice to enter a note whenever you make a non-trivial edit, to explain the edit to other users. Entering a URL link to supporting information is particularly helpful. It is also important to enter a note if you are making a contentious edit such as adding a non-album track or removing anything from the database, otherwise users are likely to vote against the edit.

If you are voting against an edit it is important to enter a note explaining why. Such a note serves several purposes: it explains to the editor why you believe their change to be incorrect (so that they won't make the same mistake again, and can even cancel the edit in question), it and warns other voters that they should not vote "Yes" to the edit. It also allows an editor to contact you to explain why they feel their edit is correct, and perhaps convince you to change your vote.

Edit note syntax

HTML syntax is not supported, but URLs are automatically displayed as clickable links and there is some basic wiki syntax markup available.

Description You type You get
Italic text ''italic'' italic
Bold text '''bold''' bold
Linking to an edit edit #123456
edit:123456
edit 123456		 edit #123456
Linking to a WikiDoc page doc:Edit_Note_Syntax
[Edit_Note_Syntax]		 Edit_Note_Syntax
Linking to artist/release group/release/track/label Not available yet, see ticket #1609.
Notes
  • There is no syntax to use when entering in a URL, any entered URLs will turn into links automatically.
  • URLs may break if there are special characters in the URL, but if this happens it is a simple matter to fix.
    • Copy the URL (by right clicking on the link); paste this URL into a new window or tab; now copy the remaining portion of the URL that was left out of the clickable link.
  • Long URLs will be shortened when displayed, don't worry the link will still work.
Retrieved from "https://wiki.musicbrainz.org/index.php?title=Edit_Note&oldid=40443"