Bulgogi2: Created page with "{{Module rating|beta}} {{lua|Module:WikitextParser |Module:yesno |Module:CatMark}} This module is a shared toolkit metamodule for modules that assign categories from infobox parameters. It provides the ability to "read" infobox fields, matching aliases, handling overrides and suppression, and creating category links. This module does not decide what the information it reads means, instead, submodules specifically tailored for an infobox must supply that logic and inter..."

2026-10-11T01:09:11Z

Created page with "{{Module rating|beta}} {{lua|Module:WikitextParser |Module:yesno |Module:CatMark}} This module is a shared toolkit metamodule for modules that assign categories from infobox parameters. It provides the ability to "read" infobox fields, matching aliases, handling overrides and suppression, and creating category links. This module does not decide what the information it reads means, instead, submodules specifically tailored for an infobox must supply that logic and inter..."

New page

{{Module rating|beta}}

{{lua|Module:WikitextParser
|Module:yesno
|Module:CatMark}}

This module is a shared toolkit metamodule for modules that assign categories from infobox parameters. It provides the ability to "read" infobox fields, matching aliases, handling overrides and suppression, and creating category links. This module does not decide what the information it reads means, instead, submodules specifically tailored for an infobox must supply that logic and interpretation. Submodules must also decide which configuration(s) to load{{Note|No records are loaded automatically. You can find a "registrar list" of records as subpages of this module or in a list below.}}{{Note|When compiling provided alias sets, earlier sets will have priority over later sets for the same alias or domain, "ownership". Beware!}}, and which categories to add. The toolkit does not render an infobox, nor does it have a main function. Therefore, it cannot be invoked directly, per design.

== reading infobox values ==
{{Tip|You need to have some experience with [[Lua]] to be able to understand anything below this section, or if you want to make a submodule.}}

{| class="wikitable"

! function

! result

|-

| <code>trim(value)</code>

| Converts a value to trimmed text. <code>nil</code> becomes an empty string.

|-well

| <code>normalize(value, mode)</code>

| Lowercases text. Default or <code>compact</code> removes nonword characters. <code>spaced</code> replaces runs of them with spaces, if you need that.

|-

|<code>clean(value)</code>

| Returns text for matching. It will remove references, hidden markers, comments, and tags. It substitutes displayed wikilink text and external link labels removes bare HTTP(S) urls and decodes entities. It is an analysis aid only.

|-

| <code>findYears(value)</code>

| finds distinct{{Note|Read more on Lua frontier patterns to understand what this means exactly.}} four-digit years in the cleaned text, in encounter order.
|-
| <code>findYearRanges(value)</code>
| if the parameter you want to read recommends years be entered as YYYY - YYYY, use this function. It will find all distinct pairs, returning, for example, <code><nowiki>{{'2020', '2022'}, ...}</nowiki></code> . It does not expand or interpret ranges. -, em dash, whatever dash, all are supported.
|-
| <code>findLinkTargets(value, opts)</code>

| Returns distinct wikilink targets as prefixed page titles, ignoring display labels, refs, and fragments. Defaults to namespace <code>0</code>, <code>opts.namespaces</code> changes the allowed list. '''It does not resolve redirects'''{{Note|Avoid redirects with this thing like the plague, avoid redirects in general}}
|-

| <code>[[Module:CatMark|readDataAttr]](value, name)</code>

| Reads all <code>data-cat-''name''</code> attribute values produced by [[Module:CatMark]]. Returns a list of decoded strings. The name argument may only contain letters, digits, and hyphens. Read CatMark to learn more about using it.

|-

| <code>parseNumber(value)</code>

| Parses a [[autism|signed decimal number]] after removing commas and whitespace. Returns <code>nil</code> if invalid.

|-

| <code>pickBand(number, bands)</code>

| Finds the eligible "band" with the greatest <code>min</code> and returns its <code>name</code>. Returns <code>nil</code> if none qualifies.

|}

For <code>pickBand</code>, keep in mind that bands are records such as <code>{min=100, name = '100 SoyBooru posts'}</code>. In other words, the subject module decides which number to read and whether a band category applies.
== Alias set handling ==

<code>compileAliasSet(sets, options)</code> (reported as CAS in errors) compiles an ordered list of sets. Each set is a list of category records, with aliases and, optionally, domains identifying each category. For CAS to function, '''sets must be wrapped, even if there is just one.''' Wrap them like this:

<syntaxhighlight lang="lua">

local subjectSites = {

{ category = '4chan', aliases = { '4chan', '4cuck' }, domains = { '4chan.org' } },

{ category = 'Soyjak.party', aliases = { 'sharty', 'soyjak.party' } },

}

local sharedSites = mw.loadData('Module:Infobox categorizer/sites')
local sites = core.compileAliasSet({ subjectSites, sharedSites })
local matches = core.matchAliasSets(args.frequented_sites, sites)
</syntaxhighlight>

The order of the sets determine priority. The first set to claim an alias or domain will own that claim, later sets cannot assign the same claim to another category, in other words, that claim is occupied. Putting a subject's records before shared records lets the subject override "global" records. As an example, if a country set assigns "Frog" as an alias to France, and NAS sets "Frog" to Pepe, and both are loaded with the same matching mode & case setting (defaults mean this is likely, read more below), whichever set comes first will own "Frog". Keep this in mind with complicated infoboxes, since as time passes the list of aliases will grow and conflicting sets will become inevitable. You must choose what are the appropriate sets to load and their order.

After compilation, <code>matchAliasSets(value, compiled)</code> (reported as MAS in errors) searches an input for the compiled aliases and domains. It returns every matching category once. For example, an input containing "4cuck" and "sharty" can return both "4chan" and "soyjak.party". MAS returns allow the subject module to categorize a field containing several sites, countries, or other recognized values. Record with the same category label are merged during compilation.

{{Bantext|Within a single set, two different categories cannot claim the same alias after normalization}}{{Note|Under the same matching mode and case setting.}} or the same normalized domain. This is because each alias claim within a set must have one owner. Assigning "Frog" to both France and Pepe is contradictory, so CAS rejects the set with a config error. To fix this, remove or reassign the duplicate alias. If the competing sets are intentional, place them in separate sets and sort them by priority. In separately loaded sets, the conflicts are resolved by load order.

An alias can be a string or a record containing additional matching settings if the situation calls for it. For example, the country code for the United States is "US". To avoid false flag detection of "us", making "US" case sensitive prevents lowercase "us" from matching and exact matching requires the entire field to be "US" only. This is done with <code>{'US', match = 'exact', caseSensitive = true}</code>{{Note|Remember, wiki content is extremely unpredictable and things that seem minute as this are still a key issue that you have to consider.}} The matching mode setting can be supplied through <code>options.match</code>, <code>set.match</code>, or <code>entry.match</code>, or the individual alias <code>match</code> setting. The more specific setting wins, the individual alias always has the highest priority. The default mode is <code>word</code>. Case sensitive-matching is enabled through <code>caseSensitive = true</code> on a record.

more snca to add later
{{notelist}}

<includeonly>

[[Category:Titles namespaces and categories modules]]

[[Category:Utility modules]]

</includeonly>

Module:Infobox categorizer/doc - Revision history