Template:DYK mbox/doc

From blackwiki
< Template:DYK mbox
Revision as of 07:08, 12 February 2013 by imported>John Cline (update /doc)
Jump to navigation Jump to search
Shortcut:

{{DYK mbox}} is a messaging utility template for posting messages related to Did you knowDYK comment symbol operations. It also supports other templates, internally—to facilitate interactive ease of use, on special pages, and editing scripts, used for the administration of Did you knowDYK comment symbol.

Template {{DYK mbox}}

This template was developed for the specialized needs of Did you knowDYK comment symbol.

Usage

The only required parameter for this messaging template is | text =. If | text = is blank: {{DYKM|text=}}, or not present: {{DYKM}}, the message displays {{{1}}} as shown below:



Using {{DYKM|text=Inserts your custom message.}} as follows:



You can use a non-printable character, like   if you don't want to use text and the {{{1}}} will not display because the parameter is not actually blank; as show below:



You can also use | xfile = to eliminate the image as the output for {{DYKM|xfile=x}} is shown below:



Or you could use {{DYKM|xfile=x|text=This combination to display text with no image}} as shown below:



The | small = parameter switches from the 80% width center aligned message box to a smaller box that aligns to the right side of the line it is added to. It uses similar parameters as the main box except the begin with a small s, for example the text paramater for the small box is | stext =. Therefor the following code: {{DYKM|small=y|stext=This is the small box text}} produces the following:



Several other parameters are incorporated that modify the template's output for specialized use (examples are shown below).

Examples

Custom messaging examples are included as expandable content.

See also


See also




Usage

</includeonly>