Help:Edit summary

THIS PAGE IS A WORK IN PROGRESS

Edit summaries are required. Do not use edit summaries for communicating with other editors, use article or user talk pages

See also: Justapedia:Editing policy

An edit summary is a brief explanation of an edit to a Justapedia 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).

The Justapedia community strongly encourages editors to provide meaningful edit summaries. To add a summary, type in the text entry field in the Edit summary box located near the bottom of the Editing page. The box looks like this:

Edit summary (Briefly describe your changes)

 

☐ This is a minor edit ☑ 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 3.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

Always provide an edit summary

Provide a meaningful summary for every edit. 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 that do not have an edit summary may be reverted if it is not obvious what the purpose of the edit was. 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.

Note: 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.

Edit summaries cannot be edited after publishing

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.

Places where the edit summary appears

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

• Page history – list of changes to the page you edited
• User contributions – list of all your edits
• Watchlist – list of recent changes to watched pages (logged-in users only)
• Diff page – shows the difference between two edits
• Permanent link – shows an old version of a page
• Recent changes – list of all recent edits
• Related changes – list of recent changes to pages linked to the page you edited
• List of new pages – shows the edit summary of the creation.

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 Suppress permission. User who use harmull or incivil summaries may be summarily blocked.

How to write an edit summary

• 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 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.
  • If you are copying text within Justapedia, you must at least put a link to the source page in the edit summary at the destination page.
• 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

• 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 Justapedia Civility policy.

Use of edit summaries in disputes

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 Justapedia space, do not express opinions of other users in edit summaries.

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.
• 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.

Section editing

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 in blue, 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.

Automatic 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.

The 500-character limit

The limit of 500 characters is an approximation. Do not make long edit summaries just because you can. The actual limit is 500 Unicode codepoints. Most characters occupy one codepoint, but some characters like those with diacritics may use more.