साचा:Custom rule/doc

This is a documentation subpage for साचा:Custom rule.
It contains usage information, categories and other content that is not part of the original साचा page.

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.

Shorthand	Identifier	Widths available
`sp`	Span	5, 10, 20, 40, 50, 100
`atl`, `atr`	Arrow Thin (Left, Right)	10
`tl`	Tear Left	20, 40
`tr`	Tear Right	20, 40
`str`	Star	6, 10
`w`	Wave	40
`s`	Square	10
`d`	Diamond	4, 6, 10
`do`	Diamond open	7
`c`	Circle	6
`co`	Circle open	6, 10, 20
`r`	Rectangle	15
`crt, crr, crb, crl`	Crescent	10
`el`	Ellipse	15
`col`	Colon	4, 6
`fl, fr`	Flare (Left, Right)	12, 40
`fc`	Flare Centre	14, 22, 140
`cll, clr`	Curl (Left,Right)	10
`fy1`	Fancy1	40
`fy2`	Fancy2	100
`fy3`	Fancy3	40

If an an identifier is not available for a segment you want, add it to {{custom rule segment}}, 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.

Examples

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

{{custom rule|c|6|sp|40|do|7|fy1|40|do|7|sp|40|c|6}}

{{custom rule|clr|10|sp|40|fy2|100|sp|40|cll|10}}

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 left 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 template that grabs the image segments, {{Custom rule segment}}. Instructions on modifying that template can be found on the documentation there.

Adding more segments

For complex rules, more segments can be added. Edit this template and paste in line in the format:

</noinclude>{{#if:{{{17|}}}|{{!!}}{{Custom rule segment|{{{17}}}|{{{18}}}}}}}<noinclude>

Make sure the numbers are continuous through the template, and that you match the first parameter of this line to the second one, otherwise the template will not render reliably.

Usage

Examples

Adding components

Adding new feature types

Adding more segments

See also