>Rusty.perrin |
|
(One intermediate revision by the same user not shown) |
Line 1: |
Line 1: |
| {{Documentation subpage}} | | {{Documentation subpage}} |
| | {{Uses TemplateStyles|Template:Pre/styles.css}} |
| <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> |
|
| |
|
| {{tl|{{PAGENAME}}}} uses {{code|<pre>}} tags, but with text that is either [[word wrap|wrapped]] or is contained in a horizontal scrollbox. This means the text will not stretch past the right side of the screen. | | This template implements a version of the functionality provided by the [[HTML]] {{tag|pre|o}} tag. |
|
| |
|
| As it uses real <pre> tags, it will be displayed correctly regardless of how the user's Powerpedia renders <pre> boxes.
| | ===TemplateData=== |
| | <templatedata> |
| | { |
| | "description": "This template implements a version of the functionality provided by the HTML <pre> tag.", |
| | "params": { |
| | "1": { |
| | "label": "Text", |
| | "type": "string", |
| | "description": "The text which should be wrapped in pre tags.", |
| | "required": true |
| | }, |
| | "style": { |
| | "label": "Style", |
| | "type": "string", |
| | "description": { |
| | "en": "Optional css styling applied to the pre tag" |
| | } |
| | }, |
| | "width": { |
| | "label": "Width", |
| | "type": "string", |
| | "description": { |
| | "en": "The width of the pre box" |
| | } |
| | }, |
| | "space": { |
| | "label": "Space", |
| | "type": "string", |
| | "description": { |
| | "en": "The way white space is handled in the pre box" |
| | } |
| | }, |
| | "border": { |
| | "label": "Border", |
| | "type": "string", |
| | "description": { |
| | "en": "Set to 'no' if there should be no border around the box" |
| | } |
| | } |
| | } |
| | } |
| | </templatedata> |
|
| |
|
| If you want to disable [[wikitext]] in it, you should use <nowiki> tags inside the template (see [[#wikitext|below]]).
| | ===Usage=== |
|
| |
|
| ==Usage==
| | This template supports two parameters |
| ===Wrapped text===
| |
| {{code|<nowiki>{{Pre|Text to be displayed. And more and more and more... and a paragraph break.</nowiki><br /><nowiki>And then more and more...}}</nowiki>}}
| |
| :produces:
| |
| {{Pre|Text to be displayed. And more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and a paragraph break.
| |
|
| |
|
| And then more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more.}}
| | {{para|width}} The width of the pre "box" <br> |
| | {{para|space}} The way white space is handled in the pre "box" |
|
| |
|
| ===Scrollbox===
| | {{markup |
| {{code|<nowiki>{{Pre|scroll|Text to be displayed. And more and more and more... and a paragraph break.</nowiki><br /><nowiki>And then more and more...}}</nowiki>}} | | |<nowiki>{{Pre| |
| :produces:
| | This Pre-format |
| {{Pre|scroll|Text to be displayed. And more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and a paragraph break.
| |
|
| |
|
| And then more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more and more.}}
| | can look |
|
| |
|
| ==Using wikitext {{anchor|wikitext}}==
| | like this. |
| | }}</nowiki> |
| | |{{Pre| |
| | This Pre-format |
|
| |
|
| To disable wikitext (e.g. <nowiki>[[</nowiki>[[links]]<nowiki>]]</nowiki>), <nowiki> tags must be used in the form:
| | can look |
|
| |
|
| {{code|<nowiki>{{Pre|<nowiki>Your [[text]], which ''might'' include {{tl|templates}}.<noinclude>[[Category:Examples]]</noinclude></nowiki>}}</nowiki>}}
| | like this. |
| | }} |
| | }} |
| | Main differences include: |
| | * It wraps text that overflows the page. |
| | * It allows mid-line-breaks (but not always consistently). |
|
| |
|
| This will produce this:
| | Main limitations include: |
| {{Pre|<nowiki>Your [[text]], which ''might'' include {{tl|templates}}.<noinclude>[[Category:Examples]]</noinclude></nowiki>}}
| | * If the text is a single long word, it won't be wrapped and will still break out to the right hand of the page. |
| | * HTML and wikimarkup aren't disabled as in {{tag|pre}} and are rendered as usual (thus if a parameter contains any wikimarkup, enclose it in {{tag|nowiki}}); however, multiple spaces are preserved. |
|
| |
|
| as opposed to:
| | As with {{tag|pre|o}} and {{tag|code|o}}, {{tl|pre}} displays text in the font specified as the monospace font in the user's browser options, or specified in the user's CSS pages. |
| {{Pre|Your [[text]], which ''might'' include {{tl|templates}}.<noinclude>[[Category:Examples]]</noinclude>}} | |
|
| |
|
| | ===Example=== |
| | '''Markup''' |
|
| |
|
| <includeonly> | | <syntaxhighlight lang="wikitext"> |
| | {{Pre| |
| | '''First line, markup working:''' and HTML comment <!--HIDDEN--> hidden. |
|
| |
|
| <!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
| | '''Second line, long text wrapping:''' all work and no play make jack a dull boy all work and no play make jack a dull boy all work and no play make jack a dull boy all work and no play make jack a dull boy all work and no play make jack a dull boy. |
|
| |
|
| [[Category:Programming typing-aid templates|{{PAGENAME}}]]
| | '''Third line with raw | pipe is handled''', but the space before the pipe is lost. Up to raw 20 pipes are handled, else use <nowiki>|</nowiki> and {{!}} it's {{!}} OK. |
| [[Category:Powerpedia XHTML tag replacing templates|{{PAGENAME}}]]
| |
|
| |
|
| </includeonly> | | '''Fourth line, multiple spaces preserved''' unlike in HTML and wikitext. |
| | '''Fifth line, following the previous one'''. |
| | |
| | |
| | '''Last line''' preceded by two blank lines in markup and in display. |
| | }} |
| | </syntaxhighlight> |
| | |
| | ; Result |
| | |
| | {{Pre| |
| | '''First line, markup working:''' and HTML comment <!--HIDDEN--> hidden. |
| | |
| | '''Second line, long text wrapping:''' all work and no play make jack a dull boy all work and no play make jack a dull boy all work and no play make jack a dull boy all work and no play make jack a dull boy all work and no play make jack a dull boy. |
| | |
| | '''Third line with raw | pipe is handled''', but the space before the pipe is lost. Up to raw 20 pipes are handled, else use <nowiki><nowiki></nowiki>{{!}}<nowiki></nowiki></nowiki> and {{!}} it's {{!}} OK. |
| | |
| | '''Fourth line, multiple spaces preserved''' unlike in HTML and wikitext. |
| | '''Fifth line, following the previous one'''. |
| | |
| | |
| | '''Last line''' preceded by two blank lines in markup and in display. |
| | }} |
| | |
| | ===See also=== |
| | * {{tl|monodiv}}, a template with similar functionality but without border. |
| | * {{tl|tag}} |
| | * {{tl|code}} |
| | * {{xtag|syntaxhighlight}} |
| | * [[HTML element#pre|{{tag|pre|o}}]] |
| | * [[Help:Wikitext#Text_formatting|{{tag|code|o}}]] |
| | {{semantic markup templates}} |
| | |
| | <includeonly>{{Sandbox other| |
| | | <!-- CATEGORIES BELOW THIS LINE, PLEASE: --> |
| | [[Category:Programming typing-aid templates]] |
| | [[Category:Wikipedia XHTML tag-replacing templates]] |
| | }}</includeonly> |
Lua error in Module:TNT at line 159: Missing JsonConfig extension; Cannot load https://commons.wikimedia.org/wiki/Data:I18n/Uses TemplateStyles.tab.
This template implements a version of the functionality provided by the HTML <pre>
tag.
TemplateData
Template parameters
Parameter | Description | Type | Status |
---|
Text | 1 | The text which should be wrapped in pre tags.
| String | required |
---|
Style | style | Optional css styling applied to the pre tag
| String | optional |
---|
Width | width | The width of the pre box
| String | optional |
---|
Space | space | The way white space is handled in the pre box
| String | optional |
---|
Border | border | Set to 'no' if there should be no border around the box
| String | optional |
---|
Usage
This template supports two parameters
|width=
The width of the pre "box"
|space=
The way white space is handled in the pre "box"
Markup
|
Renders as
|
[markup]
|
|
|
|
Main differences include:
- It wraps text that overflows the page.
- It allows mid-line-breaks (but not always consistently).
Main limitations include:
- If the text is a single long word, it won't be wrapped and will still break out to the right hand of the page.
- HTML and wikimarkup aren't disabled as in
<pre>...</pre>
and are rendered as usual (thus if a parameter contains any wikimarkup, enclose it in <nowiki>...</nowiki>
); however, multiple spaces are preserved.
As with <pre>
and <code>
, {{pre}} displays text in the font specified as the monospace font in the user's browser options, or specified in the user's CSS pages.
Example
Markup
{{Pre|
'''First line, markup working:''' and HTML comment <!--HIDDEN--> hidden.
'''Second line, long text wrapping:''' all work and no play make jack a dull boy all work and no play make jack a dull boy all work and no play make jack a dull boy all work and no play make jack a dull boy all work and no play make jack a dull boy.
'''Third line with raw | pipe is handled''', but the space before the pipe is lost. Up to raw 20 pipes are handled, else use <nowiki>|</nowiki> and {{!}} it's {{!}} OK.
'''Fourth line, multiple spaces preserved''' unlike in HTML and wikitext.
'''Fifth line, following the previous one'''.
'''Last line''' preceded by two blank lines in markup and in display.
}}
- Result
First line, markup working: and HTML comment hidden.
Second line, long text wrapping: all work and no play make jack a dull boy all work and no play make jack a dull boy all work and no play make jack a dull boy all work and no play make jack a dull boy all work and no play make jack a dull boy.
Third line with raw| pipe is handled, but the space before the pipe is lost. Up to raw 20 pipes are handled, else use <nowiki>|</nowiki> and | it's | OK.
Fourth line, multiple spaces preserved unlike in HTML and wikitext.
Fifth line, following the previous one.
Last line preceded by two blank lines in markup and in display.
See also
#REDIRECT Template:Category link without namespace
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
|
---|
|
Template | Example output | Use |
---|
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| Important! | To indicate <strong> importance, seriousness, or urgency instead of just simple typographical boldfacing |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| "Never use ..." | Same as {{strong}} but in red |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| "Only use ..." | Same as {{strong}} but in green |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| "An emphatic phrase" | To indicate <em> stress emphasis (not just purely typographical italicization like for book titles or foreign terms) |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| 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 |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| Template:Var serif | (see {{var}} above) |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| {{DEFAULTSORT:Y, X}} | To display wikicode variables and magic words as they would appear in code |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| |year=2008 | To display template parameters with or without values |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| {{{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 |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
|
- REDIRECT Template:Template journal parameter
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| To display template parameters with colors (as they would appear in the {{tj}} and {{tji}} templates) |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| Template:Pvalue | 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. |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
etc. | {{Template|1|2|...|10}} | To display a template call (with or without parameters and values) as code |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| Page Template:Template journal inline/styles.css has no content.{{hatnoteLua error: expandTemplate: template "Template journal inline/arg" does not exist.}} | 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 |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| "The <img>...</img> tags ..." | To render HTML elements ("tags") in prose |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
/
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| "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 |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| "FORTH has keyword Template:PreCode." | Like
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
, 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> |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| [this is a block template] | ( or {{sxhl}} ) Wrapper for <syntaxhighlight>...</syntaxhighlight> , but will wrap overflowing text |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| "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 (<Template:Dcr> ). |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| [this is a block template] | For larger blocks of source code and other pre-formatted text |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| [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 |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| [this is a block template] | For block quotations (only – never for non-quotations) |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| [this is a block template] | For indented blocks of material; visually identical to {{quote}} but without quote markup |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| user input | To indicate user input |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| Ctrl+x | To indicate specific-keystroke input, including combinations |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| Template:Key top | Similar; includes more symbols, but does not directly support combinations |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| Don't save | To indicate a button in a user interface |
- REDIRECT Template:Template link with bold
|
This page is a redirect. The following categories are used to track and monitor this redirect:
Error: missing redirect parameter (help).
When appropriate, protection levels are automatically sensed, described and categorized. |
| example output | To indicate sample or example output |
|
|