Jump to content

Template:Spec-paragraph

From mediawiki.org

Template for styling specification paragraphs following the W3C Style guidle[1].

Template styles: Template:Spec-paragraph/styles.css

To make a new template based on {{Spec-paragraph}}, use the Spec-paragraph/subst meta template:
{{subst:Spec-paragraph/subst|TYPE|ADJECTIVE|SAMPLE}}

Usage

[edit]

Mark text as descriptive, for use in guidelines and policies.

Usage: {{Spec-paragraph|Some spec text.}}

Some spec text.

Usage with a handle that functions as an anchor: {{Spec-paragraph|handle=ex-1|Some spec text.}}

ex-1 Some spec text.

Usage with a status marker: {{Spec-paragraph|status=todo|Some spec text.}}

Some spec text.

This template can also attach a discussion to a part of a guideline:

Usage with discussion:

{{{{BASEPAGENAME}}|{{{2|SAMPLE}}}
|discussion=Some ongoing discussion.
: Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
:: At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. 
: Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. 
Some spec text.
Some ongoing discussion.
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat.


Templates

[edit]

Styled box for normative text in guidelines and policies.

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
Text1

Text to be displayed

Default
Stringsuggested
Discussiondiscussion

Any discussion to be shown below the paragraph

Default
Stringoptional
Handlehandle

A moniker that functions as an anchor

Default
Stringoptional
Statusstatus

A status marker like 'wip' or 'fixme' or 'todo'.

Default
Stringoptional
CSS Classesclass

Additional classes for the spec paragraph.

Default
Stringoptional
Collapsiblecollapsible

Whether the paragraph should have a button that allows it to be collapsed and expanded

Default
Booleanoptional