Template:Tlc/doc

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 template.

It works similarly to and, but doesn'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  thereafter.

Basic operation
Here is how this template looks. Code is to the left; actual rendering to the right:



Functional details

 * This template takes another template-name and some associated pipe-tricked (numbered) parameters (or 'pass parameters'), and displays them as an 'example demonstration' of how the template-name template could be coded, literally. Its primary use is in instruction and documentation.
 * Specifics here???
 * Features of :
 * It shows a template name and up to eight parameters.
 * It also shows empty parameters. (See examples hereafter.)
 * It prevents line wraps in their output.

Usage
→

Examples
Note: Wikitables make the  tags transparent, unfortunately, so the " " is missing in these examples.

An alternative to using constructs such as  to prevent characters from getting interpreted syntactically is to use , which will prevent all characters from being interpreted. For example, in place of you can use Both render as

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 .

Here is the code to emulate using :

TemplateData
{	"description": "Template link code", "format": "inline", "params": { "1": {			"label": "Template", "description": "Linked template name", "required": true, "type": "wiki-template-name" },		"2": {			"label": "Parameter 1", "description": "First parameter value", "type": "string" },		"3": {			"label": "Parameter 2", "description": "Second parameter value", "type": "string" },		"4": {			"label": "Parameter 3", "description": "Third parameter value", "type": "string" },		"5": {			"label": "Parameter 4", "description": "Fourth parameter value", "type": "string" },		"6": {			"label": "Parameter 5", "description": "Fifth parameter value", "type": "string" },		"7": {			"label": "Parameter 6", "description": "Sixth parameter value", "type": "string" },		"8": {			"label": "Parameter 7", "description": "Seventh parameter value", "type": "string" },		"9": {			"label": "Parameter 8", "description": "Eight parameter value", "type": "string" }	} }