Admin: 1 revision imported

2021-10-25T20:08:28Z

1 revision imported

← Older revision	Revision as of 20:08, 25 October 2021
(No difference)

wikipedia>Mathglot: /* Prefix and suffix whitespace */ Use pval.

2021-08-08T10:33:59Z

Prefix and suffix whitespace: Use pval.

New page

{{documentation subpage}}

{{template shortcut|Ipsum|Lipsum|Lorem|Loremipsum}}
This template outputs the "[[lorem ipsum]]" filler text. It takes four parameters: the number of paragraphs to generate, paragraph prefix, paragraph suffix, and an option to link lorem ipsum. There are 10 distinct paragraphs, but it can produce up to 20.

==Usage==
{{tlc|Lorem ipsum}} – one paragraph 
{{tlc|Lorem ipsum|3|*}} – three paragraphs as bullet list 
{{tlc|Lorem ipsum|10}} – ten paragraphs

==Parameters==

There are four positional parameters and two named parameters, all optional:

* 1 – Number of paragraphs to display (1..20; default: 1)
* 2 – prefix character(s) to emit before each paragraph (such as a quotation mark, an asterisk for bullet list, etc.; default: none)
* 3 – suffix (such as ending quote; default: none)
* 4 – if set to {{para|4|yes}}, causes the first two words of paragraph 1 to be linked to [[Lorem ipsum]]. (default: 'no'. Alias: 'link'.)
* join – if set to {{para|join|yes}}, causes all output to be emitted as a single paragraph (default: 'no'). Use of 'join' alters how prefix is handled.
* cat – Adds article to [[:Category:Wikipedia articles containing placeholders]], unless {{para|cat|no}} (default: 'yes')

==Notes about font styling==

For most parameter combinations, this template produces block-level Html output, and for those cases, font styling using [[Help:Wikitext#Format|wiki markup]] such as <code><nowiki>'''bold'''</nowiki></code>, <code><nowiki>''italic''</nowiki></code> or {{nowrap|<code><nowiki>...</nowiki></code>}} may not produce the desired results. (This is true of all templates that generate [[HTML_element#Block_elements|Html block elements]].) If font styling is required, you can use block level alternatives, such as these:
* for smaller font, you may use ⟶ <code><nowiki>{{small div | {{Lorem ipsum|3}} }}</nowiki></code>
* for bold ⟶ <code><nowiki>{{bold div | {{Lorem ipsum|3}} }}</nowiki></code>
* for italics ⟶ <code><nowiki>{{italic div | {{Lorem ipsum|3}} }}</nowiki></code>

The latter two have a parameter to make the text smaller at the same time. Alternatively, if you only need one paragraph of lorem output, consider using {{tl|lorem ipsum span}} instead, which generates an [[HTML element#Inline elements|Html inline-level element]] and so may be used with all the normal in-line wiki markup to alter the font style.

Exceptionally, standard wiki markup may be used when param {{para|join|yes}} is in use. See [[#Running paragraphs together]].

==Examples==

===Linking "lorem ipsum"===
To link the [[incipit]] (the first two words of paragraph one, i.e. ''Lorem ipsum'') to the Wikipedia article [[Lorem ipsum]], either use param {{para|link|yes}}, or place <code>yes</code> in the fourth positional parameter. {{tlc|Lorem ipsum|1|#|link{{=}}yes}} generates:
{{Lorem ipsum|1|#|link=yes}}

===Prefix and suffix===

Param 2 is the prefix, and 3 is the suffix added to the beginning and end of each paragraph. In the example below, the prefix is {{pval|:* "}}, and the suffix is {{pval|"}}:

<code><nowiki>{{Lorem ipsum|2|:* "|"}}</nowiki></code> generates:
{{Lorem ipsum|2|:* "|"}}
Note that if param {{para|join|yes}} is in effect, the wiki markup behavior of prefix metacharacters <code>#</code>, <code>*</code>, and <code>:</code> is only apparent at the beginning of the output, because there is only one, long paragraph. For example, if prefix is {{pval|#}} with {{para|join|yes}}, the output consists of one long paragraph, numbered "1". The prefix character(s) will still be placed in the content where paragraph breaks would normally occur in non-joined results, but they appear as normal characters (hash, asterisk, colon) and are not interpreted as wiki markup.

===Prefix and suffix whitespace===
Note that whitespace is important in the second and third parameters. In the example <code><nowiki>{{Lorem ipsum|1| * " | " }}</nowiki></code> the prefix is {{pval| * " }} and the suffix is {{pval| " }}. The space in front of the asterisk prevents it from being interpreted as a bullet metacharacter, and it is seen as a plain asterisk. This results in the following:
{{Lorem ipsum|1| * " | " }}

In this example, the prefix is {{pval| * " }}; the leading white space before the asterisk forces the asterisk to be read as plain text, not a bullet metacharacter.

===Running paragraphs together===
All requested paragraphs of text can be joined together in one long paragraph using the {{para|join|yes}} param. Use of this parameter alters the behavior of param 2 (prefix): see [[#Prefix and suffix]] for details. The link param (4) behaves as usual: {{nowrap|{{tlc|Lorem ipsum|2|link{{=}}yes|join{{=}}yes}}}} will produce:

:{{Lorem ipsum|2|link=yes|join=yes}}

Since joined text produces a single string without line breaks and without block-level tags such as , if no prefix metacharacters are in use, the result of transcluding the template with {{para|join|yes}} is an [[HTML element#Inline elements|inline-level Html element]], meaning that standard [[Help:Wikitext#Format|wiki markup]] for font styling (like bold, italic, or font-size such as '') may be used in this case. See [[#Notes about font styling]] for details.

===Limiting character count to less than one paragraph===

If fewer than 446 characters are desired, use {{tl|lorem ipsum span}} and truncate to the desired size with {{nowrap|[[Template:Str left]]}}:

<code><nowiki>{{Str left|{{Lorem ipsum span}}|123}}</nowiki></code> will result in:

{{Str left|{{Lorem ipsum span}}|123}}

==Full text==
<code><nowiki>{{Lorem ipsum|10}}</nowiki></code> will produce:

{{collapse top}}
{{Lorem ipsum|10}}
{{collapse bottom}}

==See also==
* {{tl|lorem ipsum span}}

==Template data==
{{TemplateData header}}
<templatedata>
{
"description": "This template generates a filler text for test purposes. Text generated is the well-known \"Lorem ipsum\" passage, which is gibberish that somewhat resembles Latin. There are 10 distinct paragraphs, but it can produce up to 20.",
"params": {
"1": {
"label": "Number of paragraphs",
"description": "Number of paragraphs to be shown. A number from 1 to 20 is acceptable.",
"type": "number",
"suggested": true,
"default": "1"
},
"2": {
"label": "Paragraph prefix",
"description": "Wikicode or text to prefix to each paragraph. For example, specifying * ( causes each paragraph to become a bullet list and start with an opening parenthesis.",
"type": "unbalanced-wikitext"
},
"3": {
"label": "Paragraph suffix",
"description": "Wikicode or text to suffix to each paragraph. For example, specifying ) causes each paragraph to end with a closing parenthesis.",
"type": "unbalanced-wikitext"
},
"4": {
"aliases": [
"link"
],
"label": "Link to [[Lorem ipsum]]?",
"description": "Setting this parameter to \"yes\" causes a link to the \"Lorem ipsum\" article to appear.",
"type": "boolean"
},
"join": {
"label": "Join all output into one paragraph?",
"description": "Setting this parameter to \"yes\" causes all output to go into one paragraph.",
"type": "boolean",
"default": "no"
},
"cat": {
"label": "Add to category \"Wikipedia articles containing placeholders\"?",
"description": "Setting this parameter to \"no\" prevents the page from being added to [[Category:Wikipedia articles containing placeholders]].",
"type": "boolean",
"default": "yes"
}
}
}
</templatedata>

<includeonly>{{Sandbox other||

{{DEFAULTSORT:Lorem ipsum}}
[[Category:Placeholder templates]]

}}</includeonly>

Template:Lorem ipsum/doc - Revision history

Admin: 1 revision imported

wikipedia>Mathglot: /* Prefix and suffix whitespace */ Use pval.