Template:Node list/doc: Difference between revisions
Add example code |
Add more examples and parameter definition |
||
Line 3: | Line 3: | ||
==Usage== | ==Usage== | ||
This template | This template can be used in several distinct ways: | ||
== | ===Simple form=== | ||
The simple form only works for nodes whose file name, display name and page name are all the same. For example, the "Build Array" node must have a corresponding [[:File:Build Array.png]] file and a [[Build Array]] page. If this is not the case, the elemental form must be used. | |||
{| class="wikitable" | |||
!Parameter | |||
!Description | |||
|- | |||
|1..50 | |||
|Node name, which is also used for the image file name (<code><nowiki>[[File:name.png]]</nowiki></code>) and page link (<code><nowiki>[[name]]</nowiki></code>). | |||
|} | |||
===Elements form=== | |||
The elements form can be used when the simple form does not work (e.g., because the node name is ambiguous). In this case, the "entries" parameter is used to specify the nodes explicitly using the [[:Template:node list/entry]] template. | |||
{| class="wikitable" | |||
!Parameter | |||
!Description | |||
|- | |||
|elements | |||
|One or more elements using [[:Template:node list/entry]]. | |||
|} | |||
The elements form can also be used for adding more advanced entries in the form of [[wikipedia:HTML|HTML]] table rows: | |||
<pre> | |||
<tr><td>icon field</td><td>name field</td></tr> | |||
</pre> | |||
or using the [https://www.mediawiki.org/wiki/Tag_(parser_function) #tag] parser function. | |||
==Examples== | |||
'''Simple form''' | |||
<pre> | <pre> | ||
{{node list | {{node list | ||
Line 16: | Line 46: | ||
|Build Array | |Build Array | ||
|Sort 1D Array | |Sort 1D Array | ||
}} | |||
'''Entries form with named parameters''' | |||
<pre> | |||
{{node list|entries= | |||
{{node list/entry|icon=Build Array.png|link=Build Array function|name=Build Array}} | |||
{{node list/entry|icon=Sort 1D Array.png|link=Sort 1D Array function|name=Sort 1D Array}} | |||
}} | |||
</pre> | |||
{{node list|entries= | |||
{{node list/entry|icon=Build Array.png|link=Build Array function|name=Build Array}} | |||
{{node list/entry|icon=Sort 1D Array.png|link=Sort 1D Array function|name=Sort 1D Array}} | |||
}} | |||
'''Entries form with unnamed parameters (simplified entries form)''' | |||
<pre> | |||
{{node list|entries= | |||
{{node list/entry|Build Array.png|Build Array function|Build Array}} | |||
{{node list/entry|Sort 1D Array.png|Sort 1D Array function|Sort 1D Array}} | |||
}} | |||
</pre> | |||
{{node list|entries= | |||
{{node list/entry|Build Array.png|Build Array function|Build Array}} | |||
{{node list/entry|Sort 1D Array.png|Sort 1D Array function|Sort 1D Array}} | |||
}} | |||
'''Manual form with HTML table rows''' | |||
<pre> | |||
{{node list|entries= | |||
<tr><td>[[File:Build Array.png|Build Array]]</td><td>[[Build Array function|Build Array]]</td></tr> | |||
<tr><td>[[File:Sort 1D Array.png|Sort 1D Array]]</td><td>[[Sort 1D Array function|Sort 1D Array]]</td></tr> | |||
}} | |||
</pre> | |||
{{node list|entries= | |||
<tr><td>[[File:Build Array.png|Build Array]]</td><td>[[Build Array function|Build Array]]</td></tr> | |||
<tr><td>[[File:Sort 1D Array.png|Sort 1D Array]]</td><td>[[Sort 1D Array function|Sort 1D Array]]</td></tr> | |||
}} | |||
'''Manual form using the #tag parser function''' | |||
<pre> | |||
{{node list|entries= | |||
{{#tag:tr|{{#tag:td|[[File:Build Array.png|Build Array]]}}{{#tag:td|[[Build Array function|Build Array]]}}}} | |||
{{#tag:tr|{{#tag:td|[[File:Sort 1D Array.png|Sort 1D Array]]}}{{#tag:td|[[Sort 1D Array function|Sort 1D Array]]}}}} | |||
}} | |||
</pre> | |||
{{node list|entries= | |||
{{#tag:tr|{{#tag:td|[[File:Build Array.png|Build Array]]}}{{#tag:td|[[Build Array function|Build Array]]}}}} | |||
{{#tag:tr|{{#tag:td|[[File:Sort 1D Array.png|Sort 1D Array]]}}{{#tag:td|[[Sort 1D Array function|Sort 1D Array]]}}}} | |||
}} | }} | ||
Revision as of 07:11, 12 August 2024
Create a node list, where each entry has an icon and links to the corresponding page.
Usage
This template can be used in several distinct ways:
Simple form
The simple form only works for nodes whose file name, display name and page name are all the same. For example, the "Build Array" node must have a corresponding File:Build Array.png file and a Build Array page. If this is not the case, the elemental form must be used.
Parameter | Description |
---|---|
1..50 | Node name, which is also used for the image file name ([[File:name.png]] ) and page link ([[name]] ).
|
Elements form
The elements form can be used when the simple form does not work (e.g., because the node name is ambiguous). In this case, the "entries" parameter is used to specify the nodes explicitly using the Template:node list/entry template.
Parameter | Description |
---|---|
elements | One or more elements using Template:node list/entry. |
The elements form can also be used for adding more advanced entries in the form of HTML table rows:
<tr><td>icon field</td><td>name field</td></tr>
or using the #tag parser function.
Examples
Simple form
{{node list |Build Array |Sort 1D Array }}
Icon | Name |
---|---|
![]() | Build Array |
![]() | Sort 1D Array |
Entries form with named parameters
{{node list|entries= {{node list/entry|icon=Build Array.png|link=Build Array function|name=Build Array}} {{node list/entry|icon=Sort 1D Array.png|link=Sort 1D Array function|name=Sort 1D Array}} }}
Icon | Name |
---|---|
![]() | Build Array |
![]() | Sort 1D Array |
Entries form with unnamed parameters (simplified entries form)
{{node list|entries= {{node list/entry|Build Array.png|Build Array function|Build Array}} {{node list/entry|Sort 1D Array.png|Sort 1D Array function|Sort 1D Array}} }}
Icon | Name |
---|---|
![]() | Build Array |
![]() | Sort 1D Array |
Manual form with HTML table rows
{{node list|entries= <tr><td>[[File:Build Array.png|Build Array]]</td><td>[[Build Array function|Build Array]]</td></tr> <tr><td>[[File:Sort 1D Array.png|Sort 1D Array]]</td><td>[[Sort 1D Array function|Sort 1D Array]]</td></tr> }}
Icon | Name |
---|---|
![]() | Build Array |
![]() | Sort 1D Array |
Manual form using the #tag parser function
{{node list|entries= {{#tag:tr|{{#tag:td|[[File:Build Array.png|Build Array]]}}{{#tag:td|[[Build Array function|Build Array]]}}}} {{#tag:tr|{{#tag:td|[[File:Sort 1D Array.png|Sort 1D Array]]}}{{#tag:td|[[Sort 1D Array function|Sort 1D Array]]}}}} }}
Icon | Name |
---|---|
![]() | Build Array |
![]() | Sort 1D Array |