Template:Pre/doc: Difference between revisions
>Rusty.perrin (→Using wikitext {{anchor|wikitext}}: Removed links to dn template) |
m (1 revision imported) |
||
(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 --> | ||
{{ | This template implements a version of the functionality provided by the [[HTML]] {{tag|pre|o}} tag. | ||
===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> | |||
===Usage=== | |||
This template supports two parameters | |||
{{para|width}} The width of the pre "box" <br> | |||
{{para|space}} The way white space is handled in the pre "box" | |||
{{markup | |||
{{ | |<nowiki>{{Pre| | ||
This Pre-format | |||
can look | |||
like this. | |||
}}</nowiki> | |||
|{{Pre| | |||
This Pre-format | |||
can look | |||
like this. | |||
}} | |||
}} | |||
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 {{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 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. | |||
{{ | |||
===Example=== | |||
'''Markup''' | |||
< | <syntaxhighlight lang="wikitext"> | ||
{{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. | |||
</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> |
Latest revision as of 07:59, 13 September 2024
This is a documentation subpage for Template:Pre
(see that page for the template itself). It contains usage information, categories, and other content that is not part of the original template page. |
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
This template implements a version of the functionality provided by the HTML <pre> tag.
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] |
[rendering] |
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
- {{monodiv}}, a template with similar functionality but without border.
- {{tag}}
- {{code}}
<syntaxhighlight>
<pre>
<code>
|