Help:Edit summary

Jump to: navigation, search

It is good practice to fill in the Edit Summary field, or add to it in the case of section editing, 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 Edit) to "Prompt me when entering a blank edit summary".

In the case of applying substitution, providing the line of wikitext containing "subst:" in the edit summary is especially useful, because otherwise substitution does not show up as such in the page history.


Properties

The edit summary box can hold one line of 200 characters. If you attempt to type or paste more than this only the first 200 characters will be displayed - the rest will be disregarded. 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.

When pressing "preview", also a preview of the edit summary is obtained; thus e.g. links can be checked.


Recommendations

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

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.

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 Abbreviations section 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. It also makes it easy for color-blind or visually impaired readers to see punctuation and other tiny changes that may be difficult to discern. It also helps users to check Recent changes, Page history and User contributions (see below) very efficiently, and reduces the load on the servers.

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

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.

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

After saving the page, the summary can not be edited--another reason to avoid spelling errors.

In the case of important omissions or errors in the edit summary, you can make a dummy edit just to put the correction in the edit summary.


Changing an edit summary

Changing an edit summary is cumbersome and requires importing (hence this has to be enabled on the wiki and the user needs to have that user right): export the page with history, delete the page, make the change in the xml file, and import it again. To change the edit summary of the current revision one can also export the page without history, delete the page, restore it except the last revision, make the change in the xml file, and import it again.

The import log shows the import of the page, with user name, date, time, and number of revisions. The deletion log shows the deletion and, if applicable, restoration, with user name, date, and time. The "View and restore deleted pages" feature shows deleted revisions. There is no easy way (like a diff) to see what changes were made. In the case of multiple deletions and imports or restorations it is not recorded which revisions existed when in the regular page history, so it is not possible at all to know what was changed in the last delete/import operation.

You can edit or add to this article.
Please enter article title and section to proceed.
Create a new article
Enter article title   belonging to the section

Do you have any old photos you'd like to share?
Upload ImageClick here to upload image

Share this page: del.icio.us | digg | Fark | Furl | BlogMarks