Template:AKTOC

Create an Answer Key's Table of Contents.

Parameters

page: This should be the title of an honor's landing page. If omitted, the template will assume that it has been invoked from a landing page or a subpage of one and construct a page title for the landing page from the first two elements of {{PAGENAME}}. Note that language detection is based on the invoking page rather than on the {{{page}}} parameter.

Mechanics

The template starts by defining two variables to sort out the page title of the landing page and the requirements page.

After that it has three nested while loops. The outer loop is for the primary requirement numbers (1), then the secondary (1.b), and finally, the tertiary (1.b.iii)

Within each loop, it determines if the proposed requirement exists or not with this fragment:

{{#vardefineecho:req|{{#lst:{{#var:reqpage}}|req{{#var:primary}}}}}}

This snippet defines a variable and echos the definition. The echo is important, because this line of code serves as the condition for the while loop. As long as this snippet returns a non-empty string, the loop will continue. The requirement is extracted from the requirements page by transcluding a labeled section with {{#lst:...}}. The section label is simply "req" with the requirement number as a suffix.

For the two inner loops it's slightly more complex since the label will be of the form "1b" or "1biii", but the loops must operate on numeric quantities. To do this, the loop variables (primary, secondary, and tertiary) are numeric, and we rely on template:boiler to convert them to the form "1biii". For the secondary requirements this is done with this fragment:

{{#vardefine:reqnum|{{boiler|{{#var:primary}}|{{#var:secondary}}}}}}

and for the tertiary:

{{#vardefine:reqnum|{{boiler|{{#var:primary}}|{{#var:secondary}}|{{#var:tertiary}}}}}}

Once the while condition has been specified, we have the body to execute when the condition is true. This is simply:

{{reqreqlink|page={{#var:landing}}|num={{#var:reqnum}}|dispreq=<li>}}<li/>

plus the loop variable incrementer:

{{#vardefine:tertiary|{{#expr: {{#var:tertiary}} + 1 }} }}

Note that the "dispreq" parameter to reqreqlink is simply an html list element.

Each loop is nested inside an order list tag <ol>, and the tag speficies how the list elements should be rendered. For the primary loop, we rely on the default of decimal. For the secondary we specify <ol style="list-style-type:lower-alpha">, and for the tertiary <style="list-style-type:lower-roman">

template:reqreqlink returns a link to an anchor within the answer key (created by template:ansreq.

Bugs

This template has problems rendering honors with unconventional requirement numbering. It returns nothing for Abseiling, for example, and I have no intention of fixing this. It would be far easier to hand-craft the TOC for that honor if we choose to give it one.