View source for Template:Template journal/doc

{{Documentation subpage}}
{{Template shortcut|tj|TJ}}
{{lua|Module:Params}}
{{Uses TemplateStyles|Template:Template journal/styles.css}}

The {{tl|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 {{tl|Template journal inline}}. See also {{tl|Template journal parameter}} for a template similar to {{tl|para}} that uses the same syntax and produces the same output as the parameters displayed by {{tl|tj}} and {{tl|tji}}.

== Usage ==

;Syntax
:{{tji|tj|template|param. name 1&#58; param. content 1|param. name 2&#58; param. content 2...}}

{{vpad}}

For instance, the following code

<syntaxhighlight lang="wikitext">{{tj|cite book
  |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.

{{tj|cite book
  |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">{{tj|Infobox movie quote|name:|image:|caption:|character:|actor:|writer:
  |firstusedin:|alsousedin:|moviequotes:}}</syntaxhighlight>

will produce the following result.

{{tj|Infobox movie quote|name:|image:|caption:|character:|actor:|writer:
  |firstusedin:|alsousedin:|moviequotes:}}

And finally, the following code

<syntaxhighlight lang="wikitext">{{tj|Blockquote
  | Cry "Havoc" and let slip the dogs of war.
  | <nowiki>[[William Shakespeare]]</nowiki>
  | character: Mark Antony
  | title: <nowiki>''[[Julius Caesar (play)|Julius Caesar]]''</nowiki>
  | source: act III, scene I
}}</syntaxhighlight>

will produce the following result.

{{tj|Blockquote
  | Cry "Havoc" and let slip the dogs of war.
  | <nowiki>[[William Shakespeare]]</nowiki>
  | character: Mark Antony
  | title: <nowiki>''[[Julius Caesar (play)|Julius Caesar]]''</nowiki>
  | source: act III, scene I
}}

=== Edge cases ===

To preserve one or more initial colons from being replaced, the <code>&amp;#58;</code> HTML 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 <code><nowiki>{{=}}</nowiki></code> or <code>&amp;#61;</code> must be used.

Thus, the following are all valid parameters,

<syntaxhighlight lang="wikitext"><!-- Good example -->

{{tj|Some template
  | Hello
  | World
  | foo: bar
  |
  | road:
  | keep&#58;the&#58;colon:I:said:keep:it!
  | ink      :marble
  | book: /books?id{{=}}mAlLt1aGsWYC
}}</syntaxhighlight>

and they will produce the following result.

{{tj|Some template
  | Hello
  | World
  | foo: bar
  |
  | road:
  | keep&#58;the&#58;colon:I:said:keep:it!
  | ink      :marble
  | book: /books?id{{=}}mAlLt1aGsWYC
}}

Arguments containing one or more unescaped equals signs will be silently ignored. Thus, the following code

<syntaxhighlight lang="wikitext"><!-- Bad example -->

{{tj|Some template
  | Hello
  | this = will = be = ignored
  | road: unknown
}}</syntaxhighlight>

will produce the following problematic result.

{{tj|Some template
  | Hello
  | this = will = be = ignored
  | road: unknown
}}

Instead, the right way to write the previous unlikely example is the following,

<syntaxhighlight lang="wikitext"><!-- Good example -->

{{tj|Some template
  | Hello
  | this {{=}} will {{=}} not {{=}} be {{=}} ignored
  | road: unknown
}}</syntaxhighlight>

which will correctly print

{{tj|Some template
  | Hello
  | this {{=}} will {{=}} not {{=}} be {{=}} ignored
  | road: unknown
}}

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 {{tl|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 [[Template talk:Template journal|talk page]] first
* If you do make changes, please make always sure that the {{tl|tji}} template remains consistent with this template

== Subpages ==
* &#123;&#123;Template journal/arg&#125;&#125; – no longer used, will be removed at some point
* {{rel|Template:Template journal/styles.css}}

== See also ==
* {{Tl|Template journal inline}}
* {{Tl|Template journal parameter}}
* {{Tl|Template link}}
* {{Tl|Template link expanded}}
* {{Tlx|Syntaxhighlight|lang{{=}}wikitext}}
** {{xtag|syntaxhighlight|p|params=lang="wikitext"}}
{{semantic markup templates}}
<includeonly>{{Sandbox other||

<!-- Categories below this line -->
[[Category:Wikitext typing-aid templates]]
[[Category:Internal template-link templates]]
}}</includeonly>