Template:Template journal/doc: Difference between revisions

From HIBIKIFORUM
Jump to navigation Jump to search
(Created page with "{{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 :{{...")
 
mNo edit summary
Line 7: Line 7:


== Usage ==
== 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


<syntaxhighlight lang="wikitext">{{tj|cite book
{{Pre|{{{{fcb|#2e8b57|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
   |title: Work's title|url: Work's URL|location: Where the work was published
   |title: Work's title|url: Work's URL|location: Where the work was published
   |publisher: Name of the publisher}}</syntaxhighlight>
   |publisher: Name of the publisher}} }}


will produce the following result.
will produce the following result.
Line 29: Line 28:
Likewise, the following code
Likewise, the following code


<syntaxhighlight lang="wikitext">{{tj|Infobox movie quote|name:|image:|caption:|character:|actor:|writer:
{{Pre|{{{{fcb|#2e8b57|tj}}|Infobox movie quote|name:|image:|caption:|character:|actor:|writer:
   |firstusedin:|alsousedin:|moviequotes:}}</syntaxhighlight>
   |firstusedin:|alsousedin:|moviequotes:}} }}


will produce the following result.
will produce the following result.
Line 39: Line 38:
And finally, the following code
And finally, the following code


<syntaxhighlight lang="wikitext">{{tj|Blockquote
{{Pre|{{{{fcb|#2e8b57|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 45: Line 44:
   | title: <nowiki>''[[Julius Caesar (play)|Julius Caesar]]''</nowiki>
   | title: <nowiki>''[[Julius Caesar (play)|Julius Caesar]]''</nowiki>
   | source: act III, scene I
   | source: act III, scene I
}}</syntaxhighlight>
}} }}


will produce the following result.
will produce the following result.
Line 60: Line 59:


=== Edge cases ===
=== 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.
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.


Line 67: Line 65:
Thus, the following are all valid parameters,
Thus, the following are all valid parameters,


<syntaxhighlight lang="wikitext"><!-- Good example -->
{{Pre|<nowiki><!-- Good example --></nowiki>


{{tj|Some template
{{{{fcb|#2e8b57|tj}}|Some template
   | Hello
   | Hello
   | World
   | World
Line 78: Line 76:
   | ink      :marble
   | ink      :marble
   | book: /books?id{{=}}mAlLt1aGsWYC
   | book: /books?id{{=}}mAlLt1aGsWYC
}}</syntaxhighlight>
}} }}


and they will produce the following result.
and they will produce the following result.
Line 95: Line 93:
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
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"><!-- Bad example -->
{{Pre|<nowiki><!-- Bad example --></nowiki>


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


will produce the following problematic result.
will produce the following problematic result.
Line 115: Line 113:
Instead, the right way to write the previous unlikely example is the following,
Instead, the right way to write the previous unlikely example is the following,


<syntaxhighlight lang="wikitext"><!-- Good example -->
{{Pre|<nowiki><!-- Good example --></nowiki>


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


which will correctly print
which will correctly print

Revision as of 02:11, 19 June 2023

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

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 

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

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 &#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


Retrieved from "http://hibikiforum.net/index.php?title=Template:Template_journal/doc&oldid=97815"