View source for Template:Template journal/doc

{{Documentation subpage}}
{{Uses TemplateStyles|Template:Template journal/styles.css}}
{{Support|Template:Template journal/arg}}
{{tsh|tj}}

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}}.

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

For instance, the following code

{{Pre|{{{{fcb|#2e8b57|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}} }}

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

{{Pre|{{{{fcb|#2e8b57|tj}}|Infobox movie quote|name:|image:|caption:|character:|actor:|writer:
  |firstusedin:|alsousedin:|moviequotes:}} }}

will produce the following result.

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

And finally, the following code

{{Pre|{{{{fcb|#2e8b57|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
}} }}

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
}}

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 <code>&amp;#58;</code> 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 <code><nowiki>{{=}}</nowiki></code> or <code>&amp;#61;</code> must be used.

Thus, the following are all valid parameters,

{{Pre|<nowiki><!-- Good example --></nowiki>

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

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. 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

{{Pre|<nowiki><!-- Bad example --></nowiki>

{{{{fcb|#2e8b57|tj}}|Some template
  | Hello
  | this = will = be = ignored
  | road: unknown
  | :windmill: true
}} }}

will produce the following problematic result.

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

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

{{Pre|<nowiki><!-- Good example --></nowiki>

{{{{fcb|#2e8b57|tj}}|Some template
  | Hello
  | this {{=}} will {{=}} not {{=}} be {{=}} ignored
  | road: unknown
  | &#58;windmill: true
}} }}

which will correctly print

{{tj|Some template
  | Hello
  | this {{=}} will {{=}} not {{=}} be {{=}} ignored
  | road: unknown
  | &#58;windmill: true
}}

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.

== See also ==
* {{Tl|Template journal inline}}
* {{Tl|Template link}}

<includeonly>{{sandbox other||{{testcases other||
<!-- Categories below this line, please -->
[[Category:Templates]]
[[Category:Documentation formatting templates]]
}}}}</includeonly>