Misplaced Pages

Help:Edit summary: Difference between revisions

Article snapshot taken from Wikipedia with creative commons attribution-sharealike license. Give it a read and then ask your questions in the chat. We can research this topic together.
Browse history interactively← Previous editContent deleted Content addedVisualWikitext
Revision as of 03:54, 10 September 2009 view sourceTossie (talk | contribs)35 editsm Japanese page← Previous edit Latest revision as of 23:19, 28 September 2024 view source WhatamIdoing (talk | contribs)Autopatrolled, Extended confirmed users, Pending changes reviewers121,699 edits Rm disputedTag: Visual edit 
(534 intermediate revisions by more than 100 users not shown)
Line 1: Line 1:
{{hatnote|See {{slink|Misplaced Pages:Editing policy|Be helpful: explain}} for the relevant Misplaced Pages policy.}}
{{pp-semi-protected|small=yes}}{{pp-move-indef}}
{{hatnote|See ] if you are already familiar with this page.}}
{{shortcut|H:ES|WP:ES|WP:EDSUM}}
{{hatnote|"WP:ES" redirects here. For encyclopedic style, see {{slink|Misplaced Pages:Writing better articles|Information style and tone}}.}}
An '''edit summary''' is brief explanation of an ] to a Misplaced Pages page. When you edit a page you will find a small "Edit summary" field under the main edit-box. The edit summary field looks like this:
{{pp-semi-indef|small=yes}}
{{infopage|H:ES|WP:ES}}
{{nutshell|When editing, be sure to summarize your contributions.}}
{{clear}}


An '''edit summary''' is a ''brief'' explanation of an ] to a Misplaced Pages page. Summaries help other editors by (a) providing a reason for the edit, (b) saving the time to open up the edit to find out what it's all about, and (c) providing information about the edit on ] pages and lists of changes (such as ] and ]).
]


== How to add an edit summary ==
It is good practice to fill in the Edit Summary field, or add to it in the case of ], as it helps everyone to understand what is changed, such as when perusing the history of the page. It's a good idea to set your user preferences (under Editing) to "Prompt me when entering a blank edit summary".
To add a summary, type in the text entry field in the ''Edit summary'' box located near the bottom of the Editing page. In the ], the box looks like this:
{{EditOptions}}


In the ] and the ], it looks like this:
==Properties==


]
The edit summary box can hold one line of 200 characters. If you attempt to type or paste more, only the first 200 characters will be displayed – the rest will be discarded. Also, for example attempting to add 10 new characters (at the end or in between) to a summary already containing 195 characters will result in the first 5 new characters being inserted and the second 5 being disregarded.


== Edits should be explained<span class="anchor" id="Always provide an edit summary"></span> ==
The "Show preview" button also provides a preview of the edit summary to facilitate checking links.
{{shortcut|H:FIES|WP:FIES}}
According to the ], {{Strong|all edits should be explained}} <em>(unless the reason for them is obvious)—either by clear edit summaries, or by discussion on the associated talk page.</em> It is a good practice to provide a meaningful summary for every edit, especially when ] (undoing) the actions of other editors or deleting existing text; otherwise, people may question your motives for the edit. In appropriate circumstances, a summary can be quite brief ("]" and "]" for example).


Accurate summaries help other contributors decide whether they want to review an edit, and to understand the change should they choose to review it. Edits without edit summaries are more likely to be reverted incorrectly because they provide no explanation or rationale for the change. Editors should not revert an otherwise good edit because of a missing or confusing edit summary; good editors may simply have forgotten, or a confusing edit summary may have been the result of an ] mishap. (If the edit summary itself violates privacy or other policies, see the ] section below.) However, realistically, when a major edit (e.g., addition or deletion of a substantial amount of article text, or a substantial rewrite) doesn't have an edit summary, some busy editors might not ] and revert the change without evaluating it properly. Providing an edit summary helps prevent that kind of error.
==Recommendations==
{{shortcut|WP:FILLINEDITSUMMARY|H:FILLINEDITSUMMARY|WP:FIES|H:FIES}}
'''Always fill in the summary field'''. This is considered an important guideline. Even a short summary is better than no summary. An edit summary is even more important if you delete any text; otherwise, people may question your motives for the edit. Also, mentioning one change but not another one can be misleading to someone who finds the other one more important; add "and misc." to cover the other change(s).


Summaries are less important for '']'' (which means generally unchallengeable changes, such as spelling or grammar corrections), but a brief note like "fixed spelling" is helpful even then.
Accurate summaries help people decide whether it is worthwhile for them to check a change. We've found that summaries often pique the interest of contributors with expertise in the area. This may not be as necessary for "minor changes", but "fixed spelling" would be nice even then.


To avoid accidentally leaving edit summaries blank, registered editors can select "Prompt me when entering a blank edit summary" on the ''Editing'' tab of the ].
In the case of a small addition to an article, it is highly recommended to copy the full text of this addition to the summary field, giving a maximum of information with a minimum of effort. Put ''ft'' in front, as an abbreviation of "full text" (see the ] for other abbreviations). This way, readers of the summary will be unlikely to check the page itself as they already know the extent of the edit. Some users also find it helpful to paste their talk page comments into the edit summary field in this manner. These kinds of edits allow users to check Recent changes, Page history and User contributions (see below) very efficiently; this also reduces the load on the servers.


{{Clear}}
If the addition is more than 200 characters, so it does not fit fully in the edit summary box, you should write a short summary of the changes you have introduced into the article. For an addition of, say, 400 characters you can also save time by simply copying that into the summary field. The excess will fall off, and the first 200 characters will usually be acceptable as a crude "summary".


==How to write an edit summary==
Unfortunately you can copy only one line of text from the edit box into the edit summary box. The contents of further lines can be pasted at the end of the line. Thus, for example, a bulleted "see also" list is cumbersome to put in the edit summary box. One possible workaround for a new list is putting the list on one line, separated by the asterisks for the bullets, copying it to the edit summary box, and then, in the main edit box, putting the new lines before the asterisks.
{{shortcut|WP:EDITSUMCITE}}
{{seealso|Misplaced Pages:Edit summary legend}}
* ''Summarize''. Summarize the change, even if only briefly; even a short summary is better than no summary.
* ''Explain''. Give reasons for the change, if you think other editors may be unclear as to why you made it. If you believe a Misplaced Pages policy or guideline justifies the change then you may include a link to it in your explanation.
* ''Abbreviations''. Abbreviations should be used with care. They can be confusing for new contributors. For an explanation of some commonly used abbreviations, see this ].
* ''Expand on important information''. Readers who see only the summary might not get the entire picture. Prevent misunderstanding: If an edit requires more explanation than will fit in the summary box, post a comment to the article's ] to give more information, and include "see talk" or "see discussion page" in the edit summary.
** If you are ], you must at least put a link to the source page in the edit summary at the destination page.
* ''Talk pages''. When editing ], consider reflecting the gist of your comment in the edit summary; this allows users to check Recent changes, Page history and User contributions (see below) very efficiently.


=== What to avoid in edit summaries ===
In addition to a summary of the change itself, the summary field may also contain an explanation of the change; note that if the reason for an edit is not clear, it is more likely to be reverted, especially in the case that some text is deleted. To give a longer explanation, use the Talk page and put in the edit summary "see Talk".
{{shortcut|WP:SUMMARYNO}}
* ''Avoid misleading summaries''. Mentioning one change but not another one can be misleading to someone who finds the other one more important. You could add something like "and misc." to cover the other changes.
* ''Avoid vagueness''. While edit summaries can be terse, they should still be specific. Providing an edit summary similar to "I made some changes" is functionally equivalent to not providing a summary at all.
* ''Avoid long summaries''. Edit summaries are not for explaining every detail, writing essays about "the truth", or long-winded arguments with fellow editors. For discussions, you should use the talk page.
* ''Avoid inappropriate summaries''. You should explain your edits, but without being overly critical or harsh when editing or reverting others' work. This may be perceived as ], and cause resentment or conflict. Explain what you changed, citing the relevant policies, guidelines, or principles of good writing, but do not target others in a way that may come across as a ].
* ''Avoid incivility. ''Snide comments, personal remarks about editors, and other aggressive edit summaries are explicit ] of the Misplaced Pages ].
'''Warning''': be careful of what you write in edit summaries. Inappropriate edit summaries may be used as evidence against you in behavioral complaints. This applies particularly to uncivil and deliberately misleading edit summaries.


===Use of edit summaries in disputes===
After you save the page, you cannot edit the summary.
{{shortcut|WP:REVTALK}}
Proper use of edit summaries is critical to resolving ]. Edit summaries should accurately and succinctly summarize the nature of the edit, especially if it could be controversial. If the edit involves ], it should be marked as a revert ("rv") in the edit summary.


Avoid using edit summaries to carry on debates or negotiation over the content. This creates an atmosphere where the only way to carry on discussion is to revert other editors! If you notice this happening, start a section on the talk page and place your comments there. This keeps discussions and debates away from the article page itself. For example:
In the case of important omissions or errors in the edit summary, you can make a ] just to put the correction in the edit summary.


:''reverted edits by ], see talk for rationale''
In the extreme case of an edit summary containing certain kinds of harmful content, a small group of users with ] can hide it from the view of most users.


As with any other Misplaced Pages space, ] in edit summaries.
==Places where the edit summary appears==


===Fixing===
The edit summary appears in black italics in the following places:
After you publish the page, ''you cannot change the edit summary'', so be careful with it, particularly if you are in a heated content dispute&nbsp;– do not write things you will regret.


If you make an important omission or error in an edit summary, you can correct this by making a ] (a change in the page with no visible effects), and adding further information in the dummy edit's summary.
*] – list of changes to the page you edited
*] – list of all your edits
*]'''<nowiki>*</nowiki>''' – list of recent changes to watched pages (] users only)
*] – shows the difference between two edits
*] – list of all recent edits
*] – real time list of all edits
*] – list of recent changes to pages linked to the page you edited
*List of new pages: shows the edit summary of the creation.


In the extreme case of an edit summary containing certain kinds of harmful content, the summary can be deleted on request. They may be removed from public view by ] using ]; such edit summaries remain visible to administrators. In even more limited circumstances, the entire edit may be ], leaving it and its edit summary visible only to the handful of users with the Oversight permission.
'''<nowiki>*</nowiki>''' Use the enhanced watchlist to see all recent changes in the watched pages, not just the last change in each page.


==Edit summary properties and features==
== Abbreviations ==
* '']''. The edit summary box can hold one line of approximately 500 characters. If you attempt to type or paste more, only the first 500 will be displayed – the rest will be discarded. For example, attempting to add 10 new characters (at the end or in between) to a summary already containing 495 characters may result in the first 5 new characters being inserted and the final 5 being disregarded.
* ''Show preview''. The "Show preview" button also provides a preview of the edit summary to facilitate checking links.
* ''Can't be changed after saving''. After you publish the page, you cannot change the edit summary (see ] tasks ] and ]).
* ''Doesn't appear in searches''. The built-in ] cannot search edit summaries, and they are not indexed by external search engines.
* ''Wikilinks '''always''' rendered; other wikitext coding ignored''. Edit summaries render internal links, including ], and ] links, even when enclosed within {{tag|nowiki}} tags. Therefore, copying wikitext in the edit summary box may be preferable to copying text from the preview, except when one wants to save space. Other wikitext coding is not interpreted. Although URLs do not produce clickable links, a wikilink with ] can make clickable ], and ] can make ]. <code><nowiki>~~~~</nowiki></code> has no effect, so do not ] edit summaries.
* You can ] (or "ping") a user in your edit summary. To mention the user "]" you need to type: <nowiki>]</nowiki> anywhere in the edit summary.


===Places where the edit summary appears===
Experienced users, especially those with many edits to make, will often use abbreviations in edit summaries (as well as ] entries), in order to save time; for example, "rv" for "]". These should be used with care, as they can be confusing for inexperienced users, but they are generally fine for small edits such as formatting and grammar changes. See ] for a list of commonly used abbreviations in edit summaries.
The edit summary appears in black italics in the following places:
* ]&nbsp;– list of changes to the page you edited
* ]&nbsp;– list of all your edits
* ]<ref group="note">Use the enhanced watchlist to see all recent changes in the watched pages, not just the last change in each page.</ref>&nbsp;– list of recent changes to watched pages (] users only)
* ]&nbsp;– shows the difference between two edits
* ]&nbsp;– shows an old version of a page
* ]&nbsp;– list of all recent edits
* ]&nbsp;– real-time list of all edits
* ]&nbsp;– list of recent changes to pages linked to the page you edited
* ]&nbsp;– shows the edit summary of the creation.


The source text of the edit summary can be seen at <span class="plainlinks"></span>''id'', where ''id'' is the revision number. For example, says <code>diff=845523983</code> in the url so <span class="plainlinks"></span> shows the edit summary source. The link uses ], which is mainly intended for programs.
==Searching==


====Notes====
The ] cannot search edit summaries, and they are not indexed by external search engines.
{{reflist|group="note"}}


===Section editing===
==File upload summary==
{{redirect|WP:→||WP:Redirect|and|WP:Moving a page}}
When adding a new section to a discussion page with the "new section" button, the section title is used as the edit summary. When ], the section title is inserted at the beginning of the edit summary, enclosed with /* and */ marks, for example /* External links */. Details of the edit should be added after this text.


When viewing such an edit summary, the section name will appear with a small arrow next to it: <span class="autocomment">]</span>. Click the arrow or section name to view the section (if the section no longer exists, the link will simply take you to the top of the page).
When uploading an image one can supply an upload summary. This serves multiple purposes:
*as second part of the automatically created edit summary of the upload log (the first part giving the file name)
*as text in the entry of the ]
*in the case that the file name of the image is new:
**as edit summary for the creation of the image page
**as wikitext for the editable part of the image page, which includes the following possibilities:
***briefly describe the image
***provide internal or external links
***call templates
***specify one or more categories the image is in


If you create a new section before or after an existing section by clicking a section "''edit''{{-"}} link, delete the text between /* and */ marks (or change it to the new section title) to avoid confusion.<ref>It is possible to manually include links to multiple sections using the /* */ syntax&nbsp;– this may be useful when editing several sections at once.
The capacity of the upload summary is one line of 250 characters; in the upload log the last part may fall off, because this can contain 255 characters, including "uploaded "''filename''"".


The edit summary:
Note that there is no preview function to check the code for the links, template calls and category tags, but of course, if needed one can edit the image page after uploading, to correct errors and also to extend the text.


: {{Inputbox|/* Foo */ test /* Bar */ test}}
See also ].


should be rendered as:
== Section editing ==


: <span class="comment"><span class="autocomment">]:</span> test <span class="autocomment">]:</span> test</span>.
When adding a new section to a discussion page with the "new section" button, the section title is used as the edit summary. When ], the section title is inserted at the beginning of the edit summary, enclosed with /* and */ marks, for example /* External links */. Details of the edit should be added after this text. In the case that you provide a long summary yourself you can delete the section title in order to stay within the limit of 200 characters.


See .</ref>
When viewing such an edit summary, the section name will appear in grey, with a small link next to it: <span class="autocomment">] External links</span>. Click the link to view the section (if the section no longer exists, the link will just take you to the page).


'''Note''': Tools that track edit summary usage by a user (such as ) do not consider the auto-added part as a summary; that's any part within /* and */. You're encouraged to provide real edit summary, whether the editbox contains such auto-summary or not.
If you create a new section before or after an existing section by clicking a section "''edit''" link, delete the text between /* and */ marks to avoid confusion.
{{reflist}}


===Automatic summaries===
Note: The following does not work as of June 2009. It has been reported in ].
{{main|Help:Automatic edit summaries}}
In certain circumstances, an automatic summary is generated when an edit is published without one. This is slightly different from the summary added when editing a section, as that can be modified by the user before saving.


Except for the automatic summary when creating a redirect, which usually says all that needs to be said, these are not a substitute for a proper edit summary&nbsp;– you should always leave a meaningful summary, even in the above cases. They are, however, useful in providing some context for edits made by inexperienced users who are not aware of the importance of edit summaries, and for spotting vandalism.
It is possible to manually include links to multiple sections using the /* */ syntax – this may be useful when editing several sections at once.


When starting a new thread on a ] by using the "New section" tab, the text you type into the "subject/headline" field becomes both the heading of your discussion topic, and the edit summary for that edit.
For example, the edit summary:


====Tags====
: {{Inputbox|/* Foo */ test /* Bar */ test}}
{{see also|Misplaced Pages:Tags}}
Tags (i.e., edit tags) are brief messages that the software automatically places next to certain edits in ], ] and other special pages. They are implemented by the ] to help assist vandalism patrollers and other page watchers. They cannot be added or removed manually.


==Notes for experienced users==
is rendered as:
* There are ] for warning editors who delete content without providing an edit summary: {{tl|Uw-delete1}} (which assumes good faith) and {{tl|Uw-delete2}} (which doesn't). {{tl|Uw-editsummary}} is available for notifying users who have not provided an edit summary for other types of edits; {{tl|Summary2}} works better for more experienced users who need to be reminded rather than taught. These are available via ].
* When editors ], their RfA pages include statistics about how often they have provided edit summaries in the past.
* A user's edit summary usage can be checked with .{{sup|()}}


If you are a ] and want to show your commitment to always leaving edit summaries, which will remind other users of the importance of doing so, you can use any of the following userboxes:
: <span class="comment"><span class="autocomment">]Foo</span> test <span class="autocomment">]Bar</span> test</span>
{{Yytop}}
{{Yy|User edit summary}}
{{Yy|User:Idell/editsummary}}
{{Yy|User leaves edit summaries}}
{{Yy|User:Marek69/edit summary template}}
{{Yy|User:Ritchie333/Userbox ES}}
{{Yy|User:Sdrqaz/userbox/macbeth}}
{{Yybottom}}


===The 500-character limit===
=="Post a comment" feature==
The limit of 500 characters is an approximation. The actual limit is 500 ]s. Most characters occupy one codepoint, but some characters like those with ]s or ]s may consist of more than one codepoint. The limit of 500 codepoints includes the section title marker (and the associated <code>/*&nbsp;&nbsp;*/</code>) and also any wiki markup that may be present.
When starting a new thread on a Talk page, the "Post a comment" feature can be used. Click the plus sign next to the Edit link. A box labelled "''Subject/headline''" appears before the main editing box. Text typed into the subject field becomes both the edit summary and a new heading (which is added to the end of the page), and text entered into the main edit box is inserted below this heading.


For editors who have JavaScript enabled, there is a script included with the page that monitors the codepoint-length of the summary and prevents entering summaries longer than 500 codepoints (both in "Edit source" and in Visual editor). A count is displayed at the right-hand end of the text entry field, showing the number of unused codepoints. When JavaScript is disabled, this safeguard can't function and the only protection is the browser's limit of 500 characters, which may overflow the 500-codepoint limit as a result of any characters that are represented by more than one codepoint.
== Automatic summaries ==
{{main|Misplaced Pages:Automatic edit summaries}}
In certain circumstances, an automatic summary is generated when an edit is saved without one. This is slightly different to the summary added when editing a section, as that can be modified by the user before saving.

{| border class="wikitable"
! Situation !! Page !! Text
|-
| Creating or replacing a page with a redirect<br/>('$1' is replaced with the target of the redirect)
| ]
| {{#ifexist:MediaWiki:Autoredircomment|{{msgnw:MediaWiki:Autoredircomment}}|<nowiki>Redirecting to ]</nowiki>}}
|-
| Removing all text from a page
| ]
| {{#ifexist:MediaWiki:Autosumm-blank|{{msgnw:MediaWiki:Autosumm-blank}}|Blanking page}}
|-
| Removing most of the text from a page, or editing a short page <br/> ('$1' is replaced with the page text)
| ]
|{{#ifexist:MediaWiki:Autosumm-replace|{{msgnw:MediaWiki:Autosumm-replace}}|Replacing page with '$1'}}
|-
| Creating a new page ($1 is replaced with the page text)
| ]
| {{#ifexist:MediaWiki:Autosumm-new|{{msgnw:MediaWiki:Autosumm-new}}|New page: $1}}
|}

With the exception of the automatic summary when creating a redirect, which usually says all that needs to be said, these are not a substitute for a proper edit summary – you should always leave a meaningful summary, even in the above cases. They are, however, useful in providing some context for edits made by inexperienced users who are not aware of the importance of edit summaries, and for spotting vandalism.

==Rendering of wikitext; URLs==
Text in edit summaries renders internal links, including ]s, and ] links, even when enclosed within <nowiki><nowiki> and </nowiki></nowiki>. Therefore, copying wikitext in the edit summary box may be preferable to copying text from the preview, except when one wants to save space.

Other wikitext coding is not interpreted.
When copying an external link from the preview into the edit summary box then, depending on the operating system, the
"printable version" is copied, i.e. how it is normally rendered, and in addition, between parentheses, the URL; hence the same information as in the wikitext, but in a different format, as well as a possible sequential number.

=== Use of edit summaries in disputes ===
Proper use of edit summaries is critical to resolving ]s. Edit summaries should accurately and succinctly summarize the nature of the edit, especially if it could be controversial. If the edit involves ], it should be marked as a revert ("rv") in the edit summary.

Avoid using edit summaries to carry on debates or negotiation over the content or to express opinions of the other users involved. This creates an atmosphere where the only way to carry on discussion is to revert other editors! If you notice this happening, start a section on the talk page and place your comments there. This keeps discussions and debates away from the article page itself. For example:

:''reverted edits by ], see talk for rationale''


When the edit is done by a bot, through an external tool (such as ]) or through some user script or gadget, it's the responsibility of the tool or script to safeguard against overflowing this limit. In any situation where more than 500 codepoints are entered for the edit summary, the summary is truncated to 500 codepoints when the revision is published.
==See also==
*]
*] for notifying users who have not provided an edit summary


== See also ==
{{Misplaced Pages policies and guidelines}}
{{Misplaced Pages glossary}}
* ] – commonly used edit summary abbreviations
* ]
* ]
* ]
* ]
* ]


==External links==
* This tool will search through a user's edit summaries and return edits with a partial match as a ] file.


{{Help navigation}}
]


]
]
]
]
]
]
]
]
]
]
]
]
]
]
]
]
]
]
]
]

Latest revision as of 23:19, 28 September 2024

See Misplaced Pages:Editing policy § Be helpful: explain for the relevant Misplaced Pages policy. See WP:Edit summary legend if you are already familiar with this page. "WP:ES" redirects here. For encyclopedic style, see Misplaced Pages:Writing better articles § Information style and tone.

Misplaced Pages information page
This is an information page.
It is not an encyclopedic article, nor one of Misplaced Pages's policies or guidelines; rather, its purpose is to explain certain aspects of Misplaced Pages's norms, customs, technicalities, or practices. It may reflect differing levels of consensus and vetting.		Shortcuts
This page in a nutshell: When editing, be sure to summarize your contributions.

An edit summary is a brief explanation of an edit to a Misplaced Pages page. Summaries help other editors by (a) providing a reason for the edit, (b) saving the time to open up the edit to find out what it's all about, and (c) providing information about the edit on diff pages and lists of changes (such as page histories and watchlists).

How to add an edit summary

To add a summary, type in the text entry field in the Edit summary box located near the bottom of the Editing page. In the 2010 wikitext editor, the box looks like this:

Edit summary (Briefly describe your changes)

Empty This is a minor edit Tick Watch this page

By publishing changes, you agree to the Terms of Use, and you irrevocably agree to release your contribution under the CC BY-SA 4.0 License and the GFDL. You agree that a hyperlink or URL is sufficient attribution under the Creative Commons license.

Publish changes Show preview Show changes Cancel

In the visual editor and the 2017 wikitext editor, it looks like this:

Edits should be explained

Shortcuts

According to the consensus policy, all edits should be explained (unless the reason for them is obvious)—either by clear edit summaries, or by discussion on the associated talk page. It is a good practice to provide a meaningful summary for every edit, especially when reverting (undoing) the actions of other editors or deleting existing text; otherwise, people may question your motives for the edit. In appropriate circumstances, a summary can be quite brief ("ce" and "rvv" for example).

Accurate summaries help other contributors decide whether they want to review an edit, and to understand the change should they choose to review it. Edits without edit summaries are more likely to be reverted incorrectly because they provide no explanation or rationale for the change. Editors should not revert an otherwise good edit because of a missing or confusing edit summary; good editors may simply have forgotten, or a confusing edit summary may have been the result of an autofill mishap. (If the edit summary itself violates privacy or other policies, see the Fixing section below.) However, realistically, when a major edit (e.g., addition or deletion of a substantial amount of article text, or a substantial rewrite) doesn't have an edit summary, some busy editors might not assume good faith and revert the change without evaluating it properly. Providing an edit summary helps prevent that kind of error.

Summaries are less important for minor changes (which means generally unchallengeable changes, such as spelling or grammar corrections), but a brief note like "fixed spelling" is helpful even then.

To avoid accidentally leaving edit summaries blank, registered editors can select "Prompt me when entering a blank edit summary" on the Editing tab of the user preferences.

How to write an edit summary

Shortcut See also: Misplaced Pages:Edit summary legend
  • Summarize. Summarize the change, even if only briefly; even a short summary is better than no summary.
  • Explain. Give reasons for the change, if you think other editors may be unclear as to why you made it. If you believe a Misplaced Pages policy or guideline justifies the change then you may include a link to it in your explanation.
  • Abbreviations. Abbreviations should be used with care. They can be confusing for new contributors. For an explanation of some commonly used abbreviations, see this edit summary legend.
  • Expand on important information. Readers who see only the summary might not get the entire picture. Prevent misunderstanding: If an edit requires more explanation than will fit in the summary box, post a comment to the article's talk page to give more information, and include "see talk" or "see discussion page" in the edit summary.
  • Talk pages. When editing talk pages, consider reflecting the gist of your comment in the edit summary; this allows users to check Recent changes, Page history and User contributions (see below) very efficiently.

What to avoid in edit summaries

Shortcut
  • Avoid misleading summaries. Mentioning one change but not another one can be misleading to someone who finds the other one more important. You could add something like "and misc." to cover the other changes.
  • Avoid vagueness. While edit summaries can be terse, they should still be specific. Providing an edit summary similar to "I made some changes" is functionally equivalent to not providing a summary at all.
  • Avoid long summaries. Edit summaries are not for explaining every detail, writing essays about "the truth", or long-winded arguments with fellow editors. For discussions, you should use the talk page.
  • Avoid inappropriate summaries. You should explain your edits, but without being overly critical or harsh when editing or reverting others' work. This may be perceived as uncivil, and cause resentment or conflict. Explain what you changed, citing the relevant policies, guidelines, or principles of good writing, but do not target others in a way that may come across as a personal attack.
  • Avoid incivility. Snide comments, personal remarks about editors, and other aggressive edit summaries are explicit edit-summary "don'ts" of the Misplaced Pages Civility policy.

Warning: be careful of what you write in edit summaries. Inappropriate edit summaries may be used as evidence against you in behavioral complaints. This applies particularly to uncivil and deliberately misleading edit summaries.

Use of edit summaries in disputes

Shortcut

Proper use of edit summaries is critical to resolving content disputes. Edit summaries should accurately and succinctly summarize the nature of the edit, especially if it could be controversial. If the edit involves reverting previous changes, it should be marked as a revert ("rv") in the edit summary.

Avoid using edit summaries to carry on debates or negotiation over the content. This creates an atmosphere where the only way to carry on discussion is to revert other editors! If you notice this happening, start a section on the talk page and place your comments there. This keeps discussions and debates away from the article page itself. For example:

reverted edits by User:Example, see talk for rationale

As with any other Misplaced Pages space, do not express opinions of other users in edit summaries.

Fixing

After you publish the page, you cannot change the edit summary, so be careful with it, particularly if you are in a heated content dispute – do not write things you will regret.

If you make an important omission or error in an edit summary, you can correct this by making a dummy edit (a change in the page with no visible effects), and adding further information in the dummy edit's summary.

In the extreme case of an edit summary containing certain kinds of harmful content, the summary can be deleted on request. They may be removed from public view by administrators using revision deletion; such edit summaries remain visible to administrators. In even more limited circumstances, the entire edit may be oversighted, leaving it and its edit summary visible only to the handful of users with the Oversight permission.

Edit summary properties and features

  • Limited to 500 characters. The edit summary box can hold one line of approximately 500 characters. If you attempt to type or paste more, only the first 500 will be displayed – the rest will be discarded. For example, attempting to add 10 new characters (at the end or in between) to a summary already containing 495 characters may result in the first 5 new characters being inserted and the final 5 being disregarded.
  • Show preview. The "Show preview" button also provides a preview of the edit summary to facilitate checking links.
  • Can't be changed after saving. After you publish the page, you cannot change the edit summary (see Phabricator tasks T12105 and T15937).
  • Doesn't appear in searches. The built-in search function cannot search edit summaries, and they are not indexed by external search engines.
  • Wikilinks always rendered; other wikitext coding ignored. Edit summaries render internal links, including piped links, and interwiki links, even when enclosed within <nowiki>...</nowiki> tags. Therefore, copying wikitext in the edit summary box may be preferable to copying text from the preview, except when one wants to save space. Other wikitext coding is not interpreted. Although URLs do not produce clickable links, a wikilink with Special:Diff/ can make clickable diffs, and Special:PermaLink/ can make permanent links. ~~~~ has no effect, so do not sign edit summaries.
  • You can mention (or "ping") a user in your edit summary. To mention the user "Example" you need to type: ] anywhere in the edit summary.

Places where the edit summary appears

The edit summary appears in black italics in the following places:

The source text of the edit summary can be seen at en.wikipedia.org/w/api.php?action=query&prop=revisions&rvprop=comment&revids=id, where id is the revision number. For example, says diff=845523983 in the url so revids=845523983 shows the edit summary source. The link uses mw:API:Revisions, which is mainly intended for programs.

Notes

  1. Use the enhanced watchlist to see all recent changes in the watched pages, not just the last change in each page.

Section editing

"WP:→" redirects here. For other uses, see WP:Redirect and WP:Moving a page.

When adding a new section to a discussion page with the "new section" button, the section title is used as the edit summary. When editing an existing section, the section title is inserted at the beginning of the edit summary, enclosed with /* and */ marks, for example /* External links */. Details of the edit should be added after this text.

When viewing such an edit summary, the section name will appear with a small arrow next to it: →External links. Click the arrow or section name to view the section (if the section no longer exists, the link will simply take you to the top of the page).

If you create a new section before or after an existing section by clicking a section "edit" link, delete the text between /* and */ marks (or change it to the new section title) to avoid confusion.

Note: Tools that track edit summary usage by a user (such as XTools) do not consider the auto-added part as a summary; that's any part within /* and */. You're encouraged to provide real edit summary, whether the editbox contains such auto-summary or not.

  1. It is possible to manually include links to multiple sections using the /* */ syntax – this may be useful when editing several sections at once. The edit summary:
    /* Foo */ test /* Bar */ test
    should be rendered as:
    →Foo: test →Bar: test.
    See this edit.

Automatic summaries

Main page: Help:Automatic edit summaries

In certain circumstances, an automatic summary is generated when an edit is published without one. This is slightly different from the summary added when editing a section, as that can be modified by the user before saving.

Except for the automatic summary when creating a redirect, which usually says all that needs to be said, these are not a substitute for a proper edit summary – you should always leave a meaningful summary, even in the above cases. They are, however, useful in providing some context for edits made by inexperienced users who are not aware of the importance of edit summaries, and for spotting vandalism.

When starting a new thread on a talk page by using the "New section" tab, the text you type into the "subject/headline" field becomes both the heading of your discussion topic, and the edit summary for that edit.

Tags

See also: Misplaced Pages:Tags

Tags (i.e., edit tags) are brief messages that the software automatically places next to certain edits in histories, recent changes and other special pages. They are implemented by the edit filter to help assist vandalism patrollers and other page watchers. They cannot be added or removed manually.

Notes for experienced users

  • There are standard templates for warning editors who delete content without providing an edit summary: {{Uw-delete1}} (which assumes good faith) and {{Uw-delete2}} (which doesn't). {{Uw-editsummary}} is available for notifying users who have not provided an edit summary for other types of edits; {{Summary2}} works better for more experienced users who need to be reminded rather than taught. These are available via Twinkle.
  • When editors run for adminship, their RfA pages include statistics about how often they have provided edit summaries in the past.
  • A user's edit summary usage can be checked with this tool.

If you are a registered user and want to show your commitment to always leaving edit summaries, which will remind other users of the importance of doing so, you can use any of the following userboxes:

Wikitext userbox where used
{{User edit summary}}
WTF?This user ALWAYS leaves
an edit summary.
 linked pages
{{User:Idell/editsummary}}
This user's mind-reading skills are not so good. Please leave an edit summary.
 linked pages
{{User leaves edit summaries}}
What did you do?This user includes edit summaries in their contributions and thinks that everybody should use them as well.
 linked pages
{{User:Marek69/edit summary template}}
This user uses edit summaries.
 linked pages
{{User:Ritchie333/Userbox ES}}
This user's mind-reading skills are not so good. Please leave an edit summary.
 linked pages
{{User:Sdrqaz/userbox/macbeth}}
This user is haunted by the times they forgot to use an edit summary.
Out, damned spot! What, will these hands ne'er be clean?
 linked pages

The 500-character limit

The limit of 500 characters is an approximation. The actual limit is 500 Unicode codepoints. Most characters occupy one codepoint, but some characters like those with diacritics or emojis may consist of more than one codepoint. The limit of 500 codepoints includes the section title marker (and the associated /*  */) and also any wiki markup that may be present.

For editors who have JavaScript enabled, there is a script included with the page that monitors the codepoint-length of the summary and prevents entering summaries longer than 500 codepoints (both in "Edit source" and in Visual editor). A count is displayed at the right-hand end of the text entry field, showing the number of unused codepoints. When JavaScript is disabled, this safeguard can't function and the only protection is the browser's limit of 500 characters, which may overflow the 500-codepoint limit as a result of any characters that are represented by more than one codepoint.

When the edit is done by a bot, through an external tool (such as WP:AWB) or through some user script or gadget, it's the responsibility of the tool or script to safeguard against overflowing this limit. In any situation where more than 500 codepoints are entered for the edit summary, the summary is truncated to 500 codepoints when the revision is published.

See also

This page is referenced in the Misplaced Pages Glossary.

External links

Misplaced Pages help pages
About Misplaced Pages (?)
Help for readers (?)
Contributing
to Misplaced Pages (?)
Getting started (?)
Dos and don'ts (?)
How-to pages and
information pages (?)
Coding (?)
Directories (?)
Missing Manual
Ask for help on your talk page (?)
Categories: