Template:Nowrap/doc: Difference between revisions
More actions
m use {{TemplateBox}} |
Use main {{TemplateBox}} |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> | |||
{{TemplateBox | {{TemplateBox | ||
|1 = 1 | |1 = 1 | ||
| Line 4: | Line 5: | ||
|1label = text | |1label = text | ||
|1aliases = <!-- List of aliases, separated by / (a slash) --> | |1aliases = <!-- List of aliases, separated by / (a slash) --> | ||
|1type = | |1type = line | ||
|1def = <!-- default value for the parameter --> | |1def = <!-- default value for the parameter --> | ||
|1stat = required | |1stat = required | ||
| name = nowrap{{\sandbox}} | |||
|desc = | | mbox = | ||
{{Sandbox other|{{Uses TemplateStyles|Template:Nowrap/styles.css}}}} | |||
|desc = This template makes sure that text passed to it is not broken, even if it happens to be at the end of the line, but rather the whole text is moved to the next line. If the text is longer than a whole line (which can happen on narrow screens!), the reader needs to scroll horizontally to read the whole text, so it should be used only with short passages (a measurement with unit, punctuation preceded by space, an icon and the corresponding few words etc.). | |||
|namespace = all | |namespace = all | ||
|usergroup = all | |usergroup = all | ||
|usage-notes = ;Handling interpreted characters | |usage-notes = ;Handling interpreted characters | ||
*For text that includes an equals sign (=), precede the text with <code>1=</code>. For example, | *For text that includes an equals sign (=), precede the text with <code>1=</code>. For example, | ||
| Line 21: | Line 24: | ||
*:produces {{!}}2{{!}} < 3. | *:produces {{!}}2{{!}} < 3. | ||
|type = | |type = | ||
| example = {{#tag:nowiki|1={{lorem}}}} | |||
| example-value = <div style="overflow:auto">{{nowrap{{\sandbox}}|1={{lorem}}}}</div> | |||
|i18n-method = - | |i18n-method = - | ||
|i18n-desc = | |i18n-desc = | ||
| Line 33: | Line 36: | ||
|relieson = | |relieson = | ||
|mustbesubst = | |mustbesubst = | ||
|useTemplateData = | |useTemplateData = only | ||
}}<includeonly> | }} | ||
<!--Categories--> | <includeonly>{{Sandbox other|| | ||
<!-- Categories below this line; interwikis at Wikidata --> | |||
[[Category:Formatting templates|{{PAGENAME}}]] | [[Category:Formatting templates|{{PAGENAME}}]] | ||
</includeonly> | }}</includeonly> | ||
Latest revision as of 20:54, 24 November 2024
| This template uses TemplateStyles: |
This template makes sure that text passed to it is not broken, even if it happens to be at the end of the line, but rather the whole text is moved to the next line. If the text is longer than a whole line (which can happen on narrow screens!), the reader needs to scroll horizontally to read the whole text, so it should be used only with short passages (a measurement with unit, punctuation preceded by space, an icon and the corresponding few words etc.).
Usage
{{nowrap |1= }}
- Handling interpreted characters
- For text that includes an equals sign (=), precede the text with
1=. For example,{{nowrap|1=2 + 2 = 4}}- produces 2 + 2 = 4.
- For text that includes a vertical bar (|), escape the bar(s) with
|or{{!}}. For example,{{nowrap|1=|2| < 3}}- produces |2| < 3.
Template parameters
- TemplateData
TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.
Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either useTemplateData=1 or useTemplateData=only on the /doc subpage and transcluding it with {{Documentation}} into the template. <nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.
Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw <templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.
Wikipedia's help about TemplateData • Commons-specific information
This template makes sure that text passed to it is not broken, even if it happens to be at the end of the line, but rather the whole text is moved to the next line. If the text is longer than a whole line (which can happen on narrow screens!), the reader needs to scroll horizontally to read the whole text, so it should be used only with short passages (a measurement with unit, punctuation preceded by space, an icon and the corresponding few words etc.).
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| text | 1 | Your text to be shown | Line | required |
Additional information
The template is intended to be used in the following namespaces: all namespaces
The template is intended to be used by the following user groups: all users
Example
{{nowrap|1=[[Lorem ipsum]] dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.}}
renders as:
Localization
This template is not intended to be localized.