Template:SB tree/doc: Difference between revisions

m Exclude the category from the template page
Ganaram inukshuk (talk | contribs)
m Template has not been a dependency for any other module for a while
 
(9 intermediate revisions by one other user not shown)
Line 1: Line 1:
== Parameters ==
{{dochead}}{{lua}}
{| class="wikitable"
This template is used to create a Stern–Brocot tree, given a pair of starting ratios and a depth.
|-
! Parameter !! Required? !! Description
|-
| Start Ratio|| No (optional)|| The starting ratio for the SB tree. The default is 1/1.
|-
| Stop Ratio || No (optional)|| The stopping ratio for the SB tree. The default is 1/0.
|-
| Depth || No (optional)|| How many layers from the starting ratio the tree should extend. The default is 4 layers.
|-
| Edge Extend || No (optional) || How many additional layers the edges should be extended. The default is 0 layers.
|-
| Stagger Ratios || No (optional) || Whether to display ratios in a staggered formation (spans multiple columns) or in only one column. The default is true.
|}


<noinclude>[[Category:Template documentation]]</noinclude>
=== Usage ===
No parameters are required, but will accept up to 5.<br /><br />
 
; <code>Start Ratio</code>
: The starting ratio for the SB tree. The default is 1/1.
 
; <code>Stop Ratio</code>
: The stopping ratio for the SB tree. The default is 1/0.
 
; <code>Depth</code>
: How many layers from the starting ratio the tree should extend. The default is 4 layers.
 
; <code>Edge Extend</code>
: How many additional layers the edges should be extended. The default is 0 layers.
 
; <code>Stagger Ratios</code>
: Whether to display ratios in a staggered formation (spans multiple columns) or in only one column. The default is true.