Module:RoundN/doc: Difference between revisions

Content deleted Content added
added documentation for score-boxes parameter
basic documentation for node functions; change status from alpha to release (I originally had more planned for this module and was waiting to add those features but haven't found the time in years)
Line 1:
{{Tfm/dated|page=RoundN/doc|otherpage=Team bracket|link=Wikipedia:Templates for discussion/Log/2021 February 10#Module:RoundN|type=module|help=off|bigbox=yes}}{{Module rating |alpharelease<!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
== Usage ==
Line 190:
 
|}
 
===Node Functions===
{{Ombox
|type=notice
|text=Some of these functions are still in alpha testing and may not be stable. Please feel free to comment at the [[Module_talk:RoundN|1talk page]].
}}
 
For greater customization, node functions may be added to the parameter usually used for providing match information such as dates and ___location. Simply insert <code>node_function{''function name''}</code> in the appropriate ___location. A demonstration of most of the node functions can be found at [[Module_talk:RoundN/testcases/4|RoundN/testcases/4]].
 
* '''orphan''' - Current node is disconnected from all other nodes (no lines will be drawn). One practical use for this may be when the winners of the previous round advance to a different tournament instead of playing each other but the losers still play a consolation match for 3rd place, as per [[Module talk:RoundN#Lines_between_matches_not_in_line_with_centre_of_box|this discussion]].
 
For the next three node functions, the parameters usually used for team names and scores should be omitted if these node functions are used.
* '''line''' - Current node is omitted and replaced with a horizontal line. Text may be displayed above this line via <code>node_function{line(''text'')}</code> (at some point, the preferred format would be <code>node_function{line}''text''</code> to match the form of the canvas function though backwards compatibility would probably be maintained). If [[Bracket#Curly_brackets|curly brackets]] are desired in the text, make sure to escape them with <code>\</code>.
* '''bridge''' - Current node is omitted and replaced with a vertical line.
* '''canvas''' - Current node is replaced with whatever you want via <code>node_function{canvas}''anything''</code>
* '''heading''' - <u>Not yet implemented.</u> Planned node function with the form <code>node_function{heading(''name'')}''date/___location''</code>. Makes a round name heading like for the [[Module:RoundN#Consol|Consol]] parameter, but may be placed anywhere, as per the "Elimination Rounds" of [[Module_talk:RoundN/testcases/6|RoundN/testcases/6]] (which currently renders the planned output of this function without the functions).
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->