Template:Dialog/notes/doc
 |
This is a documentation subpage for Template:Dialog/notes (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 a dialog page indicates — when viewing the dialog page via dialog action do verb view — that any internal notes about the current page view should be placed on the page at the position of each call to this template. Internal dialog notes are generated as low-profile diagnostic information explaining complex rejection-decisions that don't warrant an obtrusive error message, such as why a page does not provide outgoing authentication, or why it doesn't qualify for continuation of an action-sequence. Under ordinary circumstances the user doesn't want to know these things, but when debugging a dialog it can be extremely useful to have an explanation of why the software isn't doing something.
Internals
editThe view verb of action do processes calls to this template — and {{dialog/incoming untouched}} and {{dialog/incoming localized}} — after all other processing has been completed; so this information is not available as template parameters or even as dialog field values. This timing prevents the inspection feature, which is meant to be the sole purpose of the notes, from affecting dialog behavior.
See also
edit