Template:SB tree/doc: Difference between revisions
Jump to navigation
Jump to search
Creating documentation page for SB tree template |
No edit summary |
||
| (15 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
== | {{dochead}} | ||
{{Template rating|details=This template works, but hasn't found any use ever since its module was dropped as a dependency for another template.}} | |||
This template is used to create a Stern–Brocot tree, given a pair of starting ratios and a depth. | |||
=== 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. | |||
Latest revision as of 06:35, 31 October 2025
- This template is implemented by the Lua module Module:SB tree.
- This template invokes the following functions: sb_table from SB tree.
|
This documentation is for a draft template. It is incomplete and may not be in active development. If possible, editors are encouraged to help with its development. In the meantime, editors should avoid using this template across the Xenharmonic Wiki, except for testing.
Details: This template works, but hasn't found any use ever since its module was dropped as a dependency for another template. |
This template is used to create a Stern–Brocot tree, given a pair of starting ratios and a depth.
Usage
No parameters are required, but will accept up to 5.
Start Ratio- The starting ratio for the SB tree. The default is 1/1.
Stop Ratio- The stopping ratio for the SB tree. The default is 1/0.
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.