Template:Custom rule/sandbox

This is the template sandbox page for Template:Custom rule (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

Shortcut: {{cr}}

This template uses TemplateStyles:

Template:Custom rule/styles.css

This template uses Lua:

Module:Custom rule

Usage

This template creates a rule made up of a number of interchangeable image segments. Each element is a pair of parameters, the first selecting the pattern, the second selecting the size, as such there will always be an even number of parameters added.

The parameters are a sequence of identifiers for the type of feature followed by that feature's width in pixels. These always form pairs of parameters. Below is a list of the features available. Update this list if you know of elements that are missing.

Stylistic options for Template:Custom rule
Shorthand	Identifier	Widths available
`sp`	Span	5, 10, 20, 40, 50, 100
`al`, `ar`	Arrow (Left, Right)	12
`atl`, `atr`	Arrow Thin (Left, Right)	10
`ac`	Arrow Cross	18
`tl`, `tr`	Tear (Left, Right)	20, 28, 40, 57
`str`	Star	6, 10
`w`	Wave	1–40, 160
`s`	Square	5, 10
`so`	Square open	5, 10
`d`	Diamond	4, 6, 10
`do`	Diamond open	7
`lz`	Lozenge	20, 40, 60, 140
`lzt`	Lozenge thin	20, 40, 60, 100, 200, 250, 300, 350, 400
`c`	Circle	6, 10
`co`	Circle open	6, 10, 20
`qc`	Quatrefoil in circle	12, 25
`r`	Rectangle	15
`crt`, `crr`, `crb`, `crl`	Crescent (top, right, bottom, left)	10
`bcrt`, `bcrr`, `bcrb`, `bcrl`	Black Crescent (top, right, bottom, left)	10
`el`	Ellipse	15
`elo`	Ellipse open	15
`col`	Colon	4, 6
`fl`, `fr`	Flare (Left, Right)	11, 12, 15, 30, 40
`fc`	Flare Centre	14, 22, 40, 60, 80, 100, 140
`fct`	Flare Centre thin	20, 40, 60, 80, 100, 120, 140
`fcw`	Flare Centre White	22, 40
`cll`, `clr`	Curl (Left, Right)	10
`ltr, rtr`	Triangle (Left, Right)	5, 10
`lo`	Loops	141, 283
`fy1`	Fancy1	40
`fy2`	Fancy2	100
`fy3`	Fancy3	40

If an an identifier is not available for a segment you want, add it to Module:Custom rule/segments, or use the plain identifier without a shorthand. Eg {{custom rule|sp|100}} = {{custom rule|Span|100}}.

The feature must be available as that specific size. If it is not, the image will not be found, and a red link will appear. You can see a full list at the Rule segments category at Commons. If you add your own segments, add them to this category.

Example

text
{{Custom rule|sp|100|d|6|sp|10|d|10|sp|10|d|6|sp|100}}
text

text

Example

text
{{Custom rule|sp|100|d|6|sp|10|d|10|sp|10|d|6|sp|100|inline=true}}
text

text text

Adding components

Adding new feature types

It is easy to add images to the set. In order to be found, the filename must be in the form "Rule Segment - [Identifier] - [Width]px.svg. Example: File:Rule Segment - Span - 10px.svg

Note that it is also required that the image meet up well at the sides. The rule is 1px wide, so the features must have a 1px edge on each side, in the exact centre (vertically) of the edge. To ensure this, run a 1px line through the feature so that it fills in the gaps. See the diagram on the right for an example of how this is done. Ensure that the line is aligned with the pixel grid (but not centred on it), otherwise it will come out blurry when rendered. To fix this, shift up or down by 0.5px. Be careful about edges of features as well, especially horizontal or vertical ones—these should be also aligned to pixel edges.

You will also need to add code to the module that grabs the image segments, Module:Custom rule/segments. Instructions on modifying that module can be found in the documentation there.