Fire at 23:00, 22 January 2023

2023-01-22T23:00:05Z

← Older revision		Revision as of 08:00, 23 January 2023
Line 10:		Line 10:
	\|align=right		\|align=right
	\|description=		\|description=
	\|code=		\|code=
	\|output=		\|output=
	\|comment=		\|comment=

imported>Fire: ページの作成:「{{Documentation subpage}} {{二次利…」

2021-03-17T13:15:21Z

ページの作成:「{{Documentation subpage}}  {{二次利…」

New page

{{Documentation subpage}}

{{二次利用}}
{{Uses Lua|Module:Clade/example}}

{{hatnote|Note. The original goal of this template was to make writing the documentation easier by avoiding the need to repeat the code twice, once enclosed in the pre tags and once without. Unfortunately this is not possible. Parameters are transcluded when used unless in certain tags (pre, nowiki). Unfortunately these tags are passed to the module as [https://www.mediawiki.org/wiki/Strip_marker strip markers] so it is not possible to strip the tags from a transclusion protected parameter in the Lua module.}}

{{Clade example
|align=right
|description=
|code=
|output=
|comment=
|description1=Simple demo
|code1=<pre>{{clade
|label1=label
|1={{clade
|1=leaf1
|2=leaf2
}}
}}</pre>
|output1={{clade
|label1=label
|1={{clade |1=leaf1 |2=leaf2 }}
}}
|comment1=''optional''
}}

This template is designed to aid writing documentation of the {{tl|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 <nowiki><pre></nowiki> tags,
* the executed code, and
* a comment on the example

{{clear}}{{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 }} }} }}

'''Selecting columns.''' Columns may be omitted optionally. The columns to be shown are indicated by the following four parameters.
* <code>|description=</code> indicates that the description column should be shown. If used with a value it will set the header (default: Description).
* <code>|code=</code> indicates that the code column should be shown. A value will be used as the header (default: Code).
* <code>|output=</code> indicates that the output column should be shown. A value will be used as the header (default: Output).
* <code>|comment=</code> 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>|code=</code> and <code>|output=</code> 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:
** <code>|description1=</code> contains text describing the example in the first row. Similarly for |description2= ... |descriptionN.
** <code>|code1=</code> contains the clade code for the first row wrapped <nowiki><pre></nowiki> tags.
** <code>|output1=</code> contains the transcluded output of the clade code.
** <code>|comment1=</code> contains a comment

'''Other options:'''
* <code>|align=</code> left | right | center

{{clear}}

'''A more complex example:'''

<code><nowiki>

{{Clade example
|align=left
|description=
|code=
|output=
|comment=
|description1=Simple clade element
|code1=<pre>{{clade
|label1=Label
|1={{clade
|1=Leaf A
|2=Leaf B
}}
}}</pre>
|output1={{clade
|label1=Label
|1={{clade |1=Leaf A |2=Leaf B}}
}}
|comment1=Two child elements
|description2=A more complex clade structure
|code2=<pre>{{clade
|label1=Label
|1={{clade
|1=Node A (terminal)
|label2=Node B
|sublabel2=(internal)
|2={{clade
|1=Leaf 1
|2=Leaf 2
}}
}}
}}</pre>
|output2={{clade
|label1=Label
|1={{clade
|1=Node A (terminal)
|label2=Node B
|sublabel2=(internal)
|2={{clade
|1=Leaf 1
|2=Leaf 2
}}
}}
}}
|comment2=Two levels. The second clade element is nested in the first.
|description3=description 3|code3=code 3 |output3=output 3 |comment3=comment 3
|description4=description 4|code4=code 4 |output4=output 4 |comment4=comment 4

}}

</nowiki></code>

{{Clade example
|align=left
|description=
|code=
|output=
|comment=
|description1=Simple clade element
|code1=<pre>{{clade
|label1=Label
|1={{clade
|1=Leaf A
|2=Leaf B
}}
}}</pre>
|output1={{clade
|label1=Label
|1={{clade |1=Leaf A |2=Leaf B}}
}}
|comment1=Two child elements
|description2=A more complex clade structure
|code2=<pre>{{clade
|label1=Label
|1={{clade
|1=Node A (terminal)
|label2=Node B
|sublabel2=(internal)
|2={{clade
|1=Leaf 1
|2=Leaf 2
}}
}}
}}</pre>
|output2={{clade
|label1=Label
|1={{clade
|1=Node A (terminal)
|label2=Node B
|sublabel2=(internal)
|2={{clade
|1=Leaf 1
|2=Leaf 2
}}
}}
}}
|comment2=Two levels. The second clade element is nested in the first.
|description3=description 3|code3=code 3 |output3=output 3 |comment3=comment 3
|description4=description 4|code4=code 4 |output4=output 4 |comment4=comment 4

}}

{{clear}}

<includeonly>{{sandbox other||


}}</includeonly>

Template:Clade example/doc - Revision history

Fire at 23:00, 22 January 2023

imported>Fire: ページの作成:「{{Documentation subpage}} {{二次利…」