Template:Pre/sandbox
 | This is the template sandbox page for Template:Pre (diff). See also the companion subpage for test cases. |
 | This template uses TemplateStyles: |
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 |
|---|---|
{{Pre|
This Pre-format
can look
like this.
}} |
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
<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.