Draft:Edit summary - Revision history

Tungstenchan: Text replacement - "BattleTechWiki" to "BattleIntelligence"

2025-05-01T01:56:27Z

Text replacement - "BattleTechWiki" to "BattleIntelligence"

imported>Deadfire: /* Edit summary properties and features */

2024-10-04T19:59:06Z

Edit summary properties and features

New page

{{hatnote|See {{slink|BattleTechWiki:Editing policy|Be helpful: explain}} for the relevant BattleTechWiki policy.}}
{{pp-semi-indef|small=yes}}
{{infopage|H:ES|BTW:ES}}
{{nutshell|When editing, be sure to summarize your contributions.}}
{{clear}}

An '''edit summary''' is a ''brief'' explanation of an [[Help:editing|edit]] to a BattleTechWiki 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 [[w:Help:Diff|diff]] pages and lists of changes (such as [[w:Help:Page history|page histories]] and [[w:Help:Watching pages|watchlists]]).

According to the [[Policy:Consensus#Through editing|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. 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:

{{EditOptions}}

==Always provide an edit summary==
{{shortcut|H:FIES|BTW:FIES}}
It is a good practice to '''provide a meaningful summary for every edit''', especially when [[BTW:Reverting|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 ("[[BattleTechWiki:BattleTechWiki_abbreviations#C|ce]]" and "[[BattleTechWiki:BattleTechWiki_abbreviations#R|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 that do not have an edit summary are more likely to be reverted incorrectly, because it may not be obvious what the purpose of the edit was. 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|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 [[BTW:AGF|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 ''[[Help:Minor edit|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 [[Special:Preferences|user preferences]].

{{Clear}}

==How to write an edit summary==
{{shortcut|BTW:EDITSUMCITE}}
{{seealso|BattleTechWiki: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 BattleTechWiki 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 [[BTW:ESL|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 [[BTW:TALK|talk page]] to give more information, and include "see talk" or "see discussion page" in the edit summary.
** If you are [[BattleTechWiki:Copying within BattleTechWiki|copying text within BattleTechWiki]], you must at least put a link to the source page in the edit summary at the destination page.
* ''Talk pages''. When editing [[BTW:TALKPAGE|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|BTW: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 [[BTW:INCIVILITY|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 [[BTW:No personal attacks|personal attack]].
* ''Avoid incivility. ''Snide comments, personal remarks about editors, and other aggressive edit summaries are explicit [[BTW:Civility#Edit summary dos and don'ts|edit-summary "don'ts"]] of the BattleTechWiki [[BTW:CIVIL|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|BTW:REVTALK}}
Proper use of edit summaries is critical to resolving [[BattleTechWiki:Dispute resolution|content disputes]]. Edit summaries should accurately and succinctly summarize the nature of the edit, especially if it could be controversial. If the edit involves [[Help:Reverting|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 BattleTechWiki space, [[BTW:NPA|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 [[Help:Dummy edit|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 [[BTW:ADMIN|administrators]] using [[BTW:REVDEL|revision deletion]]; such edit summaries remain visible to administrators. In even more limited circumstances, the entire edit may be [[BTW:OVERSIGHT|oversighted]], leaving it and its edit summary visible only to the handful of users with the Oversight permission.

==Edit summary properties and features==
* ''[[#The 500-character limit|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 [[w:Help:Piped link|piped links]], and [[w:Help:Interwiki linking|interwiki]] 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 [[Special:Diff/]] can make clickable [[Help:Diff#Internal links|diffs]], and [[Special:PermaLink/]] can make [[Help:Permanent link|permanent links]]. <code><nowiki>~~~~</nowiki></code> has no effect, so do not [[BattleTechWiki:Signatures|sign]] edit summaries.

===Places where the edit summary appears===
The edit summary appears in black italics in the following places:
* [[Help:Page history|Page history]] – list of changes to the page you edited
* [[Help:User contributions|User contributions]] – list of all your edits
* [[Help:Watchlist|Watchlist]]<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> – list of recent changes to watched pages (logged-in users only)
* [[Help:Diff|Diff page]] – shows the difference between two edits
* [[Help:Permanent link|Permanent link]] – shows an old version of a page
* [[Help:Recent changes|Recent changes]] – list of all recent edits
* [[BattleTechWiki:Discord|BattleTechWiki discord channels]] – real-time list of all edits
* [[Help:Related changes|Related changes]] – list of recent changes to pages linked to the page you edited
* [[Special:NewPages|List of new pages]] – shows the edit summary of the creation.

====Notes====
{{reflist|group="note"}}

===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 [[Help:Section#Section editing|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: [[#Foo|''→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.<ref>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:

: {{Inputbox|/* Foo */ test /* Bar */ test}}

should be rendered as:

: [[#Foo|→Foo]]: test [[#Bar|→Bar]]: test.

See [{{fullurl:Help:Edit_summary|diff=384901084&oldid=384900839}} this edit].</ref>

'''Note''': Tools that track edit summary usage by a user (such as [https://xtools.wmflabs.org/editsummary/en.wikipedia.org 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.
{{reflist}}

[[Category:Help]]

← Older revision		Revision as of 21:56, 30 April 2025
Line 1:		Line 1:
	{{hatnote\|See {{slink\|~~BattleTechWiki~~:Editing policy\|Be helpful: explain}} for the relevant ~~BattleTechWiki~~ policy.}}		{{hatnote\|See {{slink\|BattleIntelligence:Editing policy\|Be helpful: explain}} for the relevant BattleIntelligence policy.}}
	{{pp-semi-indef\|small=yes}}		{{pp-semi-indef\|small=yes}}
	{{infopage\|H:ES\|BTW:ES}}		{{infopage\|H:ES\|BTW:ES}}
Line 5:		Line 5:
	{{clear}}		{{clear}}

	An '''edit summary''' is a ''brief'' explanation of an [[Help:editing\|edit]] to a ~~BattleTechWiki~~ 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 [[w:Help:Diff\|diff]] pages and lists of changes (such as [[w:Help:Page history\|page histories]] and [[w:Help:Watching pages\|watchlists]]).		An '''edit summary''' is a ''brief'' explanation of an [[Help:editing\|edit]] to a BattleIntelligence 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 [[w:Help:Diff\|diff]] pages and lists of changes (such as [[w:Help:Page history\|page histories]] and [[w:Help:Watching pages\|watchlists]]).

	According to the [[Policy:Consensus#Through editing\|consensus policy]]: <em>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.</em> 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:		According to the [[Policy:Consensus#Through editing\|consensus policy]]: <em>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.</em> 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:
Line 13:		Line 13:
	==Always provide an edit summary==		==Always provide an edit summary==
	{{shortcut\|H:FIES\|BTW:FIES}}		{{shortcut\|H:FIES\|BTW:FIES}}
	It is a good practice to '''provide a meaningful summary for every edit''', especially when [[BTW:Reverting\|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 ("[[~~BattleTechWiki~~:~~BattleTechWiki_abbreviations~~#C\|ce]]" and "[[~~BattleTechWiki~~:~~BattleTechWiki_abbreviations~~#R\|rvv]]" for example).		It is a good practice to '''provide a meaningful summary for every edit''', especially when [[BTW:Reverting\|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 ("[[BattleIntelligence:BattleIntelligence_abbreviations#C\|ce]]" and "[[BattleIntelligence:BattleIntelligence_abbreviations#R\|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 that do not have an edit summary are more likely to be reverted incorrectly, because it may not be obvious what the purpose of the edit was. 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\|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 [[BTW:AGF\|assume good faith]] and revert the change without evaluating it properly. Providing an edit summary helps prevent that kind of error.		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 are more likely to be reverted incorrectly, because it may not be obvious what the purpose of the edit was. 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\|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 [[BTW:AGF\|assume good faith]] and revert the change without evaluating it properly. Providing an edit summary helps prevent that kind of error.
Line 25:		Line 25:
	==How to write an edit summary==		==How to write an edit summary==
	{{shortcut\|BTW:EDITSUMCITE}}		{{shortcut\|BTW:EDITSUMCITE}}
	{{seealso\|~~BattleTechWiki~~:Edit summary legend}}		{{seealso\|BattleIntelligence:Edit summary legend}}
	* ''Summarize''. Summarize the change, even if only briefly; even a short summary is better than no 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 ~~BattleTechWiki~~ policy or guideline justifies the change then you may include a link to it in your explanation.		* ''Explain''. Give reasons for the change, if you think other editors may be unclear as to why you made it. If you believe a BattleIntelligence 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 [[BTW:ESL\|edit summary legend]].		* ''Abbreviations''. Abbreviations should be used with care. They can be confusing for new contributors. For an explanation of some commonly used abbreviations, see this [[BTW:ESL\|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 [[BTW:TALK\|talk page]] to give more information, and include "see talk" or "see discussion page" in the edit summary.		* ''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 [[BTW:TALK\|talk page]] to give more information, and include "see talk" or "see discussion page" in the edit summary.
	** If you are [[~~BattleTechWiki~~:Copying within ~~BattleTechWiki~~\|copying text within ~~BattleTechWiki~~]], you must at least put a link to the source page in the edit summary at the destination page.		** If you are [[BattleIntelligence:Copying within BattleIntelligence\|copying text within BattleIntelligence]], you must at least put a link to the source page in the edit summary at the destination page.
	* ''Talk pages''. When editing [[BTW:TALKPAGE\|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.		* ''Talk pages''. When editing [[BTW:TALKPAGE\|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.

Line 39:		Line 39:
	* ''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 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 [[BTW:INCIVILITY\|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 [[BTW:No personal attacks\|personal attack]].		* ''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 [[BTW:INCIVILITY\|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 [[BTW:No personal attacks\|personal attack]].
	* ''Avoid incivility. ''Snide comments, personal remarks about editors, and other aggressive edit summaries are explicit [[BTW:Civility#Edit summary dos and don'ts\|edit-summary "don'ts"]] of the ~~BattleTechWiki~~ [[BTW:CIVIL\|Civility policy]].		* ''Avoid incivility. ''Snide comments, personal remarks about editors, and other aggressive edit summaries are explicit [[BTW:Civility#Edit summary dos and don'ts\|edit-summary "don'ts"]] of the BattleIntelligence [[BTW:CIVIL\|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.		'''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===		===Use of edit summaries in disputes===
	{{shortcut\|BTW:REVTALK}}		{{shortcut\|BTW:REVTALK}}
	Proper use of edit summaries is critical to resolving [[~~BattleTechWiki~~:Dispute resolution\|content disputes]]. Edit summaries should accurately and succinctly summarize the nature of the edit, especially if it could be controversial. If the edit involves [[Help:Reverting\|reverting previous changes]], it should be marked as a revert ("rv") in the edit summary.		Proper use of edit summaries is critical to resolving [[BattleIntelligence:Dispute resolution\|content disputes]]. Edit summaries should accurately and succinctly summarize the nature of the edit, especially if it could be controversial. If the edit involves [[Help:Reverting\|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:		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:
Line 50:		Line 50:
	:''reverted edits by [[User:Example]], see talk for rationale''		:''reverted edits by [[User:Example]], see talk for rationale''

	As with any other ~~BattleTechWiki~~ space, [[BTW:NPA\|do not express opinions of other users]] in edit summaries.		As with any other BattleIntelligence space, [[BTW:NPA\|do not express opinions of other users]] in edit summaries.

	===Fixing===		===Fixing===
Line 64:		Line 64:
	* ''Can't be changed after saving''. After you publish the page, you cannot change the edit summary		* ''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.		* ''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 [[w:Help:Piped link\|piped links]], and [[w:Help:Interwiki linking\|interwiki]] 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 [[Special:Diff/]] can make clickable [[Help:Diff#Internal links\|diffs]], and [[Special:PermaLink/]] can make [[Help:Permanent link\|permanent links]]. <code><nowiki>~~~~</nowiki></code> has no effect, so do not [[~~BattleTechWiki~~:Signatures\|sign]] edit summaries.		* ''Wikilinks '''always''' rendered; other wikitext coding ignored''. Edit summaries render internal links, including [[w:Help:Piped link\|piped links]], and [[w:Help:Interwiki linking\|interwiki]] 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 [[Special:Diff/]] can make clickable [[Help:Diff#Internal links\|diffs]], and [[Special:PermaLink/]] can make [[Help:Permanent link\|permanent links]]. <code><nowiki>~~~~</nowiki></code> has no effect, so do not [[BattleIntelligence:Signatures\|sign]] edit summaries.

	===Places where the edit summary appears===		===Places where the edit summary appears===
Line 74:		Line 74:
	* [[Help:Permanent link\|Permanent link]] – shows an old version of a page		* [[Help:Permanent link\|Permanent link]] – shows an old version of a page
	* [[Help:Recent changes\|Recent changes]] – list of all recent edits		* [[Help:Recent changes\|Recent changes]] – list of all recent edits
	* [[~~BattleTechWiki~~:Discord\|~~BattleTechWiki~~ discord channels]] – real-time list of all edits		* [[BattleIntelligence:Discord\|BattleIntelligence discord channels]] – real-time list of all edits
	* [[Help:Related changes\|Related changes]] – list of recent changes to pages linked to the page you edited		* [[Help:Related changes\|Related changes]] – list of recent changes to pages linked to the page you edited
	* [[Special:NewPages\|List of new pages]] – shows the edit summary of the creation.		* [[Special:NewPages\|List of new pages]] – shows the edit summary of the creation.