Template:Template journal/doc
 | This is a documentation subpage for Template:Template journal. It may contain usage information, categories and other content that is not part of the original template page. |
| File:Farm-Fresh css add.svg | This template uses TemplateStyles: |
The {{Template journal}} template allows to showcase with colors and multiple lines the syntax of any template, while providing an easy way to display placeholder texts using colons as separators. For an identical template that displays the output in horizontal format, see {{Template journal inline}}.
Usage
- Syntax
- {{tj
|template |param. name 1: param. content 1 |param. name 2: param. content 2...}}
For instance, the following code
<syntaxhighlight lang="wikitext">
| last = Author's last name
| first = Author's first name
| author-link = Author's page name on Wikipedia
| date = Publication date
| title = Work's title
| url = Work's URL
| location = Where the work was published
| publisher = Name of the publisher
}}
</syntaxhighlight>
will produce the following result.
| last = Author's last name
| first = Author's first name
| author-link = Author's page name on Wikipedia
| date = Publication date
| title = Work's title
| url = Work's URL
| location = Where the work was published
| publisher = Name of the publisher
}}
Likewise, the following code
<syntaxhighlight lang="wikitext">
| name =
| image =
| caption =
| character =
| actor =
| writer =
| firstusedin =
| alsousedin =
| moviequotes =
}}
</syntaxhighlight>
will produce the following result.
| name =
| image =
| caption =
| character =
| actor =
| writer =
| firstusedin =
| alsousedin =
| moviequotes =
}}
And finally, the following code
<syntaxhighlight lang="wikitext">
| Cry "Havoc" and let slip the dogs of war.
| [[William Shakespeare]]
| character = Mark Antony
| title = ''[[Julius Caesar (play)|Julius Caesar]]''
| source = act III, scene I
}}
</syntaxhighlight>
will produce the following result.
| Cry "Havoc" and let slip the dogs of war.
| [[William Shakespeare]]
| character = Mark Antony
| title = ''[[Julius Caesar (play)|Julius Caesar]]''
| source = act III, scene I
}}
Currently it is possible to showcase up to 50 template parameters (both named and unnamed).
Edge cases
To preserve one or more initial colons from being replaced, the : wikitext entity must be used. After one colon has been replaced all other colons in the argument will be preserved.
Similarly, to insert one or more equals signs into a parameter content, either {{=}} or = must be used.
Thus, the following are all valid parameters,
<syntaxhighlight lang="wikitext">
| Hello
| World
| foo = bar
|
| road =
| keep:the:colon = I:said:keep:it!
| ink = marble
| book = /books?id=mAlLt1aGsWYC
}}
</syntaxhighlight>
and they will produce the following result.
| Hello
| World
| foo = bar
|
| road =
| keep:the:colon = I:said:keep:it!
| ink = marble
| book = /books?id=mAlLt1aGsWYC
}}
Arguments containing one or more unescaped equals signs will be silently ignored. An unescaped leading colon will be treated as a normal character, exactly like any other colon that might follow in the same parameter. Thus, the following code
<syntaxhighlight lang="wikitext">
</syntaxhighlight>
will produce the following problematic result.
Instead, the right way to write the previous unlikely example is the following,
<syntaxhighlight lang="wikitext">
</syntaxhighlight>
which will correctly print
By design, there is no way to deviate from the format of one argument per line (vertical format). If you need to display a template and all its arguments in one single line (horizontal format), please refer to {{tji}}. If you need a more irregular output, please refer to other solutions.
Before editing this template
- Do not add optional arguments for offering customized results (e.g. changing colors on demand, font, etc.): one of the purposes of this template is that of maintaining always the same look across the entire Wikipedia concerning how templates are shown and explained
- If you intend to introduce substantial changes that are not simple bug fixes, you are invited to discuss them in the talk page first
- If you do make changes, please make always sure that the {{tji}} template remains consistent with this template
Subpages
See also
- {{Template journal inline}}
- {{Template journal parameter}}
- {{Template link}}
- {{Template link expanded}}
{{Syntaxhighlight|lang=wikitext}}<syntaxhighlight lang="wikitext">...</syntaxhighlight>
