Template:Pre/doc: Difference between revisions

From Saintapedia
Jump to navigation Jump to search
>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 -->


{{tl|{{PAGENAME}}}} uses {{code|&lt;pre&gt;}} 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 &lt;pre&gt; tags, it will be displayed correctly regardless of how the user's Powerpedia renders &lt;pre&gt; 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 &lt;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>), &lt;nowiki> tags must be used in the form:
can look


{{code|<nowiki>{{Pre|&lt;nowiki>Your [[text]], which ''might'' include {{tl|templates}}.<noinclude>[[Category:Examples]]</noinclude>&lt;/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>

Latest revision as of 07:59, 13 September 2024

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.

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

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