Template:Dolorem ipsum/doc

From Wikipedia, the free encyclopedia
Jump to navigation Jump to search

This template outputs the "lorem ipsum" filler text, except instead of nonsense it is the actual text of De finibus bonorum et malorum. It takes four parameters: the number of paragraphs to generate, paragraph prefix, paragraph suffix, and an option to link lorem ipsum from "Sed ut perspiciatis". There are 20 distinct paragraphs.

{{Dolorem ipsum}} – one paragraph
{{Dolorem ipsum|3|*}} – three paragraphs as bullet list
{{Dolorem ipsum|10}} – ten paragraphs

Parameters

[edit source]

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 |4=yes, causes the first two words of paragraph 1 to be linked to Lorem ipsum. (default: 'no'. Alias: 'link'.)
  • join – if set to |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 |cat=no (default: 'yes')

Notes about font styling

[edit source]

For most parameter combinations, this template produces block-level Html output, and for those cases, font styling using wiki markup such as '''bold''', ''italic'' or <small>...</small> may not produce the desired results. (This is true of all templates that generate Html block elements.) If font styling is required, you can use block level alternatives, such as these:

  • for smaller font, you may use ⟶ {{small div | {{Dolorem ipsum|3}} }}
  • for bold ⟶ {{bold div | {{Dolorem ipsum|3}} }}
  • for italics ⟶ {{italic div | {{Dolorem ipsum|3}} }}

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 {{lorem ipsum span}} instead, which generates an 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 |join=yes is in use. See #Running paragraphs together.

Examples

[edit source]

Linking "lorem ipsum"

[edit source]

To link the incipit (the first three words of paragraph one, i.e. Sed ut perspiciatis) to the Wikipedia article Lorem ipsum, either use param |link=yes, or place yes in the fourth positional parameter. {{Dolorem ipsum|1|#|link=yes}} generates:

  1. Sed ut perspiciatis, unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam eaque ipsa, quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt, explicabo. Nemo enim ipsam voluptatem, quia voluptas sit, aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos, qui ratione voluptatem sequi nesciunt, neque porro quisquam est, qui dolorem ipsum, quia dolor sit amet consectetur adipisci velit.


Prefix and suffix

[edit source]

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 :* ", and the suffix is ":

{{Dolorem ipsum|2|:* "|"}} generates:

  • "Sed ut perspiciatis, unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam eaque ipsa, quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt, explicabo. Nemo enim ipsam voluptatem, quia voluptas sit, aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos, qui ratione voluptatem sequi nesciunt, neque porro quisquam est, qui dolorem ipsum, quia dolor sit amet consectetur adipisci velit."
  • "Sed quia non numquam eius modi tempora incidunt, ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit, qui in ea voluptate velit esse, quam nihil molestiae consequatur, vel illum, qui dolorem eum fugiat, quo voluptas nulla pariatur?"

Note that if param |join=yes is in effect, the wiki markup behavior of prefix metacharacters #, *, and : is only apparent at the beginning of the output, because there is only one, long paragraph. For example, if prefix is # with |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

[edit source]

Note that whitespace is important in the second and third parameters. In the example {{Dolorem ipsum|1| * " | " }} the prefix is  * "  and the suffix is  " . 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:

  • "Sed ut perspiciatis, unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam eaque ipsa, quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt, explicabo. Nemo enim ipsam voluptatem, quia voluptas sit, aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos, qui ratione voluptatem sequi nesciunt, neque porro quisquam est, qui dolorem ipsum, quia dolor sit amet consectetur adipisci velit."

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

Running paragraphs together

[edit source]

All requested paragraphs of text can be joined together in one long paragraph using the |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: {{Dolorem ipsum|2|link=yes|join=yes}} will produce:

Sed ut perspiciatis, unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam eaque ipsa, quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt, explicabo. Nemo enim ipsam voluptatem, quia voluptas sit, aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos, qui ratione voluptatem sequi nesciunt, neque porro quisquam est, qui dolorem ipsum, quia dolor sit amet consectetur adipisci velit. Sed quia non numquam eius modi tempora incidunt, ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit, qui in ea voluptate velit esse, quam nihil molestiae consequatur, vel illum, qui dolorem eum fugiat, quo voluptas nulla pariatur?

Since joined text produces a single string without line breaks and without block-level tags such as <p>, if no prefix metacharacters are in use, the result of transcluding the template with |join=yes is an inline-level HTML element, meaning that standard wiki markup for font styling (like bold, italic, or font-size such as '<small>') may be used in this case. See #Notes about font styling for details.

Limiting character count to less than one paragraph

[edit source]

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

{{Str left|{{Lorem ipsum span}}|123}} will result in:

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Full text

[edit source]

{{Dolorem ipsum|20}} will produce:

See also

[edit source]

Template data

[edit source]
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Dolorem ipsum in articles based on its TemplateData.

TemplateData for Dolorem ipsum

This template generates a filler text for test purposes. Text generated is the original Cicero passage from which the well-known "Lorem ipsum" text was created, which is an excerpt from De finibus bonorum et malorum. It has 20 distinct paragraphs.

Template parameters

ParameterDescriptionTypeStatus
Number of paragraphs1

Number of paragraphs to be shown. A number from 1 to 20 is acceptable.

Default
1
Numbersuggested
Paragraph prefix2

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.

Unbalanced wikitextoptional
Paragraph suffix3

Wikicode or text to suffix to each paragraph. For example, specifying ) causes each paragraph to end with a closing parenthesis.

Unbalanced wikitextoptional
Link to [[Lorem ipsum]]?4 link

Setting this parameter to "yes" causes a link to the "Lorem ipsum" article to appear.

Booleanoptional
Join all output into one paragraph?join

Setting this parameter to "yes" causes all output to go into one paragraph.

Default
no
Booleanoptional
Add to category "Wikipedia articles containing placeholders"?cat

Setting this parameter to "no" prevents the page from being added to [[Category:Wikipedia articles containing placeholders]].

Default
yes
Booleanoptional