Template:Clade example/doc: Difference between revisions
m (syntaxhighlight lang="wikitext") |
m (1 revision imported) |
(No difference)
|
Latest revision as of 00:25, 5 December 2023
This is a documentation subpage for Template:Clade example. It contains usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
Script error: No such module "Clade/example".
This template is designed to aid writing documentation of the {{clade}} by showing examples of code and the executed output, with option description and comment. It creates a table with four columns:
- a description of what the example in the row shows
- the code wrapped in <pre> tags,
- the executed code, and
- a comment on the example
Parameters
{{Clade example |align=right
|code= |output=
|code1=<pre>{{clade
|label1=label
|1={{clade
|1=leaf1
|2=leaf2
}}
}}</pre>
|output1={{clade
|label1=label
|1={{clade
|1=leaf1
|2=leaf2
}} }} }}
Script error: No such module "Clade/example".
Selecting columns. Columns may be omitted optionally. The columns to be shown are indicated by the following four parameters.
|description=
indicates that the description column should be shown. If used with a value it will set the header (default: Description).|code=
indicates that the code column should be shown. A value will be used as the header (default: Code).|output=
indicates that the output column should be shown. A value will be used as the header (default: Output).|comment=
indicates that the comment column should be shown. A value will be used as the header (default: Commment).
Omitting the parameter omits the column. For instance, just using |code=
and |output=
just shows the code and output (as shown on the right).
Content of rows. The content of the rows is used using the parameters with a numerical suffix indicating the row number:
|description1=
contains text describing the example in the first row. Similarly for |description2= ... |descriptionN.|code1=
contains the clade code for the first row wrapped <pre> or <nowiki> tags.|output1=
contains the transcluded output of the clade code. This parameter is not necessary if the|code1=
is wrapped in <nowiki> tags, when the|code1=
content will be used to render the output.|comment1=
contains a comment
Other options:
|align=
left | right | center
Examples
The following table uses {{clade example}} to give some example uses of the clade template system for building cladograms. use edit mode to see how it is used.
Script error: No such module "Clade/example".