ಟೆಂಪ್ಲೇಟು:Custom rule/doc ಇಗೆ ಮೂಲವನ್ನು ವಿಕ್ಷಿಸಿ

{{documentation subpage}}{{template shortcut|cr}}
{{templatestyles|Template:Custom rule/styles.css}}
{{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.

{| style="text-align:center; margin:auto;"
|+Stylistic options for Template:Custom rule
!scope="col"|Shorthand
!scope="col"|Identifier
!scope="col"|Example
!scope="col"|Widths available
|-
|<code>sp</code>||Span||[[File:Rule Segment - Span - 10px.svg]]||5, 10, 20, 40, 50, 100
|-
|<code>al</code>, <code>ar</code>||Arrow (Left, Right)||[[File:Rule Segment - Arrow Left - 12px.svg]] [[File:Rule Segment - Arrow Right - 12px.svg]]||12
|-
|<code>atl</code>, <code>atr</code>||Arrow Thin (Left, Right)||[[File:Rule Segment - Arrow Thin Left - 10px.svg]] [[File:Rule Segment - Arrow Thin Right - 10px.svg]]||10
|-
|<code>ac</code>||Arrow Cross||[[File:Rule Segment - Arrow Cross - 18px.svg]]||18
|-
|<code>tl</code>||Tear Left||[[File:Rule Segment - Tear Left - 20px.svg]]||20, 28, 40, 57
|-
|<code>tr</code>||Tear Right||[[File:Rule Segment - Tear Right - 20px.svg]]||20, 28, 40, 57
|-
|<code>str</code>||Star||[[File:Rule Segment - Star - 10px.svg]]||6, 10
|-
|<code>w</code>||Wave||[[File:Rule Segment - Wave - 40px.svg]]||1–40, 160
|-
|<code>s</code>||Square||[[File:Rule Segment - Square - 10px.svg]]||5, 10
|-
|<code>so</code>||Square open||[[File:Rule Segment - Square open - 10px.svg]]||5, 10
|-
|<code>d</code>||Diamond||[[File:Rule Segment - Diamond - 10px.svg]]||4, 6, 10
|-
|<code>do</code>||Diamond open||[[File:Rule Segment - Diamond open - 7px.svg]]||7
|-
|<code>lz</code>||Lozenge||[[File:Rule Segment - Lozenge - 60px.svg]]||20, 40, 60, 140
|-
|<code>lzt</code>||Lozenge thin||[[File:Rule Segment - Lozenge 5px - 60px.svg]]||20, 40, 60, 100, 200, 250, 300, 350, 400
|-
|<code>c</code>||Circle||[[File:Rule Segment - Circle - 6px.svg]]||6, 10
|-
|<code>co</code>||Circle open||[[File:Rule Segment - Circle open - 6px.svg]]||6, 10, 20
|-
|<code>qc</code>||Quatrefoil in circle||[[File:Rule Segment - Quatrefoil in circle - 12px.svg]]||12, 25
|-
|<code>r</code>||Rectangle||[[File:Rule Segment - Rectangle - 15px.svg]]||15
|-
|<code>crt</code>, <code>crr</code>, <code>crb</code>, <code>crl</code>||Crescent (top, right, bottom, left)||[[File:Rule Segment - Crescent top - 10px.svg]] [[File:Rule Segment - Crescent right - 10px.svg]] [[File:Rule Segment - Crescent bottom - 10px.svg]] [[File:Rule Segment - Crescent left - 10px.svg]]||10
|-
|<code>bcrt</code>, <code>bcrr</code>, <code>bcrb</code>, <code>bcrl</code>||Black Crescent (top, right, bottom, left)||[[File:Rule Segment - Black Crescent top - 10px.svg]] [[File:Rule Segment - Black Crescent right - 10px.svg]] [[File:Rule Segment - Black Crescent bottom - 10px.svg]] [[File:Rule Segment - Black Crescent left - 10px.svg]]||10
|-
|<code>el</code>||Ellipse||[[File:Rule Segment - Ellipse - 15px.svg]]||15
|-
|<code>elo</code>||Ellipse open||[[File:Rule Segment - Ellipse open - 15px.svg]]||15
|-
|<code>col</code>||Colon||[[File:Rule Segment - Colon - 6px.svg]]||4, 6
|-
|<code>fl</code>, <code>fr</code>||Flare (Left, Right)||[[File:Rule Segment - Flare Left - 12px.svg]] [[File:Rule Segment - Flare Right - 12px.svg]]||11, 12, 15, 30, 40
|-
|<code>fc</code>||Flare Centre||[[File:Rule Segment - Flare Centre - 60px.svg]]||14, 22, 40, 60, 80, 100, 140
|-
|<code>fct</code>||Flare Centre thin||[[File:Rule Segment - Flare Centre 5px - 60px.svg]]||20, 40, 60, 80, 100, 120, 140
|-
|<code>fcw</code>||Flare Centre White||[[File:Rule Segment - Flare Centre White - 40px.svg]]||22, 40
|-
|<code>cll</code>, <code>clr</code>||Curl (Left, Right)||[[File:Rule Segment - Curl Left - 10px.svg]] [[File:Rule Segment - Curl Right - 10px.svg]]||10
|-
|<code>ltr, rtr</code> || Triangle (Left, Right)|| [[File:Rule Segment - Lefttriangle - 10px.svg]] [[File:Rule Segment - Righttriangle - 10px.svg]]||5, 10
|-
|<code>lo</code>||Loops||[[File:Rule Segment - loops - 141px.svg]]||141, 283
|-
|<code>fy1</code>||Fancy1||[[File:Rule Segment - Fancy1 - 40px.svg]]||40
|-
|<code>fy2</code>||Fancy2||[[File:Rule Segment - Fancy2 - 100px.svg]]||100
|-
|<code>fy3</code>||Fancy3||[[File:Rule Segment - Fancy3 - 40px.svg]]||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 <nowiki>{{custom rule|sp|100}} = {{custom rule|Span|100}}</nowiki>.

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 [[:c:Category:Rule segments|Rule segments category]] at Commons. If you add your own segments, add them to this category.

==Example==

{{doc example|
<syntaxhighlight lang="wikitext">
text
{{Custom rule|sp|100|d|6|sp|10|d|10|sp|10|d|6|sp|100}}
text
</syntaxhighlight>
text
{{Custom rule|sp|100|d|6|sp|10|d|10|sp|10|d|6|sp|100}}
text
}}

{{doc example|
<syntaxhighlight lang="wikitext">
text
{{Custom rule|sp|100|d|6|sp|10|d|10|sp|10|d|6|sp|100|inline=true}}
text
</syntaxhighlight>
text
{{Custom rule|sp|100|d|6|sp|10|d|10|sp|10|d|6|sp|100|inline=true}}
text
}}

==Adding components==

===Adding new feature types===
[[File:Rule Segment - Circle - 6px.svg|thumb|200px|Notice the "flange" for matching to the background rule.]]
It is easy to add images to the set. In order to be found, the filename '''must''' be in the form "{{code|Rule Segment - [Identifier] - [Width]px.svg}}. Example: {{code|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.

==See also==

* [[Template:rule]] Simple rule of variable width - use this if you just want a line
* [[Template:***]] for spaced centered characters, typically asterisks
* [[Template:PSM rule]] specific use of this template for use in [[Popular Science Monthly]] articles.
* [[Template:separator]] for a row of dots


<includeonly>
[[Category:Formatting templates]]
</includeonly>