Template:Pre/doc: Difference between revisions

From HIBIKIFORUM
Jump to navigation Jump to search
(Created page with "{{Documentation subpage}} {{Uses TemplateStyles|Template:Pre/styles.css}} __NOTOC__ This template implements a version of the functionality provided by the HTML {{tag|pre|o}} tag. == Usage == This template supports two parameters * {{para|width}} The width of the pre "box" * {{para|space}} The way white space is handled in the pre "box" {| class="wikitable" |- ! Markup !! Renders As |- |<pre>{{Pre| This Pre-format can look like this. }}</pre> |{{...")
 
mNo edit summary
 
Line 127: Line 127:
<!-- Categories below this line, please -->
<!-- Categories below this line, please -->
[[Category:Templates]]
[[Category:Documentation formatting templates]]
[[Category:Documentation formatting templates]]
}}}}</includeonly>
}}}}</includeonly>

Latest revision as of 02:26, 20 August 2023

Light bulb.png }}
It contains usage information, categories and other content that is not part of the original template page.


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

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.

See also

TemplateData

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

Template parameters

ParameterDescriptionTypeStatus
Text1

The text which should be wrapped in pre tags.

Stringrequired
Stylestyle

Optional css styling applied to the pre tag

Stringoptional
Widthwidth

The width of the pre box

Stringoptional
Spacespace

The way white space is handled in the pre box

Stringoptional
Borderborder

Set to 'no' if there should be no border around the box

Stringoptional