Template:Template journal/doc: Difference between revisions

From HIBIKIFORUM
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
{{lua|Module:Params}}
{{Support|Template:Template journal/arg}}
{{Uses TemplateStyles|Template:Template journal/styles.css}}
{{Uses TemplateStyles|Template:Template journal/styles.css}}
{{Support|Template:Template journal/arg}}
{{tsh|tj}}
{{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}}.
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 ==
;Syntax
{{tji|tj|template|param. name 1: param. content 1|param. name 2: param. content 2...}}
: {{tji|tj|template|param. name 1: param. content 1|param. name 2: param. content 2...}}


For instance, the following code
For instance, the following code


{{Pre|{{{{fcb|#2e8b57|tj}}|cite book
{{Pre|{{{{tcp|tj}}|cite book
   |last: Author's last name|first: Author's first name
   |last: Author's last name|first: Author's first name
   |author-link: Author's page name on Wikipedia|date: Publication date
   |author-link: Author's page name on Wikipedia|date: Publication date
Line 28: Line 28:
Likewise, the following code
Likewise, the following code


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


Line 38: Line 38:
And finally, the following code
And finally, the following code


{{Pre|{{{{fcb|#2e8b57|tj}}|Blockquote
{{Pre|{{{{tcp|tj}}|Blockquote
   | Cry "Havoc" and let slip the dogs of war.
   | Cry "Havoc" and let slip the dogs of war.
   | <nowiki>[[William Shakespeare]]</nowiki>
   | <nowiki>[[William Shakespeare]]</nowiki>
Line 55: Line 55:
   | source: act III, scene I
   | source: act III, scene I
}}
}}
Currently it is possible to showcase '''up to 50 template parameters''' (both named and unnamed).


=== Edge cases ===
=== Edge cases ===
Line 67: Line 65:
{{Pre|<nowiki><!-- Good example --></nowiki>
{{Pre|<nowiki><!-- Good example --></nowiki>


{{{{fcb|#2e8b57|tj}}|Some template
{{{{tcp|tj}}|Some template
   | Hello
   | Hello
   | World
   | World
Line 95: Line 93:
{{Pre|<nowiki><!-- Bad example --></nowiki>
{{Pre|<nowiki><!-- Bad example --></nowiki>


{{{{fcb|#2e8b57|tj}}|Some template
{{{{tcp|tj}}|Some template
   | Hello
   | Hello
   | this = will = be = ignored
   | this = will = be = ignored
Line 115: Line 113:
{{Pre|<nowiki><!-- Good example --></nowiki>
{{Pre|<nowiki><!-- Good example --></nowiki>


{{{{fcb|#2e8b57|tj}}|Some template
{{{{tcp|tj}}|Some template
   | Hello
   | Hello
   | this {{=}} will {{=}} not {{=}} be {{=}} ignored
   | this {{=}} will {{=}} not {{=}} be {{=}} ignored
Line 138: Line 136:


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

Latest revision as of 05:38, 20 August 2023

Light bulb.png }}
It contains usage information, categories and other content that is not part of the original template page.

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

Syntax

{{tj|template|param. name 1: param. content 1|param. name 2: param. content 2...}}

For instance, the following code

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

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

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

will produce the following result.

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

And finally, the following code

{{tj|Blockquote
  | 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
}}

will produce the following result.

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

Edge cases

To preserve one or more initial colons from being replaced, the &#58; 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 &#61; must be used.

Thus, the following are all valid parameters,

<!-- Good example -->

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

and they will produce the following result.

{{Some template
| 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

<!-- Bad example -->

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

will produce the following problematic result.

{{Some template
| Hello
| road = unknown
| :windmill: true
}}

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

<!-- Good example -->

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

which will correctly print

{{Some template
| Hello
| this = will = not = be = ignored
| road = unknown
| :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 {{tji}}. If you need a more irregular output, please refer to other solutions.

See also