View source for Module:Dependencies/doc

{{documentation|git=true}}

The folded Technical details panel on module and template pages: which pages use the page, what it uses, and the functions a module defines.

Module:Documentation shows it on every documented module and template, and [[MediaWiki:Scribunto-doc-page-does-not-exist]] on a module with no <code><nowiki>/doc</nowiki></code>.

== For module editors ==

=== API ===

Each page's row lives in the <code><nowiki>dependencies</nowiki></code> table of [https://www.mediawiki.org/wiki/Extension:Bucket Extension:Bucket], schema <code><nowiki>Bucket:Dependencies</nowiki></code>, generated by <code><nowiki>mise run bucket:schemas</nowiki></code> from <code><nowiki>properties.json</nowiki></code>, registered in <code><nowiki>Module:BucketQuery/manifests.json</nowiki></code>.

* <code><nowiki>panel(options) → string</nowiki></code>: the panel followed by the page's categories, or the categories alone when the panel would be empty. Writes the page's row when the render is the page itself.

{| class="wikitable"
|-
! Field
! Type
! Default
! Meaning
|-
| <code><nowiki>page</nowiki></code>
| string
| the current page
| The page to describe. A <code><nowiki>/doc</nowiki></code> page describes the page it documents.
|-
| <code><nowiki>addCategories</nowiki></code>
| boolean or string
| true, except on a <code><nowiki>/doc</nowiki></code> render
| Whether to add the categories below.
|-
| <code><nowiki>sources</nowiki></code>
| list of <code><nowiki>{ label, text }</nowiki></code>
| none
| A Source row above the other rows, one line per entry's <code><nowiki>text</nowiki></code> (wikitext), with each <code><nowiki>label</nowiki></code> (plain text) leading the folded header's facts. Module:Documentation passes the page's wiki-tools and Wikipedia origins.
|}

* <code><nowiki>main(frame)</nowiki></code>: <code><nowiki>panel()</nowiki></code> for the current page, as <code><nowiki>{{#invoke:Dependencies|main}}</nowiki></code>.
* With categories on, a template with at least one invoke joins <code><nowiki>[[Category:Lua-based templates]]</nowiki></code>, a module that requires <code><nowiki>strict</nowiki></code> joins <code><nowiki>[[Category:Strict mode modules]]</nowiki></code>, and a module nothing invokes, requires, or loads joins <code><nowiki>[[Category:Unused modules]]</nowiki></code>.
* The functions come from [[Module:Module toc]].
* Uses lists, under Files, the image files the page names: a module string that is a whole file name, a template's <code><nowiki>[[File:…]]</nowiki></code> or a parameter value that is a whole file name, and media URLs (<code><nowiki>https://media.starcitizen.tools/a/ab/<File></nowiki></code>) in either one or in the page's own <code><nowiki>/styles.css</nowiki></code> when the page loads it. Rendered on the page itself, each file is a thumbnail in a 20px box, which records the page under the file's File usage; the <code><nowiki>/doc</nowiki></code> and sandbox renders show the name alone. Files are not stored in Bucket.

=== Gotchas ===

* The folded header sits inside <code><nowiki><summary></nowiki></code>, so it holds plain text only: a link there would be followed instead of opening the panel.
* A page writes its row only while rendering itself: never from its <code><nowiki>/doc</nowiki></code>, or a title containing <code><nowiki>/sandbox</nowiki></code> or <code><nowiki>/testcases</nowiki></code>, or starting with <code><nowiki>Sandbox/</nowiki></code>, in either namespace. Such a page is never flagged unused. A module's Used by row reads other pages' rows when the module's own page renders, so a new dependent appears after that page is next re-parsed.
* Only literal module names are stored. A dynamic <code><nowiki>require('Module:X/' .. name)</nowiki></code> is shown as <code><nowiki>Module:X/…</nowiki></code> and stored nowhere.
* A template that never shows <code><nowiki>{{Documentation}}</nowiki></code> writes no row, so the modules it invokes do not list it; a module whose <code><nowiki>/doc</nowiki></code> never shows it writes no row either.
* Stylesheet pages show no panel, so a stylesheet's users are listed on the page that owns it: <code><nowiki>Module:Icon</nowiki></code> lists who loads <code><nowiki>Module:Icon/styles.css</nowiki></code> under Styles used by. Only a <code><nowiki>/styles.css</nowiki></code> subpage has an owner. Loading a module's stylesheet does not use its code: a module whose only users load its stylesheet is still unused.
* When the Bucket lookup fails, a module's Used by row says the list is unavailable, and the module is not flagged unused.
* A file drawn as a CSS mask, through <code><nowiki>{{filepath:}}</nowiki></code> or a stylesheet URL, records no use on the pages that show it. The Files thumbnail is the only record, made against the page whose source names the file, and it keeps the file off Special:UnusedFiles.
* A module's file name built while the page runs shows as a pattern with no thumbnail, such as <code><nowiki>Sc-icon-brand-….svg</nowiki></code>, when string literals are joined with names, calls or indexes, or fill a <code><nowiki>string.format</nowiki></code> pattern. A pattern with nothing literal but the extension is dropped, and a name built any other way, or in a template from a parameter, is not seen.
* A file chosen from data (API images, Bucket values) is not seen either. The page that draws it records it only when it draws a <code><nowiki>[[File:]]</nowiki></code>; drawn as a mask, nothing records it.
* Any string that is a whole file name counts, even a sentence that happens to end in one.
* A media URL is checked against its name. A path that is not the md5 of the name is flagged, and so is a file that has moved: <code><nowiki>[[File:]]</nowiki></code> follows the redirect, so the thumbnail still shows, but the URL no longer works. The moved check is one expensive lookup per file named by a URL.
* A missing file shows as a red link, and MediaWiki adds the page to its hidden <code><nowiki>Category:Pages with broken file links</nowiki></code>.
* An SVG thumbnail is a silhouette in the text colour, the way the wiki draws most icons, so a colour logo shows without its colours. A raster thumbnail keeps its own colours.