Difference between revisions of "Edit Note"

From MusicBrainz Wiki
(Moderation/ModNote -> EditNote (Imported from MoinMoin))
 
m (Edit note syntax: fix typo)
 
(30 intermediate revisions by 14 users not shown)
Line 1: Line 1:
 +
Edit notes are comments left by [[Editor|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.
  
[[Image:Alert.png]] All [[Editor]]s and [[Auto-Editor|AutoEditor]]s entering moderation notes are expected to follow the [[Code Of Conduct|CodeOfConduct]].  
+
'''Note:''' All users are expected to follow the [[Code Of Conduct|Code of Conduct]] when entering an edit note.
  
[[Moderation Note|ModerationNote]]s (sometimes called Mod­Notes) provide an important [[MusicBrainz Forums|forum]] for discussing specific changes to the [[MusicBrainz]] database.
+
== What to use them for ==
  
Whenever you make an edit (moderation in [[Bad Terminology|BadTerminology]]) you are prompted to enter a moderation note, and any moderator may enter a note on their own or other moderators' existing edits in addition to voting on them.
+
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)
  
===How to do it===
+
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|AddNote]] link.  These can be found on the moderation pop-up at the top of many pages, or any [http://musicbrainz.org/mod/search/results.html?artist_type=3&artist_id=36434&orderby=desc Moderation Search] page.  Then enter your comment in the [http://musicbrainz.org/mod/addnote.html?modid=1686231 text box] and click Submit!  HTML is not supported, but URLs are automatically displayed as clickable links.
+
== Email notification ==
  
If you want to make a link to another moderation, you can enter the full URL, or as a shortcut '''edit #modid''', with ''modid'' replaced with the moderation number. Example: ''edit #123456''.
+
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
  
===What it does===
+
'''Note:''' Any vote, be it "Yes", "No" or "Abstain", will cause you to receive notes (previously, that was restricted to only "Yes" or "No" votes).
  
The moderation note will be displayed with the edit, and sent by e-mail to:
+
== When to do it ==
* The Moderator who made the edit
 
* Anyone who has entered a moderation note on the edit (whether they have voted or not).
 
  
Note: '''Voters who have not entered a moderation note will not receive an email.'''
+
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 [[Standalone _Recording|standalone recording]] or removing anything from the database, otherwise users are likely to vote against the edit.
  
This allows most interested parties to be included in the discussion. This is why it's important to provide a valid e-mail address in your profile.  
+
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.
  
===When to do it===
+
== Edit note syntax ==
  
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.  
+
HTML syntax is not supported, but URLs are automatically displayed as clickable links and there is some basic wiki syntax markup available.
  
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.  
+
{| class="wikitable"
 +
!Description
 +
!Markup
 +
!Result
 +
|-
 +
|Italic Text
 +
|<code><nowiki>''italic''</nowiki></code>
 +
|''italic
 +
|-
 +
|Bold Text
 +
|<code><nowiki>'''bold'''</nowiki></code>
 +
|'''bold'''
 +
|-
 +
|rowspan="3"| Linking to an edit
 +
|<code>edit #123456</code>
 +
|rowspan="3"| [[Edit:123456|edit #123456]]
 +
|-
 +
| <code>edit:123456</code>
 +
|-
 +
| <code>edit 123456</code>
 +
|-
 +
|rowspan="3"| Linking to a [[WikiDocs]] page
 +
|<code>doc:Edit_Note</code>
 +
|rowspan="3"| [[Edit_Note]]
 +
|-
 +
| <code>[Edit_Note]</code>
 +
|-
 +
|(note: bracketed form must be Capitalized)
 +
|-
 +
| Linking to a [[MusicBrainz_Entity]]
 +
|colspan="2"| '''''Not available yet, see [[jira:MBS-764|MBS-764]].'''''
 +
|}
  
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.
+
; Notes
  
==Related==
+
* 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.
  
[[Commonly Used Moderation Notes|CommonlyUsedModerationNotes]]
+
[[Category:Editing]] [[Category:Communication Forum]] [[Category:Terminology]] [[Category:WikiDocs Page]] [[Category:To Be Reviewed]]
 
 
==Questions / Discussion==
 
 
 
The notes a voter can add to an edit are [[Moderation Note|ModerationNote]]s as well, right? Does somebody recall under which circumstances these notes get send (per email) to whom? It would be quite helpful to have this documented here. --[[User:DonRedman|DonRedman]]  
 
<ul><li style="list-style-type:none">''Is there something about the "How to do it" and "What it does" sections above that is unclear?  Because to my mind, they completely answer these questions.  I've added some more text to "When to do it" for the case where a voter should make a note (the previous cases were only for the editor).'' [[User:Dupuy|@alex]]  
 
</ul>
 
 
 
[[Category:To Be Reviewed]] [[Category:Editing]] [[Category:Terminology]]
 

Latest revision as of 12:06, 27 February 2021

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: Any vote, be it "Yes", "No" or "Abstain", will cause you to receive notes (previously, that was restricted to only "Yes" or "No" votes).

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 standalone recording 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 Markup Result
Italic Text ''italic'' italic
Bold Text '''bold''' bold
Linking to an edit edit #123456 edit #123456
edit:123456
edit 123456
Linking to a WikiDocs page doc:Edit_Note Edit_Note
[Edit_Note]
(note: bracketed form must be Capitalized)
Linking to a MusicBrainz_Entity Not available yet, see MBS-764.
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.