Template:SB tree/doc: Difference between revisions

Latest revision as of 01:41, 21 June 2025

This template uses Lua:

This template is used to create a Stern–Brocot tree, given a pair of starting ratios and a depth.

No parameters are required, but will accept up to 5.

Depth: How many layers from the starting ratio the tree should extend. The default is 4 layers.

Edge Extend: How many additional layers the edges should be extended. The default is 0 layers.

Stagger Ratios: Whether to display ratios in a staggered formation (spans multiple columns) or in only one column. The default is true.

@@ 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.
-|}
-[[Category:Template documentation]]
+=== 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.