Xenharmonic Wiki - User contributions [en]

User:Ganaram inukshuk

2026-02-06T11:14:36Z

Ganaram inukshuk:

I generally go by "Ganaram" or some variant of that (ganaram_inukshuk, gdinuk). (Discord: ganaraminukshuk0; he/they; generally more active on the Xen Discord unless work bogs me down.)

I've heard about microtonality on and off over the years, but what drew me into the topic was two things: HEHEHE I AM A SUPAHSTAR SAGA's video series on 19edo and Patricia Taxxon's song Spiral Staircase.

From a compositional perspective, my goal is to incorporate xenharmonic elements into an otherwise normal-sounding song, though my more ambitious goal is to not use the diatonic (LLLsLLs) scale structure at all.

From a theory perspective, my goal is to better understand xenharmony from a temperament-agnostic perspective. This primarily means edos and MOSses, but extends to MV3 scales and higher.

From a wikian perspective, my goal is to better the wiki itself, at least as it pertains to how mos-related info is displayed. The most immediate way to achieve this is to create and deploy templates for the most commonly displayed mos-related info, as well as wikifying any text present (so it looks like an actual wiki page!) and trying to verify the source or attribution to things taken for granted (because misattribution happens concerningly). I've written a style guide to be applied to all mos pages (see subpages below), but I'm also open to better ideas.

== Main mindset ==
I summarize my main mindset using the following trinity: '''temperaments, mosses, and edos are not each other'''.

Temperaments produce mosses, but two different temperaments may produce the same mos. Edos support more than one family of mos, so it's fruitless to shoehorn the notation meant for one mos for a different mos within the same edo. Two temperaments may produce the same JI ratio, but have different qualities in different mosses.

This level of decoupling makes it so I don't let any one temperament, mos, or edo influence how I look at either. Just because a nondiatonic mos has a perfect 5th doesn't mean I should think of it as such, especially if that isn't the generator to begin with.

That said, I focus more on mosses and, secondarily, edos when it comes to this trinity. I prefer to look at scales based in a temperament-agnostic sense, as mosses that are supported by an edo, or different edos. Doing so relieves me of the expectation that a certain interval must necessarily fall within a few cents of a [[Just intonation|JI]] ratio and lets me be more explorative with musical scales. This is also less names to memorize, since there are a lot of temperament names, and looking at mosses directly means fewer names to remember.

Other running assumptions and techniques may be found under the methodologies page below.

== TO-DO list, major contributions, and wish list ==
=== Contributions ===
{| class="wikitable mw-collapsible"
|+ style="font-size: 105%; white-space: nowrap;" | Major work on modules and templates in (roughly) chronological order of inception or involvement
|-
! Modules and templates
! New?
! Description of template or contribution
! Status or todo
|-
| [[Module:SB tree]]
[[Template:SB tree]]
| Yes
| Creates a Stern-Brocot tree's entries and their depths.
| Fallen into disuse.
|-
| [[Module:Scale tree|<s>Module:Scale tree</s>]]
[[Template:Scale tree|<s>Template:Scale tree</s>]]
| No
| Automates the creation of a mos's scale tree and tuning spectrum.
Contributor with CompactStar. (I made it so comments can be entered using one param.)
| '''Deprecated, following changes that made it unmaintainable.'''
Superseded by Module:MOS tuning spectrum.
|-
| [[Module:MOS modes]]
[[Template:MOS modes]]
| Yes
| Displays the modes of a mos.
| Current means of row/col data is not ideal.
Further developments uncertain due to personal decision to halt further improvement.
|-
| [[Module:MOS intro]]
[[Template:MOS intro]]
| Yes
| Creates a consistent, common introductory paragraph for a mos page's lead section.
| '''Possibly rewrite to follow new coding conventions.'''
Rewording for nonoctave tunings.

Deprecate name fields as they're redundant if used with Template:TAMNAMS name.

Possible refactoring.
|-
| [[Module:MOS gamut]]
[[Template:MOS gamut]]
| Yes
| Given a notation scheme and assigned mode for a mos for an edo, display the note names.
| Fallen into disuse.
|-
| <s>[[Module:MOS degrees]]</s>
<s>[[Template:MOS degrees]]</s>
| Yes
| Displays cent values for a mos for up to 5 step ratios.
| '''Deprecated, following decision to start over.'''
Superseded by Module:MOS tunings.
|-
| [[Module:MOS notation]]
| Yes
| Helper module for displaying mos notation.
| Fallen into disuse.
|-
| [[Module:MOS intervals]]
[[Template:MOS intervals]]
| Yes
| Displays the interval names of a mos and their cent ranges.
Rewritten to new coding conventions.
| Experiment with interval lookup.
'''REFACTOR.'''
|-
| [[Module:MOS mode degrees]]
[[Template:MOS mode degrees]]
| Yes
| Displays the qualities of each scale degree of every mode of a mos.
| '''Possibly rewrite to follow new coding conventions.'''
Split modmos info into its own template; see Template:MODMOS mode degrees.

'''REFACTOR.'''
|-
| [[Module:MOS in EDO]]
[[Template:MOS in EDO]]
| Yes
| rowspan="4" | Displays and visualizes the mosses that an edo contains.

* MOS in EDO: shows the mosses created using a particular generator and period.
* ...allgens: shows all mosses for all generators for a particular period.
* ...allperiods or MOSes in EDO: shows all mosses for all generators for all periods.
| rowspan="4" | '''To be rewritten as a subst-template.'''
|-
| [[Module:MOS in EDO allgens]]
[[Template:MOS in EDO allgens]]
| Yes
|-
| [[Module:MOS in EDO allperiods]]
[[Template:MOS in EDO allperiods]]
| Yes
|-
| [[Template:MOSes in EDO]] (shortcut template)
| Yes
|-
| [[Module:Template input parse]]
| Yes
| Helper module for various templates that have large amounts of info to be displayed.
| Possible reorganization?
|-
| [[Module:Step vis]]
[[Template:Step vis]]
| Yes
| Step visualization template for MOS(es) in EDO for standalone use.
| Consider html-based visualization?
|-
| <s>[[Module:EDO intro]]</s>
<s>[[Template:EDO intro]]</s>
| Yes (module only)
| Automation of the EDO intro.
| '''Deprecated.'''

Superseded by Module:ED intro.
|-
| <s>[[Module:JI ratio finder]]</s>
| Yes
| Helper module for JI ratios in ED. Superseded by Module:JI ratios.
| Fallen into disuse, but not officially deprecated.
|-
| [[Module:JI ratios in ED|<s>Module:JI ratios in ED</s>]]
[[Template:JI ratios in ED|<s>Template:JI ratios in ED</s>]]
| Yes
| Creates a table showing the JI ratios approximated by an ED.
| Fallen into disuse, as JI ratio finder was superseded.
|-
| [[Module:Xenpaper]]
| Yes
| For making links to audio examples to be listened to.
|
|-
| [[Module:ED intro]]
[[Template:ED intro]]
| Yes
| Automation of the EDO intro, generalized for other equaves.
| Possible code cleanup.
|-
| [[Template:Idiosyncratic terms]]
| Yes
| An alternative to [[Template:Idiosyncratic]] when the original's use is infeasible.
|
|-
| [[Module:Infobox MOS]]
[[Template:Infobox MOS]]
| No
| Code cleanup and additional info.
Moved 8-link infobox to infobox module.
| '''Possibly rewrite to follow new coding conventions.'''
|-
| [[Module:Infobox]]
| No
| Support for infoboxes with 8 navlinks added.
| '''REFACTOR.'''
|-
| [[Module:Keyboard vis]]
| Yes
| Keyboard visualization template for Infobox MOS. No template currently exists.
| Possibly extend to ternary and quaternary scales.
|-
| [[Template:Mbox]]
| No
| Added the option to show an icon.
|
|-
| [[Template:Quickstart]]
[[Template:Has quickstart]]
| Yes
| For disambiguating pages meant for theory from pages meant for practice, and for linking between them.
| ROLLOUT.
|-
| [[Module:MOS]]
| No
| Splitting TAMNAMS-related stuff to its own module.
Redefining the module into a library for all mos-related templates/modules.
|
|-
| [[Module:TAMNAMS]]
| Yes
| A module that contains the entire TAMNAMS specification as it pertains to mosses and step ratios.
Has lookup functions for names and related mosses.
|
|-
| [[Template:TAMNAMS use]]
| Yes
| Shows that a scale page uses TAMNAMS.
|
|-
| [[Module:MOS genchain]]
[[Template:MOS genchain]]
| Yes
| Shows the generator chain of a mos.
| Dev on hold.
|-
| [[Template:MOS scale properties|<s>Template:MOS scale properties</s>]] (former name)
| rowspan="2" | Yes
| rowspan="2" | Combo template of:

* <s>Template:TAMNAMS use</s>
* Template:MOS intervals
* Template:MOS genchain
* Template:MOS mode degrees
| rowspan="2" | '''Deprecated, following changes that made it unmaintainable.'''
'''No combo templates for mos pages.'''
|-
| [[Module:MOS data|<s>Module:MOS data</s>]]
[[Template:MOS data|<s>Template:MOS data</s>]]
|-
| [[Module:TAMNAMS lookup]]
[[Template:TAMNAMS lookup]]
| Yes
| TAMNAMS name lookup as a standalone template.
| Dev direction unclear.
|-
| [[Template:TAMNAMS name]]
| Yes
| For writing the paragraph that states a mos's TAMNAMS name and its etymology or reasoning.
| ROLLOUT.
|-
| [[Module:MOS interval HE]]
[[Template:MOS interval HE]]
| Yes
| Standalone template for harmonic entropy.
Formerly a part of MOS intervals; added by [[User:R-4981]] but separated due to concerns regarding HE.
| Further developments uncertain.
|-
| [[Module:MOS tunings]]
[[Template:MOS tunings]]
| Yes
| Replacement for Template:MOS degrees.
| '''Rewrite to follow new coding conventions.'''
|-
| [[Template:Nutshell]]
| Yes
| See equivalent template on Wikipedia.
|
|-
| [[Module:JI ratios]]
| Yes
| Module for searching for JI ratios, as well as parsing them from template input.
Replacement for Module:JI ratio finder.
|
|-
| [[Module:Mediants]]
| Yes
| Standalone template for mediant calculations. To be used for the following modules:

* Module:SB tree
* <s>Module:Scale tree</s>
* Module:MOS tuning spectrum
* Module:JI ratios
|
|-
| [[Template:Deprecated parameters]]
| Yes
| A module for denoting one or more deprecated parameters in a template.
|
|-
! colspan="4" | New templates after this line follow new (personal) coding conventions, outlined in v1 of my style guide.
|-
! Modules and templates
! New?
! Description of template or contribution
! Status or todo
|-
| [[Template:Navbox]]
[[Module:Navbox]]
| Yes
| A template and module for producing a navbox. Module builds up navbox from input.
Navboxes can be made either as a template or using a lua module calling the navbox functions.
|Possibly add templatestyles integration
|-
| [[Module:Infobox]]
[[Template:Infobox]]
| Yes (template only)
| Rewrote entire infobox from scratch to support infobox template.
Same as navbox; infoboxes can be made either using a module calling the infobox functions or with a template.
|Possibly add templatestyles integration
|-
| [[Module:Numlinks]]
[[Template:Numlinks]]
|Yes
| A template for calculating and creating prev/next links for a numbered page. Pages are incremented (or decremented) by 1.
| Possibly let template auto-extract text.
|-
| [[Template:MOS tuning spectrum]]
[[Module:MOS tuning spectrum]]
| Yes
| Made to address maintenance issues with Module:Scale tree.
Comment entries are reverted back to having one param per ratio, where params are generated on the fly, not hardocded.
| Add comments for step ratios not found by search.
|-
| [[Template:MOS scalesig]]
[[Module:MOS scalesig]]
| Yes
| Made to address shortcomings with [[Template:Scale link]] and need to format mos scalesigs.
This template auto-formats a scale signature:

* Spaces are replaced with nonbreaking spaces.
* For nonoctave scales, angle brackets are replaced with the appropriate ones.
* Can format the scalesig as a link, if needed.
|
|-
| <s>Template:MOS stub</s>
|
| A proposed combination template consisting of:

* Template:Infobox MOS
* Template:MOS intro
* Template:MOS intervals
* Template:MOS tuning spectrum
Such a template would be a subst-template.
| '''Cancelled. No combo templates for mos pages.'''
|-
|[[Module:JI ratios]]
|Yes
|Rewrite of existing JI ratios module into two modules: one for searching for ratios, and one for filtering ratios
|
|-
|[[Template:Disavowed]]
|Yes
|Denotes terms whose usage is no longer advised, generally due to the name being unsuitable (EG, offensive, inappropriate, etc) or due to the person who coined the term retracting it.
|Use-cases to be determined.
|-
|[[Template:Navbox Lumatone]]
[[Template:Navbox fractional-octave]]
[[Module:Navbar]]
|No
|Decoupling navbar so it doesn't generate navboxes' or their prev/next links; that work is delegated to Template:Numlinks and Template:Navbox.
|
|-
|[[Template:Sidebar]]
[[Module:Sidebar]]
|Yes
|A template that's a basic implementation of Wikipedia's sidebar. Some infobox-like templates use this over the actual infobox, so it's made into an actual template.
|Possibly add templatestyles integration
|-
|[[Module:Template input utils]]
|Yes
|A library for preprocessing template args.
May possibly be a new location for Module:Template input parse (TIP).

Proposed functions:

* numbered_args_to_table(args, key_fmt, max_num)
* header_data_pairs_to_table(args, header_fmt, data_fmt)
* Functions to parse key-value, ratios, and sequences of ratios (from TIP)
|
|-
|[[Template:Numlinks 2-num]]
[[Module:Numlinks 2-num]]
|Yes
|A variant of numlinks that supports two varying numbers. Intended for pages such as mosses, EG 5L 2s.
|
|-
|[[Template:Template rating]]
|Yes
|A template that implements Wikipedia's template/module rating template. Advises editors that the template is one of several things:

* Draft; a mockup of a new template/module that is undergoing testing. Not ready for use anywhere except test pages. (encompasses pre-alpha/alpha/beta/mockup)
* Ready; template/module is ready for use
* Broken; self-explanatory. Definitely do not use until it's either fixed or deemed unfixable.
* Replaced; template is deprecated and has a replacement; template is kept for archival purposes or can be deleted.
* Deprecated; do not use anywhere; template is kept for archival purposes or can be deleted.
|In development
|-
|[[Template:Category handler]]
[[Module:Category handler]]
|Yes
|A proposed template-module pair that is a basic implementation of Wikipedia's module of the same name: https://en.wikipedia.org/wiki/Module:Category_handler
Features:

* Allows templates to categorize pages, given a list of categories

* Suppresses categories based on a list of suppressed namespaces (configurable) and a list of suppressed suffixes (subpages; configurable)
* Module is standalone; it requires no other modules as dependencies, apart from possibly utility modules.
|Attempted in the past by someone else but was deleted.
|-
|[[Template:Todo]]
|No
|Integrate category handler so templates/modules with todos don't get categorized twice (once for the template/module and once more for its /doc page)
|
|-
! colspan="4" |New templates after this line follow new (personal) coding conventions, outlined in v2 of my style guide. Features:
Use of snake_case for ALL param names; previous templates go through template name normalization to maintain backwards-compatibility (automated for lua-based templates)

For lua-based templates, no params will ever be defined at the template level, instead defined at the module level
|-
!Modules and templates
!New?
!Description of template or contribution
!Status or todo
|-
|[[Module:Module introspection]]
[[Template:Module introspection]]
|Yes
| rowspan="3" |A set of modules that inspects mediawiki templates and lua code for:

* (FOR TEMPLATES): detecting whether a template invokes a module's function
* (FOR MODULES): detecting a module's dependencies and the functions used.

Common functionality is stored in Module:Introspection utils. Module introspection serves to implement this functionality for modules; template introspection is handled as part of Module:Dochead.

These templates/changes replace [[Template:Lua]] as used on module docpaegs.
| rowspan="3" |Detect data being used from a module, not just functions.
Arrange functions in a list rather than in a table.
|-
|[[Module:Template introspection|<s>Module:Template introspection</s>]]
[[Template:Template introspection|<s>Template:Template introspection</s>]]
|Yes
|-
|[[Module:Introspection utils]]
|Yes
|-
|[[Module:Dochead]]
[[Template:Dochead]]
|Yes (module only)
|Module is a rewrite of Template:Dochead that makes the template able to:

* Autodetect modules with corresponding templates, with options for overrides
* Autodetect templates with corresponding modules, with options for overrides
* Display which functions are invoked and from which modules.
These templates/changes replace [[Template:Lua]] as used on template docpages.
|
|-
|All deprecation templates except [[Template:Deprecated parameters]]
|No
|Minor changes to inform editors if they're used in the wrong namespaces.
|
|-
|All categorizing infoboxes:

* [[Template:Infobox MOS]]
* [[Template:Infobox AFDO]]
* [[Template:Infobox chord]]
* [[Template:Infobox ET]]
* [[Template:Infobox interval]]
|No
|Proposal to add [[Module:Category handler]] so these templates automatically categorize themselves when in the correct namespaces
|
|-
|Template:Template quick copy (shortcut name: tqc)
|
|A proposed module-template pair used to automatically format a template's code for easy copy-pasting. Subst-template.
|
|-
|Template:Keyboard vis
|
|See Module:Keyboard vis.
Module does not have a corresponding template. For module, add scaling options now that visualization is image-based instead of using box-drawing characters (low-priority).
|
|-
| Module:ED ratios
Template:ED ratios
|
| A proposed template that is an upgraded version of Module:JI ratios in ED
|
|-
| Module:Interval regions
|
| A proposed module for roughly classifying diatonic intervals (1st, 2nd etc; major, minor) plus some intermediate or in-between categories ( neutral and interseptimal intervals)
|
|-
| Module:MODMOS mode degrees
Template:MODMOS mode degrees
|
|
|
|-
| Module:MOS superset degrees
Template:MOS superset degrees
|
| Like MOS mode degrees, except the scale degrees are in relation to an ancestor mos.
|
|-
|
|
|
|
|}

=== Wikiprojects and style guides ===
* [[Xenharmonic Wiki:WikiProject Mospage|Project Mospage]] and [[Xenharmonic Wiki:MOS page style guide|mospage style guide]]
* [[User:Ganaram inukshuk/Docpage style guide|Docpage style guide]] (not worthy of a wikiproject since most docpages have been written alraedy; this would be a guide on how to format and arrange what goes on a docpage)

=== Project mbox-icon ===
Various wikis have custom/themed icons. Apart from exceptions where a more common icon is preferred, why not have custom mbox icons for xenwiki?

=== Other contributions ===
* Mos page standardization (work-in-progress)
* [[Recursive structure of MOS scales|MOS recursion and MOS recursion algorithms]]; tried my best to make the descriptions for MOS recursion apply to all cases (Work-in-progress)
* Some rewording of the [[TAMNAMS]] page for readability and flow. I have a few TAMNAMS-related proposals of my own that aren't quite ready to be called official. See todo list or TAMNAMS subpage.
* [[Horogram|A page for horograms]], since it was totally absent (Work-in-progress).
* [[MOS Scale Family Tree|Mos family tree page]] for a tree I independently discovered before realizing Erv Wilson had already described it. Also has to do with mos recursion.

===To-do list ===
* '''<s>Rewrite page(s)</s> Under jurisdiction of Project Mospage.'''
** [[Operations on MOSes|<s>Operations on MOSes</s>]]
** [[MOS scale|<s>MOS scale</s>]]
** <s>[[TAMNAMS/Appendix]] (primarily for names reasoning and adding general principles)</s>
** <s>[[TAMNAMS Extension]] (since such names should follow the same naming principles as the "named range" names, but no such principles currently exist)</s>
* <s>'''Rewrite all octave-equivalent mos pages.''' This is primarily replacing every scale tree for the corresponding template and rewriting the lead sections to make sense and does not present redundant information already given by one of the templates. To a lesser extent, this also involves trying to confirm temperaments said to be attributed to these mosses, but this step will require additional help.</s> '''Under jurisdiction of Project Mospage.'''
** <s>This is done concurrently with writing a style guide for these pages; see [[User:Ganaram inukshuk/MOS page standardization guide]] for a proposed guide.</s>
** <s>Mosses whose pages have been rewritten to meet the style guide to satisfactory levels (that doesn't mean the pages can't be polished further!):</s>
*** <s>5L 1s</s>
*** <s>5L 2s</s>
*** <s>4L 3s</s>
*** <s>3L 4s</s>
*** <s>2L 5s</s>
*** <s>1L 5s</s>
*** <s>7L 1s</s>
*** <s>3L 7s</s>

* '''Update templates I've made to current coding style/structure''':
** The template calls a wrapper function, meant to be used with template params as input. Its name should be suggestive of the module's primary use, and is usually the same name as the template.
** The wrapper function calls the "main function", which has the code that produces the output. Its name is the same as name as with the wrapper function, except it's prefixed by an underscore.
* Clean up mos recursion page (because I feel bad leaving the algorithms untouched and untested for so long).
** Replace pseudocode for is-this-scale-a-mos? program with python code; clarify with more examples.
** Relate mos recursion with the mos family tree.
** All the recursive algorithms described on that page have time complexities of O(n log n), but the algorithm that generates a Christoffel word (combinatorics-on-words term for the brightest mode of a mos) has a time complexity of O(n). Resolve...?
* Standardize mosinedo pages. Examples include:
** [[List of MOS scales in 12edo]]
** [[List of MOS scales in 17edo]]
** [[List of MOS scales in 29edo]]
** [[List of MOS scales in 31edo]]

=== Wish list ===
* Composing music with these abstract ideas.

== Subpages ==
These pages contain content that currently don't have an exact place elsewhere on the Wiki, or contains personal notes that otherwise don't have an exact place on the Wiki. I do my best to explain these things as though I magically forgot everything I know about xenharmony, so I consider it a bonus if someone else found this easy to understand.
* [[User:Ganaram inukshuk/Diagrams]] – For xen-related diagrams
* [[User:Ganaram inukshuk/Notes]] – For xen-related notes
** [[User:Ganaram inukshuk/Notes/TAMNAMS]] – Since I have so many notes related to TAMNAMS, I made a dedicated page for it
* [[User:Ganaram inukshuk/Tables]] – For xen-related tables
* [[User:Ganaram inukshuk/Code]] – For xen-related code
* [[User:Ganaram inukshuk/Models]] – For xen-related models (needs reorganizing)
* [[User:Ganaram inukshuk/TAMNAMS Extension]] – Since there were others making their own TAMNAMS extension pages, I decided to make my own.
** [[User:Ganaram inukshuk/TAMEX]] – Rewrite of the above page for describing any mos descendant, short for "temperament-agnostic moment-of-symmetry scale extension description system"
** [[User:Ganaram inukshuk/Additional temperament-agnostic mos names]] – Rewrite of the above page for names for proposed names.

These pages are descriptions on how I approach various things, such as compositional techniques and how I approach a scale I've never used before.
* [[User:Ganaram inukshuk/Methodologies]]

Sandbox pages (for testing things)
* [[User:Ganaram inukshuk/Sandbox]]
** [[User:Ganaram inukshuk/Sandbox/JI ratios]]
**[[User:Ganaram inukshuk/Sandbox/Navboxes]]
**[[User:Ganaram inukshuk/Sandbox/Modmosses]]
* [[User:Ganaram inukshuk/Template sandbox]]

Test pages (for proposed rewrites or new templates):
* [[User:Ganaram inukshuk/Catalog of MOS Scales]]
* [[User:Ganaram inukshuk/4L 3s]] (Template test page and test page for style guide)
* [[User:Ganaram inukshuk/5L 2s]] (Template test page and test page for style guide)
** [[User:Ganaram inukshuk/MODMOS scales of 5L 2s]]
* [[User:Ganaram inukshuk/7L 3s]] (Rewrite page)
* [[User:Ganaram inukshuk/TAMNAMS]] (Rewrite page)
** [[User:Ganaram inukshuk/TAMNAMS/Appendix]]
* [[User:Ganaram inukshuk/MOS scale]] (rewrite page)
* [[User:Ganaram inukshuk/Template:Rewrite draft]]
* [[User:Ganaram inukshuk/Template:Template rating]]
* [[User:Ganaram inukshuk/Template:Todo]]

Experimental pages (for content considered idiosyncratic, ad-hoc, or otherwise weird):
* [[User:Ganaram inukshuk/LCP 5L 3s]]

Test templates:
* [[User:Ganaram inukshuk/Template:Mbox]]
* [[User:Ganaram inukshuk/Template:TAMNAMS name]]
* [[User:Ganaram inukshuk/Template:Tcode]]
* [[User:Ganaram inukshuk/Template:Tester]]
* [[User:Ganaram inukshuk/Template:Transcript]]
* [[User:Ganaram inukshuk/Template:Joke page|User:Ganaram inukshuk/Joke page]]
* [[User:Ganaram inukshuk/JI ratios]]
* [[User:Ganaram inukshuk/Template:Navbox fractional-octave]]
* [[User:Ganaram inukshuk/Template:Navbox Lumatone]]

Other:
* [[User:Ganaram inukshuk/Provisional style guide for Lua]]

[[Category:User on Discord]]

Template:Template rating/doc

2026-02-06T10:59:42Z

Ganaram inukshuk:

{{dochead|mod=aaa}}{{substitute|no}}{{clear}}{{wikipedia}}
'''{{ARTICLEROOTPAGENAME}}''' is used to denote the rating of a template or module, namely denoting whether or not it can be used. This template is placed within the documentation page of a template, not its <code><nowiki><noinclude></noinclude></nowiki></code> block.

Despite the name, this template can also be used on Lua modules' documentation pages.

=== Parameters ===

; <code>rating</code> (required; default <code>draft</code>)
: The rating of template or module.

; <code>namespace</code> (automatically detected using <code><nowiki>{{ARTICLESPACE}}</nowiki></code>)
: The namespace of the page. For normal use, this is automatically detected and does not need to be entered manually.

; <code>pagename</code> (automatically detected using <code><nowiki>{{PAGENAME}}</nowiki></code>)
: The name of the page. For normal use, this is automatically detected and does not need to be entered manually.

; <code>details</code> (optional)
: Any details about the template or module in question.

; <code>replacement</code> (required if <code>rating=replaced</code>)
: The name of the replacement template or module, if the current template or module is being replaced by a new one.

; <code>delete</code> (required if <code>rating=replaced</code> or <code>rating=deprecated</code>; default <code>false</code>)
: Whether to delete the template or module, if the current template or module is being either replaced or deprecated. Deprecated templates and modules are generally kept for archival and historical purposes, but those that have seen little use (such as those made for testing or with experimental features) may be deleted instead.

; <code>debug</code> (optional; default <code>false</code>)
: Whether to disable categories for [[Template:Category handler]]. For normal use, this should be left unchanged.

=== Quick copy (essential params only) ===

<pre>{{Template rating
| rating =
| details =
| replacement =
| delete =
}}</pre>

=== Usage ===

The following examples assumes use for a template. Usage within the module namespace is automatically detected.

'''Draft template'''

'''Ready''' denotes a template that is work-in-progress, or templates that are being rewritten or refactored.

<code><nowiki>{{Template rating|Sometemplate|rating=draft|details=Other details go here.}}</nowiki></code>
{{Template rating|Sometemplate|rating=draft|namespace=Template|details=Other details go here.|debug=1}}

'''Ready template'''

'''Ready''' denotes a template that is ready for use on the wiki. The use of this template is not necessary for most templates, as a template without any other indicators is assumed to be a ready template.

<code><nowiki>{{Template rating|Sometemplate|rating=ready|details=Other details go here.}}</nowiki></code>
{{Template rating|Sometemplate|rating=ready|namespace=Template|details=Other details go here.}}

'''Broken template'''

'''Broken''' denotes a template that is not functioning properly and is currently being fixed. For templates that work but are undergoing refactoring, use the '''draft''' rating.

<code><nowiki>{{Template rating|Sometemplate|rating=broken|details=Other details go here.}}</nowiki></code>
{{Template rating|Sometemplate|rating=broken|namespace=Template|details=Other details go here.|debug=1}}

'''Replaced template'''

'''Replaced''' denotes a template that should no longer be used and have been superseded by a new template. By default, deprecated templates are ''not'' nominated for deletion, as deleting a deprecated template makes viewing past revisions of transcluding pages much more difficult.

<code><nowiki>{{Template rating|Sometemplate|rating=replaced|replacement=Somenewtemplate|details=Other details go here.}}</nowiki></code>
{{Template rating|Sometemplate|rating=replaced|namespace=Template|replacement=Somenewtemplate|details=Other details go here.|debug=1}}

If a template has not been extensively used, it may be nominated for deletion by adding <code>delete=1</code>.

<code><nowiki>{{Template rating|Sometemplate|rating=replaced|replacement=Somenewtemplate|details=Other details go here.|delete=1}}</nowiki></code>
{{Template rating|Sometemplate|rating=replaced|namespace=Template|replacement=Somenewtemplate|details=Other details go here.|debug=1|delete=1}}

'''Deprecated template'''

'''Deprecated''' denotes a template that should no longer be used and has no replacement.

<code><nowiki>{{Template rating|Sometemplate|rating=deprecated|details=Other details go here.}}</nowiki></code>
{{Template rating|Sometemplate|rating=deprecated|namespace=Template|details=Other details go here.|debug=1}}

As with replaced templates, deprecated templates are ''not'' nominated for deletion by default. To nominate it for deletion, add <code>delete=1</code>.

<code><nowiki>{{Template rating|Sometemplate|rating=deprecated|details=Other details go here.|delete=1}}</nowiki></code>
{{Template rating|Sometemplate|rating=deprecated|namespace=Template|details=Other details go here.|debug=1|delete=1}}

'''Incorrect options and categories'''

This template uses [[Template:Category handler]], which categories templates and modules using this template in the appropriate categories, except those with a rating of ''ready''. Categories are not enabled on /doc or /sandbox pages.

In addition to this, this template detects whether it's in the incorrect namespace, such as when used on User namespace pages, and can detect whether it has an unrecognized rating.

<code><nowiki>{{Template rating|Sometemplate|rating=aaa}}</nowiki></code>
{{Template rating|Sometemplate|rating=aaa|namespace=User}}

=== See also ===
* [[Template:Deprecated template]], a template added to a deprecated template's code, to be used in conjunction with this template

Template:Template rating/doc

2026-02-05T21:31:51Z

Ganaram inukshuk: clarify when some params are used; module namespace detection is automatic, so there's no need to enter the namespace manually; added a quick copy to see how it looks

{{dochead|mod=aaa}}{{substitute|no}}{{clear}}{{wikipedia}}
'''{{ARTICLEROOTPAGENAME}}''' is used to denote the rating of a template or module, namely denoting whether or not it can be used. This template is placed within the documentation page of a template, not its <code><nowiki><noinclude></noinclude></nowiki></code> block.

Despite the name, this template can also be used on Lua modules' documentation pages.

=== Parameters ===

; <code>rating</code> (required; default <code>draft</code>)
: The rating of template or module.

; <code>namespace</code> (required; default is based on <code><nowiki>{{ARTICLESPACE}}</nowiki></code>)
: The namespace of the page. For normal use, this is automatically detected and does not need to be entered manually.

; <code>pagename</code> (required; default is based on <code><nowiki>{{PAGENAME}}</nowiki></code>)
: The name of the page. For normal use, this is automatically detected and does not need to be entered manually.

; <code>details</code> (optional)
: Any details about the template or module in question.

; <code>replacement</code> (required if <code>rating=replaced</code>)
: The name of the replacement template or module, if the current template or module is being replaced by a new one.

; <code>delete</code> (required if <code>rating=replaced</code> or <code>rating=deprecated</code>; default <code>false</code>)
: Whether to delete the template or module, if the current template or module is being either replaced or deprecated. Deprecated templates and modules are generally kept for archival and historical purposes, but those that have seen little use (such as those made for testing or with experimental features) may be deleted instead.

; <code>debug</code> (optional; default <code>false</code>)
: Whether to disable categories for [[Template:Category handler]]. For normal use, this should be left unchanged.

=== Quick copy (essential params only) ===

<pre>{{Template rating
| rating =
| details =
| replacement =
| delete =
}}</pre>

=== Usage ===

The following examples assumes use for a template. Usage within the module namespace is automatically detected.

'''Draft template'''

'''Ready''' denotes a template that is work-in-progress, or templates that are being rewritten or refactored.

<code><nowiki>{{Template rating|Sometemplate|rating=draft|details=Other details go here.}}</nowiki></code>
{{Template rating|Sometemplate|rating=draft|namespace=Template|details=Other details go here.|debug=1}}

'''Ready template'''

'''Ready''' denotes a template that is ready for use on the wiki. The use of this template is not necessary for most templates, as a template without any other indicators is assumed to be a ready template.

<code><nowiki>{{Template rating|Sometemplate|rating=ready|details=Other details go here.}}</nowiki></code>
{{Template rating|Sometemplate|rating=ready|namespace=Template|details=Other details go here.}}

'''Broken template'''

'''Broken''' denotes a template that is not functioning properly and is currently being fixed. For templates that work but are undergoing refactoring, use the '''draft''' rating.

<code><nowiki>{{Template rating|Sometemplate|rating=broken|details=Other details go here.}}</nowiki></code>
{{Template rating|Sometemplate|rating=broken|namespace=Template|details=Other details go here.|debug=1}}

'''Replaced template'''

'''Replaced''' denotes a template that should no longer be used and have been superseded by a new template. By default, deprecated templates are ''not'' nominated for deletion, as deleting a deprecated template makes viewing past revisions of transcluding pages much more difficult.

<code><nowiki>{{Template rating|Sometemplate|rating=replaced|replacement=Somenewtemplate|details=Other details go here.}}</nowiki></code>
{{Template rating|Sometemplate|rating=replaced|namespace=Template|replacement=Somenewtemplate|details=Other details go here.|debug=1}}

If a template has not been extensively used, it may be nominated for deletion by adding <code>delete=1</code>.

<code><nowiki>{{Template rating|Sometemplate|rating=replaced|replacement=Somenewtemplate|details=Other details go here.|delete=1}}</nowiki></code>
{{Template rating|Sometemplate|rating=replaced|namespace=Template|replacement=Somenewtemplate|details=Other details go here.|debug=1|delete=1}}

'''Deprecated template'''

'''Deprecated''' denotes a template that should no longer be used and has no replacement.

<code><nowiki>{{Template rating|Sometemplate|rating=deprecated|details=Other details go here.}}</nowiki></code>
{{Template rating|Sometemplate|rating=deprecated|namespace=Template|details=Other details go here.|debug=1}}

As with replaced templates, deprecated templates are ''not'' nominated for deletion by default. To nominate it for deletion, add <code>delete=1</code>.

<code><nowiki>{{Template rating|Sometemplate|rating=deprecated|details=Other details go here.|delete=1}}</nowiki></code>
{{Template rating|Sometemplate|rating=deprecated|namespace=Template|details=Other details go here.|debug=1|delete=1}}

'''Incorrect options and categories'''

This template uses [[Template:Category handler]], which categories templates and modules using this template in the appropriate categories, except those with a rating of ''ready''. Categories are not enabled on /doc or /sandbox pages.

In addition to this, this template detects whether it's in the incorrect namespace, such as when used on User namespace pages, and can detect whether it has an unrecognized rating.

<code><nowiki>{{Template rating|Sometemplate|rating=aaa}}</nowiki></code>
{{Template rating|Sometemplate|rating=aaa|namespace=User}}

=== See also ===
* [[Template:Deprecated template]], a template added to a deprecated template's code, to be used in conjunction with this template

Template:Template rating/doc

2026-02-05T02:39:30Z

Ganaram inukshuk: /* Usage */

{{dochead|mod=aaa}}{{substitute|no}}{{clear}}{{wikipedia}}
'''{{ARTICLEROOTPAGENAME}}''' is used to denote the rating of a template or module, namely denoting whether or not it can be used. This template is placed within the documentation page of a template, not its <code><nowiki><noinclude></noinclude></nowiki></code> block.

Despite the name, this template can also be used on Lua modules' documentation pages.

=== Parameters ===

; <code>rating</code> (required; default <code>draft</code>)
: The rating of template or module.

; <code>namespace</code> (required; default is based on <code><nowiki>{{ARTICLESPACE}}</nowiki></code>)
: The namespace of the page. For normal use, this is automatically detected and does not need to be entered manually.

; <code>pagename</code> (required; default is based on <code><nowiki>{{PAGENAME}}</nowiki></code>)
: The name of the page. For normal use, this is automatically detected and does not need to be entered manually.

; <code>details</code> (optional)
: Any details about the template or module in question.

; <code>replacement</code> (required if <code>rating=replaced</code>)
: The name of the replacement template or module.

; <code>delete</code> (optional; default <code>false</code>)
: Whether to delete the template or module.

; <code>debug</code> (optional; default <code>false</code>)
: Whether to disable categories for [[Template:Category handler]].

=== Usage ===

The following examples assumes use for a template. For use with module documentation, add <code>namespace = Module</code>.

'''Draft template'''

'''Ready''' denotes a template that is work-in-progress, or templates that are being rewritten or refactored.

<code><nowiki>{{Template rating|Sometemplate|rating=draft|details=Other details go here.}}</nowiki></code>
{{Template rating|Sometemplate|rating=draft|namespace=Template|details=Other details go here.|debug=1}}

'''Ready template'''

'''Ready''' denotes a template that is ready for use on the wiki. The use of this template is not necessary for most templates, as a template without any other indicators is assumed to be a ready template.

<code><nowiki>{{Template rating|Sometemplate|rating=ready|details=Other details go here.}}</nowiki></code>
{{Template rating|Sometemplate|rating=ready|namespace=Template|details=Other details go here.}}

'''Broken template'''

'''Broken''' denotes a template that is not functioning properly and is currently being fixed. For templates that work but are undergoing refactoring, use the '''draft''' rating.

<code><nowiki>{{Template rating|Sometemplate|rating=broken|details=Other details go here.}}</nowiki></code>
{{Template rating|Sometemplate|rating=broken|namespace=Template|details=Other details go here.|debug=1}}

'''Replaced template'''

'''Replaced''' denotes a template that should no longer be used and have been superseded by a new template. By default, deprecated templates are ''not'' nominated for deletion, as deleting a deprecated template makes viewing past revisions of transcluding pages much more difficult.

<code><nowiki>{{Template rating|Sometemplate|rating=replaced|replacement=Somenewtemplate|details=Other details go here.}}</nowiki></code>
{{Template rating|Sometemplate|rating=replaced|namespace=Template|replacement=Somenewtemplate|details=Other details go here.|debug=1}}

If a template has not been extensively used, it may be nominated for deletion by adding <code>delete=1</code>.

<code><nowiki>{{Template rating|Sometemplate|rating=replaced|replacement=Somenewtemplate|details=Other details go here.|delete=1}}</nowiki></code>
{{Template rating|Sometemplate|rating=replaced|namespace=Template|replacement=Somenewtemplate|details=Other details go here.|debug=1|delete=1}}

'''Deprecated template'''

'''Deprecated''' denotes a template that should no longer be used and has no replacement.

<code><nowiki>{{Template rating|Sometemplate|rating=deprecated|details=Other details go here.}}</nowiki></code>
{{Template rating|Sometemplate|rating=deprecated|namespace=Template|details=Other details go here.|debug=1}}

As with replaced templates, deprecated templates are ''not'' nominated for deletion by default. To nominate it for deletion, add <code>delete=1</code>.

<code><nowiki>{{Template rating|Sometemplate|rating=deprecated|details=Other details go here.|delete=1}}</nowiki></code>
{{Template rating|Sometemplate|rating=deprecated|namespace=Template|details=Other details go here.|debug=1|delete=1}}

'''Incorrect options and categories'''

This template uses [[Template:Category handler]], which categories templates and modules using this template in the appropriate categories, except those with a rating of ''ready''. Categories are not enabled on /doc or /sandbox pages.

In addition to this, this template detects whether it's in the incorrect namespace, such as when used on User namespace pages, and can detect whether it has an unrecognized rating.

<code><nowiki>{{Template rating|Sometemplate|rating=aaa}}</nowiki></code>
{{Template rating|Sometemplate|rating=aaa|namespace=User}}

=== See also ===
* [[Template:Deprecated template]], a template added to a deprecated template's code, to be used in conjunction with this template

Template:Alert/doc

2026-02-04T23:41:59Z

Ganaram inukshuk: rewrite; emphasize (hopefully) usage as a metatemplate

{{Dochead|header=metatemplate}}{{Template rating|{{PAGENAME}}|rating=ready}}{{clear}}{{templatestyles}}

The '''Alert''' template is a metatemplate which is used to create alerts, also known as callouts or admonitions, to call attention to critical information. It is intended to be used in other templates for messages which are expected to be used on multiple pages.

=== Usage ===
The template accepts the following parameters:
* <code>type</code>: Defines the color of the left border; the type should be chosen according to context, not for aesthetic reasons. Types are described in the next section.
* <code>text</code>: Message to be displayed in the box.
* <code>icon</code>: Icon to be displayed in the box, if provided. Icons appear on the left side of the message box. Unlike mbox, alert uses an {{w|emoji}} rather than an image, which should be passed in using its {{w|HTML entity}} representation (e.g. use <code>&#x1F642;</code> for 🙂</code>).
* <code>label</code>: A custom label, if provided.

Templates that use this metatemplate (namely <code><nowiki>{{note}}</nowiki></code>, <code><nowiki>{{tip}}</nowiki></code>, and <code><nowiki>{{warning}}</nowiki></code>) should have pre-assigned values for <code>type</code>, <code>icon</code>, and <code>label</code>, leaving only <code>text</code> available to be modified.

=== Types and examples ===
{{Alert|text=Alert of '''note''' type, used by [[Template: Note]]. |type=note}}
{{Alert|text=Alert of '''tip''' type, used by [[Template: Tip]]. |type=tip}}
{{Alert|text=Alert of '''warning''' type, used by [[Template: Warning]]. |type=warning}}

=== See also ===
* [[Template: Mbox]]

Module:Template input utils

2026-02-04T10:22:30Z

Ganaram inukshuk:

-- This module follows [[User:Ganaram inukshuk/Provisional style guide for Lua]]
local p = {}

-- TODO: move tip functions here? See [[Module:Template input parse]]

-- TODO:
-- Add param name normalization: params close enough to snake_case are normal-
-- ized to snake_case

-- Library module for common operations with handling template input.
-- - Numbered <anything> to table extract args and places them into a table.

-- Normalize params to snake case (may change to a different form later);
-- anything close enough to snake case is converted to snake case:
-- TRAIN_CASE, KEBEB-CASE, no dashes (OK!)
-- PascalCase, camelCase (will not convert properly)
-- Function work-in-progress
function p.normalize_params(args)

-- Local function for normalizing strings
-- Spaces and dashes turn into underscores
-- and all capital letters become lowercase
local function normalize(input_string)
local cleaned_string = string.gsub(string.lower(input_string), "[%-%s]", "_")
end

end

-- Extracts numbered args (from frame.args) and stores them into one table.
-- Removes original numbered args from args table. Sequence of numbered args
-- may have gaps.
-- Table of entries is returned without being inserted into the original args
-- table, as it may require further processing (EG, parsing to number, ratio,
-- kv-pairs, etc).
function p.numbered_args_to_table(args, max_num, key_fmt, keep_originals)
local max_num = max_num or 100
local key_fmt = key_fmt or "Entry %d"
local keep_originals = keep_originals or false -- Denotes whether to keep originals in table or remove them; default false

local entries = {}
for i = 1, max_num do
local key = string.format(key_fmt, i) -- Make key
local entry = args[key] -- Extract
table.insert(entries, entry) -- Insert
if not keep_originals then
args[key] = nil -- Remove original
end
end

return entries
end

-- Extracts numbered args that correspond to header-data pairs of a two-col
-- table, commonly seen in navboxes and infoboxes. Removes original numbered
-- args from args table. Sequence of numbered args may have gaps, and a pair may
-- have one element be missing/nil (headerless data and dataless header).
-- Table of entries is returned without being inserted into the original args
-- table, as it may require further processing (EG, parsing to number, ratio,
-- kv-pairs, etc).
function p.numbered_header_data_args_to_table(args, max_num, keep_originals, is_strict_pair, header_fmt, data_fmt)
local max_num = max_num or 100
local header_fmt = header_fmt or "Header %d"
local data_fmt = data_fmt or "Data %d"
local is_strict_pair = is_strict_pair or false -- Denotes whether a pair must have both header and data
local keep_originals = keep_originals or false -- Denotes whether to keep originals in table or remove them; default false

local entries = {}
for i = 1, max_num do
-- Make keys
local header_key = string.format(header_fmt, i)
local data_key = string.format(data_fmt, i)

-- Extract header and data
local header = args[header_key]
local data = args[data_key]
local entry = { ["Header"] = args[header_key], ["Data"] = args[data_key] }

-- Insert
if is_strict_pair then
if (header and data) then table.insert(entries, entry) end
else
if (header or data) then table.insert(entries, entry) end
end

-- Remove originals
if not keep_originals then
args[header_key] = nil
args[data_key] = nil
end
end

return entries
end

-- Some older infoboxes use a jagged array instead of an assoc-array, so convert
-- two-element tables into a header-data pair, and one-element tables into
-- either a headerless data row, or a dataless header row.
-- Default is to interpret size-1 arrays as data rows, which corresponds to how
-- the infobox worked before it became template-ified. This old input method may
-- be easier to work with.
function p.jagged_array_to_header_data_pairs(rows, is_header_row)
local is_header_row = is_header_row or false
local new_rows = {}
for i = 1, #rows do
local row = rows[i]
if #row == 2 then
table.insert(new_rows, { ["Header"] = row[1], ["Data"] = row[2] })
elseif #row == 1 and not is_header_row then
table.insert(new_rows, { ["Data" ] = row[1] })
elseif #row == 1 and is_header_row then
table.insert(new_rows, { ["Header"] = row[1] })
end
end
return new_rows
end

function p.tester()
local test_args = {
["Entry 1"] = "aaa",
["Entry 2"] = "bbb",
["Entry 3"] = "ccc",
["Header 2"] = "BBB",
["Entry 5"] = "ddd",
}

--test_args["Entries"] = p.numbered_args_to_table(test_args, "Entry %d", 10)
test_args["Entries"] = p.numbered_header_data_args_to_table(test_args, 10, "Header %d", "Entry %d")
return test_args
end

return p

Template:Mbox/doc

2026-02-04T02:24:34Z

Ganaram inukshuk: /* Usage */ removed unused params

{{Dochead|header=metatemplate}}{{Wikipedia}}{{templatestyles}}
The '''Mbox''' template is a metatemplate which is used to create message boxes which are placed at the top of a page. It is intended to be used in other templates for messages which are expected to be used on multiple pages.

=== Usage ===
The template accepts the following parameters:
* <code>type</code>: Defines the color of the left border; the type should be chosen according to context, not for aesthetic reasons. Types are described in the next section.
* <code>text</code>: Message to be displayed in the box.
* <code>icon</code>: Icon to be displayed in the box, if provided. Icons appear on the left side of the message box.
* <code>icon size</code>: Size of the icon displayed. Default is 60px.
{{clear}}

=== Types and examples ===
{{Mbox|text=Messagebox of '''delete''' type. Typically used for pages whose content is deprecated or to be deleted.|type=delete}}

{{Mbox|text=Messagebox of '''content''' type. Typically used for pages whose content requires verification or rewriting.|type=content}}

{{Mbox|text=Messagebox of '''style''' type. Typically used for pages whose writing deviates from the wiki's standards.|type=style}}

{{Mbox|text=Messagebox of '''ready''' type. Used to denote wiki features (such as templates) that are ready for use.|type=ready}}

{{Mbox|text=Messagebox of '''notice''' type. Used to denote general notices. Most messageboxes are of this type.|type=notice}}

{{Mbox|text=Messagebox of '''move''' type. Denotes pages that are to be moved.|type=move}}

{{Mbox|text=Messagebox of '''protection''' type. Denotes pages that are protected from editing.|type=protection}}

=== See also ===
* [[Template: Alert]]

Module:Template input utils

2026-02-04T02:20:27Z

Ganaram inukshuk:

-- This module follows [[User:Ganaram inukshuk/Provisional style guide for Lua]]
local p = {}

-- TODO: move tip functions here? See [[Module:Template input parse]]

-- TODO:
-- Add param name normalization: params close enough to snake_case are normal-
-- ized to snake_case

-- Library module for common operations with handling template input.
-- - Numbered <anything> to table extract args and places them into a table.

-- Normalize params to snake case; anything close enough to snake case is
-- converted to snake case:
-- TRAIN_CASE, KEBEB-CASE, no dashes (OK!)
-- PascalCase, camelCase (will not convert properly)
-- Function work-in-progress
function p.normalize_params(args)

-- Local function for normalizing strings
-- Spaces and dashes turn into underscores
-- and all capital letters become lowercase
local function normalize(input_string)
local cleaned_string = string.gsub(string.lower(input_string), "[%-%s]", "_")
end

end

-- Extracts numbered args (from frame.args) and stores them into one table.
-- Removes original numbered args from args table. Sequence of numbered args
-- may have gaps.
-- Table of entries is returned without being inserted into the original args
-- table, as it may require further processing (EG, parsing to number, ratio,
-- kv-pairs, etc).
function p.numbered_args_to_table(args, max_num, key_fmt, keep_originals)
local max_num = max_num or 100
local key_fmt = key_fmt or "Entry %d"
local keep_originals = keep_originals or false -- Denotes whether to keep originals in table or remove them; default false

local entries = {}
for i = 1, max_num do
local key = string.format(key_fmt, i) -- Make key
local entry = args[key] -- Extract
table.insert(entries, entry) -- Insert
if not keep_originals then
args[key] = nil -- Remove original
end
end

return entries
end

-- Extracts numbered args that correspond to header-data pairs of a two-col
-- table, commonly seen in navboxes and infoboxes. Removes original numbered
-- args from args table. Sequence of numbered args may have gaps, and a pair may
-- have one element be missing/nil (headerless data and dataless header).
-- Table of entries is returned without being inserted into the original args
-- table, as it may require further processing (EG, parsing to number, ratio,
-- kv-pairs, etc).
function p.numbered_header_data_args_to_table(args, max_num, keep_originals, is_strict_pair, header_fmt, data_fmt)
local max_num = max_num or 100
local header_fmt = header_fmt or "Header %d"
local data_fmt = data_fmt or "Data %d"
local is_strict_pair = is_strict_pair or false -- Denotes whether a pair must have both header and data
local keep_originals = keep_originals or false -- Denotes whether to keep originals in table or remove them; default false

local entries = {}
for i = 1, max_num do
-- Make keys
local header_key = string.format(header_fmt, i)
local data_key = string.format(data_fmt, i)

-- Extract header and data
local header = args[header_key]
local data = args[data_key]
local entry = { ["Header"] = args[header_key], ["Data"] = args[data_key] }

-- Insert
if is_strict_pair then
if (header and data) then table.insert(entries, entry) end
else
if (header or data) then table.insert(entries, entry) end
end

-- Remove originals
if not keep_originals then
args[header_key] = nil
args[data_key] = nil
end
end

return entries
end

-- Some older infoboxes use a jagged array instead of an assoc-array, so convert
-- two-element tables into a header-data pair, and one-element tables into
-- either a headerless data row, or a dataless header row.
-- Default is to interpret size-1 arrays as data rows, which corresponds to how
-- the infobox worked before it became template-ified. This old input method may
-- be easier to work with.
function p.jagged_array_to_header_data_pairs(rows, is_header_row)
local is_header_row = is_header_row or false
local new_rows = {}
for i = 1, #rows do
local row = rows[i]
if #row == 2 then
table.insert(new_rows, { ["Header"] = row[1], ["Data"] = row[2] })
elseif #row == 1 and not is_header_row then
table.insert(new_rows, { ["Data" ] = row[1] })
elseif #row == 1 and is_header_row then
table.insert(new_rows, { ["Header"] = row[1] })
end
end
return new_rows
end

function p.tester()
local test_args = {
["Entry 1"] = "aaa",
["Entry 2"] = "bbb",
["Entry 3"] = "ccc",
["Header 2"] = "BBB",
["Entry 5"] = "ddd",
}

--test_args["Entries"] = p.numbered_args_to_table(test_args, "Entry %d", 10)
test_args["Entries"] = p.numbered_header_data_args_to_table(test_args, 10, "Header %d", "Entry %d")
return test_args
end

return p

Module:Template input utils

2026-02-04T00:19:55Z

Ganaram inukshuk: add empty function for param normalizing

-- This module follows [[User:Ganaram inukshuk/Provisional style guide for Lua]]
local p = {}

-- TODO: move tip functions here? See [[Module:Template input parse]]

-- TODO:
-- Add param name normalization: params close enough to snake_case are normal-
-- ized to snake_case

-- Library module for common operations with handling template input.
-- - Numbered <anything> to table extract args and places them into a table.

-- Normalize params to snake case; anything close enough to snake case is
-- converted to snake case:
-- - PascalCase -> pascal_case
-- - camelCase -> camel_case
-- - ALL_CAPS -> all_caps
-- - TRAIN-CASE -> train_case
-- - kebab-case -> kebab_case
-- - Whatever-This-Case-Is -> whatever_this_case_is
-- - lowercase, UPPERCASE -> cannot be converted properly (lowercase, uppercase)
function p.normalize_params(args)

end

-- Extracts numbered args (from frame.args) and stores them into one table.
-- Removes original numbered args from args table. Sequence of numbered args
-- may have gaps.
-- Table of entries is returned without being inserted into the original args
-- table, as it may require further processing (EG, parsing to number, ratio,
-- kv-pairs, etc).
function p.numbered_args_to_table(args, max_num, key_fmt, keep_originals)
local max_num = max_num or 100
local key_fmt = key_fmt or "Entry %d"
local keep_originals = keep_originals or false -- Denotes whether to keep originals in table or remove them; default false

local entries = {}
for i = 1, max_num do
local key = string.format(key_fmt, i) -- Make key
local entry = args[key] -- Extract
table.insert(entries, entry) -- Insert
if not keep_originals then
args[key] = nil -- Remove original
end
end

return entries
end

-- Extracts numbered args that correspond to header-data pairs of a two-col
-- table, commonly seen in navboxes and infoboxes. Removes original numbered
-- args from args table. Sequence of numbered args may have gaps, and a pair may
-- have one element be missing/nil (headerless data and dataless header).
-- Table of entries is returned without being inserted into the original args
-- table, as it may require further processing (EG, parsing to number, ratio,
-- kv-pairs, etc).
function p.numbered_header_data_args_to_table(args, max_num, keep_originals, is_strict_pair, header_fmt, data_fmt)
local max_num = max_num or 100
local header_fmt = header_fmt or "Header %d"
local data_fmt = data_fmt or "Data %d"
local is_strict_pair = is_strict_pair or false -- Denotes whether a pair must have both header and data
local keep_originals = keep_originals or false -- Denotes whether to keep originals in table or remove them; default false

local entries = {}
for i = 1, max_num do
-- Make keys
local header_key = string.format(header_fmt, i)
local data_key = string.format(data_fmt, i)

-- Extract header and data
local header = args[header_key]
local data = args[data_key]
local entry = { ["Header"] = args[header_key], ["Data"] = args[data_key] }

-- Insert
if is_strict_pair then
if (header and data) then table.insert(entries, entry) end
else
if (header or data) then table.insert(entries, entry) end
end

-- Remove originals
if not keep_originals then
args[header_key] = nil
args[data_key] = nil
end
end

return entries
end

-- Some older infoboxes use a jagged array instead of an assoc-array, so convert
-- two-element tables into a header-data pair, and one-element tables into
-- either a headerless data row, or a dataless header row.
-- Default is to interpret size-1 arrays as data rows, which corresponds to how
-- the infobox worked before it became template-ified. This old input method may
-- be easier to work with.
function p.jagged_array_to_header_data_pairs(rows, is_header_row)
local is_header_row = is_header_row or false
local new_rows = {}
for i = 1, #rows do
local row = rows[i]
if #row == 2 then
table.insert(new_rows, { ["Header"] = row[1], ["Data"] = row[2] })
elseif #row == 1 and not is_header_row then
table.insert(new_rows, { ["Data" ] = row[1] })
elseif #row == 1 and is_header_row then
table.insert(new_rows, { ["Header"] = row[1] })
end
end
return new_rows
end

function p.tester()
local test_args = {
["Entry 1"] = "aaa",
["Entry 2"] = "bbb",
["Entry 3"] = "ccc",
["Header 2"] = "BBB",
["Entry 5"] = "ddd",
}

--test_args["Entries"] = p.numbered_args_to_table(test_args, "Entry %d", 10)
test_args["Entries"] = p.numbered_header_data_args_to_table(test_args, 10, "Header %d", "Entry %d")
return test_args
end

return p

Template:Mbox/doc

2026-02-02T02:08:31Z

Ganaram inukshuk: /* Usage */ it's more than 3 params now

{{Dochead|header=metatemplate}}{{Wikipedia}}{{templatestyles}}
The '''Mbox''' template is a metatemplate which is used to create message boxes which are placed at the top of a page. It is intended to be used in other templates for messages which are expected to be used on multiple pages.

=== Usage ===
The template accepts the following parameters:
* <code>class</code>: Defines the "class" of the message box ("mbox" for a standard message box, "alert" for alerts, etc.)
* <code>type</code>: Defines the color of the left border; the type should be chosen according to context, not for aesthetic reasons. Types are described in the next section.
* <code>text</code>: Message to be displayed in the box.
* <code>icon</code>: Icon to be displayed in the box, if provided. Icons appear on the left side of the message box.
* <code>icon size</code>: Size of the icon displayed. Default is 60px.

{{clear}}

=== Types and examples ===

{{Mbox|text=Messagebox of '''delete''' type. Typically used for pages whose content is deprecated or to be deleted.|type=delete}}

{{Mbox|text=Messagebox of '''content''' type. Typically used for pages whose content requires verification or rewriting.|type=content}}

{{Mbox|text=Messagebox of '''style''' type. Typically used for pages whose writing deviates from the wiki's standards.|type=style}}

{{Mbox|text=Messagebox of '''ready''' type. Used to denote wiki features (such as templates) that are ready for use.|type=ready}}

{{Mbox|text=Messagebox of '''notice''' type. Used to denote general notices. Most messageboxes are of this type.|type=notice}}

{{Mbox|text=Messagebox of '''move''' type. Denotes pages that are to be moved.|type=move}}

{{Mbox|text=Messagebox of '''protection''' type. Denotes pages that are protected from editing.|type=protection}}

=== See also ===
* [[Template: Alert]]

User:Ganaram inukshuk

2026-02-02T01:34:55Z

Ganaram inukshuk: /* Contributions */

I generally go by "Ganaram" or some variant of that (ganaram_inukshuk, gdinuk). (Discord: ganaraminukshuk0; he/they; generally more active on the Xen Discord unless work bogs me down.)

I've heard about microtonality on and off over the years, but what drew me into the topic was two things: HEHEHE I AM A SUPAHSTAR SAGA's video series on 19edo and Patricia Taxxon's song Spiral Staircase.

From a compositional perspective, my goal is to incorporate xenharmonic elements into an otherwise normal-sounding song, though my more ambitious goal is to not use the diatonic (LLLsLLs) scale structure at all.

From a theory perspective, my goal is to better understand xenharmony from a temperament-agnostic perspective. This primarily means edos and MOSses, but extends to MV3 scales and higher.

From a wikian perspective, my goal is to better the wiki itself, at least as it pertains to how mos-related info is displayed. The most immediate way to achieve this is to create and deploy templates for the most commonly displayed mos-related info, as well as wikifying any text present (so it looks like an actual wiki page!) and trying to verify the source or attribution to things taken for granted (because misattribution happens concerningly). I've written a style guide to be applied to all mos pages (see subpages below), but I'm also open to better ideas.

== Main mindset ==
I summarize my main mindset using the following trinity: '''temperaments, mosses, and edos are not each other'''.

Temperaments produce mosses, but two different temperaments may produce the same mos. Edos support more than one family of mos, so it's fruitless to shoehorn the notation meant for one mos for a different mos within the same edo. Two temperaments may produce the same JI ratio, but have different qualities in different mosses.

This level of decoupling makes it so I don't let any one temperament, mos, or edo influence how I look at either. Just because a nondiatonic mos has a perfect 5th doesn't mean I should think of it as such, especially if that isn't the generator to begin with.

That said, I focus more on mosses and, secondarily, edos when it comes to this trinity. I prefer to look at scales based in a temperament-agnostic sense, as mosses that are supported by an edo, or different edos. Doing so relieves me of the expectation that a certain interval must necessarily fall within a few cents of a [[Just intonation|JI]] ratio and lets me be more explorative with musical scales. This is also less names to memorize, since there are a lot of temperament names, and looking at mosses directly means fewer names to remember.

Other running assumptions and techniques may be found under the methodologies page below.

== TO-DO list, major contributions, and wish list ==
=== Contributions ===
{| class="wikitable mw-collapsible"
|+ style="font-size: 105%; white-space: nowrap;" | Major work on modules and templates in (roughly) chronological order of inception or involvement
|-
! Modules and templates
! New?
! Description of template or contribution
! Status or todo
|-
| [[Module:SB tree]]
[[Template:SB tree]]
| Yes
| Creates a Stern-Brocot tree's entries and their depths.
| Fallen into disuse.
|-
| [[Module:Scale tree|<s>Module:Scale tree</s>]]
[[Template:Scale tree|<s>Template:Scale tree</s>]]
| No
| Automates the creation of a mos's scale tree and tuning spectrum.
Contributor with CompactStar. (I made it so comments can be entered using one param.)
| '''Deprecated, following changes that made it unmaintainable.'''
Superseded by Module:MOS tuning spectrum.
|-
| [[Module:MOS modes]]
[[Template:MOS modes]]
| Yes
| Displays the modes of a mos.
| Current means of row/col data is not ideal.
Further developments uncertain due to personal decision to halt further improvement.
|-
| [[Module:MOS intro]]
[[Template:MOS intro]]
| Yes
| Creates a consistent, common introductory paragraph for a mos page's lead section.
| '''Possibly rewrite to follow new coding conventions.'''
Rewording for nonoctave tunings.

Deprecate name fields as they're redundant if used with Template:TAMNAMS name.

Possible refactoring.
|-
| [[Module:MOS gamut]]
[[Template:MOS gamut]]
| Yes
| Given a notation scheme and assigned mode for a mos for an edo, display the note names.
| Fallen into disuse.
|-
| <s>[[Module:MOS degrees]]</s>
<s>[[Template:MOS degrees]]</s>
| Yes
| Displays cent values for a mos for up to 5 step ratios.
| '''Deprecated, following decision to start over.'''
Superseded by Module:MOS tunings.
|-
| [[Module:MOS notation]]
| Yes
| Helper module for displaying mos notation.
| Fallen into disuse.
|-
| [[Module:MOS intervals]]
[[Template:MOS intervals]]
| Yes
| Displays the interval names of a mos and their cent ranges.
Rewritten to new coding conventions.
| Experiment with interval lookup.
'''REFACTOR.'''
|-
| [[Module:MOS mode degrees]]
[[Template:MOS mode degrees]]
| Yes
| Displays the qualities of each scale degree of every mode of a mos.
| '''Possibly rewrite to follow new coding conventions.'''
Split modmos info into its own template; see Template:MODMOS mode degrees.

'''REFACTOR.'''
|-
| [[Module:MOS in EDO]]
[[Template:MOS in EDO]]
| Yes
| rowspan="4" | Displays and visualizes the mosses that an edo contains.

* MOS in EDO: shows the mosses created using a particular generator and period.
* ...allgens: shows all mosses for all generators for a particular period.
* ...allperiods or MOSes in EDO: shows all mosses for all generators for all periods.
| rowspan="4" | '''To be rewritten as a subst-template.'''
|-
| [[Module:MOS in EDO allgens]]
[[Template:MOS in EDO allgens]]
| Yes
|-
| [[Module:MOS in EDO allperiods]]
[[Template:MOS in EDO allperiods]]
| Yes
|-
| [[Template:MOSes in EDO]] (shortcut template)
| Yes
|-
| [[Module:Template input parse]]
| Yes
| Helper module for various templates that have large amounts of info to be displayed.
| Possible reorganization?
|-
| [[Module:Step vis]]
[[Template:Step vis]]
| Yes
| Step visualization template for MOS(es) in EDO for standalone use.
| Consider html-based visualization?
|-
| <s>[[Module:EDO intro]]</s>
<s>[[Template:EDO intro]]</s>
| Yes (module only)
| Automation of the EDO intro.
| '''Deprecated.'''

Superseded by Module:ED intro.
|-
| <s>[[Module:JI ratio finder]]</s>
| Yes
| Helper module for JI ratios in ED. Superseded by Module:JI ratios.
| Fallen into disuse, but not officially deprecated.
|-
| [[Module:JI ratios in ED|<s>Module:JI ratios in ED</s>]]
[[Template:JI ratios in ED|<s>Template:JI ratios in ED</s>]]
| Yes
| Creates a table showing the JI ratios approximated by an ED.
| Fallen into disuse, as JI ratio finder was superseded.
|-
| [[Module:Xenpaper]]
| Yes
| For making links to audio examples to be listened to.
|
|-
| [[Module:ED intro]]
[[Template:ED intro]]
| Yes
| Automation of the EDO intro, generalized for other equaves.
| Possible code cleanup.
|-
| [[Template:Idiosyncratic terms]]
| Yes
| An alternative to [[Template:Idiosyncratic]] when the original's use is infeasible.
|
|-
| [[Module:Infobox MOS]]
[[Template:Infobox MOS]]
| No
| Code cleanup and additional info.
Moved 8-link infobox to infobox module.
| '''Possibly rewrite to follow new coding conventions.'''
|-
| [[Module:Infobox]]
| No
| Support for infoboxes with 8 navlinks added.
| '''REFACTOR.'''
|-
| [[Module:Keyboard vis]]
| Yes
| Keyboard visualization template for Infobox MOS. No template currently exists.
| Possibly extend to ternary and quaternary scales.
|-
| [[Template:Mbox]]
| No
| Added the option to show an icon.
|
|-
| [[Template:Quickstart]]
[[Template:Has quickstart]]
| Yes
| For disambiguating pages meant for theory from pages meant for practice, and for linking between them.
| ROLLOUT.
|-
| [[Module:MOS]]
| No
| Splitting TAMNAMS-related stuff to its own module.
Redefining the module into a library for all mos-related templates/modules.
|
|-
| [[Module:TAMNAMS]]
| Yes
| A module that contains the entire TAMNAMS specification as it pertains to mosses and step ratios.
Has lookup functions for names and related mosses.
|
|-
| [[Template:TAMNAMS use]]
| Yes
| Shows that a scale page uses TAMNAMS.
|
|-
| [[Module:MOS genchain]]
[[Template:MOS genchain]]
| Yes
| Shows the generator chain of a mos.
| Dev on hold.
|-
| [[Template:MOS scale properties|<s>Template:MOS scale properties</s>]] (former name)
| rowspan="2" | Yes
| rowspan="2" | Combo template of:

* <s>Template:TAMNAMS use</s>
* Template:MOS intervals
* Template:MOS genchain
* Template:MOS mode degrees
| rowspan="2" | '''Deprecated, following changes that made it unmaintainable.'''
'''No combo templates for mos pages.'''
|-
| [[Module:MOS data|<s>Module:MOS data</s>]]
[[Template:MOS data|<s>Template:MOS data</s>]]
|-
| [[Module:TAMNAMS lookup]]
[[Template:TAMNAMS lookup]]
| Yes
| TAMNAMS name lookup as a standalone template.
| Dev direction unclear.
|-
| [[Template:TAMNAMS name]]
| Yes
| For writing the paragraph that states a mos's TAMNAMS name and its etymology or reasoning.
| ROLLOUT.
|-
| [[Module:MOS interval HE]]
[[Template:MOS interval HE]]
| Yes
| Standalone template for harmonic entropy.
Formerly a part of MOS intervals; added by [[User:R-4981]] but separated due to concerns regarding HE.
| Further developments uncertain.
|-
| [[Module:MOS tunings]]
[[Template:MOS tunings]]
| Yes
| Replacement for Template:MOS degrees.
| '''Rewrite to follow new coding conventions.'''
|-
| [[Template:Nutshell]]
| Yes
| See equivalent template on Wikipedia.
|
|-
| [[Module:JI ratios]]
| Yes
| Module for searching for JI ratios, as well as parsing them from template input.
Replacement for Module:JI ratio finder.
|
|-
| [[Module:Mediants]]
| Yes
| Standalone template for mediant calculations. To be used for the following modules:

* Module:SB tree
* <s>Module:Scale tree</s>
* Module:MOS tuning spectrum
* Module:JI ratios
|
|-
| [[Template:Deprecated parameters]]
| Yes
| A module for denoting one or more deprecated parameters in a template.
|
|-
! colspan="4" | New templates after this line follow new (personal) coding conventions, outlined in v1 of my style guide.
|-
! Modules and templates
! New?
! Description of template or contribution
! Status or todo
|-
| [[Template:Navbox]]
[[Module:Navbox]]
| Yes
| A template and module for producing a navbox. Module builds up navbox from input.
Navboxes can be made either as a template or using a lua module calling the navbox functions.
|Possibly add templatestyles integration
|-
| [[Module:Infobox]]
[[Template:Infobox]]
| Yes (template only)
| Rewrote entire infobox from scratch to support infobox template.
Same as navbox; infoboxes can be made either using a module calling the infobox functions or with a template.
|Possibly add templatestyles integration
|-
| [[Module:Numlinks]]
[[Template:Numlinks]]
|Yes
| A template for calculating and creating prev/next links for a numbered page. Pages are incremented (or decremented) by 1.
| Possibly let template auto-extract text.
|-
| [[Template:MOS tuning spectrum]]
[[Module:MOS tuning spectrum]]
| Yes
| Made to address maintenance issues with Module:Scale tree.
Comment entries are reverted back to having one param per ratio, where params are generated on the fly, not hardocded.
| Add comments for step ratios not found by search.
|-
| [[Template:MOS scalesig]]
[[Module:MOS scalesig]]
| Yes
| Made to address shortcomings with [[Template:Scale link]] and need to format mos scalesigs.
This template auto-formats a scale signature:

* Spaces are replaced with nonbreaking spaces.
* For nonoctave scales, angle brackets are replaced with the appropriate ones.
* Can format the scalesig as a link, if needed.
|
|-
| <s>Template:MOS stub</s>
|
| A proposed combination template consisting of:

* Template:Infobox MOS
* Template:MOS intro
* Template:MOS intervals
* Template:MOS tuning spectrum
Such a template would be a subst-template.
| '''Cancelled. No combo templates for mos pages.'''
|-
|[[Module:JI ratios]]
|Yes
|Rewrite of existing JI ratios module into two modules: one for searching for ratios, and one for filtering ratios
|
|-
|[[Template:Disavowed]]
|Yes
|Denotes terms whose usage is no longer advised, generally due to the name being unsuitable (EG, offensive, inappropriate, etc) or due to the person who coined the term retracting it.
|Use-cases to be determined.
|-
|[[Template:Navbox Lumatone]]
[[Template:Navbox fractional-octave]]
[[Module:Navbar]]
|No
|Decoupling navbar so it doesn't generate navboxes' or their prev/next links; that work is delegated to Template:Numlinks and Template:Navbox.
|
|-
|[[Template:Sidebar]]
[[Module:Sidebar]]
|Yes
|A template that's a basic implementation of Wikipedia's sidebar. Some infobox-like templates use this over the actual infobox, so it's made into an actual template.
|Possibly add templatestyles integration
|-
|[[Module:Template input utils]]
|Yes
|A library for preprocessing template args.
May possibly be a new location for Module:Template input parse (TIP).

Proposed functions:

* numbered_args_to_table(args, key_fmt, max_num)
* header_data_pairs_to_table(args, header_fmt, data_fmt)
* Functions to parse key-value, ratios, and sequences of ratios (from TIP)
|
|-
|[[Template:Numlinks 2-num]]
[[Module:Numlinks 2-num]]
|Yes
|A variant of numlinks that supports two varying numbers. Intended for pages such as mosses, EG 5L 2s.
|
|-
|[[Template:Template rating]]
|Yes
|A template that implements Wikipedia's template/module rating template. Advises editors that the template is one of several things:

* Draft; a mockup of a new template/module that is undergoing testing. Not ready for use anywhere except test pages. (encompasses pre-alpha/alpha/beta/mockup)
* Ready; template/module is ready for use
* Broken; self-explanatory. Definitely do not use until it's either fixed or deemed unfixable.
* Replaced; template is deprecated and has a replacement; template is kept for archival purposes or can be deleted.
* Deprecated; do not use anywhere; template is kept for archival purposes or can be deleted.
|In development
|-
|[[Template:Category handler]]
[[Module:Category handler]]
|Yes
|A proposed template-module pair that is a basic implementation of Wikipedia's module of the same name: https://en.wikipedia.org/wiki/Module:Category_handler
Features:

* Allows templates to categorize pages, given a list of categories

* Suppresses categories based on a list of suppressed namespaces (configurable) and a list of suppressed suffixes (subpages; configurable)
* Module is standalone; it requires no other modules as dependencies, apart from possibly utility modules.
|Attempted in the past by someone else but was deleted.
|-
|[[Template:Todo]]
|No
|Integrate category handler so templates/modules with todos don't get categorized twice (once for the template/module and once more for its /doc page)
|
|-
! colspan="4" |New templates after this line follow new (personal) coding conventions, outlined in v2 of my style guide. Features:
Use of snake_case for ALL param names; previous templates go through template name normalization to maintain backwards-compatibility (automated for lua-based templates)

For lua-based templates, no params will ever be defined at the template level, instead defined at the module level
|-
!Modules and templates
!New?
!Description of template or contribution
!Status or todo
|-
|[[Module:Module introspection]]
[[Template:Module introspection]]
|Yes
| rowspan="3" |A set of modules that inspects mediawiki templates and lua code for:

* (FOR TEMPLATES): detecting whether a template invokes a module's function
* (FOR MODULES): detecting a module's dependencies and the functions used.

Common functionality is stored in Module:Introspection utils. Module introspection serves to implement this functionality for modules; template introspection is handled as part of Module:Dochead.

These templates/changes replace [[Template:Lua]] as used on module docpaegs.
| rowspan="3" |
|-
|[[Module:Template introspection|<s>Module:Template introspection</s>]]
[[Template:Template introspection|<s>Template:Template introspection</s>]]
|Yes
|-
|[[Module:Introspection utils]]
|Yes
|-
|[[Module:Dochead]]
[[Template:Dochead]]
|Yes (module only)
|Proposed module is a rewrite of Template:Dochead that makes the template able to:

* Autodetect modules with corresponding templates, with options for overrides
* Autodetect templates with corresponding modules, with options for overrides
* Display which functions are invoked and from which modules.
These templates/changes replace [[Template:Lua]] as used on template docpages.
|
|-
|All deprecation templates except [[Template:Deprecated parameters]]
|No
|Minor changes to inform editors if they're used in the wrong namespaces.
|
|-
|All categorizing infoboxes:

* [[Template:Infobox MOS]]
* [[Template:Infobox AFDO]]
* [[Template:Infobox chord]]
* [[Template:Infobox ET]]
* [[Template:Infobox interval]]
|No
|Proposal to add [[Module:Category handler]] so these templates automatically categorize themselves when in the correct namespaces
|
|-
|Template:Keyboard vis
|
|See Module:Keyboard vis.
|
|-
| Module:ED ratios
Template:ED ratios
|
| A proposed template that is an upgraded version of Module:JI ratios in ED
|
|-
| Module:Interval regions
|
| A proposed module for roughly classifying diatonic intervals (1st, 2nd etc; major, minor) plus some intermediate or in-between categories ( neutral and interseptimal intervals)
|
|-
| Module:MODMOS mode degrees
Template:MODMOS mode degrees
|
|
|
|-
| Module:MOS superset degrees
Template:MOS superset degrees
|
| Like MOS mode degrees, except the scale degrees are in relation to an ancestor mos.
|
|-
|
|
|
|
|}

=== Wikiprojects and style guides ===
* [[Xenharmonic Wiki:WikiProject Mospage|Project Mospage]] and [[Xenharmonic Wiki:MOS page style guide|mospage style guide]]
* [[User:Ganaram inukshuk/Docpage style guide|Docpage style guide]] (not worthy of a wikiproject since most docpages have been written alraedy)

=== Project mbox-icon ===
Various wikis have custom/themed icons. Apart from exceptions where a more common icon is preferred, why not have custom mbox icons for xenwiki?

=== Other contributions ===
* Mos page standardization (work-in-progress)
* [[Recursive structure of MOS scales|MOS recursion and MOS recursion algorithms]]; tried my best to make the descriptions for MOS recursion apply to all cases (Work-in-progress)
* Some rewording of the [[TAMNAMS]] page for readability and flow. I have a few TAMNAMS-related proposals of my own that aren't quite ready to be called official. See todo list or TAMNAMS subpage.
* [[Horogram|A page for horograms]], since it was totally absent (Work-in-progress).
* [[MOS Scale Family Tree|Mos family tree page]] for a tree I independently discovered before realizing Erv Wilson had already described it. Also has to do with mos recursion.

===To-do list ===
* '''<s>Rewrite page(s)</s> Under jurisdiction of Project Mospage.'''
** [[Operations on MOSes|<s>Operations on MOSes</s>]]
** [[MOS scale|<s>MOS scale</s>]]
** <s>[[TAMNAMS/Appendix]] (primarily for names reasoning and adding general principles)</s>
** <s>[[TAMNAMS Extension]] (since such names should follow the same naming principles as the "named range" names, but no such principles currently exist)</s>
* <s>'''Rewrite all octave-equivalent mos pages.''' This is primarily replacing every scale tree for the corresponding template and rewriting the lead sections to make sense and does not present redundant information already given by one of the templates. To a lesser extent, this also involves trying to confirm temperaments said to be attributed to these mosses, but this step will require additional help.</s> '''Under jurisdiction of Project Mospage.'''
** <s>This is done concurrently with writing a style guide for these pages; see [[User:Ganaram inukshuk/MOS page standardization guide]] for a proposed guide.</s>
** <s>Mosses whose pages have been rewritten to meet the style guide to satisfactory levels (that doesn't mean the pages can't be polished further!):</s>
*** <s>5L 1s</s>
*** <s>5L 2s</s>
*** <s>4L 3s</s>
*** <s>3L 4s</s>
*** <s>2L 5s</s>
*** <s>1L 5s</s>
*** <s>7L 1s</s>
*** <s>3L 7s</s>

* '''Update templates I've made to current coding style/structure''':
** The template calls a wrapper function, meant to be used with template params as input. Its name should be suggestive of the module's primary use, and is usually the same name as the template.
** The wrapper function calls the "main function", which has the code that produces the output. Its name is the same as name as with the wrapper function, except it's prefixed by an underscore.
* Clean up mos recursion page (because I feel bad leaving the algorithms untouched and untested for so long).
** Replace pseudocode for is-this-scale-a-mos? program with python code; clarify with more examples.
** Relate mos recursion with the mos family tree.
** All the recursive algorithms described on that page have time complexities of O(n log n), but the algorithm that generates a Christoffel word (combinatorics-on-words term for the brightest mode of a mos) has a time complexity of O(n). Resolve...?
* Standardize mosinedo pages. Examples include:
** [[List of MOS scales in 12edo]]
** [[List of MOS scales in 17edo]]
** [[List of MOS scales in 29edo]]
** [[List of MOS scales in 31edo]]

=== Wish list ===
* Composing music with these abstract ideas.

== Subpages ==
These pages contain content that currently don't have an exact place elsewhere on the Wiki, or contains personal notes that otherwise don't have an exact place on the Wiki. I do my best to explain these things as though I magically forgot everything I know about xenharmony, so I consider it a bonus if someone else found this easy to understand.
* [[User:Ganaram inukshuk/Diagrams]] – For xen-related diagrams
* [[User:Ganaram inukshuk/Notes]] – For xen-related notes
** [[User:Ganaram inukshuk/Notes/TAMNAMS]] – Since I have so many notes related to TAMNAMS, I made a dedicated page for it
* [[User:Ganaram inukshuk/Tables]] – For xen-related tables
* [[User:Ganaram inukshuk/Code]] – For xen-related code
* [[User:Ganaram inukshuk/Models]] – For xen-related models (needs reorganizing)
* [[User:Ganaram inukshuk/TAMNAMS Extension]] – Since there were others making their own TAMNAMS extension pages, I decided to make my own.
** [[User:Ganaram inukshuk/TAMEX]] – Rewrite of the above page for describing any mos descendant, short for "temperament-agnostic moment-of-symmetry scale extension description system"
** [[User:Ganaram inukshuk/Additional temperament-agnostic mos names]] – Rewrite of the above page for names for proposed names.

These pages are descriptions on how I approach various things, such as compositional techniques and how I approach a scale I've never used before.
* [[User:Ganaram inukshuk/Methodologies]]

Sandbox pages (for testing things)
* [[User:Ganaram inukshuk/Sandbox]]
** [[User:Ganaram inukshuk/Sandbox/JI ratios]]
**[[User:Ganaram inukshuk/Sandbox/Navboxes]]
**[[User:Ganaram inukshuk/Sandbox/Modmosses]]
* [[User:Ganaram inukshuk/Template sandbox]]

Test pages (for proposed rewrites or new templates):
* [[User:Ganaram inukshuk/Catalog of MOS Scales]]
* [[User:Ganaram inukshuk/4L 3s]] (Template test page and test page for style guide)
* [[User:Ganaram inukshuk/5L 2s]] (Template test page and test page for style guide)
** [[User:Ganaram inukshuk/MODMOS scales of 5L 2s]]
* [[User:Ganaram inukshuk/7L 3s]] (Rewrite page)
* [[User:Ganaram inukshuk/TAMNAMS]] (Rewrite page)
** [[User:Ganaram inukshuk/TAMNAMS/Appendix]]
* [[User:Ganaram inukshuk/MOS scale]] (rewrite page)
* [[User:Ganaram inukshuk/Template:Rewrite draft]]
* [[User:Ganaram inukshuk/Template:Template rating]]
* [[User:Ganaram inukshuk/Template:Todo]]

Experimental pages (for content considered idiosyncratic, ad-hoc, or otherwise weird):
* [[User:Ganaram inukshuk/LCP 5L 3s]]

Test templates:
* [[User:Ganaram inukshuk/Template:Mbox]]
* [[User:Ganaram inukshuk/Template:TAMNAMS name]]
* [[User:Ganaram inukshuk/Template:Tcode]]
* [[User:Ganaram inukshuk/Template:Tester]]
* [[User:Ganaram inukshuk/Template:Transcript]]
* [[User:Ganaram inukshuk/Template:Joke page|User:Ganaram inukshuk/Joke page]]
* [[User:Ganaram inukshuk/JI ratios]]
* [[User:Ganaram inukshuk/Template:Navbox fractional-octave]]
* [[User:Ganaram inukshuk/Template:Navbox Lumatone]]

Other:
* [[User:Ganaram inukshuk/Provisional style guide for Lua]]

[[Category:User on Discord]]

Template:Alert

2026-02-01T08:15:40Z

Ganaram inukshuk: a div

<includeonly><templatestyles src="alert/styles.css" />{{mbox
| class=alert
| type={{{type|note}}}
| text={{{text|}}}
| icon={{{icon|}}}
| icon size={{{icon size|20px}}}
}}
</includeonly><noinclude>
{{Documentation}}

[[Category:Alert templates]]
</noinclude>

Module:Dochead

2026-01-31T23:01:59Z

Ganaram inukshuk: autocategorize metatemplates

-- This module follows [[User:Ganaram inukshuk/Provisional style guide for Lua]]
local getArgs = require("Module:Arguments").getArgs
local iutils = require("Module:Introspection utils")
local yesno = require("Module:Yesno")

local p = {}

-- TODO: (Low-ish priority): rewrite to eliminate redundant code

-- Produces a hatnote that is placed on the top of a documentation page (either
-- template or module documentation) and can autodetect and categorize:
-- - FOR MODULES:
-- - whether a module has an accompanying template (overridable/toggleable)
-- - whether a module is meant as a library for other modules
-- - FOR TEMPLATES:
-- - whether a template has an accompanying module (overridable/toggleable)
-- - what functions from which modules are invoked

-- Helper function: categorize modules
local function categorize_module(pagename)
local cats = ""
if pagename:match("/doc$") then
cats = "[[Category:Module documentation]]"
else
cats = "[[Category:Lua modules]]"
end
return cats
end

-- Helper function to handle modules
function p.make_module_hatnote(header, pagename, corr_template, detect_corr_page)
-- Check whether corresponding template exists
-- Then check whether that template invokes the module
local has_template = iutils.page_exists("Template:" .. corr_template:gsub("/doc$", ""))

-- Check whether to use detect_corr_page option
-- If the header option is dualuse, metatemplate, or noinvoke, this option
-- is ignored. For any other option, it's not.
if header ~= "dualuse" and header ~= "metatemplate" and header ~= "noinvoke" then
has_template = has_template and detect_corr_page
end

-- If the module has a template, check for whether it invokes it.
if has_template then
local wikitext = iutils.get_and_preprocess_content("Template", corr_template:gsub("/doc$", ""))
local invokes = iutils.find_invokes(wikitext)
has_template = has_template and iutils.invocation_exists(invokes, pagename:gsub("/doc$", ""))
end

-- Heading meanings and usage on module
-- - dualuse means a template is implement by a module, but its template may
-- be bypassed by using its module directly from other modules.
-- - metatemplate is a special case of dualuse; the template-module pair is
-- for a metatemplate, a template used to build other templates.
-- - noinvoke indicates a lua-based template, but the module's code is so
-- specialized that its code should not be used by other modules or
-- invoked by other templates.
-- - metamodule and library indicate a module whose code is used mainly for
-- other modules. Such modules generally don't have a corresponding
-- template.
-- - data/datamodule indicates a module whose purpose is to provide data
-- values to other modules. Like library modules, these don't have a
-- corresponding template.
-- Does the module have a template?
-- - dualuse, metatemplate, and noinvoke: YES (REQUIRED!!)
-- - metamodule/library and data: GENERALLY NO
local result = ""
if header == "dualuse" then
if has_template then
result = string.format(
"This module may be invoked by templates using its corresponding template [[Template:%s]], or used directly from other modules.",
corr_template:gsub("/doc$", "")
)
else
result = string.format(
"This module has a corresponding template that is currently missing or does not use this module. ([[Special:EditPage/Template:%s|edit template]])",
corr_template:gsub("/doc$", "")
)
end

elseif header == "metatemplate" then
if has_template then
result = string.format(
"This module implements a metatemplate, and may be invoked by templates using its corresponding template [[Template:%s]], or used directly from other modules.",
corr_template:gsub("/doc$", "")
)
else
result = "This module is used to create other Lua-based templates and has no corresponding template."
end

elseif header == "noinvoke" then
if has_template then
result = string.format(
"This module should not be invoked directly; use its corresponding template instead: [[Template:%s]].",
corr_template:gsub("/doc$", "")
)
else
result = string.format(
"This module implements a template that is currently missing or does not use this module. ([[Special:EditPage/Template:%s|edit template]])",
corr_template:gsub("/doc$", "")
)
end

elseif header == "library" or header == "metamodule" then
result = "This module primarily serves as a library for other modules and has no corresponding template."

elseif header == "data" or pagename:gsub("/doc$", ""):match("/data$") then
result = "This module primarily serves to provide data values for other modules and has no corresponding template."

elseif header == "none" then
result = ""

else
if has_template and header ~= "" then
result = string.format("%s This module implements [[Template:%s]].", header, corr_template:gsub("/doc$", ""))
elseif has_template and header == "" then
result = string.format("This module implements [[Template:%s]].", corr_template:gsub("/doc$", ""))
else
result = header
end
end

-- Produce categories
local cats = categorize_module(pagename)

-- Return
if result == "" then
return "" .. cats
else
return string.format(": ''%s''%s\n", result, cats)
end
end

-- Helper function: categorize template
local function categorize_template(pagename, has_invoke, is_metatemplate)
local cats = ""
if pagename:match("/doc$") then
cats = "[[Category:Template documentation]]"
else
cats = "[[Category:Templates]]"
if has_invoke then
cats = cats .. " [[Category:Lua-based templates]]"
end
if is_metatemplate then
cats = cats .. " [[Category:Metatemplates]]"
end
end
return cats
end

-- Helper function
-- Creates an additional hatnote denoting which functions are invoked from which
-- modules, if a has more than one invoke.
local function make_invocation_hatnote(invokes)
local hatnote = ""
if #invokes == 0 then
return ""
else
hatnote = "This template invokes the following functions:"
local calls = {}
for _, call in ipairs(invokes) do
local module_link = iutils.make_module_link(call.module)
table.insert(calls, string.format("'''%s''' from %s", call.func, module_link))
end
return string.format("%s %s.", hatnote, table.concat(calls, ", "))
end
end

-- Helper function to handle templates
function p.make_template_hatnote(header, pagename, corr_module, detect_corr_page)
-- Check whether corresponding module exists
-- Then check whether this template invokes the module
local has_module = iutils.page_exists("Module:" .. corr_module:gsub("/doc$", ""))

-- Check whether to use detect_corr_page option
-- If the header option is dualuse or metatemplate, this option is ignored.
-- For any other option, it's not (although it also has no effect on
-- noinvoke or library/metamodule).
if header ~= "dualuse" and header ~= "metatemplate" then
has_module = has_module and detect_corr_page
end

-- Check for whether the template invokes that module, regardless of whether
-- it uses the corresponding module.
local wikitext = iutils.get_and_preprocess_content("Template", pagename:gsub("/doc$", ""))
local invokes = iutils.find_invokes(wikitext)
local is_module_invoked = iutils.invocation_exists(invokes, corr_module:gsub("/doc$", ""))

-- Heading meanings and usage on templates
-- - dualuse means a template is implement by a module, but its template may
-- be bypassed by using its module directly from other modules.
-- - metatemplate is a special case of dualuse; the template-module pair is
-- for a metatemplate, a template used to build other templates.
-- - noinvoke and metamodule/library don't have use for templates.
-- Does the template have a module?
-- - dualuse and metatemplate: YES (REQUIRED!!)
-- - noinvoke, metamodule/library, and data/datamodule: option's don't apply
-- to templates.
-- RATIONALE FOR NOINVOKE NOT APPLYING: a template may invoke functions from
-- more than one module, but one of them must be the "main" module. Since
-- there's no way to autodetect that, that info must be manually entered.
-- If that doesn't happen
local result = ""
if header == "dualuse" then
if has_module and is_module_invoked then
result = string.format(
"This template is implemented by the Lua module [[Module:%s]]. See its module page for Lua-based template implementation.",
corr_module:gsub("/doc$", "")
)
elseif has_module and not is_module_invoked then
result = string.format(
"This template has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
corr_module:gsub("/doc$", "")
)
else
result = string.format(
"This template is implemented by a module that is currently missing. [[Special:EditPage/Module:%s]]",
corr_module:gsub("/doc$", "")
)
end

elseif header == "metatemplate" then
if has_module and is_module_invoked then
result = string.format(
"This template is a metatemplate. It is used to build other templates and should not be used standalone, except for testing or simple usage. This template is implemented by the Lua module [[Module:%s]].",
corr_module:gsub("/doc$", "")
)
elseif has_module and not is_module_invoked then
result = string.format(
"This metatemplate has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
corr_module:gsub("/doc$", "")
)
else
result = "This template is a metatemplate. It is used to build other templates and should not be used standalone, except for testing or simple usage."
end

elseif header == "noinvoke" or header == "library" or header == "metamodule" or header == "data" or header == "datamodule" then
result = "This template has a header option in the wrong namespace. It should be used within the Module namespace."

else
if has_module and header ~= "" and is_module_invoked then
result = string.format(
"%s. This template is implemented by the Lua module [[Module:%s]].",
header,
corr_module:gsub("/doc$", "")
)
elseif has_module and header ~= "" and not is_module_invoked then
result = string.format(
"%s. This template has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
header,
corr_module:gsub("/doc$", "")
)
elseif has_module and header == "" and is_module_invoked then
result = string.format(
"This template is implemented by the Lua module [[Module:%s]].",
corr_module:gsub("/doc$", "")
)
elseif has_module and header == "" and not is_module_invoked then
result = string.format(
"This template has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
corr_module:gsub("/doc$", "")
)
else
result = header
end
end

-- Find all invocations for the template and add it as an addl hatnote.
local invocation_hatnote = make_invocation_hatnote(invokes)

-- Categorize
local cats = categorize_template(pagename, #invokes > 0, header == "metatemplate")

if header == "none" then
return cats
elseif result == "" and invocation_hatnote == "" then
return ""
elseif result == "" and invocation_hatnote ~= "" then
return string.format(": ''%s''%s\n", invocation_hatnote, cats)
elseif result ~= "" and invocation_hatnote == "" then
return string.format(": ''%s''%s\n", result, cats)
else
return string.format(": ''%s''\n: ''%s'' %s\n", result, invocation_hatnote, cats)
end
end

-- Main function
function p._dochead(args)
local namespace = args["namespace"]
local pagename = args["pagename"]
local header = args["header"] or "none"
local corr_template = args["temp"] or pagename
local corr_module = args["mod"] or pagename
local detect_corr_page = args["detect_corr_page"]

-- If header is none, skip everything
if header == "none" then
--return categorize(namespace, pagename)
end

-- Call appropriate hatnote-making function
-- Remove /doc suffix if this is on a /doc page to ensure links are made
-- properly. :gsub("/doc$", "")
local result = ""
if namespace == "Module" then
result = p.make_module_hatnote(header, pagename, corr_template, detect_corr_page)
elseif namespace == "Template" then
result = p.make_template_hatnote(header, pagename, corr_module, detect_corr_page)
else
result = ": ''This documentation template is in the wrong namespace. It should be within the Template or Module namespaces.''\n"
end

return result
end

-- Wrapper to be invoked
function p.dochead(frame)
local args = getArgs(frame, { removeBlanks = true }) or {}
local title = mw.title.getCurrentTitle()

-- Extract or parse args
args["namespace"] = args["namespace"] or title.nsText
args["pagename" ] = args["pagename" ] or title.text

-- Extract header or set it to defaults
if args["header"] == nil or args["header"] == "" then
if args["namespace"] == "Module" then
args["header"] = "noinvoke"
else
args["header"] = ""
end
end

-- Extract template/module names, or autogenerate them
args["temp"] = args["temp"] or args["pagename"]
args["mod" ] = args["mod" ] or args["pagename"]

-- Option to detect corresponding page (default true)
args["detect_corr_page"] = args["detect_corr_page"] == nil and true or yesno(args["detect_corr_page"])

local result = p._dochead(args)

-- Debugger option to show generated WikiText
local wtext = yesno(frame.args["wtext"] or args["wtext"])

if wtext == true then
result = "<syntaxhighlight lang=\"wikitext\">" .. result .. "</syntaxhighlight>"
end

return frame:preprocess(result)
end

function p.tester()
local args = {}

args["namespace"] = "Template"
args["pagename" ] = "Module introspection"

args["temp"] = args["pagename"]
args["mod" ] = args["pagename"]

args["header"] = ""

return p._dochead(args)
end

return p

Module:Utils/doc

2025-11-25T04:28:35Z

Ganaram inukshuk:

{{Documentation|{{dochead|header=library}}
This module provides several mathematical functions which are likely to be used frequently on the Xenharmonic Wiki.

Namely, the functions in this module can be called from other modules by using <code>require("Module:Utils")</code> and calling the desired functions.

For pairs of functions with names that differ by a single leading underscore (for example, <code>gcd</code> and <code>_gcd</code>), the function ''with'' an underscore is meant to be called by other modules, and the function ''without'' an underscore can be used with <code>#invoke</code>.

{{Module introspection
| desc_trim = Removes leading and trailing whitespaces (but not interior ones) from a string.
| desc__yesno = Wrapper function for [[Module:Yesno]], for use with templates. (Module:Yesno does not have a corresponding template.)
| desc__clamp = Returns <code>val</code> such that it is between <code>min_val</code> and <code>max_val</code>.
| desc_table_contains = Checks whether table <code>tbl</code> contains <code>value</code> and returns <code>true</code> (if found) or <code>false</code> if not found. Passing <code>compare_func</code> is optional. By default, <code>value</code> is a numeric value or a string; to check for other values, such as ratios defined by [[Module:Rational]], a comparison function <code>compare_func</code> must be passed in.
| desc_index_of = Returns the first index with the given <code>value</code> (or nil if not found). Passing <code>compare_func</code> is optional. By default, <code>value</code> is a numeric value or a string; to check for other values, such as ratios defined by [[Module:Rational]], a comparison function <code>compare_func</code> must be passed in.
| desc_value_provided = Checks whether <code>s</code> is a non-empty string.
| desc_eval_num_arg = Evaluates <code>input</code> as a number, fraction notation supported but not other expressions; uses <code>def_value</code> on error.
| desc_log = Returns the logarithm base <code>b</code> of <code>x</code>. Parameter <code>b</code> defaults to base 2 (octave) if it is omitted.
| desc_gcd = Returns the greatest common divisor of <code>a</code> and <code>b</code>.
| desc_round_dec = Returns <code>x</code> rounded to a precision of <code>places</code> decimal places. Parameter <code>places</code> defaults to 0 if it is omitted.
| desc_round = Returns <code>x</code> rounded to a precision of <code>prec</code> significant figures. Parameter <code>prec</code> defaults to 6 if it is omitted.
| desc_is_prime = Returns <code>true</code> if the given integer <code>n</code> is a prime number.
| desc_prime_factorization = Returns the prime factorization of the given integer <code>n</code> using the exponential form (in wikitext).
| desc_prime_factorization_raw = Returns a table encoding the prime factorization of <code>n</code>.
| desc_signum = Returns 1 for positive numbers, −1 for negative ones, and 0 for zero and non-integer inputs.
| desc_next_young_diagram = Returns the next Young diagram of the same size; the first one is <code>[N]</code>, the last one is <code>[1, 1, …, 1]</code>. After the last one, <code>nil</code> is returned. The input table is modified.
| desc_log2 = Returns the base-2 logarithm of <code>x</code>.
| desc__log = Lua-only implementation of <code>log</code>.
| desc__gcd = Lua-only implementation of <code>gcd</code>.
| desc__round_dec = Lua-only implementation of <code>round_dec</code>.
| desc__round = Lua-only implementation of <code>round</code>.
| desc__prime_factorization = Lua-only implementation of <code>prime_factorization</code>.
}}
}}

Module:Utils/doc

2025-11-25T04:27:59Z

Ganaram inukshuk:

Module:Utils/doc

2025-11-25T04:26:10Z

Ganaram inukshuk: add descriptions for other functions

{{Documentation|{{dochead|header=library}}
This module provides several mathematical functions which are likely to be used frequently on the Xenharmonic Wiki.

Namely, the functions in this module can be called from other modules by using <code>require("Module:Utils")</code> and calling the desired functions.

For pairs of functions with names that differ by a single leading underscore (for example, <code>gcd</code> and <code>_gcd</code>), the function ''with'' an underscore is meant to be called by other modules, and the function ''without'' an underscore can be used with <code>#invoke</code>.

{{Module introspection
| desc_trim = Removes leading and trailing whitespaces (but not interior ones) from a string.
| desc__yesno = Wrapper function for [[Module:Yesno]], for use with templates. (Module:Yesno does not have a corresponding template.)
| desc__clamp = Returns <code>val</code> such that it is between <code>min_val</code> and <code>max_val</code>.
| desc_table_contains = Checks whether table <code>tbl</code> contains <code>value</code> and returns <code>true</code> (if found) or <code>false</code> if not found. Passing <code>compare_func</code> is optional. By default, <code>value</code> is a numeric value or a string; to check for other values, such as ratios defined by [[Module:Rational]], a comparison function <code>compare_func</code> must be passed in.
| desc_index_of = Returns the first index with the given <code>value</code> (or nil if not found). Passing <code>compare_func</code> is optional. By default, <code>value</code> is a numeric value or a string; to check for other values, such as ratios defined by [[Module:Rational]], a comparison function <code>compare_func</code> must be passed in.
| desc_value_provided = Checks whether <code>s</code> is a non-empty string.
| desc_eval_num_arg = Evaluates <code>input</code> as a number, fraction notation supported but not other expressions; uses <code>def_value</code> on error.
| desc_log = Returns the logarithm base <code>b</code> of <code>x</code>. Parameter <code>b</code> defaults to base 2 (octave) if it is omitted.
| desc_gcd = Returns the greatest common divisor of <code>a</code> and <code>b</code>.
| desc_round_dec = Returns <code>x</code> rounded to a precision of <code>places</code> decimal places. Parameter <code>places</code> defaults to 0 if it is omitted.
| desc_round = Returns <code>x</code> rounded to a precision of <code>prec</code> significant figures. Parameter <code>prec</code> defaults to 6 if it is omitted.
| desc_is_prime = Returns <code>true</code> if the given integer <code>n</code> is a prime number.
| desc_prime_factorization = Returns the prime factorization of the given integer <code>n</code> using the exponential form (in wikitext).
| desc_prime_factorization_raw = Returns a table encoding the prime factorization of <code>n</code>.
| desc_signum = Returns 1 for positive numbers, −1 for negative ones, and 0 for zero and non-integer inputs.
| desc_next_young_diagram = Returns the next Young diagram of the same size; the first one is <code>[N]</code>, the last one is <code>[1, 1, …, 1]</code>. After the last one, <code>nil</code> is returned. The input table is modified.}}
| desc_log2 = Returns the base-2 logarithm of <code>x</code>.
| desc__log = Lua-only implementation of <code>log</code>.
| desc__gcd = Lua-only implementation of <code>gcd</code>.
| desc__round_dec = Lua-only implementation of <code>round_dec</code>.
| desc__round = Lua-only implementation of <code>round</code>.
| desc__prime_factorization = Lua-only implementation of <code>prime_factorization</code>.
}}

Module:Utils/doc

2025-11-25T04:19:48Z

Ganaram inukshuk: clarify; transfer all function descriptions to module introspection

{{Documentation|{{dochead|header=library}}
This module provides several mathematical functions which are likely to be used frequently on the Xenharmonic Wiki.

Namely, the functions in this module can be called from other modules by using <code>require("Module:Utils")</code> and calling the desired functions.

For pairs of functions with names that differ by a single leading underscore (for example, <code>gcd</code> and <code>_gcd</code>), the function ''with'' an underscore is meant to be called by other modules, and the function ''without'' an underscore can be used with <code>#invoke</code>.

{{Module introspection
| desc_trim = Removes leading and trailing whitespaces (but not interior ones) from a string.
| desc__yesno = Wrapper function for [[Module:Yesno]], for use with templates. (Module:Yesno does not have a corresponding template.)
| desc_table_contains = Checks whether table <code>tbl</code> contains <code>value</code> and returns <code>true</code> (if found) or <code>false</code> if not found. Passing <code>compare_func</code> is optional. By default, <code>value</code> is a numeric value or a string; to check for other values, such as ratios defined by [[Module:Rational]], a comparison function <code>compare_func</code> must be passed in.
| desc_index_of = Returns the first index with the given <code>value</code> (or nil if not found). Passing <code>compare_func</code> is optional. By default, <code>value</code> is a numeric value or a string; to check for other values, such as ratios defined by [[Module:Rational]], a comparison function <code>compare_func</code> must be passed in.
| desc_value_provided = Checks whether <code>s</code> is a non-empty string.
| desc_eval_num_arg = Evaluates <code>input</code> as a number, fraction notation supported but not other expressions; uses <code>def_value</code> on error.
| desc_log = Returns the logarithm base <code>b</code> of <code>x</code>. Parameter <code>b</code> defaults to base 2 (octave) if it is omitted.
| desc_gcd = Returns the greatest common divisor of <code>a</code> and <code>b</code>.
| desc_round_dec = Returns <code>x</code> rounded to a precision of <code>places</code> decimal places. Parameter <code>places</code> defaults to 0 if it is omitted.
| desc_round = Returns <code>x</code> rounded to a precision of <code>prec</code> significant figures. Parameter <code>prec</code> defaults to 6 if it is omitted.
| desc_is_prime = Returns <code>true</code> if the given integer <code>n</code> is a prime number.
| desc_prime_factorization = Returns the prime factorization of the given integer <code>n</code> using the exponential form (in wikitext).
| desc_prime_factorization_raw = Returns a table encoding the prime factorization of <code>n</code>.
| desc_signum = Returns 1 for positive numbers, −1 for negative ones, and 0 for zero and non-integer inputs.
| desc_next_young_diagram = Returns the next Young diagram of the same size; the first one is <code>[N]</code>, the last one is <code>[1, 1, …, 1]</code>. After the last one, <code>nil</code> is returned. The input table is modified.}}

}}

Module:Utils/doc

2025-11-25T04:10:15Z

Ganaram inukshuk:

{{Documentation|{{dochead|header=library}}
This module provides several mathematical functions which are likely to be used frequently on the Xenharmonic Wiki.

Namely, the functions in this module can be called from other modules by using <code>require("Module:Utils")</code> and calling the desired functions.

For pairs of functions with names that differ by a single leading underscore (for example, <code>gcd</code> and <code>_gcd</code>), the function ''with'' an underscore is meant to be called by other modules, and the function ''without'' an underscore can be used with <code>#invoke</code>.

{{Module introspection
| desc_trim = Removes leading and trailing whitespaces (but not interior ones) from a string.
| desc__yesno = Wrapper function for [[Module:Yesno]], for use with templates. }}

=== Functions ===

; <code>_clamp(val, min_val, max_val)</code>
: Returns <code>val</code> such that it's between <code>min_val</code> and <code>max_val</code>.

; <code>table_contains(tbl, value, compare_func)</code> *
: Checks whether table <code>tbl</code> contains <code>value</code>. Passing in <code>compare_func</code> is optional; if <code>value</code> is a table and <code>tbl</code> a table of tables, pass in a comparison function <code>compare_func</code>, which returns <code>true</code> if <code>value</code> and an element in <code>tbl</code> have the same value.{{clarify}}

; <code>index_of(array, value, compare_func)</code> *
: Returns the first index with the given <code>value</code> (or nil if not found). Passing in <code>compare_func</code> is optional; if <code>value</code> is a table and <code>tbl</code> a table of tables, pass in a comparison function <code>compare_func</code>, which returns <code>true</code> if <code>value</code> and an element in <code>tbl</code> have the same value.{{clarify}}

; <code>value_provided(s)</code> *
: Checks if <code>s</code> is a non-empty string.

; <code>eval_num_arg(input, def_value)</code> *
: Evaluates <code>input</code> as a number, fraction notation supported but not other expressions; uses <code>def_value</code> on error.

; <code>log(x, b)</code>
: Returns the logarithm base <code>b</code> of <code>x</code>. Parameter <code>b</code> defaults to base 2 (octave) if it is omitted.

; <code>gcd(a, b)</code>
: Returns the greatest common divisor of <code>a</code> and <code>b</code>.

; <code>round_dec(x, places)</code>
: Returns <code>x</code> rounded to a precision of <code>places</code> decimal places. Parameter <code>places</code> defaults to 0 if it is omitted.

; <code>round(x, prec)</code>
: Returns <code>x</code> rounded to a precision of <code>prec</code> significant figures. Parameter <code>prec</code> defaults to 6 if it is omitted.

; <code>is_prime(n)</code>*
: Returns <code>true</code> if the given integer <code>n</code> is a prime number.

; <code>prime_factorization(n)</code>
: Returns the prime factorization of the given integer <code>n</code> using the exponential form (in wikitext).

; <code>prime_factorization_raw(n)</code> *
: Returns a table encoding the prime factorization of <code>n</code>.

; <code>signum(x)</code> *
: Returns 1 for positive numbers, −1 for negative ones, and 0 for zero and non-integer inputs.

; <code>next_young_diagram(d)</code>
: Returns the next Young diagram of the same size; the first one is <code>[N]</code>, the last one is <code>[1, 1, …, 1]</code>. After the last one, <code>nil</code> is returned. The input table is modified.

<nowiki>*</nowiki> These functions are designed to be used by other modules only; they cannot be called with <code><nowiki>{{#invoke: }}</nowiki></code>.

}}

Module:Utils/doc

2025-11-25T04:09:35Z

Ganaram inukshuk: Partially transfer function descriptions to module introspection

{{Documentation|{{dochead|header=library}}
This module provides several mathematical functions which are likely to be used frequently on the Xenharmonic Wiki.

Namely, the functions in this module can be called from other modules by using <code>require("Module:Utils")</code> and calling the desired functions.

For pairs of functions with names that differ by a single leading underscore (for example, <code>gcd</code> and <code>_gcd</code>), the function ''with'' an underscore is meant to be called by other modules, and the function ''without'' an underscore can be used with <code>#invoke</code>.

{{Module introspection
| desc_trim = Removes leading and trailing whitespaces (but not interior ones) from a string.
| desc_yesno = Wrapper function for [[Module:Yesno]], for use with templates. }}

=== Functions ===

; <code>_clamp(val, min_val, max_val)</code>
: Returns <code>val</code> such that it's between <code>min_val</code> and <code>max_val</code>.

; <code>table_contains(tbl, value, compare_func)</code> *
: Checks whether table <code>tbl</code> contains <code>value</code>. Passing in <code>compare_func</code> is optional; if <code>value</code> is a table and <code>tbl</code> a table of tables, pass in a comparison function <code>compare_func</code>, which returns <code>true</code> if <code>value</code> and an element in <code>tbl</code> have the same value.{{clarify}}

; <code>index_of(array, value, compare_func)</code> *
: Returns the first index with the given <code>value</code> (or nil if not found). Passing in <code>compare_func</code> is optional; if <code>value</code> is a table and <code>tbl</code> a table of tables, pass in a comparison function <code>compare_func</code>, which returns <code>true</code> if <code>value</code> and an element in <code>tbl</code> have the same value.{{clarify}}

; <code>value_provided(s)</code> *
: Checks if <code>s</code> is a non-empty string.

; <code>eval_num_arg(input, def_value)</code> *
: Evaluates <code>input</code> as a number, fraction notation supported but not other expressions; uses <code>def_value</code> on error.

; <code>log(x, b)</code>
: Returns the logarithm base <code>b</code> of <code>x</code>. Parameter <code>b</code> defaults to base 2 (octave) if it is omitted.

; <code>gcd(a, b)</code>
: Returns the greatest common divisor of <code>a</code> and <code>b</code>.

; <code>round_dec(x, places)</code>
: Returns <code>x</code> rounded to a precision of <code>places</code> decimal places. Parameter <code>places</code> defaults to 0 if it is omitted.

; <code>round(x, prec)</code>
: Returns <code>x</code> rounded to a precision of <code>prec</code> significant figures. Parameter <code>prec</code> defaults to 6 if it is omitted.

; <code>is_prime(n)</code>*
: Returns <code>true</code> if the given integer <code>n</code> is a prime number.

; <code>prime_factorization(n)</code>
: Returns the prime factorization of the given integer <code>n</code> using the exponential form (in wikitext).

; <code>prime_factorization_raw(n)</code> *
: Returns a table encoding the prime factorization of <code>n</code>.

; <code>signum(x)</code> *
: Returns 1 for positive numbers, −1 for negative ones, and 0 for zero and non-integer inputs.

; <code>next_young_diagram(d)</code>
: Returns the next Young diagram of the same size; the first one is <code>[N]</code>, the last one is <code>[1, 1, …, 1]</code>. After the last one, <code>nil</code> is returned. The input table is modified.

<nowiki>*</nowiki> These functions are designed to be used by other modules only; they cannot be called with <code><nowiki>{{#invoke: }}</nowiki></code>.

}}

User:Ganaram inukshuk/Provisional style guide for Lua

2025-11-06T21:14:11Z

Ganaram inukshuk:

The following style guide is a personal, provisional guide adapted from the LuaRocks style guide: https://github.com/luarocks/lua-style-guide

Parts of it are adapted for use on the wiki, with details on specific conventions. If a specific convention is missing, fall back to that described in the Luarocks style guide.

== Provisional additions for version 2 ==
Consistency with param names, including spelling:

* Define all param names at the module level, not the template level
* Use snake_case for all param names throughout; anything remotely close to snake_case is normalized to snake_case
* "debug" and "nocat" are reserved for toggling categories; the use of "debug" this way has already been the standard

== Preliminaries ==

=== Indentation and formatting ===
The in-browser Lua editor uses tabs for indenting, which equates to 4 spaces.

=== Naming and declaring variables ===

Variable names should be short and descriptive, written in <code>snake_case</code>. Exceptions to this include counter variables, like with <code>i</code> in for loops. Boolean variables are prefixed with <code>is_</code> or <code>has_</code> wherever possible. Constants are named using <code>TRAIN_CASE</code>.

All variable declarations should start with <code>local</code>.

=== Strings ===

Strings are enclosed in double quotes <code>" "</code>. If a string contains double quotes, do not escape them while enclosing the string in double quotes, as this reduces readability; instead, enclose the string in single quotes <code>' '</code>. Escape characters for quotes should only be used if the string contains both single and double quotes.

'''Preferred'''
<syntaxhighlight lang="lua">local sentence = "That's his cheese quesadilla!"
local quotation = "And he said to me, \"One man's trash is another man's treasure.\""
</syntaxhighlight>

'''Avoid'''
<syntaxhighlight lang="lua">local formatting = "padding: 0.25em 0.5em; border: 1px solid white;\" colspan="2\" | "
</syntaxhighlight>

=== Line lengths ===

The 80-column limit should be observed wherever possible for both comments and code, except for cases where strings, inline comments, or function calls are too long.

<syntaxhighlight lang="lua">
local function navbox_title()
if not title then return "" end
local has_navbar = name ~= nil

return "|-\n" ..
'! style="text-align: center; background-color: #eaecf0; white-space: nowrap; margin: 0em 4em 0em 4em;' ..
'padding: 0.25em 0.5em; border: 1px solid white;" colspan="2" | ' ..
'' ..
(has_navbar and navbar(name, "mini", "") or "") .. '' ..
'' .. title .. '' ..
(is_collapsible and '' or ' ')
end
</syntaxhighlight>

=== Naming, declaring, and calling functions ===

As with variables, functions are named using <code>snake_case</code>. Functions that return a boolean variable are prefixed with <code>is_</code> or <code>has_</code>.

''tbd''

=== Comments in code ===

Well-commented code should speak for itself. Self-documenting code can only go so far, so comments should be used to briefly describe what the function does. If a module has several types of functions, comments can also be used as section separators.

TODOs are allowed in comments. Separating TODOs into the module's documentation page makes code harder to maintain.

=== Commented-out code ===

Only block comments <code> --[[ ]]-- </code> should only be used for commented-out code. This can be hard to do if a string contains a <code>]]</code>, so <code>--</code> may be used instead.

== Conventions for Lua modules ==

=== Boilerplate code ===
Alphabetize dependencies, except for p, which goes last and separated by a line. Equals signs may be lined up.

'''Preferred order'''<syntaxhighlight lang="lua" line="1">local mos = require("Module:MOS")
local rat = require("Module:Rational")
local utils = require("Module:Utils")

local p = {}</syntaxhighlight>'''Avoid'''<syntaxhighlight lang="lua" line="1">
local p = {}
local mos = require("Module:MOS")
local rat = require("Module:Rational")
local utils = require("Module:Utils")
</syntaxhighlight><syntaxhighlight lang="lua" line="1">
local p = {}
local rat = require("Module:Rational")
local mos = require("Module:MOS")
local utils = require("Module:Utils")
</syntaxhighlight>

=== Placement of comments and TODO comments ===
Comments may be placed before modules as a preface, inline with modules to describe what each module does, and after the boilerplate code as a descripion. TODO comments should be placed before the code's description for ease of access.

TODO comments should not be confused with the todo categories, nor should such code-based TODOs ever be placed in [[Template:Todo]]; placing such tasks in the template makes it harder to maintain code and mixes up code-based tasks with wiki-based tasks.<syntaxhighlight lang="lua" line="1">-- Preface goes here
local mos = require("Module:MOS") -- For mos scale functions
local rat = require("Module:Rational") -- For JI ratio calculations
local utils = require("Module:Utils") -- Contains the gcd function

local p = {}

-- TODO goes here, if any

-- Description goes here</syntaxhighlight>
=== Use of functions ===

===== Modules that implement templates =====
Modules that implement templates should consist of at least two functions: a "main" function prefixed with an underscore, and a wrapper function of the same name but without an underscore.

The use of a wrapper and "main" function allows for a module to be used directly in another module or indirectly through its corresponding template. A module should only provide '''one''' wrapper for '''one''' template. If the "main" function is short enough, its code may be merged with the wrapper function.

A tester function may be added for testing purposes, which is itself a wrapper that also calls the "main" function. This allows it to be tested using the in-browser console by calling mw.logObject(p.tester()). Tester functions may be removed if the "main" function is determined to be functional under expected conditions.<syntaxhighlight lang="lua">-- "Main" function to be called by wrapper or another module
function p._call_me(args)
return "something" .. args["something"]
end

-- Wrapper function; to be called by template using {{#invoke}}
function p.call_me(frame)
return p._call_me(frame.args)
end

-- Tester function; test wrapper that calls the "main" function
function p.tester()
local args = { ["something"] = 123 }
return p._call_me(args)
end</syntaxhighlight><syntaxhighlight lang="lua">-- Wrapper function; to be called by template
function p.call_me(frame)
local arg = frame.args["arg"]

-- Code goes here

return call_me(arg)
end</syntaxhighlight>

==== Modules that serve as libraries ====
Modules that serve as libraries for other modules do not need a wrapper function, apart from the tester. Examples include [[Module:MOS]], [[Module:Rational]], and [[Module:Utils]].

Modules that serve as libraries for multiple, related templates may provide multiple wrapper functions. If a module provides multiple wrappers that each call a corresponding function, the name of the function called within the wrapper must be prefixed with an underscore.<syntaxhighlight lang="lua">-- MAIN FUNCTIONS
-- Usable by other modules

function p._call_me(arg1, arg2, arg3)
-- Code goes here
end

function p._truncate(arg1)
-- Code goes here
end

-- WRAPPER FUNCTIONS
-- Usable by templates with {{#invoke}}

function p._call_me(frame)
return p._clamp(frame.args["arg1"], frame.args["arg2"], frame.args["arg3"])
end

function p.truncate(frame)
return p._truncate(frame.args["arg1"])
end</syntaxhighlight>Modules that only provide one function may simply consist of that function as a return value. Example: [[Module:Yesno]].

==== Helper functions ====
For code readability and code reusability within the module, the use of helper functions is recommended.

Ideally, helper functions should be nested within the calling function if those helpers only serve that function, but this rule may be disregarded for testing purposes, or for helper functions needed by more than one function. Nested functions have access to the variables and parameters of the outer function, so an equivalent nested function may require fewer parameters.<syntaxhighlight lang="lua">function p._call_me(args)
-- Get args here
local arg1 = args["Arg 1"]
local arg2 = args["Arg 2"]

-- Helper function
function helper_function(some_value)
return "result" .. some_value
end
end</syntaxhighlight>

==== What to pass into a "main" function ====
For an underscore-prefixed "main" function, if its expected inputs is determined to be fixed (for example, no new features are expected to ever be added), the function may accept them individually.<syntaxhighlight lang="lua">-- "Main" function to be called by wrapper or another module
-- Function signature consists of three args and the return value (not shown)
function p._call_me(arg1, arg2, arg3)
-- Code goes here
end</syntaxhighlight>If there is large amounts of input, or if the number of inputs is not known, the function should have a single parameter that is a table of passed-in arguments. This allows for expansion of the template's inputs without making the function signature any larger.<syntaxhighlight lang="lua">
-- "Main" function to be called by wrapper or another module
-- Function signature consists of one table and the output (not shown)
function p._call_me(args)
-- Get args here
local arg1 = args["args1"]
local arg2 = args["args2"]
local arg3 = args["args3"]

-- Code goes here
end
</syntaxhighlight>

==== What to get out of a function ====
Most functions should return something (a value, a string, a table, or more than one of those things), with the exception of functions that change the contents of a table. Modules that implement templates typically return a string that represents something that can be interpreted as wikitext. Guidance on how to create such strings is explained in later sections.

=== Concatenating strings ===

When concatenating long strings, it is best practice to insert constituent strings into a table, then concatenate afterwards. https://www.lua.org/pil/11.6.html

This rule does not apply to concatenating a few small strings together.

'''Preferred'''<syntaxhighlight lang="lua">
local lines = {}
table.insert(lines, '{| class="wikitable"')
table.insert(lines, '|+ Caption text')
table.insert(lines, '|-')
table.insert(lines, '! Header 1')
table.insert(lines, '! Header 2')
table.insert(lines, '! Header 3')
table.insert(lines, '|-')
table.insert(lines, '| aa')
table.insert(lines, '| bb')
table.insert(lines, '| cc')
table.insert(lines, '|-')
table.insert(lines, '| dd')
table.insert(lines, '| ee')
table.insert(lines, '| ff')
table.insert(lines, '|}')

return table.concat(lines, '\n')
</syntaxhighlight>'''Avoid'''<syntaxhighlight lang="lua">
local result = '{| class="wikitable"\n'
.. '|+ Caption text\n'
.. '|-\n'
.. '! Header 1\n'
.. '! Header 2\n'
.. '! Header 3\n'
.. '|-\n'
.. '| aa\n'
.. '| bb\n'
.. '| cc\n'
.. '|-\n'
.. '| dd\n'
.. '| ee\n'
.. '| ff\n'
.. '|}\n'
</syntaxhighlight>'''Allowed''' (although an alternative to this exists by using <code>string.format()</code>)<syntaxhighlight lang="lua">
local table_line = "Number of steps: " .. tonumber(num_steps) .. " steps"
</syntaxhighlight>

=== Mediawiki table formatting ===
Wikitables should be written with one line per cell instead of one line per row. This is for ease-of-reading when debugging the output of a module-generated table. Add a space between pipes/exclamation points and table entries to avoid accidentally adding new rows, such as when inputting negative numbers. Mediawiki tables generated using Lua code must follow this convention.

'''Preferred'''<syntaxhighlight lang="wikitext">{| class="wikitable"
|+ Caption text
|-
! Header 1
! Header 2
! Header 3
|-
| aa
| bb
| cc
|-
| dd
| ee
| ff
|}</syntaxhighlight>

'''Avoid'''

<syntaxhighlight lang="wikitext">{| class="wikitable"
|+ Caption text
|-
! Header 1 !! Header 2 !! Header 3
|-
| aa || bb || cc
|-
| dd || ee || ff
|}
</syntaxhighlight>

=== <code>ipairs</code> versus <code>pairs</code> versus <code>for</code> loop ===

<syntaxhighlight lang="lua">
local sometable = { "egg", "bread", "banana", nil, "milk" }

-- As a for loop
-- Order is guaranteed, but where to stop and start is needed
-- Iterates through all numeric indices, even if values are nil
for i = 1, #sometable do
-- Code goes here
end

-- As a for loop using ipairs
-- Order is guaranteed, in ascending order
-- Iterates through numeric keys/indices, but stops at the first value of nil encountered
-- Obviates using sometable[i], as value has the same... value
for index, value in ipairs(sometable) do
-- Code goes here
end

-- As a for loop using pairs
-- Order is not guaranteed
-- Iterates through numeric and non-numeric keys
for key, value in pairs(sometable) do
-- Code goes here
end
</syntaxhighlight>

== Templates and modules ==

=== Param names ===
Capitalized, short, and descriptive parameter names are preferred wherever possible, such as <code>Scale Signature</code>, and not <code>scalesig</code> or <code>ssg</code>.

Non-capitalized parameter names are used for debugging, testing, or meta-use (parameters used to build other templates and typically would never be seen in normal use), such as <code>name</code> and <code>debug</code>. Templates with simple usage can use non-capitalized parameter names throughout.

Template:Module introspection

2025-11-06T21:09:20Z

Ganaram inukshuk: template should have no params defined at the template level; it can all be done at the module level

<includeonly>{{#invoke: Module introspection | module_introspection}}</includeonly><noinclude>
{{documentation}}

[[Category:Documentation templates]]
</noinclude>

Module:Module introspection

2025-11-06T21:07:22Z

Ganaram inukshuk: for consistency, "debug" should be used for toggling categories; either rename this or use special:expandtemplates

-- This module follows [[User:Ganaram inukshuk/Provisional style guide for Lua]]
local getArgs = require("Module:Arguments").getArgs
local iutils = require("Module:Introspection utils")

local p = {}

-- Helper function
-- Given the output of the above function, create a mediawiki table
function p.make_dependency_table(module_deps)

-- Table headers
local lines = {}
table.insert(lines, '{| class="wikitable sortable"')
table.insert(lines, "|+ style=\"font-size: 105%;\" | Lua modules required " .. string.format("(%d)", #module_deps))
table.insert(lines, "|-")
table.insert(lines, "! Variable")
table.insert(lines, "! Module")
table.insert(lines, "! Functions used")

-- Table rows (assuming they're all alphabetized)
for _, info in ipairs(module_deps) do
local funcs_text
if #info.funcs == 0 then
funcs_text = "''dependency not used''"
else
local func_lines = {}
for _, func in ipairs(info.funcs) do
table.insert(func_lines, string.format("<code>%s</code>", func))
end
funcs_text = table.concat(func_lines, " ")
end

table.insert(lines, "|-")
table.insert(lines, "| " .. info.var)
table.insert(lines, "| [[" .. info.dep .. "]]")
table.insert(lines, "| " .. funcs_text)
end

-- Table footer
table.insert(lines, "|}")

-- Join all lines into a single string
return table.concat(lines, "\n")
end

-- Helper function
-- Lists module's own functions; requires module name to produce links to each
-- function.
function p.make_function_table(module_name, module_funcs, descriptions, main_function)

-- Check whether descriptions was passed in
local has_descriptions = false
if type(descriptions) == "table" then
for _, _ in pairs(descriptions) do
has_descriptions = true
break
end
end

-- Table headers
local lines = {}
--table.insert(lines, string.format("'''Module:%s''' provides %d function(s):", module_name, #module_funcs))
table.insert(lines, '{| class="wikitable sortable"')
table.insert(lines, "|+ style=\"font-size: 105%;\" | Functions provided " .. string.format("(%d)", #module_funcs))
table.insert(lines, "|-")
table.insert(lines, "! Line")
table.insert(lines, "! Function")
table.insert(lines, "! Params")

-- If there are descriptions, add a column for that
if has_descriptions then
table.insert(lines, "! Description")
end

-- Table rows
for _, info in ipairs(module_funcs) do

-- Find params for that function, or say "none" if none
local params = {}
for _, param in ipairs(info.params) do
table.insert(params, param)
end
local params_string = ""
if #params == 0 then
params_string = "''none''"
else
params_string = string.format("<code>(%s)</code>", table.concat(params, ", "))
end

-- Create link to line for that function
local line_num = string.format("[[Module:%s#L-%d|%d]]", module_name, info.line, info.line)

-- Create text for function
local func = ""
if info.name then
func = string.format("<code>%s</code>", info.name)
else
func = "''none''"
end

-- If the function is the main function, add "main" to that cell
if info.name == main_function then
func = func .. " '''(main)'''"
end

-- If the function is invokable (it has one param called "frame"), add
-- "invokable" to that cell
if #params == 1 and params[1] == "frame" then
func = func .. " '''(invokable)'''"
end

table.insert(lines, "|-")
table.insert(lines, "| " .. line_num)
table.insert(lines, "| " .. func)
table.insert(lines, "| " .. params_string)

if has_descriptions then
table.insert(lines, "| " .. (descriptions[info.name] or ""))
end
end
table.insert(lines, "|}")

return table.concat(lines, "\n")
end

-- Main function; to be called by wrapper
function p._module_introspection(args)
local args = args or {}
local module_name = args["module_name" ]
local main_function = args["main_function"]
local descriptions = args["descriptions" ]
local is_doc = args["is_doc"]

-- Check whether this page is a docpage
-- If so, don't bother
if is_doc then
return "''To see introspection summary, see this module's main page.''"
end

-- Preprocess module and blank-out comments
--local title = mw.title.new('Module:' .. module_name)
--local code = title:getContent()
--code = iutils.preprocess_code(code) -- Blank-out comments
local code = iutils.get_and_preprocess_content("Module", module_name)

-- Get dependencies and their functions used, then build a table
local module_deps = iutils.find_dependencies(code)
local dep_table = p.make_dependency_table(module_deps)

-- Get module's functions, then build a table using that information
local module_funcs = iutils.find_functions(code)
local func_table = p.make_function_table(module_name, module_funcs, descriptions, main_function)

-- Return the tables
-- Styling may be improved at a later time
local lines = {
'{| class="wikitable mw-collapsible"',
'|-',
'! colspan="2" style="font-size: 105%;" | Introspection summary for Module:' .. module_name .. " ",
"|-",
'| style="vertical-align: top; border-right: none;"; |',
func_table,
'| style="vertical-align: top; border-left: none;" |',
dep_table,
"|}"
}

-- Check whether descriptions was passed in
local has_descriptions = false
if type(descriptions) == "table" then
for _, _ in pairs(descriptions) do
has_descriptions = true
break
end
end

-- If no descriptions were provided, add text below that points to the code.
if not has_descriptions then
table.insert(lines, "''No function descriptions were provided. The Lua code may have further information.''")
end

return table.concat(lines, "\n")
end

-- Wrapper function for modules
function p.module_introspection(frame)
-- Extract arguments using getArgs
local args = getArgs(frame) or {}

-- Get module name from arguments, or default to current page
local module_name = args["module_name"] or mw.title.getCurrentTitle().text

-- Strip trailing "/doc" if the template is used on a documentation subpage
--module_name = module_name:gsub("/doc$", "")

-- Check whether page is the doc page
-- To ensure proper referencing, do not display introspection on a docpage.
local is_doc = string.find(module_name, "/doc$")

-- Normalize module name so it can be used to find the main function, which
-- is assumed to be the same name as the module. Module assumes snake_case
-- is used for function names. (If this fails, it can be entered manually.)
local normalized_name = module_name:gsub("[^%w]", "_"):lower()
local main_function = args["main_function"] or "_" .. normalized_name

-- Process all function descriptions, if provided as desc_function_name
local func_descriptions = {}
for key, val in pairs(args) do
local func_name = key:match("^desc_([%w_]+)$")
if func_name and val and val ~= "" then
func_descriptions[func_name] = val
end
end

-- Return
local result = p._module_introspection({
["module_name" ] = module_name,
["main_function"] = main_function,
["descriptions" ] = func_descriptions,
["is_doc"] = is_doc
})

return frame:preprocess(result)
end

return p

Module:Dochead

2025-11-03T09:18:58Z

Ganaram inukshuk: quick and dirty fix to add none header back

-- This module follows [[User:Ganaram inukshuk/Provisional style guide for Lua]]
local getArgs = require("Module:Arguments").getArgs
local iutils = require("Module:Introspection utils")
local yesno = require("Module:Yesno")

local p = {}

-- TODO: (Low-ish priority): rewrite to eliminate redundant code

-- Produces a hatnote that is placed on the top of a documentation page (either
-- template or module documentation) and can autodetect and categorize:
-- - FOR MODULES:
-- - whether a module has an accompanying template (overridable/toggleable)
-- - whether a module is meant as a library for other modules
-- - FOR TEMPLATES:
-- - whether a template has an accompanying module (overridable/toggleable)
-- - what functions from which modules are invoked

-- Helper function: categorize modules
local function categorize_module(pagename)
local cats = ""
if pagename:match("/doc$") then
cats = "[[Category:Module documentation]]"
else
cats = "[[Category:Lua modules]]"
end
return cats
end

-- Helper function to handle modules
function p.make_module_hatnote(header, pagename, corr_template, detect_corr_page)
-- Check whether corresponding template exists
-- Then check whether that template invokes the module
local has_template = iutils.page_exists("Template:" .. corr_template:gsub("/doc$", ""))

-- Check whether to use detect_corr_page option
-- If the header option is dualuse, metatemplate, or noinvoke, this option
-- is ignored. For any other option, it's not.
if header ~= "dualuse" and header ~= "metatemplate" and header ~= "noinvoke" then
has_template = has_template and detect_corr_page
end

-- If the module has a template, check for whether it invokes it.
if has_template then
local wikitext = iutils.get_and_preprocess_content("Template", corr_template:gsub("/doc$", ""))
local invokes = iutils.find_invokes(wikitext)
has_template = has_template and iutils.invocation_exists(invokes, pagename:gsub("/doc$", ""))
end

-- Heading meanings and usage on module
-- - dualuse means a template is implement by a module, but its template may
-- be bypassed by using its module directly from other modules.
-- - metatemplate is a special case of dualuse; the template-module pair is
-- for a metatemplate, a template used to build other templates.
-- - noinvoke indicates a lua-based template, but the module's code is so
-- specialized that its code should not be used by other modules or
-- invoked by other templates.
-- - metamodule and library indicate a module whose code is used mainly for
-- other modules. Such modules generally don't have a corresponding
-- template.
-- - data/datamodule indicates a module whose purpose is to provide data
-- values to other modules. Like library modules, these don't have a
-- corresponding template.
-- Does the module have a template?
-- - dualuse, metatemplate, and noinvoke: YES (REQUIRED!!)
-- - metamodule/library and data: GENERALLY NO
local result = ""
if header == "dualuse" then
if has_template then
result = string.format(
"This module may be invoked by templates using its corresponding template [[Template:%s]], or used directly from other modules.",
corr_template:gsub("/doc$", "")
)
else
result = string.format(
"This module has a corresopnding template that is currently missing or does not use this module. ([[Special:EditPage/Template:%s|edit template]])",
corr_template:gsub("/doc$", "")
)
end

elseif header == "metatemplate" then
if has_template then
result = string.format(
"This module implements a metatemplate, and may be invoked by templates using its corresponding template [[Template:%s]], or used directly from other modules.",
corr_template:gsub("/doc$", "")
)
else
result = "This module is used to create other Lua-based templates and has no corresponding template."
end

elseif header == "noinvoke" then
if has_template then
result = string.format(
"This module should not be invoked directly; use its corresponding instead: [[Template:%s]].",
corr_template:gsub("/doc$", "")
)
else
result = string.format(
"This module implements a template that is currently missing or does not use this module. ([[Special:EditPage/Template:%s|edit template]])",
corr_template:gsub("/doc$", "")
)
end

elseif header == "library" or header == "metamodule" then
result = "This module primarily serves as a library for other modules and has no corresponding template."

elseif header == "data" or pagename:gsub("/doc$", ""):match("/data$") then
result = "This module primarily serves to provide data values for other modules and has no corresponding template."

elseif header == "none" then
result = ""

else
if has_template and header ~= "" then
result = string.format("%s This module implements [[Template:%s]].", header, corr_template:gsub("/doc$", ""))
elseif has_template and header == "" then
result = string.format("This module implements [[Template:%s]].", corr_template:gsub("/doc$", ""))
else
result = header
end
end

-- Produce categories
local cats = categorize_module(pagename)

-- Return
if result == "" then
return "" .. cats
else
return string.format(":''%s''%s\n", result, cats)
end
end

-- Helper function: categorize template
local function categorize_template(pagename, has_invoke)
local cats = ""
if pagename:match("/doc$") then
cats = "[[Category:Template documentation]]"
else
cats = "[[Category:Templates]]"
if has_invoke then
cats = cats .. " [[Category:Lua-based templates]]"
end
end
return cats
end

-- Helper function
-- Creates an additional hatnote denoting which functions are invoked from which
-- modules, if a has more than one invoke.
local function make_invocation_hatnote(invokes)
local hatnote = ""
if #invokes == 0 then
return ""
else
hatnote = "This template invokes the following functions:"
local calls = {}
for _, call in ipairs(invokes) do
local module_link = iutils.make_module_link(call.module)
table.insert(calls, string.format("'''%s''' from %s", call.func, module_link))
end
return string.format("%s %s.", hatnote, table.concat(calls, ", "))
end
end

-- Helper function to handle templates
function p.make_template_hatnote(header, pagename, corr_module, detect_corr_page)
-- Check whether corresponding module exists
-- Then check whether this template invokes the module
local has_module = iutils.page_exists("Module:" .. corr_module:gsub("/doc$", ""))

-- Check whether to use detect_corr_page option
-- If the header option is dualuse or metatemplate, this option is ignored.
-- For any other option, it's not (although it also has no effect on
-- noinvoke or library/metamodule).
if header ~= "dualuse" and header ~= "metatemplate" then
has_module = has_module and detect_corr_page
end

-- Check for whether the template invokes that module, regardless of whether
-- it uses the corresponding module.
local wikitext = iutils.get_and_preprocess_content("Template", pagename:gsub("/doc$", ""))
local invokes = iutils.find_invokes(wikitext)
local is_module_invoked = iutils.invocation_exists(invokes, corr_module:gsub("/doc$", ""))

-- Heading meanings and usage on templates
-- - dualuse means a template is implement by a module, but its template may
-- be bypassed by using its module directly from other modules.
-- - metatemplate is a special case of dualuse; the template-module pair is
-- for a metatemplate, a template used to build other templates.
-- - noinvoke and metamodule/library don't have use for templates.
-- Does the template have a module?
-- - dualuse and metatemplate: YES (REQUIRED!!)
-- - noinvoke, metamodule/library, and data/datamodule: option's don't apply
-- to templates.
-- RATIONALE FOR NOINVOKE NOT APPLYING: a template may invoke functions from
-- more than one module, but one of them must be the "main" module. Since
-- there's no way to autodetect that, that info must be manually entered.
-- If that doesn't happen
local result = ""
if header == "dualuse" then
if has_module and is_module_invoked then
result = string.format(
"This template is implemented by the Lua module [[Module:%s]]. See its module page for Lua-based template implementation.",
corr_module:gsub("/doc$", "")
)
elseif has_module and not is_module_invoked then
result = string.format(
"This template has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
corr_module:gsub("/doc$", "")
)
else
result = string.format(
"This template is implemented by a module that is currently missing. [[Special:EditPage/Module:%s]]",
corr_module:gsub("/doc$", "")
)
end

elseif header == "metatemplate" then
if has_module and is_module_invoked then
result = string.format(
"This template is a metatemplate. It is used to build other templates and should not be used standalone, except for testing or simple usage. This template is implemented by the Lua module [[Module:%s]].",
corr_module:gsub("/doc$", "")
)
elseif has_module and not is_module_invoked then
result = string.format(
"This metatemplate has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
corr_module:gsub("/doc$", "")
)
else
result = "This template is a metatemplate. It is used to build other templates and should not be used standalone, except for testing or simple usage."
end

elseif header == "noinvoke" or header == "library" or header == "metamodule" or header == "data" or header == "datamodule" then
result = "This template has a header option in the wrong namespace. It should be used within the Module namespace."

else
if has_module and header ~= "" and is_module_invoked then
result = string.format(
"%s. This template is implemented by the Lua module [[Module:%s]].",
header,
corr_module:gsub("/doc$", "")
)
elseif has_module and header ~= "" and not is_module_invoked then
result = string.format(
"%s. This template has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
header,
corr_module:gsub("/doc$", "")
)
elseif has_module and header == "" and is_module_invoked then
result = string.format(
"This template is implemented by the Lua module [[Module:%s]].",
corr_module:gsub("/doc$", "")
)
elseif has_module and header == "" and not is_module_invoked then
result = string.format(
"This template has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
corr_module:gsub("/doc$", "")
)
else
result = header
end
end

-- Find all invocations for the template and add it as an addl hatnote.
local invocation_hatnote = make_invocation_hatnote(invokes)

-- Categorize
local cats = categorize_template(pagename, #invokes > 0)

if header == "none" then
return cats
elseif result == "" and invocation_hatnote == "" then
return ""
elseif result == "" and invocation_hatnote ~= "" then
return string.format(":''%s''%s\n", invocation_hatnote, cats)
elseif result ~= "" and invocation_hatnote == "" then
return string.format(":''%s''%s\n", result, cats)
else
return string.format(":''%s''\n:''%s''%s\n", result, invocation_hatnote, cats)
end
end

-- Main function
function p._dochead(args)
local namespace = args["namespace"]
local pagename = args["pagename"]
local header = args["header"] or "none"
local corr_template = args["temp"] or pagename
local corr_module = args["mod"] or pagename
local detect_corr_page = args["detect_corr_page"]

-- If header is none, skip everything
if header == "none" then
--return categorize(namespace, pagename)
end

-- Call appropriate hatnote-making function
-- Remove /doc suffix if this is on a /doc page to ensure links are made
-- properly. :gsub("/doc$", "")
local result = ""
if namespace == "Module" then
result = p.make_module_hatnote(header, pagename, corr_template, detect_corr_page)
elseif namespace == "Template" then
result = p.make_template_hatnote(header, pagename, corr_module, detect_corr_page)
else
result = ":''This documentation template is in the wrong namespace. It should be within the Template or Module namespaces.''\n"
end

return result
end

-- Wrapper to be invoked
function p.dochead(frame)
local args = getArgs(frame, { removeBlanks = true }) or {}
local title = mw.title.getCurrentTitle()

-- Extract or parse args
args["namespace"] = args["namespace"] or title.nsText
args["pagename" ] = args["pagename" ] or title.text

-- Extract header or set it to defaults
if args["header"] == nil or args["header"] == "" then
if args["namespace"] == "Module" then
args["header"] = "noinvoke"
else
args["header"] = ""
end
end

-- Extract template/module names, or autogenerate them
args["temp"] = args["temp"] or args["pagename"]
args["mod" ] = args["mod" ] or args["pagename"]

-- Option to detect corresponding page (default true)
args["detect_corr_page"] = args["detect_corr_page"] == nil and true or yesno(args["detect_corr_page"])

return p._dochead(args)
end

function p.tester()
local args = {}

args["namespace"] = "Template"
args["pagename" ] = "Module introspection"

args["temp"] = args["pagename"]
args["mod" ] = args["pagename"]

args["header"] = ""

return p._dochead(args)
end

return p

Module:Dochead

2025-11-02T02:21:28Z

Ganaram inukshuk: temporarily disable categories for none header, pending a proper fix

-- This module follows [[User:Ganaram inukshuk/Provisional style guide for Lua]]
local getArgs = require("Module:Arguments").getArgs
local iutils = require("Module:Introspection utils")
local yesno = require("Module:Yesno")

local p = {}

-- TODO: (Low-ish priority): rewrite to eliminate redundant code

-- Produces a hatnote that is placed on the top of a documentation page (either
-- template or module documentation) and can autodetect and categorize:
-- - FOR MODULES:
-- - whether a module has an accompanying template (overridable/toggleable)
-- - whether a module is meant as a library for other modules
-- - FOR TEMPLATES:
-- - whether a template has an accompanying module (overridable/toggleable)
-- - what functions from which modules are invoked

-- Helper function: categorize modules
local function categorize_module(pagename)
local cats = ""
if pagename:match("/doc$") then
cats = "[[Category:Module documentation]]"
else
cats = "[[Category:Lua modules]]"
end
return cats
end

-- Helper function to handle modules
function p.make_module_hatnote(header, pagename, corr_template, detect_corr_page)
-- Check whether corresponding template exists
-- Then check whether that template invokes the module
local has_template = iutils.page_exists("Template:" .. corr_template:gsub("/doc$", ""))

-- Check whether to use detect_corr_page option
-- If the header option is dualuse, metatemplate, or noinvoke, this option
-- is ignored. For any other option, it's not.
if header ~= "dualuse" and header ~= "metatemplate" and header ~= "noinvoke" then
has_template = has_template and detect_corr_page
end

-- If the module has a template, check for whether it invokes it.
if has_template then
local wikitext = iutils.get_and_preprocess_content("Template", corr_template:gsub("/doc$", ""))
local invokes = iutils.find_invokes(wikitext)
has_template = has_template and iutils.invocation_exists(invokes, pagename:gsub("/doc$", ""))
end

-- Heading meanings and usage on module
-- - dualuse means a template is implement by a module, but its template may
-- be bypassed by using its module directly from other modules.
-- - metatemplate is a special case of dualuse; the template-module pair is
-- for a metatemplate, a template used to build other templates.
-- - noinvoke indicates a lua-based template, but the module's code is so
-- specialized that its code should not be used by other modules or
-- invoked by other templates.
-- - metamodule and library indicate a module whose code is used mainly for
-- other modules. Such modules generally don't have a corresponding
-- template.
-- - data/datamodule indicates a module whose purpose is to provide data
-- values to other modules. Like library modules, these don't have a
-- corresponding template.
-- Does the module have a template?
-- - dualuse, metatemplate, and noinvoke: YES (REQUIRED!!)
-- - metamodule/library and data: GENERALLY NO
local result = ""
if header == "dualuse" then
if has_template then
result = string.format(
"This module may be invoked by templates using its corresponding template [[Template:%s]], or used directly from other modules.",
corr_template:gsub("/doc$", "")
)
else
result = string.format(
"This module has a corresopnding template that is currently missing or does not use this module. ([[Special:EditPage/Template:%s|edit template]])",
corr_template:gsub("/doc$", "")
)
end

elseif header == "metatemplate" then
if has_template then
result = string.format(
"This module implements a metatemplate, and may be invoked by templates using its corresponding template [[Template:%s]], or used directly from other modules.",
corr_template:gsub("/doc$", "")
)
else
result = "This module is used to create other Lua-based templates and has no corresponding template."
end

elseif header == "noinvoke" then
if has_template then
result = string.format(
"This module should not be invoked directly; use its corresponding instead: [[Template:%s]].",
corr_template:gsub("/doc$", "")
)
else
result = string.format(
"This module implements a template that is currently missing or does not use this module. ([[Special:EditPage/Template:%s|edit template]])",
corr_template:gsub("/doc$", "")
)
end

elseif header == "library" or header == "metamodule" then
result = "This module primarily serves as a library for other modules and has no corresponding template."

elseif header == "data" or pagename:gsub("/doc$", ""):match("/data$") then
result = "This module primarily serves to provide data values for other modules and has no corresponding template."

else
if has_template and header ~= "" then
result = string.format("%s This module implements [[Template:%s]].", header, corr_template:gsub("/doc$", ""))
elseif has_template and header == "" then
result = string.format("This module implements [[Template:%s]].", corr_template:gsub("/doc$", ""))
else
result = header
end
end

-- Produce categories
local cats = categorize_module(pagename)

-- Return
if result == "" then
return "" .. cats
else
return string.format(":''%s''%s\n", result, cats)
end
end

-- Helper function: categorize template
local function categorize_template(pagename, has_invoke)
local cats = ""
if pagename:match("/doc$") then
cats = "[[Category:Template documentation]]"
else
cats = "[[Category:Templates]]"
if has_invoke then
cats = cats .. " [[Category:Lua-based templates]]"
end
end
return cats
end

-- Helper function
-- Creates an additional hatnote denoting which functions are invoked from which
-- modules, if a has more than one invoke.
local function make_invocation_hatnote(invokes)
local hatnote = ""
if #invokes == 0 then
return ""
else
hatnote = "This template invokes the following functions:"
local calls = {}
for _, call in ipairs(invokes) do
local module_link = iutils.make_module_link(call.module)
table.insert(calls, string.format("'''%s''' from %s", call.func, module_link))
end
return string.format("%s %s.", hatnote, table.concat(calls, ", "))
end
end

-- Helper function to handle templates
function p.make_template_hatnote(header, pagename, corr_module, detect_corr_page)
-- Check whether corresponding module exists
-- Then check whether this template invokes the module
local has_module = iutils.page_exists("Module:" .. corr_module:gsub("/doc$", ""))

-- Check whether to use detect_corr_page option
-- If the header option is dualuse or metatemplate, this option is ignored.
-- For any other option, it's not (although it also has no effect on
-- noinvoke or library/metamodule).
if header ~= "dualuse" and header ~= "metatemplate" then
has_module = has_module and detect_corr_page
end

-- Check for whether the template invokes that module, regardless of whether
-- it uses the corresponding module.
local wikitext = iutils.get_and_preprocess_content("Template", pagename:gsub("/doc$", ""))
local invokes = iutils.find_invokes(wikitext)
local is_module_invoked = iutils.invocation_exists(invokes, corr_module:gsub("/doc$", ""))

-- Heading meanings and usage on templates
-- - dualuse means a template is implement by a module, but its template may
-- be bypassed by using its module directly from other modules.
-- - metatemplate is a special case of dualuse; the template-module pair is
-- for a metatemplate, a template used to build other templates.
-- - noinvoke and metamodule/library don't have use for templates.
-- Does the template have a module?
-- - dualuse and metatemplate: YES (REQUIRED!!)
-- - noinvoke, metamodule/library, and data/datamodule: option's don't apply
-- to templates.
-- RATIONALE FOR NOINVOKE NOT APPLYING: a template may invoke functions from
-- more than one module, but one of them must be the "main" module. Since
-- there's no way to autodetect that, that info must be manually entered.
-- If that doesn't happen
local result = ""
if header == "dualuse" then
if has_module and is_module_invoked then
result = string.format(
"This template is implemented by the Lua module [[Module:%s]]. See its module page for Lua-based template implementation.",
corr_module:gsub("/doc$", "")
)
elseif has_module and not is_module_invoked then
result = string.format(
"This template has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
corr_module:gsub("/doc$", "")
)
else
result = string.format(
"This template is implemented by a module that is currently missing. [[Special:EditPage/Module:%s]]",
corr_module:gsub("/doc$", "")
)
end

elseif header == "metatemplate" then
if has_module and is_module_invoked then
result = string.format(
"This template is a metatemplate. It is used to build other templates and should not be used standalone, except for testing or simple usage. This template is implemented by the Lua module [[Module:%s]].",
corr_module:gsub("/doc$", "")
)
elseif has_module and not is_module_invoked then
result = string.format(
"This metatemplate has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
corr_module:gsub("/doc$", "")
)
else
result = "This template is a metatemplate. It is used to build other templates and should not be used standalone, except for testing or simple usage."
end

elseif header == "noinvoke" or header == "library" or header == "metamodule" or header == "data" or header == "datamodule" then
result = "This template has a header option in the wrong namespace. It should be used within the Module namespace."

else
if has_module and header ~= "" and is_module_invoked then
result = string.format(
"%s. This template is implemented by the Lua module [[Module:%s]].",
header,
corr_module:gsub("/doc$", "")
)
elseif has_module and header ~= "" and not is_module_invoked then
result = string.format(
"%s. This template has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
header,
corr_module:gsub("/doc$", "")
)
elseif has_module and header == "" and is_module_invoked then
result = string.format(
"This template is implemented by the Lua module [[Module:%s]].",
corr_module:gsub("/doc$", "")
)
elseif has_module and header == "" and not is_module_invoked then
result = string.format(
"This template has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
corr_module:gsub("/doc$", "")
)
else
result = header
end
end

-- Find all invocations for the template and add it as an addl hatnote.
local invocation_hatnote = make_invocation_hatnote(invokes)

-- Categorize
local cats = categorize_template(pagename, #invokes > 0)

if result == "" and invocation_hatnote == "" then
return ""
elseif result == "" and invocation_hatnote ~= "" then
return string.format(":''%s''%s\n", invocation_hatnote, cats)
elseif result ~= "" and invocation_hatnote == "" then
return string.format(":''%s''%s\n", result, cats)
else
return string.format(":''%s''\n:''%s''%s\n", result, invocation_hatnote, cats)
end
end

-- Main function
function p._dochead(args)
local namespace = args["namespace"]
local pagename = args["pagename"]
local header = args["header"] or "none"
local corr_template = args["temp"] or pagename
local corr_module = args["mod"] or pagename
local detect_corr_page = args["detect_corr_page"]

-- If header is none, skip everything
if header == "none" then
--return categorize(namespace, pagename)
end

-- Call appropriate hatnote-making function
-- Remove /doc suffix if this is on a /doc page to ensure links are made
-- properly. :gsub("/doc$", "")
local result = ""
if namespace == "Module" then
result = p.make_module_hatnote(header, pagename, corr_template, detect_corr_page)
elseif namespace == "Template" then
result = p.make_template_hatnote(header, pagename, corr_module, detect_corr_page)
else
result = ":''This documentation template is in the wrong namespace. It should be within the Template or Module namespaces.''\n"
end

return result
end

-- Wrapper to be invoked
function p.dochead(frame)
local args = getArgs(frame, { removeBlanks = true }) or {}
local title = mw.title.getCurrentTitle()

-- Extract or parse args
args["namespace"] = args["namespace"] or title.nsText
args["pagename" ] = args["pagename" ] or title.text

-- Extract header or set it to defaults
if args["header"] == nil or args["header"] == "" then
if args["namespace"] == "Module" then
args["header"] = "noinvoke"
else
args["header"] = ""
end
end

-- Extract template/module names, or autogenerate them
args["temp"] = args["temp"] or args["pagename"]
args["mod" ] = args["mod" ] or args["pagename"]

-- Option to detect corresponding page (default true)
args["detect_corr_page"] = args["detect_corr_page"] == nil and true or yesno(args["detect_corr_page"])

return p._dochead(args)
end

function p.tester()
local args = {}

args["namespace"] = "Template"
args["pagename" ] = "Module introspection"

args["temp"] = args["pagename"]
args["mod" ] = args["pagename"]

args["header"] = ""

return p._dochead(args)
end

return p

User:Ganaram inukshuk

2025-11-01T07:24:07Z

Ganaram inukshuk:

I generally go by "Ganaram" or some variant of that (ganaram_inukshuk, gdinuk). (Discord: ganaraminukshuk0; he/they; generally more active on the Xen Discord unless work bogs me down.)

I've heard about microtonality on and off over the years, but what drew me into the topic was two things: HEHEHE I AM A SUPAHSTAR SAGA's video series on 19edo and Patricia Taxxon's song Spiral Staircase.

From a compositional perspective, my goal is to incorporate xenharmonic elements into an otherwise normal-sounding song, though my more ambitious goal is to not use the diatonic (LLLsLLs) scale structure at all.

From a theory perspective, my goal is to better understand xenharmony from a temperament-agnostic perspective. This primarily means edos and MOSses, but extends to MV3 scales and higher.

From a wikian perspective, my goal is to better the wiki itself, at least as it pertains to how mos-related info is displayed. The most immediate way to achieve this is to create and deploy templates for the most commonly displayed mos-related info, as well as wikifying any text present (so it looks like an actual wiki page!) and trying to verify the source or attribution to things taken for granted (because misattribution happens concerningly). I've written a style guide to be applied to all mos pages (see subpages below), but I'm also open to better ideas.

== Main mindset ==
I summarize my main mindset using the following trinity: '''temperaments, mosses, and edos are not each other'''.

Temperaments produce mosses, but two different temperaments may produce the same mos. Edos support more than one family of mos, so it's fruitless to shoehorn the notation meant for one mos for a different mos within the same edo. Two temperaments may produce the same JI ratio, but have different qualities in different mosses.

This level of decoupling makes it so I don't let any one temperament, mos, or edo influence how I look at either. Just because a nondiatonic mos has a perfect 5th doesn't mean I should think of it as such, especially if that isn't the generator to begin with.

That said, I focus more on mosses and, secondarily, edos when it comes to this trinity. I prefer to look at scales based in a temperament-agnostic sense, as mosses that are supported by an edo, or different edos. Doing so relieves me of the expectation that a certain interval must necessarily fall within a few cents of a [[Just intonation|JI]] ratio and lets me be more explorative with musical scales. This is also less names to memorize, since there are a lot of temperament names, and looking at mosses directly means fewer names to remember.

Other running assumptions and techniques may be found under the methodologies page below.

== TO-DO list, major contributions, and wish list ==
=== Contributions ===
{| class="wikitable mw-collapsible"
|+ style="font-size: 105%; white-space: nowrap;" | Major work on modules and templates in (roughly) chronological order of inception or involvement
|-
! Modules and templates
! New?
! Description of template or contribution
! Status or todo
|-
| [[Module:SB tree]]
[[Template:SB tree]]
| Yes
| Creates a Stern-Brocot tree's entries and their depths.
| Fallen into disuse.
|-
| [[Module:Scale tree|<s>Module:Scale tree</s>]]
[[Template:Scale tree|<s>Template:Scale tree</s>]]
| No
| Automates the creation of a mos's scale tree and tuning spectrum.
Contributor with CompactStar. (I made it so comments can be entered using one param.)
| '''Deprecated, following changes that made it unmaintainable.'''
Superseded by Module:MOS tuning spectrum.
|-
| [[Module:MOS modes]]
[[Template:MOS modes]]
| Yes
| Displays the modes of a mos.
| Current means of row/col data is not ideal.
Further developments uncertain due to personal decision to halt further improvement.
|-
| [[Module:MOS intro]]
[[Template:MOS intro]]
| Yes
| Creates a consistent, common introductory paragraph for a mos page's lead section.
| '''Possibly rewrite to follow new coding conventions.'''
Rewording for nonoctave tunings.

Deprecate name fields as they're redundant if used with Template:TAMNAMS name.

Possible refactoring.
|-
| [[Module:MOS gamut]]
[[Template:MOS gamut]]
| Yes
| Given a notation scheme and assigned mode for a mos for an edo, display the note names.
| Fallen into disuse.
|-
| <s>[[Module:MOS degrees]]</s>
<s>[[Template:MOS degrees]]</s>
| Yes
| Displays cent values for a mos for up to 5 step ratios.
| '''Deprecated, following decision to start over.'''
Superseded by Module:MOS tunings.
|-
| [[Module:MOS notation]]
| Yes
| Helper module for displaying mos notation.
| Fallen into disuse.
|-
| [[Module:MOS intervals]]
[[Template:MOS intervals]]
| Yes
| Displays the interval names of a mos and their cent ranges.
Rewritten to new coding conventions.
| Experiment with interval lookup.
'''REFACTOR.'''
|-
| [[Module:MOS mode degrees]]
[[Template:MOS mode degrees]]
| Yes
| Displays the qualities of each scale degree of every mode of a mos.
| '''Possibly rewrite to follow new coding conventions.'''
Split modmos info into its own template; see Template:MODMOS mode degrees.

'''REFACTOR.'''
|-
| [[Module:MOS in EDO]]
[[Template:MOS in EDO]]
| Yes
| rowspan="4" | Displays and visualizes the mosses that an edo contains.

* MOS in EDO: shows the mosses created using a particular generator and period.
* ...allgens: shows all mosses for all generators for a particular period.
* ...allperiods or MOSes in EDO: shows all mosses for all generators for all periods.
| rowspan="4" | '''To be rewritten as a subst-template.'''
|-
| [[Module:MOS in EDO allgens]]
[[Template:MOS in EDO allgens]]
| Yes
|-
| [[Module:MOS in EDO allperiods]]
[[Template:MOS in EDO allperiods]]
| Yes
|-
| [[Template:MOSes in EDO]] (shortcut template)
| Yes
|-
| [[Module:Template input parse]]
| Yes
| Helper module for various templates that have large amounts of info to be displayed.
| Possible reorganization?
|-
| [[Module:Step vis]]
[[Template:Step vis]]
| Yes
| Step visualization template for MOS(es) in EDO for standalone use.
| Consider html-based visualization?
|-
| <s>[[Module:EDO intro]]</s>
<s>[[Template:EDO intro]]</s>
| Yes (module only)
| Automation of the EDO intro.
| '''Deprecated.'''

Superseded by Module:ED intro.
|-
| <s>[[Module:JI ratio finder]]</s>
| Yes
| Helper module for JI ratios in ED. Superseded by Module:JI ratios.
| Fallen into disuse, but not officially deprecated.
|-
| [[Module:JI ratios in ED|<s>Module:JI ratios in ED</s>]]
[[Template:JI ratios in ED|<s>Template:JI ratios in ED</s>]]
| Yes
| Creates a table showing the JI ratios approximated by an ED.
| Fallen into disuse, as JI ratio finder was superseded.
|-
| [[Module:Xenpaper]]
| Yes
| For making links to audio examples to be listened to.
|
|-
| [[Module:ED intro]]
[[Template:ED intro]]
| Yes
| Automation of the EDO intro, generalized for other equaves.
| Possible code cleanup.
|-
| [[Template:Idiosyncratic terms]]
| Yes
| An alternative to [[Template:Idiosyncratic]] when the original's use is infeasible.
|
|-
| [[Module:Infobox MOS]]
[[Template:Infobox MOS]]
| No
| Code cleanup and additional info.
Moved 8-link infobox to infobox module.
| '''Possibly rewrite to follow new coding conventions.'''
|-
| [[Module:Infobox]]
| No
| Support for infoboxes with 8 navlinks added.
| '''REFACTOR.'''
|-
| [[Module:Keyboard vis]]
| Yes
| Keyboard visualization template for Infobox MOS. No template currently exists.
| Possibly extend to ternary and quaternary scales.
|-
| [[Template:Mbox]]
| No
| Added the option to show an icon.
|
|-
| [[Template:Quickstart]]
[[Template:Has quickstart]]
| Yes
| For disambiguating pages meant for theory from pages meant for practice, and for linking between them.
| ROLLOUT.
|-
| [[Module:MOS]]
| No
| Splitting TAMNAMS-related stuff to its own module.
Redefining the module into a library for all mos-related templates/modules.
|
|-
| [[Module:TAMNAMS]]
| Yes
| A module that contains the entire TAMNAMS specification as it pertains to mosses and step ratios.
Has lookup functions for names and related mosses.
|
|-
| [[Template:TAMNAMS use]]
| Yes
| Shows that a scale page uses TAMNAMS.
|
|-
| [[Module:MOS genchain]]
[[Template:MOS genchain]]
| Yes
| Shows the generator chain of a mos.
| Dev on hold.
|-
| [[Template:MOS scale properties|<s>Template:MOS scale properties</s>]] (former name)
| rowspan="2" | Yes
| rowspan="2" | Combo template of:

* <s>Template:TAMNAMS use</s>
* Template:MOS intervals
* Template:MOS genchain
* Template:MOS mode degrees
| rowspan="2" | '''Deprecated, following changes that made it unmaintainable.'''
'''No combo templates for mos pages.'''
|-
| [[Module:MOS data|<s>Module:MOS data</s>]]
[[Template:MOS data|<s>Template:MOS data</s>]]
|-
| [[Module:TAMNAMS lookup]]
[[Template:TAMNAMS lookup]]
| Yes
| TAMNAMS name lookup as a standalone template.
| Dev direction unclear.
|-
| [[Template:TAMNAMS name]]
| Yes
| For writing the paragraph that states a mos's TAMNAMS name and its etymology or reasoning.
| ROLLOUT.
|-
| [[Module:MOS interval HE]]
[[Template:MOS interval HE]]
| Yes
| Standalone template for harmonic entropy.
Formerly a part of MOS intervals; added by [[User:R-4981]] but separated due to concerns regarding HE.
| Further developments uncertain.
|-
| [[Module:MOS tunings]]
[[Template:MOS tunings]]
| Yes
| Replacement for Template:MOS degrees.
| '''Rewrite to follow new coding conventions.'''
|-
| [[Template:Nutshell]]
| Yes
| See equivalent template on Wikipedia.
|
|-
| [[Module:JI ratios]]
| Yes
| Module for searching for JI ratios, as well as parsing them from template input.
Replacement for Module:JI ratio finder.
|
|-
| [[Module:Mediants]]
| Yes
| Standalone template for mediant calculations. To be used for the following modules:

* Module:SB tree
* <s>Module:Scale tree</s>
* Module:MOS tuning spectrum
* Module:JI ratios
|
|-
| [[Template:Deprecated parameters]]
| Yes
| A module for denoting one or more deprecated parameters in a template.
|
|-
! colspan="4" | New templates after this line follow new (personal) coding conventions, outlined in v1 of my style guide.
|-
! Modules and templates
! New?
! Description of template or contribution
! Status or todo
|-
| [[Template:Navbox]]
[[Module:Navbox]]
| Yes
| A template and module for producing a navbox. Module builds up navbox from input.
Navboxes can be made either as a template or using a lua module calling the navbox functions.
|Possibly add templatestyles integration
|-
| [[Module:Infobox]]
[[Template:Infobox]]
| Yes (template only)
| Rewrote entire infobox from scratch to support infobox template.
Same as navbox; infoboxes can be made either using a module calling the infobox functions or with a template.
|Possibly add templatestyles integration
|-
| [[Module:Numlinks]]
[[Template:Numlinks]]
|Yes
| A template for calculating and creating prev/next links for a numbered page. Pages are incremented (or decremented) by 1.
| Possibly let template auto-extract text.
|-
| [[Template:MOS tuning spectrum]]
[[Module:MOS tuning spectrum]]
| Yes
| Made to address maintenance issues with Module:Scale tree.
Comment entries are reverted back to having one param per ratio, where params are generated on the fly, not hardocded.
| Add comments for step ratios not found by search.
|-
| [[Template:MOS scalesig]]
[[Module:MOS scalesig]]
| Yes
| Made to address shortcomings with [[Template:Scale link]] and need to format mos scalesigs.
This template auto-formats a scale signature:

* Spaces are replaced with nonbreaking spaces.
* For nonoctave scales, angle brackets are replaced with the appropriate ones.
* Can format the scalesig as a link, if needed.
|
|-
| <s>Template:MOS stub</s>
|
| A proposed combination template consisting of:

* Template:Infobox MOS
* Template:MOS intro
* Template:MOS intervals
* Template:MOS tuning spectrum
Such a template would be a subst-template.
| '''Cancelled. No combo templates for mos pages.'''
|-
|[[Module:JI ratios]]
|Yes
|Rewrite of existing JI ratios module into two modules: one for searching for ratios, and one for filtering ratios
|
|-
|[[Template:Disavowed]]
|Yes
|Denotes terms whose usage is no longer advised, generally due to the name being unsuitable (EG, offensive, inappropriate, etc) or due to the person who coined the term retracting it.
|Use-cases to be determined.
|-
|[[Template:Navbox Lumatone]]
[[Template:Navbox fractional-octave]]
[[Module:Navbar]]
|No
|Decoupling navbar so it doesn't generate navboxes' or their prev/next links; that work is delegated to Template:Numlinks and Template:Navbox.
|
|-
|[[Template:Sidebar]]
[[Module:Sidebar]]
|Yes
|A template that's a basic implementation of Wikipedia's sidebar. Some infobox-like templates use this over the actual infobox, so it's made into an actual template.
|Possibly add templatestyles integration
|-
|[[Module:Template input utils]]
|Yes
|A library for preprocessing template args.
May possibly be a new location for Module:Template input parse (TIP).

Proposed functions:

* numbered_args_to_table(args, key_fmt, max_num)
* header_data_pairs_to_table(args, header_fmt, data_fmt)
* Functions to parse key-value, ratios, and sequences of ratios (from TIP)
|
|-
|[[Template:Numlinks 2-num]]
[[Module:Numlinks 2-num]]
|Yes
|A variant of numlinks that supports two varying numbers. Intended for pages such as mosses, EG 5L 2s.
|
|-
|[[Template:Template rating]]
|Yes
|A template that implements Wikipedia's template/module rating template. Advises editors that the template is one of several things:

* Draft; a mockup of a new template/module that is undergoing testing. Not ready for use anywhere except test pages. (encompasses pre-alpha/alpha/beta/mockup)
* Ready; template/module is ready for use
* Broken; self-explanatory. Definitely do not use until it's either fixed or deemed unfixable.
* Replaced; template is deprecated and has a replacement; template is kept for archival purposes or can be deleted.
* Deprecated; do not use anywhere; template is kept for archival purposes or can be deleted.
|In development
|-
|[[Template:Category handler]]
[[Module:Category handler]]
|Yes
|A proposed template-module pair that is a basic implementation of Wikipedia's module of the same name: https://en.wikipedia.org/wiki/Module:Category_handler
Features:

* Allows templates to categorize pages, given a list of categories

* Suppresses categories based on a list of suppressed namespaces (configurable) and a list of suppressed suffixes (subpages; configurable)
* Module is standalone; it requires no other modules as dependencies, apart from possibly utility modules.
|Attempted in the past by someone else but was deleted.
|-
|[[Template:Todo]]
|No
|Integrate category handler so templates/modules with todos don't get categorized twice (once for the template/module and once more for its /doc page)
|
|-
! colspan="4" |New templates after this line follow new (personal) coding conventions, outlined in v2 of my style guide. Features:
Use of snake_case for ALL param names, wherever possible; previous templates go through template name normalization to maintain backwards-compatibility
For lua-based templates, no params will ever be defined at the template level; params are defined at the module level
|-
!Modules and templates
!New?
!Description of template or contribution
!Status or todo
|-
|[[Module:Module introspection]]
[[Template:Module introspection]]
|Yes
| rowspan="3" |A set of modules that inspects mediawiki templates and lua code for:

* (FOR TEMPLATES): detecting whether a template invokes a module's function
* (FOR MODULES): detecting a module's dependencies and the functions used.

Common functionality is stored in Module:Introspection utils. Module introspection serves to implement this functionality for modules; template introspection is handled as part of Module:Dochead.

These templates/changes replace [[Template:Lua]] as used on module docpaegs.
| rowspan="3" |
|-
|[[Module:Template introspection|<s>Module:Template introspection</s>]]
[[Template:Template introspection|<s>Template:Template introspection</s>]]
|Yes
|-
|[[Module:Introspection utils]]
|Yes
|-
|[[Module:Dochead]]
[[Template:Dochead]]
|Yes (module only)
|Proposed module is a rewrite of Template:Dochead that makes the template able to:

* Autodetect modules with corresponding templates, with options for overrides
* Autodetect templates with corresponding modules, with options for overrides
* Display which functions are invoked and from which modules.
These templates/changes replace [[Template:Lua]] as used on template docpages.
|
|-
|All deprecation templates except [[Template:Deprecated parameters]]
|No
|Minor changes to inform editors if they're used in the wrong namespaces.
|
|-
|All categorizing infoboxes:

* [[Template:Infobox MOS]]
* [[Template:Infobox AFDO]]
* [[Template:Infobox chord]]
* [[Template:Infobox ET]]
* [[Template:Infobox interval]]
|No
|Proposal to add [[Module:Category handler]] so these templates automatically categorize themselves when in the correct namespaces
|
|-
|Template:Keyboard vis
|
|See Module:Keyboard vis.
|
|-
| Module:ED ratios
Template:ED ratios
|
| A proposed template that is an upgraded version of Module:JI ratios in ED
|
|-
| Module:Interval regions
|
| A proposed module for roughly classifying diatonic intervals (1st, 2nd etc; major, minor) plus some intermediate or in-between categories ( neutral and interseptimal intervals)
|
|-
| Module:MODMOS mode degrees
Template:MODMOS mode degrees
|
|
|
|-
| Module:MOS superset degrees
Template:MOS superset degrees
|
| Like MOS mode degrees, except the scale degrees are in relation to an ancestor mos.
|
|-
|
|
|
|
|}

=== Wikiprojects and style guides ===
* [[Xenharmonic Wiki:WikiProject Mospage|Project Mospage]] and [[Xenharmonic Wiki:MOS page style guide|mospage style guide]]
* [[User:Ganaram inukshuk/Docpage style guide|Docpage style guide]] (not worthy of a wikiproject since most docpages have been written alraedy)

=== Project mbox-icon ===
Various wikis have custom/themed icons. Apart from exceptions where a more common icon is preferred, why not have custom mbox icons for xenwiki?

=== Other contributions ===
* Mos page standardization (work-in-progress)
* [[Recursive structure of MOS scales|MOS recursion and MOS recursion algorithms]]; tried my best to make the descriptions for MOS recursion apply to all cases (Work-in-progress)
* Some rewording of the [[TAMNAMS]] page for readability and flow. I have a few TAMNAMS-related proposals of my own that aren't quite ready to be called official. See todo list or TAMNAMS subpage.
* [[Horogram|A page for horograms]], since it was totally absent (Work-in-progress).
* [[MOS Scale Family Tree|Mos family tree page]] for a tree I independently discovered before realizing Erv Wilson had already described it. Also has to do with mos recursion.

===To-do list ===
* '''<s>Rewrite page(s)</s> Under jurisdiction of Project Mospage.'''
** [[Operations on MOSes|<s>Operations on MOSes</s>]]
** [[MOS scale|<s>MOS scale</s>]]
** <s>[[TAMNAMS/Appendix]] (primarily for names reasoning and adding general principles)</s>
** <s>[[TAMNAMS Extension]] (since such names should follow the same naming principles as the "named range" names, but no such principles currently exist)</s>
* <s>'''Rewrite all octave-equivalent mos pages.''' This is primarily replacing every scale tree for the corresponding template and rewriting the lead sections to make sense and does not present redundant information already given by one of the templates. To a lesser extent, this also involves trying to confirm temperaments said to be attributed to these mosses, but this step will require additional help.</s> '''Under jurisdiction of Project Mospage.'''
** <s>This is done concurrently with writing a style guide for these pages; see [[User:Ganaram inukshuk/MOS page standardization guide]] for a proposed guide.</s>
** <s>Mosses whose pages have been rewritten to meet the style guide to satisfactory levels (that doesn't mean the pages can't be polished further!):</s>
*** <s>5L 1s</s>
*** <s>5L 2s</s>
*** <s>4L 3s</s>
*** <s>3L 4s</s>
*** <s>2L 5s</s>
*** <s>1L 5s</s>
*** <s>7L 1s</s>
*** <s>3L 7s</s>

* '''Update templates I've made to current coding style/structure''':
** The template calls a wrapper function, meant to be used with template params as input. Its name should be suggestive of the module's primary use, and is usually the same name as the template.
** The wrapper function calls the "main function", which has the code that produces the output. Its name is the same as name as with the wrapper function, except it's prefixed by an underscore.
* Clean up mos recursion page (because I feel bad leaving the algorithms untouched and untested for so long).
** Replace pseudocode for is-this-scale-a-mos? program with python code; clarify with more examples.
** Relate mos recursion with the mos family tree.
** All the recursive algorithms described on that page have time complexities of O(n log n), but the algorithm that generates a Christoffel word (combinatorics-on-words term for the brightest mode of a mos) has a time complexity of O(n). Resolve...?
* Standardize mosinedo pages. Examples include:
** [[List of MOS scales in 12edo]]
** [[List of MOS scales in 17edo]]
** [[List of MOS scales in 29edo]]
** [[List of MOS scales in 31edo]]

=== Wish list ===
* Composing music with these abstract ideas.

== Subpages ==
These pages contain content that currently don't have an exact place elsewhere on the Wiki, or contains personal notes that otherwise don't have an exact place on the Wiki. I do my best to explain these things as though I magically forgot everything I know about xenharmony, so I consider it a bonus if someone else found this easy to understand.
* [[User:Ganaram inukshuk/Diagrams]] – For xen-related diagrams
* [[User:Ganaram inukshuk/Notes]] – For xen-related notes
** [[User:Ganaram inukshuk/Notes/TAMNAMS]] – Since I have so many notes related to TAMNAMS, I made a dedicated page for it
* [[User:Ganaram inukshuk/Tables]] – For xen-related tables
* [[User:Ganaram inukshuk/Code]] – For xen-related code
* [[User:Ganaram inukshuk/Models]] – For xen-related models (needs reorganizing)
* [[User:Ganaram inukshuk/TAMNAMS Extension]] – Since there were others making their own TAMNAMS extension pages, I decided to make my own.
** [[User:Ganaram inukshuk/TAMEX]] – Rewrite of the above page for describing any mos descendant, short for "temperament-agnostic moment-of-symmetry scale extension description system"
** [[User:Ganaram inukshuk/Additional temperament-agnostic mos names]] – Rewrite of the above page for names for proposed names.

These pages are descriptions on how I approach various things, such as compositional techniques and how I approach a scale I've never used before.
* [[User:Ganaram inukshuk/Methodologies]]

Sandbox pages (for testing things)
* [[User:Ganaram inukshuk/Sandbox]]
** [[User:Ganaram inukshuk/Sandbox/JI ratios]]
**[[User:Ganaram inukshuk/Sandbox/Navboxes]]
**[[User:Ganaram inukshuk/Sandbox/Modmosses]]
* [[User:Ganaram inukshuk/Template sandbox]]

Test pages (for proposed rewrites or new templates):
* [[User:Ganaram inukshuk/Catalog of MOS Scales]]
* [[User:Ganaram inukshuk/4L 3s]] (Template test page and test page for style guide)
* [[User:Ganaram inukshuk/5L 2s]] (Template test page and test page for style guide)
** [[User:Ganaram inukshuk/MODMOS scales of 5L 2s]]
* [[User:Ganaram inukshuk/7L 3s]] (Rewrite page)
* [[User:Ganaram inukshuk/TAMNAMS]] (Rewrite page)
** [[User:Ganaram inukshuk/TAMNAMS/Appendix]]
* [[User:Ganaram inukshuk/MOS scale]] (rewrite page)
* [[User:Ganaram inukshuk/Template:Rewrite draft]]
* [[User:Ganaram inukshuk/Template:Template rating]]
* [[User:Ganaram inukshuk/Template:Todo]]

Experimental pages (for content considered idiosyncratic, ad-hoc, or otherwise weird):
* [[User:Ganaram inukshuk/LCP 5L 3s]]

Test templates:
* [[User:Ganaram inukshuk/Template:Mbox]]
* [[User:Ganaram inukshuk/Template:TAMNAMS name]]
* [[User:Ganaram inukshuk/Template:Tcode]]
* [[User:Ganaram inukshuk/Template:Tester]]
* [[User:Ganaram inukshuk/Template:Transcript]]
* [[User:Ganaram inukshuk/Template:Joke page|User:Ganaram inukshuk/Joke page]]
* [[User:Ganaram inukshuk/JI ratios]]
* [[User:Ganaram inukshuk/Template:Navbox fractional-octave]]
* [[User:Ganaram inukshuk/Template:Navbox Lumatone]]

Other:
* [[User:Ganaram inukshuk/Provisional style guide for Lua]]

[[Category:User on Discord]]

Template:Deprecated/doc

2025-11-01T07:18:12Z

Ganaram inukshuk:

{{dochead}}{{substitute|no}}
:''This template is used to deprecate content pages. For the template that is added to a template's documentation, see [[Template:Template rating]]. For the template that is added to to a template's code, see [[Template:Deprecated template]].
The '''Deprecated''' template adds a [[Template:Mbox|message box]] to inform readers of pages that is no longer valid, but worth being kept. It also places the page in [[:Category: Deprecated pages]].

=== Usage ===
This template should be placed at the top of the page, without any argument.

=== See also ===
* [[Template:Deprecated template]] – for templates whose use is no longer advised.
* [[Template:Deprecated parameters]] – for template parameters whose use is no longer advised.
* [[Template:Archive]]
* [[Template:Delete]]

Template:Deprecated/doc

2025-11-01T07:16:22Z

Ganaram inukshuk:

{{dochead}}{{substitute|no}}
:''This template is used to deprecate content pages. For the template that is added to a template page's documentation, see [[Template:Template rating]]. For the template that is added to to a template's code, see [[Template:Deprecated template]].
The '''Deprecated''' template adds a [[Template:Mbox|message box]] to inform readers of pages that is no longer valid, but worth being kept. It also places the page in [[:Category: Deprecated pages]].

=== Usage ===
This template should be placed at the top of the page, without any argument.

=== See also ===
* [[Template:Deprecated template]] – for templates whose use is no longer advised.
* [[Template:Deprecated parameters]] – for template parameters whose use is no longer advised.
* [[Template:Archive]]
* [[Template:Delete]]

Template:Deprecated

2025-11-01T07:09:50Z

Ganaram inukshuk:

<includeonly>{{#switch: {{NAMESPACE}}
| Template | Module = {{mbox
| icon = Icon-Blank.png
| type = aaa
| text = '''This template should only be used in the main namespace and other content pages.''' For documenting templates or modules' pages as deprecated, use [[Template:Template rating]] with <code><nowiki>rating=deprecated</nowiki></code> or <code><nowiki>rating=replaced</nowiki></code>. For marking templates themselves as deprecated, use [[Template:Deprecated template]].
}}

| default = {{mbox
| icon = Icon-Deprecated.png
| type = delete
| text = '''This page is [[:Category:Deprecated pages|deprecated]].''' It is being kept for posterity and for reference, but is no longer being actively maintained.

If you have contributions to add to this page, it would be advisable to add them to a different, related page instead.

When writing other pages, avoid including links to this page.
}}
{{#ifeq: {{lc: {{ARTICLEROOTPAGENAME}}}} | template:deprecated || [[Category:Deprecated pages]]}}
}}</includeonly><noinclude>
{{documentation}}

[[Category:Message boxes]]
</noinclude>

Template:Deprecated

2025-11-01T07:04:42Z

Ganaram inukshuk:

<includeonly>{{#ifeq: {{NAMESPACE}} | Template
| {{mbox
| icon = Icon-Blank.png
| type = aaa
| text = '''This template should only be used in the main namespace.''' For marking template ''pages'' as deprecated, use [[Template:Template rating]] with <code><nowiki>rating=deprecated</nowiki></code> or <code><nowiki>rating=replaced</nowiki></code>. For the template that's ''added'' to a template to notify editors of its status, use [[Template:Deprecated template]].
}}
| {{mbox
| icon = Icon-Deprecated.png
| type = delete
| text = '''This page is [[:Category:Deprecated pages|deprecated]].''' It is being kept for posterity and for reference, but is no longer being actively maintained.

If you have contributions to add to this page, it would be advisable to add them to a different, related page instead.

When writing other pages, avoid including links to this page.
}}
{{#ifeq: {{lc: {{ARTICLEROOTPAGENAME}}}} | template:deprecated || [[Category:Deprecated pages]]}}
}}</includeonly><noinclude>
{{documentation}}

[[Category:Message boxes]]
</noinclude>

Template:Deprecated

2025-11-01T07:03:48Z

Ganaram inukshuk:

<includeonly>{{#ifeq: {{NAMESPACE}} | Template
{{mbox
| icon = Icon-Blank.png
| type = aaa
| text = '''This template should only be used in the main namespace.''' For marking template ''pages'' as deprecated, use [[Template:Template rating]] with <code><nowiki>rating=deprecated</nowiki></code> or <code><nowiki>rating=replaced</nowiki></code>. For the template that's ''added'' to a template to notify editors of its status, use [[Template:Deprecated template]].
}}
| {{mbox
| icon = Icon-Deprecated.png
| type = delete
| text = '''This page is [[:Category:Deprecated pages|deprecated]].''' It is being kept for posterity and for reference, but is no longer being actively maintained.

If you have contributions to add to this page, it would be advisable to add them to a different, related page instead.

When writing other pages, avoid including links to this page.
}}
{{#ifeq: {{lc: {{ARTICLEROOTPAGENAME}}}} | template:deprecated || [[Category:Deprecated pages]]}}
}}</includeonly><noinclude>
{{documentation}}

[[Category:Message boxes]]
</noinclude>

Template:Deprecated

2025-11-01T06:57:51Z

Ganaram inukshuk:

<includeonly>{{#ifeq:{{NAMESPACE}}||
{{Mbox
| icon = Icon-Deprecated.png
| type = delete
| text = '''This page is [[:Category:Deprecated pages|deprecated]].''' It is being kept for posterity and for reference, but is no longer being actively maintained.

If you have contributions to add to this page, it would be advisable to add them to a different, related page instead.

When writing other pages, avoid including links to this page.
}}
{{#ifeq: {{lc: {{ARTICLEROOTPAGENAME}}}} | template:deprecated || [[Category:Deprecated pages]]}}
|
{{Mbox
| icon = Icon-Blank.png
| type = aaa
| text = '''This template should only be used in the main namespace.''' For marking template ''pages'' as deprecated, use [[Template:Template rating]] with <code><nowiki>rating=deprecated</nowiki></code> or <code><nowiki>rating=replaced</nowiki></code>. For the template that's ''added'' to a template to notify editors of its status, use [[Template:Deprecated template]].
}}
}}</includeonly><noinclude>
{{documentation}}

[[Category:Message boxes]]
</noinclude>

Template:Deprecated template/doc

2025-11-01T06:51:27Z

Ganaram inukshuk:

{{dochead}}{{substitute|no}}{{wikipedia|Template:Deprecated template}}
: ''Not to be confused with [[Template:Deprecated]].''

'''{{ARTICLEROOTPAGENAME}}''' notifies users that a template has been replaced by one or more new templates, or deprecated (advised to no longer be used) without a replacement. This template should ''not'' be placed in a page's documentation page; instead, it is placed ''within'' a template's code, either as part of it or replacing it entirely, to notify editors about that template's status. Pages that include this template are placed under [[:Category:Pages with deprecated templates]].

=== Usage ===
Use as follows:

<pre>{{Deprecated template|Old template|Template: New template|details=Further details.}}</pre>

to get:

{{Deprecated template|Old template|Template: New template|details=Further details.}}

The last two parameters are optional. This can be useful when the template was replaced by something other than a new template, like a category.

The parameter names can be omitted if they are used in the same order as specified above.

=== See also ===
* [[Template:Template rating]] – a similar template to be used for a template's documentation.
* [[Template:Deprecated]] – for pages whose material is no longer valid.
* [[Template:Deprecated parameters]] – for template parameters whose use is no longer advised.
* [[:Category:Deprecated templates]]
* [[:Category:Pages with deprecated templates]]

Template:Deprecated template

2025-11-01T06:47:15Z

Ganaram inukshuk:

<includeonly>{{Mbox
| icon = Icon-Deprecated.png
| type = delete
| text = [[{{ARTICLESPACE}}:{{{1|{{ROOTPAGENAME}}}}}]] is deprecated. {{#if:{{{2|}}}|Please use [[{{{2}}}]] instead.}}

{{#if: {{{details|}}} | '''Details:''' {{{details}}}}}
}}
{{Category handler
| {{#ifeq: {{NAMESPACE}} | Template
| {{#ifeq: {{lc:{{ARTICLEROOTPAGENAME}}}} | template:deprecated template
| 
| Deprecated templates
}}
| Pages with deprecated templates
}}
| {{{debug|}}}
}}</includeonly><noinclude>
{{documentation}}

[[Category:Message boxes]]
</noinclude>

Template:Deprecated template

2025-11-01T06:44:59Z

Ganaram inukshuk: try to add category handler

<includeonly>{{Mbox
| icon = Icon-Deprecated.png
| type = delete
| text = [[{{ARTICLESPACE}}:{{{1|{{ROOTPAGENAME}}}}}]] is deprecated. {{#if:{{{2|}}}|Please use [[{{{2}}}]] instead.}} {{{details|}}}
}}
{{Category handler
| {{#ifeq: {{NAMESPACE}} | Template
| {{#ifeq: {{lc:{{ARTICLEROOTPAGENAME}}}} | template:deprecated template
| 
| Deprecated templates
}}
| Pages with deprecated templates
}}
| {{{debug|}}}
}}</includeonly><noinclude>
{{documentation}}

[[Category:Message boxes]]
</noinclude>

User:Ganaram inukshuk/Template sandbox

2025-11-01T01:55:13Z

Ganaram inukshuk:

{{mbox
| icon = Icon-Deprecated.png
| type = delete
| text = '''Template:SomeTemplate''' is deprecated. Please use [[Template:SomeReplacementTemplate]] instead.

'''Details:''' Other details go here.
}}

{{sidebox
| image = Icon-Deprecated.png
| image size = 44px
| text = This template is deprecated. See its template page for more information.
}}

{{sidebar
| Title = This template is deprecated.
| Row 1 = See its template page for more information.
}}

{{clear}}

{{Mbox|text=Messagebox of '''delete''' type. Typically used for pages whose content is deprecated or to be deleted.|type=delete}}

{{Mbox|text=Messagebox of '''content''' type. Typically used for pages whose content requires verification or rewriting.|type=content}}

{{Mbox|text=Messagebox of '''style''' type. Typically used for pages whose writing style doesn't fit the wiki's standards.|type=style}}

{{Mbox|text=Messagebox of '''ready''' type. Used to denote pages with reliable content (like Wikipedia's "good articles") or features (such as templates) that are ready for use.|type=ready}}

{{Mbox|text=Messagebox of '''notice''' type. Used to denote general notices. Most messageboxes are of this type.|type=notice}}

{{Mbox|text=Messagebox of '''move''' type. Denotes pages that are to be moved.|type=move}}

{{Mbox|text=Messagebox of '''protection''' type. Denotes pages that are protected from editing.|type=protection}}

{{Mbox|text=Messagebox of an unknown type. Could be used to denote errors with a messagebox's inputs.|type=aaa}}

{{MOS mode degrees|Scale Signature=5L 2s|MODMOS Step Pattern=LsLAsLs}}

<references group="group" />
{| class="wikitable"
|+Intervals of 5L 2s
! colspan="3" |Intervals
! rowspan="2" |<abbr>Steps subtended</abbr>
! rowspan="2" |Range in cents
|-
!<abbr>Generic</abbr>[[#note1|1]]
!<abbr>Specific</abbr>
!<abbr>Abbrev.</abbr>
|-
|'''0-diastep'''
|Perfect 0-diastep
|P0ms
|0
|0.0¢
|-
| rowspan="2" |1-diastep
|Minor 1-diastep
|m1ms
|s
|0.0¢ to 171.4¢
|-
|Major 1-diastep
|M1ms
|L
|171.4¢ to 240.0¢
|-
| rowspan="2" |2-diastep
|Minor 2-diastep
|m2ms
|L + s
|240.0¢ to 342.9¢
|-
|Major 2-diastep
|M2ms
|2L
|342.9¢ to 480.0¢
|-
| rowspan="2" |3-diastep
|Perfect 3-diastep
|P3ms
|2L + s
|480.0¢ to 514.3¢
|-
|Augmented 3-diastep
|A3ms
|3L
|514.3¢ to 720.0¢
|-
| rowspan="2" |4-diastep
|Diminished 4-diastep
|d4ms
|2L + 2s
|480.0¢ to 685.7¢
|-
|Perfect 4-diastep
|P4ms
|3L + s
|685.7¢ to 720.0¢
|-
| rowspan="2" |5-diastep
|Minor 5-diastep
|m5ms
|3L + 2s
|720.0¢ to 857.1¢
|-
|Major 5-diastep
|M5ms
|4L + s
|857.1¢ to 960.0¢
|-
| rowspan="2" |6-diastep
|Minor 6-diastep
|m6ms
|4L + 2s
|960.0¢ to 1028.6¢
|-
|Major 6-diastep
|M6ms
|5L + s
|1028.6¢ to 1200.0¢
|-
|'''7-diastep'''
|Perfect 7-diastep
|P7ms
|5L + 2s
|1200.0¢
|}
Definition of generic interval.

Template:Lua

2025-11-01T01:46:42Z

Ganaram inukshuk:

<includeonly>{{sidebox|text='''This template has been deprecated. Its replacements are [[Template:Dochead]] and [[Template:Module introspection]].'''[[Category:Pages with deprecated templates]]|image=Icon-Deprecated.png|image size=60px}}

{{#invoke: Variable arguments | lua_banner
| debug_mode = {{lc:{{{debug|}}}}}
}}</includeonly>{{#ifeq: {{NAMESPACE}}|Template|{{#ifeq: {{#titleparts: {{FULLPAGENAME}}||-1}}|doc||[[Category:Lua-based templates]]}}|}}<noinclude>
{{documentation}}
</noinclude>

Template:Lua

2025-11-01T01:44:57Z

Ganaram inukshuk:

<includeonly>{{sidebox|text='''This template has been deprecated. Its replacements are [[Template:Dochead]] and [[Template:Module introspection]].'''[[Category:Pages with deprecated templates]]|image=Icon-Deprecated.png}}

{{#invoke: Variable arguments | lua_banner
| debug_mode = {{lc:{{{debug|}}}}}
}}</includeonly>{{#ifeq: {{NAMESPACE}}|Template|{{#ifeq: {{#titleparts: {{FULLPAGENAME}}||-1}}|doc||[[Category:Lua-based templates]]}}|}}<noinclude>
{{documentation}}
</noinclude>

Template:Lua

2025-11-01T01:43:48Z

Ganaram inukshuk:

<includeonly>{{sidebox|text='''This template has been deprecated. Its replacements are [[Template:Dochead]] and [[Template:Module introspection]].'''[[Category:Pages with deprecated templates]]}}

{{#invoke: Variable arguments | lua_banner
| debug_mode = {{lc:{{{debug|}}}}}
}}</includeonly>{{#ifeq: {{NAMESPACE}}|Template|{{#ifeq: {{#titleparts: {{FULLPAGENAME}}||-1}}|doc||[[Category:Lua-based templates]]}}|}}<noinclude>
{{documentation}}
</noinclude>

Module:Dochead

2025-11-01T01:41:33Z

Ganaram inukshuk: add header: data/datamodule; this is autodetected if it's a /data subpage.

-- This module follows [[User:Ganaram inukshuk/Provisional style guide for Lua]]
local getArgs = require("Module:Arguments").getArgs
local iutils = require("Module:Introspection utils")
local yesno = require("Module:Yesno")

local p = {}

-- TODO: (Low-ish priority): rewrite to eliminate redundant code

-- Produces a hatnote that is placed on the top of a documentation page (either
-- template or module documentation) and can autodetect and categorize:
-- - FOR MODULES:
-- - whether a module has an accompanying template (overridable/toggleable)
-- - whether a module is meant as a library for other modules
-- - FOR TEMPLATES:
-- - whether a template has an accompanying module (overridable/toggleable)
-- - what functions from which modules are invoked

-- Helper function: categorize modules
local function categorize_module(pagename)
local cats = ""
if pagename:match("/doc$") then
cats = "[[Category:Module documentation]]"
else
cats = "[[Category:Lua modules]]"
end
return cats
end

-- Helper function to handle modules
function p.make_module_hatnote(header, pagename, corr_template, detect_corr_page)
-- Check whether corresponding template exists
-- Then check whether that template invokes the module
local has_template = iutils.page_exists("Template:" .. corr_template:gsub("/doc$", ""))

-- Check whether to use detect_corr_page option
-- If the header option is dualuse, metatemplate, or noinvoke, this option
-- is ignored. For any other option, it's not.
if header ~= "dualuse" and header ~= "metatemplate" and header ~= "noinvoke" then
has_template = has_template and detect_corr_page
end

-- If the module has a template, check for whether it invokes it.
if has_template then
local wikitext = iutils.get_and_preprocess_content("Template", corr_template:gsub("/doc$", ""))
local invokes = iutils.find_invokes(wikitext)
has_template = has_template and iutils.invocation_exists(invokes, pagename:gsub("/doc$", ""))
end

-- Heading meanings and usage on module
-- - dualuse means a template is implement by a module, but its template may
-- be bypassed by using its module directly from other modules.
-- - metatemplate is a special case of dualuse; the template-module pair is
-- for a metatemplate, a template used to build other templates.
-- - noinvoke indicates a lua-based template, but the module's code is so
-- specialized that its code should not be used by other modules or
-- invoked by other templates.
-- - metamodule and library indicate a module whose code is used mainly for
-- other modules. Such modules generally don't have a corresponding
-- template.
-- - data/datamodule indicates a module whose purpose is to provide data
-- values to other modules. Like library modules, these don't have a
-- corresponding template.
-- Does the module have a template?
-- - dualuse, metatemplate, and noinvoke: YES (REQUIRED!!)
-- - metamodule/library and data: GENERALLY NO
local result = ""
if header == "dualuse" then
if has_template then
result = string.format(
"This module may be invoked by templates using its corresponding template [[Template:%s]], or used directly from other modules.",
corr_template:gsub("/doc$", "")
)
else
result = string.format(
"This module has a corresopnding template that is currently missing or does not use this module. ([[Special:EditPage/Template:%s|edit template]])",
corr_template:gsub("/doc$", "")
)
end

elseif header == "metatemplate" then
if has_template then
result = string.format(
"This module implements a metatemplate, and may be invoked by templates using its corresponding template [[Template:%s]], or used directly from other modules.",
corr_template:gsub("/doc$", "")
)
else
result = "This module is used to create other Lua-based templates and has no corresponding template."
end

elseif header == "noinvoke" then
if has_template then
result = string.format(
"This module should not be invoked directly; use its corresponding instead: [[Template:%s]].",
corr_template:gsub("/doc$", "")
)
else
result = string.format(
"This module implements a template that is currently missing or does not use this module. ([[Special:EditPage/Template:%s|edit template]])",
corr_template:gsub("/doc$", "")
)
end

elseif header == "library" or header == "metamodule" then
result = "This module primarily serves as a library for other modules and has no corresponding template."

elseif header == "data" or pagename:gsub("/doc$", ""):match("/data$") then
result = "This module primarily serves to provide data values for other modules and has no corresponding template."

else
if has_template and header ~= "" then
result = string.format("%s This module implements [[Template:%s]].", header, corr_template:gsub("/doc$", ""))
elseif has_template and header == "" then
result = string.format("This module implements [[Template:%s]].", corr_template:gsub("/doc$", ""))
else
result = header
end
end

-- Produce categories
local cats = categorize_module(pagename)

-- Return
if result == "" then
return "" .. cats
else
return string.format(":''%s''%s\n", result, cats)
end
end

-- Helper function: categorize template
local function categorize_template(pagename, has_invoke)
local cats = ""
if pagename:match("/doc$") then
cats = "[[Category:Template documentation]]"
else
cats = "[[Category:Templates]]"
if has_invoke then
cats = cats .. " [[Category:Lua-based templates]]"
end
end
return cats
end

-- Helper function
-- Creates an additional hatnote denoting which functions are invoked from which
-- modules, if a has more than one invoke.
local function make_invocation_hatnote(invokes)
local hatnote = ""
if #invokes == 0 then
return ""
else
hatnote = "This template invokes the following functions:"
local calls = {}
for _, call in ipairs(invokes) do
local module_link = iutils.make_module_link(call.module)
table.insert(calls, string.format("'''%s''' from %s", call.func, module_link))
end
return string.format("%s %s.", hatnote, table.concat(calls, ", "))
end
end

-- Helper function to handle templates
function p.make_template_hatnote(header, pagename, corr_module, detect_corr_page)
-- Check whether corresponding module exists
-- Then check whether this template invokes the module
local has_module = iutils.page_exists("Module:" .. corr_module:gsub("/doc$", ""))

-- Check whether to use detect_corr_page option
-- If the header option is dualuse or metatemplate, this option is ignored.
-- For any other option, it's not (although it also has no effect on
-- noinvoke or library/metamodule).
if header ~= "dualuse" and header ~= "metatemplate" then
has_module = has_module and detect_corr_page
end

-- Check for whether the template invokes that module, regardless of whether
-- it uses the corresponding module.
local wikitext = iutils.get_and_preprocess_content("Template", pagename:gsub("/doc$", ""))
local invokes = iutils.find_invokes(wikitext)
local is_module_invoked = iutils.invocation_exists(invokes, corr_module:gsub("/doc$", ""))

-- Heading meanings and usage on templates
-- - dualuse means a template is implement by a module, but its template may
-- be bypassed by using its module directly from other modules.
-- - metatemplate is a special case of dualuse; the template-module pair is
-- for a metatemplate, a template used to build other templates.
-- - noinvoke and metamodule/library don't have use for templates.
-- Does the template have a module?
-- - dualuse and metatemplate: YES (REQUIRED!!)
-- - noinvoke, metamodule/library, and data/datamodule: option's don't apply
-- to templates.
-- RATIONALE FOR NOINVOKE NOT APPLYING: a template may invoke functions from
-- more than one module, but one of them must be the "main" module. Since
-- there's no way to autodetect that, that info must be manually entered.
-- If that doesn't happen
local result = ""
if header == "dualuse" then
if has_module and is_module_invoked then
result = string.format(
"This template is implemented by the Lua module [[Module:%s]]. See its module page for Lua-based template implementation.",
corr_module:gsub("/doc$", "")
)
elseif has_module and not is_module_invoked then
result = string.format(
"This template has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
corr_module:gsub("/doc$", "")
)
else
result = string.format(
"This template is implemented by a module that is currently missing. [[Special:EditPage/Module:%s]]",
corr_module:gsub("/doc$", "")
)
end

elseif header == "metatemplate" then
if has_module and is_module_invoked then
result = string.format(
"This template is a metatemplate. It is used to build other templates and should not be used standalone, except for testing or simple usage. This template is implemented by the Lua module [[Module:%s]].",
corr_module:gsub("/doc$", "")
)
elseif has_module and not is_module_invoked then
result = string.format(
"This metatemplate has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
corr_module:gsub("/doc$", "")
)
else
result = "This template is a metatemplate. It is used to build other templates and should not be used standalone, except for testing or simple usage."
end

elseif header == "noinvoke" or header == "library" or header == "metamodule" or header == "data" or header == "datamodule" then
result = "This template has a header option in the wrong namespace. It should be used within the Module namespace."

else
if has_module and header ~= "" and is_module_invoked then
result = string.format(
"%s. This template is implemented by the Lua module [[Module:%s]].",
header,
corr_module:gsub("/doc$", "")
)
elseif has_module and header ~= "" and not is_module_invoked then
result = string.format(
"%s. This template has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
header,
corr_module:gsub("/doc$", "")
)
elseif has_module and header == "" and is_module_invoked then
result = string.format(
"This template is implemented by the Lua module [[Module:%s]].",
corr_module:gsub("/doc$", "")
)
elseif has_module and header == "" and not is_module_invoked then
result = string.format(
"This template has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
corr_module:gsub("/doc$", "")
)
else
result = header
end
end

-- Find all invocations for the template and add it as an addl hatnote.
local invocation_hatnote = make_invocation_hatnote(invokes)

-- Categorize
local cats = categorize_template(pagename, #invokes > 0)

if result == "" and invocation_hatnote == "" then
return ""
elseif result == "" and invocation_hatnote ~= "" then
return string.format(":''%s''%s\n", invocation_hatnote, cats)
elseif result ~= "" and invocation_hatnote == "" then
return string.format(":''%s''%s\n", result, cats)
else
return string.format(":''%s''\n:''%s''%s\n", result, invocation_hatnote, cats)
end
end

-- Main function
function p._dochead(args)
local namespace = args["namespace"]
local pagename = args["pagename"]
local header = args["header"] or "none"
local corr_template = args["temp"] or pagename
local corr_module = args["mod"] or pagename
local detect_corr_page = args["detect_corr_page"]

-- If header is none, skip everything
if header == "none" then
return categorize(namespace, pagename)
end

-- Call appropriate hatnote-making function
-- Remove /doc suffix if this is on a /doc page to ensure links are made
-- properly. :gsub("/doc$", "")
local result = ""
if namespace == "Module" then
result = p.make_module_hatnote(header, pagename, corr_template, detect_corr_page)
elseif namespace == "Template" then
result = p.make_template_hatnote(header, pagename, corr_module, detect_corr_page)
else
result = ":''This documentation template is in the wrong namespace. It should be within the Template or Module namespaces.''\n"
end

return result
end

-- Wrapper to be invoked
function p.dochead(frame)
local args = getArgs(frame, { removeBlanks = true }) or {}
local title = mw.title.getCurrentTitle()

-- Extract or parse args
args["namespace"] = args["namespace"] or title.nsText
args["pagename" ] = args["pagename" ] or title.text

-- Extract header or set it to defaults
if args["header"] == nil or args["header"] == "" then
if args["namespace"] == "Module" then
args["header"] = "noinvoke"
else
args["header"] = ""
end
end

-- Extract template/module names, or autogenerate them
args["temp"] = args["temp"] or args["pagename"]
args["mod" ] = args["mod" ] or args["pagename"]

-- Option to detect corresponding page (default true)
args["detect_corr_page"] = args["detect_corr_page"] == nil and true or yesno(args["detect_corr_page"])

return p._dochead(args)
end

function p.tester()
local args = {}

args["namespace"] = "Template"
args["pagename" ] = "Module introspection"

args["temp"] = args["pagename"]
args["mod" ] = args["pagename"]

args["header"] = ""

return p._dochead(args)
end

return p

Template:Documentation/doc

2025-10-31T11:08:41Z

Ganaram inukshuk:

{{Dochead}}{{substitute|no}}{{wikipedia}}{{templatestyles}}
The <code><nowiki>{{documentation}}</nowiki></code> template is used to contain information and instructions for templates and modules. Wikipedia's documentation template has modules that help render the dialog boxes, but here the box is hard-coded to simplify things.
__NOTOC__
=== Usage ===
This template automatically extracts contents from the <code>/doc</code> subpage of any page. You can optionally add an unnamed argument, which will be displayed in place.

==== Templates ====
On templates, place <code><nowiki>{{documentation}}</nowiki></code> on the page itself, place the relevant categories afterwards, and enclose them in <code><nowiki><noinclude></nowiki></code> tags:

<pre>
<noinclude>
{{Documentation}}

[[Category: …]]
…
</noinclude>
</pre>

==== Modules ====
On pages consisting of exclusively code (modules, CSS, JS, etc.), place this template on the <code>/doc</code> subpage and pass the notes, along with {{tlx|dochead}}, in as the first unnamed parameter:

<pre>
{{Documentation|
{{Dochead}}
…
}}
</pre>

{{Escape notice}}

Additionally, when {{tlx|lua}} is used on a module documentation page to indicate dependencies, the first paragraph of text after the Lua banner may need to be encased in its own paragraph (<code><nowiki></nowiki></code>) element since otherwise the MediaWiki parser may fail to render the paragraphs correctly:

<pre>
{{Documentation|
{{Dochead}}{{lua|…|…|}}
Paragraph 1

Paragraph 2

Paragraph 3
…
}}
</pre>

=== See also ===
* [[Template: Dochead]] – used to categorise and add appropriate headers onto documentation pages.

{{todo|inline=1|rework|comment=Template:Lua is deprecated; placement of dochead is incorrect; add module introspection}}

Module:Dochead

2025-10-31T10:28:49Z

Ganaram inukshuk: some cleanup; todo

-- This module follows [[User:Ganaram inukshuk/Provisional style guide for Lua]]
local getArgs = require("Module:Arguments").getArgs
local iutils = require("Module:Introspection utils")
local yesno = require("Module:Yesno")

local p = {}

-- TODO: (Low-ish priority): rewrite to eliminate redundant code

-- Produces a hatnote that is placed on the top of a documentation page (either
-- template or module documentation) and can autodetect and categorize:
-- - FOR MODULES:
-- - whether a module has an accompanying template (overridable/toggleable)
-- - whether a module is meant as a library for other modules
-- - FOR TEMPLATES:
-- - whether a template has an accompanying module (overridable/toggleable)
-- - what functions from which modules are invoked

-- Helper function: categorize modules
local function categorize_module(pagename)
local cats = ""
if pagename:match("/doc$") then
cats = "[[Category:Module documentation]]"
else
cats = "[[Category:Lua modules]]"
end
return cats
end

-- Helper function to handle modules
function p.make_module_hatnote(header, pagename, corr_template, detect_corr_page)
-- Check whether corresponding template exists
-- Then check whether that template invokes the module
local has_template = iutils.page_exists("Template:" .. corr_template:gsub("/doc$", ""))

-- Check whether to use detect_corr_page option
-- If the header option is dualuse, metatemplate, or noinvoke, this option
-- is ignored. For any other option, it's not.
if header ~= "dualuse" and header ~= "metatemplate" and header ~= "noinvoke" then
has_template = has_template and detect_corr_page
end

-- If the module has a template, check for whether it invokes it.
if has_template then
local wikitext = iutils.get_and_preprocess_content("Template", corr_template:gsub("/doc$", ""))
local invokes = iutils.find_invokes(wikitext)
has_template = has_template and iutils.invocation_exists(invokes, pagename:gsub("/doc$", ""))
end

-- Heading meanings and usage on module
-- - dualuse means a template is implement by a module, but its template may
-- be bypassed by using its module directly from other modules.
-- - metatemplate is a special case of dualuse; the template-module pair is
-- for a metatemplate, a template used to build other templates.
-- - noinvoke indicates a lua-based template, but the module's code is so
-- specialized that its code should not be used by other modules or
-- invoked by other templates.
-- - metamodule and library indicate a module whose code is used mainly for
-- other modules. Such modules generally don't have a corresponding
-- template.
-- Does the module have a template?
-- - dualuse, metatemplate, and noinvoke: YES (REQUIRED!!)
-- - metamodule/library: GENERALLY NO
local result = ""
if header == "dualuse" then
if has_template then
result = string.format(
"This module may be invoked by templates using its corresponding template [[Template:%s]], or used directly from other modules.",
corr_template:gsub("/doc$", "")
)
else
result = string.format(
"This module has a corresopnding template that is currently missing or does not use this module. ([[Special:EditPage/Template:%s|edit template]])",
corr_template:gsub("/doc$", "")
)
end

elseif header == "metatemplate" then
if has_template then
result = string.format(
"This module implements a metatemplate, and may be invoked by templates using its corresponding template [[Template:%s]], or used directly from other modules.",
corr_template:gsub("/doc$", "")
)
else
result = "This module is used to create other Lua-based templates and has no corresponding template."
end

elseif header == "noinvoke" then
if has_template then
result = string.format(
"This module should not be invoked directly; use its corresponding instead: [[Template:%s]].",
corr_template:gsub("/doc$", "")
)
else
result = string.format(
"This module implements a template that is currently missing or does not use this module. ([[Special:EditPage/Template:%s|edit template]])",
corr_template:gsub("/doc$", "")
)
end

elseif header == "library" or header == "metamodule" then
result = "This module primarily serves as a library for other modules and has no corresponding template."

else
if has_template and header ~= "" then
result = string.format("%s This module implements [[Template:%s]].", header, corr_template:gsub("/doc$", ""))
elseif has_template and header == "" then
result = string.format("This module implements [[Template:%s]].", corr_template:gsub("/doc$", ""))
else
result = header
end
end

-- Produce categories
local cats = categorize_module(pagename)

-- Return
if result == "" then
return "" .. cats
else
return string.format(":''%s''%s\n", result, cats)
end
end

-- Helper function: categorize template
local function categorize_template(pagename, has_invoke)
local cats = ""
if pagename:match("/doc$") then
cats = "[[Category:Template documentation]]"
else
cats = "[[Category:Templates]]"
if has_invoke then
cats = cats .. " [[Category:Lua-based templates]]"
end
end
return cats
end

-- Helper function
-- Creates an additional hatnote denoting which functions are invoked from which
-- modules, if a has more than one invoke.
local function make_invocation_hatnote(invokes)
local hatnote = ""
if #invokes == 0 then
return ""
else
hatnote = "This template invokes the following functions:"
local calls = {}
for _, call in ipairs(invokes) do
local module_link = iutils.make_module_link(call.module)
table.insert(calls, string.format("'''%s''' from %s", call.func, module_link))
end
return string.format("%s %s.", hatnote, table.concat(calls, ", "))
end
end

-- Helper function to handle templates
function p.make_template_hatnote(header, pagename, corr_module, detect_corr_page)
-- Check whether corresponding module exists
-- Then check whether this template invokes the module
local has_module = iutils.page_exists("Module:" .. corr_module:gsub("/doc$", ""))

-- Check whether to use detect_corr_page option
-- If the header option is dualuse or metatemplate, this option is ignored.
-- For any other option, it's not (although it also has no effect on
-- noinvoke or library/metamodule).
if header ~= "dualuse" and header ~= "metatemplate" then
has_module = has_module and detect_corr_page
end

-- Check for whether the template invokes that module, regardless of whether
-- it uses the corresponding module.
local wikitext = iutils.get_and_preprocess_content("Template", pagename:gsub("/doc$", ""))
local invokes = iutils.find_invokes(wikitext)
local is_module_invoked = iutils.invocation_exists(invokes, corr_module:gsub("/doc$", ""))

-- Heading meanings and usage on templates
-- - dualuse means a template is implement by a module, but its template may
-- be bypassed by using its module directly from other modules.
-- - metatemplate is a special case of dualuse; the template-module pair is
-- for a metatemplate, a template used to build other templates.
-- - noinvoke and metamodule/library don't have use for templates.
-- Does the template have a module?
-- - dualuse and metatemplate: YES (REQUIRED!!)
-- - noinvoke and metamodule/library: options don't apply to templates.
-- RATIONALE FOR NOINVOKE NOT APPLYING: a template may invoke functions from
-- more than one module, but one of them must be the "main" module. Since
-- there's no way to autodetect that, that info must be manually entered.
-- If that doesn't happen
local result = ""
if header == "dualuse" then
if has_module and is_module_invoked then
result = string.format(
"This template is implemented by the Lua module [[Module:%s]]. See its module page for Lua-based template implementation.",
corr_module:gsub("/doc$", "")
)
elseif has_module and not is_module_invoked then
result = string.format(
"This template has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
corr_module:gsub("/doc$", "")
)
else
result = string.format(
"This template is implemented by a module that is currently missing. [[Special:EditPage/Module:%s]]",
corr_module:gsub("/doc$", "")
)
end

elseif header == "metatemplate" then
if has_module and is_module_invoked then
result = string.format(
"This template is a metatemplate. It is used to build other templates and should not be used standalone, except for testing or simple usage. This template is implemented by the Lua module [[Module:%s]].",
corr_module:gsub("/doc$", "")
)
elseif has_module and not is_module_invoked then
result = string.format(
"This metatemplate has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
corr_module:gsub("/doc$", "")
)
else
result = "This template is a metatemplate. It is used to build other templates and should not be used standalone, except for testing or simple usage."
end

elseif header == "noinvoke" or header == "library" or header == "metamodule" then
result = "This template has a header option in the wrong namespace. It should be used within the Module namespace."

else
if has_module and header ~= "" and is_module_invoked then
result = string.format(
"%s. This template is implemented by the Lua module [[Module:%s]].",
header,
corr_module:gsub("/doc$", "")
)
elseif has_module and header ~= "" and not is_module_invoked then
result = string.format(
"%s. This template has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
header,
corr_module:gsub("/doc$", "")
)
elseif has_module and header == "" and is_module_invoked then
result = string.format(
"This template is implemented by the Lua module [[Module:%s]].",
corr_module:gsub("/doc$", "")
)
elseif has_module and header == "" and not is_module_invoked then
result = string.format(
"This template has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
corr_module:gsub("/doc$", "")
)
else
result = header
end
end

-- Find all invocations for the template and add it as an addl hatnote.
local invocation_hatnote = make_invocation_hatnote(invokes)

-- Categorize
local cats = categorize_template(pagename, #invokes > 0)

if result == "" and invocation_hatnote == "" then
return ""
elseif result == "" and invocation_hatnote ~= "" then
return string.format(":''%s''%s\n", invocation_hatnote, cats)
elseif result ~= "" and invocation_hatnote == "" then
return string.format(":''%s''%s\n", result, cats)
else
return string.format(":''%s''\n:''%s''%s\n", result, invocation_hatnote, cats)
end
end

-- Main function
function p._dochead(args)
local namespace = args["namespace"]
local pagename = args["pagename"]
local header = args["header"] or "none"
local corr_template = args["temp"] or pagename
local corr_module = args["mod"] or pagename
local detect_corr_page = args["detect_corr_page"]

-- If header is none, skip everything
if header == "none" then
return categorize(namespace, pagename)
end

-- Call appropriate hatnote-making function
-- Remove /doc suffix if this is on a /doc page to ensure links are made
-- properly. :gsub("/doc$", "")
local result = ""
if namespace == "Module" then
result = p.make_module_hatnote(header, pagename, corr_template, detect_corr_page)
elseif namespace == "Template" then
result = p.make_template_hatnote(header, pagename, corr_module, detect_corr_page)
else
result = ":''This documentation template is in the wrong namespace. It should be within the Template or Module namespaces.''\n"
end

return result
end

-- Wrapper to be invoked
function p.dochead(frame)
local args = getArgs(frame, { removeBlanks = true }) or {}
local title = mw.title.getCurrentTitle()

-- Extract or parse args
args["namespace"] = args["namespace"] or title.nsText
args["pagename" ] = args["pagename" ] or title.text

-- Extract header or set it to defaults
if args["header"] == nil or args["header"] == "" then
if args["namespace"] == "Module" then
args["header"] = "noinvoke"
else
args["header"] = ""
end
end

-- Extract template/module names, or autogenerate them
args["temp"] = args["temp"] or args["pagename"]
args["mod" ] = args["mod" ] or args["pagename"]

-- Option to detect corresponding page (default true)
args["detect_corr_page"] = args["detect_corr_page"] == nil and true or yesno(args["detect_corr_page"])

return p._dochead(args)
end

function p.tester()
local args = {}

args["namespace"] = "Template"
args["pagename" ] = "Module introspection"

args["temp"] = args["pagename"]
args["mod" ] = args["pagename"]

args["header"] = ""

return p._dochead(args)
end

return p

Template:Wikipedia/doc

2025-10-31T10:09:43Z

Ganaram inukshuk:

{{dochead|mod=Variable arguments}}{{wikipedia}}{{templatestyles}}
: ''Not to be confused with [[Template:Wlink]].''
The '''Wikipedia''' template shows a right-floating sister-project box with a link to a single English Wikipedia page. It was inspired by [[Wiktionary:Template:wikipedia|the corresponding template on the English Wiktionary]], which includes many more features that are not implemented in this simplified version of the template.

=== Usage ===
The template should be placed at the beginning of the page it refers to, immediately after hatnotes if there are any. If there are also images, box templates such as this should appear first. Alternatively, consider linking to Wikipedia in the "External links" section; see [[Special: Interwiki]] for tips on adding such links.

The template can also be placed at the beginning of a section. In that case, the title of the Wikipedia page must be explicitly given as a [[#Parameters|parameter]].{{clear}}

=== Parameters ===
All parameters are optional. Pass in all pages ''in addition to the name of the page itself'' to link to as an arbitrary number of unnamed arguments.

For example, placing this on the page [[Frequently asked questions]]:

<pre>{{Wikipedia|Frequently asked questions|page1|page2|page3}}</pre>

will yield:

{{Wikipedia|Frequently asked questions|page1|page2|page3}}{{clear}}

If you do not wish to link the page with the current page's name, simply omit it. For example, placing <code><nowiki>{{wikipedia|''page1''|''page2''|''page3''}}</nowiki></code> on [[Frequently asked questions]] will yield the same result as above, but without the link to [[Frequently asked questions]].

=== See also ===
* [[Template:Wlink]] – for formatting inline links to Wikipedia articles.

Template:Nowrap/doc

2025-10-31T10:09:32Z

Ganaram inukshuk:

{{dochead|mod=Variable arguments}}{{Wikipedia}}
The <code>{<nowiki />{nowrap}}</code> template stops wrapping of specific text that may happen at spaces, dashes, or parentheses. It is to be used for sections such as units, dates, and mathematical equations that should always stay together.

=== Usage ===
Pass in the text to be held together as a single unnamed parameter. Two or more unnamed parameters will result in individual chunks of non-wrapped text separated by a comma and space.

Leading and trailing whitespaces in the input parameters will be trimmed. Interior whitespaces will not wrap, but the spaces separating the generated <code><<nowiki />span></code> elements are ordinary spaces and will wrap by default.

{| class="wikitable"
|-
! You type
! Generated HTML
! Rendered output
|-
| {{{{ROOTPAGENAME}}|<code><nowiki>{{nowrap|10 kg (22 lb)}}</nowiki></code>}}
| <syntaxhighlight lang="html">10 kg (22 lb)</syntaxhighlight>
| {{{{ROOTPAGENAME}}|10 kg (22 lb)}}
|-
| {{{{ROOTPAGENAME}}|<code><nowiki>{{nowrap|1 Jan|2 Feb|3 Mar|4 Apr}}</nowiki></code>}}
| <syntaxhighlight lang="html">1 Jan, 2 Feb, 3 Mar, 4 Apr</syntaxhighlight>
| {{{{ROOTPAGENAME}}|1 Jan|2 Feb|3 Mar|4 Apr}}
|}

{{escape notice}}

Template:Lua/doc

2025-10-31T10:09:17Z

Ganaram inukshuk:

{{dochead|mod=Variable arguments}}{{Template rating|rating=deprecated|details=[[Template:Dochead]] and [[Template:Module introspection]] now fulfil the role of this template, which automatically finds and links to all dependencies.}}
{{clear}}{{wikipedia}}{{clear}}

On templates with modules, this template provides a link from the template or its documentation to the corresponding module.

=== Usage ===
Pass in the name of all modules used for a given template, separated by pipe characters:

{| class="wikitable"
|-
! You type !! You get
|-
| <code><nowiki>{{lua|Infobox ET}}</nowiki></code> || {{{{ROOTPAGENAMEE}}|Infobox ET}}
|-
| <code><nowiki>{{lua|Infobox ET|Utils}}</nowiki></code> || {{{{ROOTPAGENAMEE}}|Infobox ET|Utils}}
|}

If no argument is passed, there will be a single link to the module with the same name as the template.

Template:Breadcrumb/doc

2025-10-31T10:09:02Z

Ganaram inukshuk:

{{dochead|mod=Variable arguments}}{{templatestyles}}
The '''Breadcrumb''' template is used to manually insert a breadcrumb navigation bar at the top of a subpage in the main namespace. While MediaWiki has an [[mw:Help:Subpages|automated subpage feature]] that automatically inserts navigation breadcrumbs at the top of pages, this feature is normally disabled in the main (article) namespace since forward slashes in page titles may be misinterpreted as separators for subpages. On the Xenharmonic Wiki, forward slashes frequently appear in page titles, such as [[3/2]].

All subpages in the article namespace are filed under [[:Category:Article subpages]].

=== Usage ===
For pages in the (article) namespace, pass in each level of the subpage as a separate unnamed parameter.

For example, if a page titled <code>eiusmod tempor incididunt</code> is located within a page titled <code>adipiscing elit sed do</code>, which in turn is located in a page titled <code>dolor sit/amet/consectetur</code>, which is located in a master page titled <code>Lorem ipsum</code>, you would put, at the top of the page:

<pre>{{breadcrumb|Lorem ipsum|dolor sit/amet/consectetur|adipiscing elit sed do|eiusmod tempor incididunt}}</pre>

which gives:

{{{{ROOTPAGENAMEE}}|Lorem ipsum|dolor sit/amet/consectetur|adipiscing elit sed do|eiusmod tempor incididunt}}

Template:Odd-limit navigation/doc

2025-10-31T10:03:11Z

Ganaram inukshuk: Undo revision 215585 by Ganaram inukshuk (talk) testing worked; undo

{{Dochead|mod=Prime limit navigation}}
This template generates a box and navigation bar to help navigating through [[odd limit]] pages.

=== Usage ===
Use one unnamed argument for the odd limit.

=== Examples ===
You type

<pre>{{Odd limit navigation|5}}</pre>

You get

{{{{ROOTPAGENAME}}|5}}{{clear}}

Template:Odd-limit navigation/doc

2025-10-31T10:02:46Z

Ganaram inukshuk: testing

{{Dochead|mod=Prime limit navigation|detect_corr_page=false}}
This template generates a box and navigation bar to help navigating through [[odd limit]] pages.

=== Usage ===
Use one unnamed argument for the odd limit.

=== Examples ===
You type

<pre>{{Odd limit navigation|5}}</pre>

You get

{{{{ROOTPAGENAME}}|5}}{{clear}}

Template:Odd-limit navigation/doc

2025-10-31T10:00:37Z

Ganaram inukshuk:

Module:Dochead

2025-10-31T09:58:41Z

Ganaram inukshuk: bugfix removing /doc

-- This module follows [[User:Ganaram inukshuk/Provisional style guide for Lua]]
local getArgs = require("Module:Arguments").getArgs
local iutils = require("Module:Introspection utils")
local yesno = require("Module:Yesno")

local p = {}

-- TODO: Change requirements for lua-based template
-- FROM: detect whether a corresponding page exists
-- TO: detect whether it invokes ANYTHING at all

-- Produces a hatnote that is placed on the top of a documentation page (either
-- template or module documentation) and can autodetect and categorize:
-- - FOR MODULES:
-- - whether a module has an accompanying template (overridable/toggleable)
-- - whether a module is meant as a library for other modules
-- - FOR TEMPLATES:
-- - whether a template has an accompanying module (overridable/toggleable)
-- - what functions from which modules are invoked

-- Helper function
-- Categorizes pages if they're in the right namespace, and based on the nature
-- of the page
local function categorize(namespace, pagename, is_lua_based_template)
local is_lua_based_template = is_lua_based_template or false
local cats = ""

if pagename:match("/doc$") then
-- Documentation subpages
if namespace == "Template" then
cats = "[[Category:Template documentation]]"
elseif namespace == "Module" then
cats = "[[Category:Module documentation]]"
end
else
-- Main pages
if namespace == "Template" then
cats = "[[Category:Templates]]"
if is_lua_based_template then
cats = cats .. " [[Category:Lua-based templates]]"
end
elseif namespace == "Module" then
cats = "[[Category:Lua modules]]"
else
--cats = "[[Category:Templates in the incorrect namespace]]"
end
end

return cats
end

-- Helper function: categorize modules
local function categorize_module(pagename)
local cats = ""
if pagename:match("/doc$") then
cats = "[[Category:Module documentation]]"
else
cats = "[[Category:Lua modules]]"
end
return cats
end

-- Helper function to handle modules
function p.make_module_hatnote(header, pagename, corr_template, detect_corr_page)
-- Check whether corresponding template exists
-- Then check whether that template invokes the module
local has_template = iutils.page_exists("Template:" .. corr_template:gsub("/doc$", ""))

-- Check whether to use detect_corr_page option
-- If the header option is dualuse, metatemplate, or noinvoke, this option
-- is ignored. For any other option, it's not.
if header ~= "dualuse" and header ~= "metatemplate" and header ~= "noinvoke" then
has_template = has_template and detect_corr_page
end

-- If the module has a template, check for whether it invokes it.
if has_template then
local wikitext = iutils.get_and_preprocess_content("Template", corr_template:gsub("/doc$", ""))
local invokes = iutils.find_invokes(wikitext)
has_template = has_template and iutils.invocation_exists(invokes, pagename:gsub("/doc$", ""))
end

-- Heading meanings and usage on module
-- - dualuse means a template is implement by a module, but its template may
-- be bypassed by using its module directly from other modules.
-- - metatemplate is a special case of dualuse; the template-module pair is
-- for a metatemplate, a template used to build other templates.
-- - noinvoke indicates a lua-based template, but the module's code is so
-- specialized that its code should not be used by other modules or
-- invoked by other templates.
-- - metamodule and library indicate a module whose code is used mainly for
-- other modules. Such modules generally don't have a corresponding
-- template.
-- Does the module have a template?
-- - dualuse, metatemplate, and noinvoke: YES (REQUIRED!!)
-- - metamodule/library: GENERALLY NO
local result = ""
if header == "dualuse" then
if has_template then
result = string.format(
"This module may be invoked by templates using its corresponding template [[Template:%s]], or used directly from other modules.",
corr_template:gsub("/doc$", "")
)
else
result = string.format(
"This module has a corresopnding template that is currently missing or does not use this module. ([[Special:EditPage/Template:%s|edit template]])",
corr_template:gsub("/doc$", "")
)
end

elseif header == "metatemplate" then
if has_template then
result = string.format(
"This module implements a metatemplate, and may be invoked by templates using its corresponding template [[Template:%s]], or used directly from other modules.",
corr_template:gsub("/doc$", "")
)
else
result = "This module is used to create other Lua-based templates and has no corresponding template."
end

elseif header == "noinvoke" then
if has_template then
result = string.format(
"This module should not be invoked directly; use its corresponding instead: [[Template:%s]].",
corr_template:gsub("/doc$", "")
)
else
result = string.format(
"This module implements a template that is currently missing or does not use this module. ([[Special:EditPage/Template:%s|edit template]])",
corr_template:gsub("/doc$", "")
)
end

elseif header == "library" or header == "metamodule" then
result = "This module primarily serves as a library for other modules and has no corresponding template."

else
if has_template and header ~= "" then
result = string.format("%s This module implements [[Template:%s]].", header, corr_template:gsub("/doc$", ""))
elseif has_template and header == "" then
result = string.format("This module implements [[Template:%s]].", corr_template:gsub("/doc$", ""))
else
result = header
end
end

-- Produce categories
local cats = categorize_module(pagename)

-- Return
if result == "" then
return "" .. cats
else
return string.format(":''%s''%s\n", result, cats)
end
end

-- Helper function: categorize template
local function categorize_template(pagename, has_invoke)
local cats = ""
if pagename:match("/doc$") then
cats = "[[Category:Template documentation]]"
else
cats = "[[Category:Templates]]"
if has_invoke then
cats = cats .. " [[Category:Lua-based templates]]"
end
end
return cats
end

-- Helper function
-- Creates an additional hatnote denoting which functions are invoked from which
-- modules, if a has more than one invoke.
local function make_invocation_hatnote(invokes)
local hatnote = ""
if #invokes == 0 then
return ""
else
hatnote = "This template invokes the following functions:"
local calls = {}
for _, call in ipairs(invokes) do
local module_link = iutils.make_module_link(call.module)
table.insert(calls, string.format("'''%s''' from %s", call.func, module_link))
end
return string.format("%s %s.", hatnote, table.concat(calls, ", "))
end
end

-- Helper function to handle templates
function p.make_template_hatnote(header, pagename, corr_module, detect_corr_page)
-- Check whether corresponding module exists
-- Then check whether this template invokes the module
local has_module = iutils.page_exists("Module:" .. corr_module:gsub("/doc$", ""))

-- Check whether to use detect_corr_page option
-- If the header option is dualuse or metatemplate, this option is ignored.
-- For any other option, it's not (although it also has no effect on
-- noinvoke or library/metamodule).
if header ~= "dualuse" and header ~= "metatemplate" then
has_module = has_module and detect_corr_page
end

-- Check for whether the template invokes that module, regardless of whether
-- it uses the corresponding module.
local wikitext = iutils.get_and_preprocess_content("Template", pagename:gsub("/doc$", ""))
local invokes = iutils.find_invokes(wikitext)
local is_module_invoked = iutils.invocation_exists(invokes, corr_module:gsub("/doc$", ""))

-- Heading meanings and usage on templates
-- - dualuse means a template is implement by a module, but its template may
-- be bypassed by using its module directly from other modules.
-- - metatemplate is a special case of dualuse; the template-module pair is
-- for a metatemplate, a template used to build other templates.
-- - noinvoke and metamodule/library don't have use for templates.
-- Does the template have a module?
-- - dualuse and metatemplate: YES (REQUIRED!!)
-- - noinvoke and metamodule/library: options don't apply to templates.
-- RATIONALE FOR NOINVOKE NOT APPLYING: a template may invoke functions from
-- more than one module, but one of them must be the "main" module. Since
-- there's no way to autodetect that, that info must be manually entered.
-- If that doesn't happen
local result = ""
if header == "dualuse" then
if has_module and is_module_invoked then
result = string.format(
"This template is implemented by the Lua module [[Module:%s]]. See its module page for Lua-based template implementation.",
corr_module:gsub("/doc$", "")
)
elseif has_module and not is_module_invoked then
result = string.format(
"This template has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
corr_module:gsub("/doc$", "")
)
else
result = string.format(
"This template is implemented by a module that is currently missing. [[Special:EditPage/Module:%s]]",
corr_module:gsub("/doc$", "")
)
end

elseif header == "metatemplate" then
if has_module and is_module_invoked then
result = string.format(
"This template is a metatemplate. It is used to build other templates and should not be used standalone, except for testing or simple usage. This template is implemented by the Lua module [[Module:%s]].",
corr_module:gsub("/doc$", "")
)
elseif has_module and not is_module_invoked then
result = string.format(
"This metatemplate has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
corr_module:gsub("/doc$", "")
)
else
result = "This template is a metatemplate. It is used to build other templates and should not be used standalone, except for testing or simple usage."
end

elseif header == "noinvoke" or header == "library" or header == "metamodule" then
result = "This template has a header option in the wrong namespace. It should be used within the Module namespace."

else
if has_module and header ~= "" and is_module_invoked then
result = string.format(
"%s. This template is implemented by the Lua module [[Module:%s]].",
header,
corr_module:gsub("/doc$", "")
)
elseif has_module and header ~= "" and not is_module_invoked then
result = string.format(
"%s. This template has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
header,
corr_module:gsub("/doc$", "")
)
elseif has_module and header == "" and is_module_invoked then
result = string.format(
"This template is implemented by the Lua module [[Module:%s]].",
corr_module:gsub("/doc$", "")
)
elseif has_module and header == "" and not is_module_invoked then
result = string.format(
"This template has a corresponding Lua module [[Module:%s]], but does not invoke its functions.",
corr_module:gsub("/doc$", "")
)
else
result = header
end
end

-- Find all invocations for the template and add it as an addl hatnote.
local invocation_hatnote = make_invocation_hatnote(invokes)

-- Categorize
local cats = categorize_template(pagename, #invokes > 0)

if result == "" and invocation_hatnote == "" then
return ""
elseif result == "" and invocation_hatnote ~= "" then
return string.format(":''%s''%s\n", invocation_hatnote, cats)
elseif result ~= "" and invocation_hatnote == "" then
return string.format(":''%s''%s\n", result, cats)
else
return string.format(":''%s''\n:''%s''%s\n", result, invocation_hatnote, cats)
end
end

-- Main function
function p._dochead(args)
local namespace = args["namespace"]
local pagename = args["pagename"]
local header = args["header"] or "none"
local corr_template = args["temp"] or pagename
local corr_module = args["mod"] or pagename
local detect_corr_page = args["detect_corr_page"]

-- If header is none, skip everything
if header == "none" then
return categorize(namespace, pagename)
end

-- Call appropriate hatnote-making function
-- Remove /doc suffix if this is on a /doc page to ensure links are made
-- properly. :gsub("/doc$", "")
local result = ""
if namespace == "Module" then
result = p.make_module_hatnote(header, pagename, corr_template, detect_corr_page)
elseif namespace == "Template" then
result = p.make_template_hatnote(header, pagename, corr_module, detect_corr_page)
else
result = ":''This documentation template is in the wrong namespace. It should be within the Template or Module namespaces.''\n"
end

return result
end

-- Wrapper to be invoked
function p.dochead(frame)
local args = getArgs(frame, { removeBlanks = true }) or {}
local title = mw.title.getCurrentTitle()

-- Extract or parse args
args["namespace"] = args["namespace"] or title.nsText
args["pagename" ] = args["pagename" ] or title.text

-- Extract header or set it to defaults
if args["header"] == nil or args["header"] == "" then
if args["namespace"] == "Module" then
args["header"] = "noinvoke"
else
args["header"] = ""
end
end

-- Extract template/module names, or autogenerate them
args["temp"] = args["temp"] or args["pagename"]
args["mod" ] = args["mod" ] or args["pagename"]

-- Option to detect corresponding page (default true)
args["detect_corr_page"] = args["detect_corr_page"] == nil and true or yesno(args["detect_corr_page"])

return p._dochead(args)
end

function p.tester()
local args = {}

args["namespace"] = "Template"
args["pagename" ] = "Module introspection"

args["temp"] = args["pagename"]
args["mod" ] = args["pagename"]

args["header"] = ""

return p._dochead(args)
end

return p

Module:Variable arguments/doc

2025-10-31T09:52:11Z

Ganaram inukshuk:

{{documentation|{{dochead|header=This module should not be invoked directly; use its corresponding templates instead.|detect_corr_page=false}}
This module is used to store functions for templates that take a variable number of arguments but do not use [[:Module:Labelled list hatnote]]:
* [[Template:Breadcrumb]]
* [[Template:Lua]]
* [[Template:Nowrap]]
* [[Template:Wikipedia]]
{{clear}}
{{module introspection}}
}}