Template:Template journal parameter/doc: Difference between revisions

This is a documentation subpage for Template:Template journal parameter.
It contains usage information, categories and other content that is not part of the original Template page.

This template uses TemplateStyles:

Template:Template journal inline/styles.css

The {{Tjp }} template is similar to the {{Para }} template, but uses the same syntax and produces the same output as the parameters displayed by the {{Tj }} and {{Tji }} templates.

Usage

Template preview

See parameter {{tjp|title: A Clockwork Orange}}

↳ See parameter |title=A Clockwork Orange

See parameter {{tjp|title:}}

↳ See parameter |title=

See parameter {{tjp|A Clockwork Orange}}

↳ See parameter |A Clockwork Orange

Parameters

No description.

Template parameters
Parameter		Description	Type	Status
Parameter	`1`	The parameter to show, possibly accompanied by its content (use a colon to separate parameter name and parameter content; use a trailing colon for displaying only the name of the parameter) Example title: A Clockwork Orange	String	required

Before editing this template

Template	Example output	Use
{{strong}}	Important!	To indicate <strong> importance, seriousness, or urgency instead of just simple typographical boldfacing
{{strongbad}}	"Never use ..."	Same as {{strong}} but in red
{{stronggood}}	"Only use ..."	Same as {{strong}} but in green
{{em}}	"An emphatic phrase"	To indicate <em> stress emphasis (not just purely typographical italicization like for book titles or foreign terms)
{{var}}	`strPrefix`	To indicate text is a variable name. Use for any variable names except those including "I" (uppercase i) and/or "l" (lowercase L); for these, {{var serif}} should be used to ensure a noticeable distinction
{{var serif}}	`strIllustratePrefix`	(see {{var}} above)
{{tld}}	`{{DEFAULTSORT:Y, X}}`	To display wikicode variables and magic words as they would appear in code
{{para}}	`\|year=2008`	To display template parameters with or without values
{{param}}	`{{{title\|alt}}}`	To display parameters as used in code (i.e. with triple braces), especially to indicate relationships between them. May be combined with {{para}} above
{{tjp}}	\|selfref=yes	To display template parameters with colors (as they would appear in the {{Tj }} and {{Tji }} templates)
{{param value}}	`··2·blanks·fore·and·aft··`	To display parameter values lightly bordered; replaces <code>...</code>, especially when value contains embedded or leading/trailing blanks; visualized here with middot (·) but can use ␠, ▯, or any character.
{{tlx}} etc.	{{Template\|`1`\|`2`\|...\|`10`}}	To display a template call (with or without parameters and values) as code
{{tji}}	{{hatnote\|Hello\|selfref=yes\|category=no}}	To showcase with colors in horizontal format the syntax of any template, while providing an easy way to display placeholder texts using colons as separators
{{tag}}	"The `‎<img>...‎</img>` tags ..."	To render HTML elements ("tags") in prose
{{code}}/{{codett}}	"Ensure the alt= parameter ..."	To indicate text is source code. To nest other templates within {{code}}, use `‎<code>...‎</code>`. {{Codett }} differs only in styling: someMethod becomes someMethod
{{PreCode}}	"FORTH has keyword `?BRANCH`."	Like {{code}}, but prevents line breaks inside the code. Only for very short code parts.
{{subst :codenowiki}}	`{{small\|small text example}}`	To wrap example code in <code><nowiki>...</nowiki></code>
{{subst :kbdnowiki}}	`{{large\|large text example}}`	To wrap example code in <kbd><nowiki>...</nowiki></kbd>
{{syntaxhighlight}}	_{[this is a block template]}	( or {{sxhl}} ) Wrapper for `‎<syntaxhighlight>...‎</syntaxhighlight>`, but will wrap overflowing text
{{deprecated code}}	"Do not use `‎<blink>`."	( or {{dc}} ) To indicate deprecated source code in template documentation, articles on HTML specs, etc. The {{dc2}} variant uses strike-through (`‎<blink>`) while {{dcr}} uses red (`‎<blink>`).
{{pre}}	_{[this is a block template]}	For larger blocks of source code and other pre-formatted text
{{tj}}	_{[this is a block template]}	To showcase with colors and multiple lines (vertical format) the syntax of any template, while providing an easy way to display placeholder texts using colons as separators
{{quote}}	_{[this is a block template]}	For block quotations (only – never for non-quotations)
{{block indent}}	_{[this is a block template]}	For indented blocks of material; visually identical to {{quote}} but without quote markup
{{kbd}}	`user input`	To indicate user input
{{key press}}	`Ctrl`+`x`	To indicate specific-keystroke input, including combinations
{{key top}}	`Left shift`	Similar; includes more symbols, but does not directly support combinations
{{button}}	<span class="nowrap" title="<translate nowrap> This is not a clickable button; it illustrates the button one should find.</translate>" style="padding:.2em .6em; border:1px solid; border-color:#AAA #555 #555 #AAA; border-radius: 3px; background-color: #F2F2F2; background-image: linear-gradient(to bottom, #FCFCFC, #E0E0E0); ">Don't save	To indicate a button in a user interface
{{samp}}	`example output`	To indicate sample or example output

Template:Template journal parameter/doc: Difference between revisions

Latest revision as of 05:57, 27 August 2024

Usage

Parameters

Before editing this template

See also