Template:CL
{{{1}}}
|
Purpose
Create a code line which can be indented with the usual : indentation marker. Normally, a preformatted text block can be inserted with an additional space in the beginning, e.g.
MY_SPECIAL_TAG = A B C
will print as:
MY_SPECIAL_TAG = A B C
However, this syntax does not allow indenting, e.g., in lists. The CL (as in Code Line) template allows the box to be indented any level. At the same time usage of nested templates, e.g., using Template:TAG inside works (does not work with :<pre>...</pre>.
| Mind: This template is intended for a single line only! The For multi-line code blocks use Template:CB instead, however, this does not support nested templates. |
Parameters
{{CL|<content>|<<indent>>|<<padding>>}}
content: The content of the code line.indent: (optional) Allows to indent the whole box with regular colon sign. Use multiple ":" signs to get any level of indentation. Can be left empty if no indentation is needed butpaddingis required. Any other character than ":" may produce unexpected results!padding: (optional) Specifies the padding of the code box, the default is1em.
Examples
Without optional arguments the following example
{{CL|MY_SPECIAL_TAG {{=}} A B C}}
gives:
MY_SPECIAL_TAG = A B C
|
This should be very close to the regular preformatted text boxes we can obtain via MediaWiki syntax. Here are two examples for indentation levels:
{{CL|MY_SPECIAL_TAG {{=}} A B C|:}}
{{CL|MY_SPECIAL_TAG {{=}} A B C|::}}
results in:
- MY_SPECIAL_TAG = A B C
- MY_SPECIAL_TAG = A B C
Note that the boxes are correctly indented one and two levels. The padding can be reduced with the optional argument, e.g.:
{{CL|MY_SPECIAL_TAG {{=}} A B C|:|0.5em}}
{{CL|MY_SPECIAL_TAG {{=}} A B C|::|0.5em}}
gives this:
- MY_SPECIAL_TAG = A B C
- MY_SPECIAL_TAG = A B C
Finally, the padding can also be specified without any indentation:
{{CL|MY_SPECIAL_TAG {{=}} A B C||0.5em}}
shows as:
MY_SPECIAL_TAG = A B C
|
Problems and workarounds
The content cannot contain the "=" or "|" character because this has a special meaning for named template parameters. Therefore, we have to use the {{=}} and {{!}} template, respectively.