Template:Uksi/paragraph/sandbox
 | This is the template sandbox page for Template:Uksi/paragraph (diff). See also the companion subpage for test cases. |
 | This template uses block elements, e.g. See H:DIVSPAN for details. |
 | This template uses TemplateStyles: |
Helper template to construct the anchoring and alignment of "paragraphs" in UK Statutory Instruments.
UK Statutory instruments consist of "Sections" (Sometimes called Regulations) typically delinated by bold numbers. which may contain "Paragraphs" typically delinated by bracketed, numbers, which may further contain "Sub-Paragraphs" typically delinated by bracketed letters.
The UKSI template family attempts to provide a systemic way to build these types of document, with a degree of format standardisation.
The templates are in the process of being migrated to CSS. If you find a situation where the existing templates or classes do not support something please leave a note on the talk page so that the appropriate rules can be added to the relevant stylesheet.
Usage
[edit]{{uksi}}
{{uksi/paragraph|text|title|anchor|parameter|split||class}}
Uksi/paragraph
[edit]{{uksi/paragraph|title|text|anchor|split|class}}
params
[edit]- title - Title for the block (optional)
- text - Text of block concerned.
- split - Intended to mark which portion of section this is. Values : start, cont, end or none Default is none which generates the start a complete block. (optional)
- start - Marks the start of a block, causes an opening and the title to be generated if specified.
- cont - Marks the continuance of a block. text is generated, but title is omitted.
- end - Marks the end of a block , generates a closing , Other parameters ignored.
- none or default - Generates an entire block, with opening , title and closing.
- class - Used by higher level templates to define margins, indentation (optional)
- pre - Used to insert a character such as a " or ' before the numbering or 'title' of a paragraph.
- left - Used to set the left-hand margin directly (deprecated)
Notes
[edit]If you need a split between what would be two (text) paragraphs at the same level in the text as opposed to a split between "paragraphs" then use {{parabr}} to insert the gap.
Higher level Templates
[edit]These pre-process certain options such as section numbering and apply certain levels of indentation.
s1. . .s5 being the numbering shown in the Statutory Instrument concerned.
The basic types of paragraph are created using:-
- {{uksi/paragraph/1|title|text|split|s1}} - Creates a level 1 "section"
- {{uksi/paragraph/2|title|text|split|s1|s2}} - Creates a level 2 "paragraph"
- {{uksi/paragraph/3|title|text|split|s1|s2|s3}} - Creates a level 3 "sub-paragraph"
- {{uksi/paragraph/4|title|text|split|s1|s2|s3|s4}} - Creates a level 4 block
- {{uksi/paragraph/5|title|text|split|s1|s2|s3|s4|s5}} - Creates a level 5 block
More complex types are:-
- {{uksi/paragraph/1-2|title|text|split|s1|s2}} - Creates a level 1 "section" which opens immediately into a level 2 "paragraph".
- {{uksi/paragraph/2-3|title|text|split|s1|s2|s3}} - Crates a level 2 "paragraph" which opens immediately into a level 3 "sub-paragraph".