Template:Dialog/confirm edit/doc
This is a documentation subpage for Template:Dialog/confirm edit (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
This is a dialog formatting template. It is meant for use on interactive dialog pages, and may involve interactions between wiki markup, html, and javascript. Please carefully test any edits before making them. |
Usage
editPlacing this template on an dialog edit form indicates, when the form mediates dialog action do verb edit, that the user should be asked for confirmation before proceeding with the action. The question to ask for confirmation is provided as an unnamed templated parameter; if not provided, a default question is asked; as of this writing, Edit page?
. If the user cancels rather than confirming, dialog attempts to roll back to the dialog state from which the action request was made; if that can't be done, an error panel is displayed explaining the user's options for what to do next.
The {{dialog/confirm edit}} template call must appear on the form page itself, and must also still be present on the page after noinclude template-expansion of the form. Thus, confirmation may be conditional on logic on the form, determined at expansion time, but arbitrary templates used on the form cannot impose confirmation if it was not provided for by the form itself.
See also
edit