Module:Subject bar/sandbox/doc: Difference between revisions

Latest revision as of 23:21, 14 March 2025

@@ Line 1: / Line 1: @@
-{{documentation subpage}}
+<includeonly>
-Sandbox for [[Module:Subject bar]] & [[Template:Subject bar]].
+{{Lua|Module:Portal bar|Module:Sister project links|Module:TableTools|Module:Arguments}}
+This module implements the {{tl|Subject bar}} template. Please don't use this module from an article or from another wiki page. You should use the {{tl|Subject bar}} template instead. To use the module from another Lua module, read on.
+For test cases, see {{tl|Subject bar/testcases}}.
+== Use from another Lua module ==
+Load the module like this:
+<syntaxhighlight lang="lua">
+local subjectBar = require('Module:Subject bar')._main
+</syntaxhighlight>
+Then you can use the <code>subjectBar</code> function like this:
+<syntaxhighlight lang="lua">
+local myBar = subjectBar{
+    portal = 'Portal 1',
+    portal2 = 'Portal 2',
+    -- ...
+    commons = true,
+    commons-search = 'Commons search string',
+    wikt = true,
+    wikt-search = 'Wiktionary search string'
+    -- ...
+}
+</syntaxhighlight>
+Please see [[Template:Subject bar/doc]] for a full list of possible parameters.
+[[Category:Module sandboxes]]
+[[Category:Module sand&test]]
+</includeonly>
+<noinclude>
+[[Category:Module documents]]
+[[Category:Module sand&test documents]]
+</noinclude>