Template:Dialog/documentation

Template documentation[view] [edit] [history] [purge]

1 Usage
2 Examples
3 See also

Usage

If a page contains interactive dialog that should be documented, and it isn't part of an assistant, place this template at the bottom of the dialog page, and at the top of the documenting page.

The template determines which sort of page it's on by checking to see if the current page name ends with /doc. To override this determination, specify a non-blank parameter dialog; if dialog=no, the page is treated as documentation; if dialog has any other non-blank value, the page is treated as dialog.

Ordinarily, the template assumes the name of the documentation page suffixes /doc to the name of the dialog page. To override this assumption on the dialog page, provide an unnamed parameter naming the documentation page. To override this assumption on the documentation page, provide one or two unnamed parameters: one named parameter names the dialog page; two non-blank parameters are the dialog page name and a label for the link; and a blank first parameter followed by a non-blank second parameter produce an unlinked description of the dialog.

Examples

edit

On a dialog page

edit

{{dialog/documentation|foo}}

This page contains interactive dialog. Documentation for the dialog may be created here.Template:Dialog/documentation/preload

{{dialog/documentation|foo|bar}}

This page contains interactive dialog. Documentation for the dialog may be created here.Template:Dialog/documentation/preload

{{dialog/documentation||bar}}

This page contains interactive dialog. The dialog is documented here.

On a documentation page

edit

{{dialog/documentation|foo}}

This is an interactive dialog documentation page for foo.

{{dialog/documentation|foo|bar}}

This is an interactive dialog documentation page for bar.

{{dialog/documentation||bar}}

This is an interactive dialog documentation page for bar.

Default on the current page

edit

By default the template would treat this page as a dialog}} page.

{{dialog/documentation|foo}}

This page contains interactive dialog. Documentation for the dialog may be created here.Template:Dialog/documentation/preload

{{dialog/documentation|foo|bar}}

This page contains interactive dialog. Documentation for the dialog may be created here.Template:Dialog/documentation/preload

{{dialog/documentation||bar}}

This page contains interactive dialog. The dialog is documented here.

Usage

Examples

On a dialog page

On a documentation page

Default on the current page

See also