Template:Pre

Sample text

Template documentation

This documentation is  transcluded from Template:Pre/doc. (Edit | history)
Note to editors: Please don't categorize this template by editing it directly. Instead, place the category in its documentation page, in its "includeonly" section.

This template implements a version of the functionality provided by the  HTML <pre> tag.

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

Usage

This template supports two parameters

|width = The width of the pre "box"
|space = The way white space is handled in the pre "box"

{{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 <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}}
• <syntaxhighlight>
•  <pre>