Template:Tlsc/doc

This is the  template.

This page also provides the full documentation for the template , which works almost exactly identically.

Purpose and naming
When a template name with braces is to be shown in documentation, the braces have to be escaped in some way so it doesn't become an actual call to the template. Instead of using  tags you can write it more simply and concisely by using the  or  templates.

These templates work similarly to and, but don't make the template name into a link. When writing documentation you might want to avoid a lot of unnecessary links, since they can decrease readability. So on the first occurrence of a template name use or, and then use  or  thereafter.

The names were based on template substitution link', despite the fact that, unlike the actual  template, these three don't include an actual link. The mnemonics for was invented after the fact, since the template creator used the single letters still available rather than the preferred  (using  ||  || Shows up to 16 parameters. The rest are dropped.
 * || || Also shows empty parameters.
 * || || Even shows empty parameters that come in the end.
 * || || The use of equals signs is a problem, but there is a fix; see next row.
 * || || Use numbered parameters to fix the problem with equals signs. Remember to start from 2, since the "name" is number 1.
 * }
 * || || The use of equals signs is a problem, but there is a fix; see next row.
 * || || Use numbered parameters to fix the problem with equals signs. Remember to start from 2, since the "name" is number 1.
 * }
 * }


 * Exceptions: If the intended template lists numerous/keyword parameters, then perhaps this template should really not be used, and just hardcode the usage with, for example:  .  If a vertical display, with parameters on their own lines, is desired, this can also be laid out manually in this manner, or more rapidly done with.

If you have equals signs in your template parameters then it probably is simpler and clearer to code it using  tags, etc. Here are the codes to emulate,  and  respectively. Code is to the left and actual rendering to the right: