View source for ICANNWiki:Documentation

{{Note|For content-related matters, please refer to [[ICANNWiki:Content Guide]].}}

This meta space is dedicated to ICANNWiki documentation, listing features, resources and concepts that are implemented into the project. Useful for maintainers and sysops, primarily.

For our guide for wiki developers on how to avoid Cumulative Layout Shifts (CLS), see: [[ICANNWiki:Documentation/CLS]]

==All users==
* '''Video embedding'''
** Provided via [https://www.mediawiki.org/wiki/Extension:EmbedVideo Extension:EmbedVideo].
** Usage: <nowiki>{{#ev:service|id|dimensions|alignment|description|container|urlargs|autoresize|valignment}}</nowiki>
** Example: <nowiki>{{#ev:youtube|mQr3zTKvnyE}}</nowiki> embeds a Youtube video of ICANN 40's opening press conference.

*'''Audio embedding'''
** Built-in via MediaWiki.
** Usage: <nowiki>[[File:Name.extension|thumb/frameless|left/center/right|autostart=yes/no|loop=yes/no|start=number|end=number|Caption]]</nowiki>
** Example: <nowiki>[[File:Test.mp3|Test]]</nowiki> embeds a media player for the file.

* '''Mathematics'''
** Provided via [https://www.mediawiki.org/wiki/Extension:Math Extension:Math]
** Usage: <nowiki><math>LaTeX-formatted math expression</math></nowiki>
** Example: <nowiki><math>\frac{1}{2}/math></nowiki> results in <math>\frac{1}{2}</math>.

* '''PDF'''
** Provided via [https://www.mediawiki.org/wiki/Extension:PdfHandler Extension:PdfHandler]
** Usage: PdfHandler display a PDF file like an image, generating thumbnails of its pages.
** Example: <nowiki>[[File:Name.pdf|thumb|page=number|0px|Caption]]</nowiki>

* '''External data'''
** Provided via [https://www.mediawiki.org/wiki/Extension:External_Data Extension:External Data]
** Usage: See [https://www.mediawiki.org/wiki/Extension:External_Data documentation].
** Example:<nowiki>
{{#get_web_data:
 |url   = https://example.com/data.json
 |format= json
 |data  = 
   var1 = /key1
   var2 = /key2
}}
Retrieved value: {{#external_value: var1}}
Another value:   {{#external_value: var2}}
</nowiki>

* '''Lowercase title'''
** Makes use of [[Template:LowercaseTitle]].
** If the correct version of a page name requires a leading lowercase letter, this template overrides the wiki's standard capitalization behavior on display to the user.
** Usage: <nowiki>{{LowercaseTitle}}</nowiki>

* '''Simpler external linking'''
** Makes use of [[Special:Interwiki]].
** Shortcuts to relevant projects: doi, rfc, wikibooks, wikicities, wikinfo, wikipedia, wikiquote, wikisource, wiktionary.
** Usage: <nowiki>[[rfc:1040]]</nowiki>

===Content templates===
Manual list:
* '''Template:OtherUses'''
** <nowiki>{{OtherUses|TargetPage}}</nowiki>  results in: ''For another use, see TargetPage.''
** <nowiki>{{OtherUses|Page1|Page2|Page3|Page4|Page5}}</nowiki> results in: ''For other uses, see Page1, Page2, Page3, Page4, Page5.''

* '''Template:Nosource'''
**  <nowiki>{{nosource|reason=|date=}}</nowiki>

===Needed pages trackers===
* [[Special:WantedCategories]]
* [[Special:WantedPages]]

===Semi-automated wiki maintenance===
These self-updating pages point to varied issues in the wiki that need fixing at a given point in time.
* [[:Category:Pages with broken file links]]
* [[:Category:Pages using duplicate arguments in template calls]]
* [[:Category:Pages with reference errors]]
* [[Special:UnusedFiles]]
* [[Special:ListDuplicatedFiles]]
* [[Special:BrokenRedirects]]
* [[Special:DoubleRedirects]]
* [[Special:UncategorizedPages]]
* [[Special:WantedFiles]]
* [[Special:WantedTemplates]]
* [[Special:UnusedCategories]]
* When our Lua templates fail to recognize a string, they generate an entry in: [[:Category:(Unrecognized)]]
** A more complete list with less relevant indicators can be found at: [[Special:TrackingCategories]]

===ICANNWiki's presence elsewhere===
* [https://en.wikipedia.org/wiki/ICANNWiki ICANNWiki on Wikipedia]
* [https://en.wikipedia.org/wiki/List_of_wikis ICANNWiki on Wikipedia's list of wikis]
* [https://www.instagram.com/icannwiki/ ICANNWiki on Instagram]
* [https://www.linkedin.com/company/icannwiki/ ICANNWiki on LinkedIn]
* [https://www.facebook.com/ICANNWiki ICANNWiki on Facebook]

==SysOps and devs==

===Information===

====Critical resources====
* '''Mediawiki installation data''': [[Special:Version]]
* '''Mediawiki metadata (API-JSON)''': [https://icannwiki.org/api.php?action=query&meta=siteinfo&format=json]
* '''Master actions log''': [[Special:Log]]
* '''Complete user list''': [[Special:ListUsers]] and the subset [[Special:ActiveUsers]]
* Indexing of '''[[Special:ListGrants]]'''
* Indexing of '''[[Special:ListGroupRights]]''' with "Namespace restrictions"
* '''User registration''' is manually reviewed to combat abuse using [[Special:ConfirmAccounts]].
* '''User investigation''', including email accounts, can be carried out with [[Special:UserInformation]] (exercise discernment).

====System inspection====
* '''Wiki-wide statistics''': [[Special:Statistics]]
* '''List Namespaces''': [[Special:NamespaceInfo]]
* '''List pages by Namespace''': [[Special:PrefixIndex]]
* '''List pages by properties''': [[Special:PagesWithProp]] (like "hiddencat", not semantics related)
* '''Meta information about pages''': [[Special:PageInfo]]
* '''Review all page protections''': [[Special:ProtectedPages]]
* '''Search files by extension''' [[Special:MIMESearch]] and '''see relevant extension statistics''' [[Special:MediaStatistics]]

===Structure===
{| class="wikitable"
|+ 
| Favicon || [[:File:Favicon.ico]] and [[:File:Favicon.svg]]
|-
| Change page content model || [[Special:ChangeContentModel]] (such as CSS, JSON, Wikitext, etc.)
|-
| Merge page histories || [[Special:MergeHistory]]
|-
| Debug output to browser console || Append '''<nowiki>?debug=true</nowiki>''' to the end of the URL
|-
| Expose element names in pages || append '''<nowiki>?uselang=qqx</nowiki>''' to the end of the URL
|-
| Fetch the raw version of a file from the wiki || append '''<nowiki>?action=raw</nowiki>''' to the end of the URL
|-
| Access article by its ID || '''<nowiki>https://icannwiki.org/index.php?curid=NUMBER</nowiki>''' Replace NUMBER with the page's ID
|}

===Actions===
{| class="wikitable"
|+ 
! Extension !! Description !! Comments
|-
| [[Special:CheckUser]] || Displays technical information about a user || [https://www.mediawiki.org/wiki/Extension:CheckUser Extension:CheckUser]
|-
| [[Special:Nuke]] || Mass deletion tool; recent changes only || Irreversible
|-
| [[Special:ReplaceText]] || Perform regex/text replacements across the entire wiki || Shows preview before acting
|-
| [[Special:BatchUpload]] || Batch file uploading || [https://www.mediawiki.org/wiki/Extension:SimpleBatchUpload Extension:SimpleBatchUpload]
|-
| [[Special:AbuseFilter]] || Triggers actions on edits matching defined patterns || [https://www.mediawiki.org/wiki/Extension:AbuseFilter Extension:AbuseFilter] Can auto-warn, block, or tag edits; requires filter definitions
|-
| Captchas || Reliant on [https://www.mediawiki.org/wiki/Extension:ConfirmEdit Extension:ConfirmEdit] || Customizable
|-
| [https://www.mediawiki.org/wiki/Extension:Approved_Revs Extension:Approved Revs] || Can mark a revision as “approved” for default view || Controls what revision the general public sees
|-
| [https://www.mediawiki.org/wiki/Extension:SpamBlacklist Extension:SpamBlacklist] || Whitelist/blacklist URLs and email addresses || Configured via: [[MediaWiki:Spam-blacklist]], [[MediaWiki:Spam-whitelist]], [[MediaWiki:Email-blacklist]], [[MediaWiki:Email-whitelist]]
|}

===System messages===
{| class="wikitable"
|+ 
! Feature !! Source
|-
|Change system messages || [[Special:AllMessages]]
|-
| Left-hand sidebar || [[MediaWiki:Sidebar]]
|-
| Right-hand sidebar || CSS exclusion of IDs in [[MediaWiki:Common.css]]
|-
| Welcome message || Upon account confirmation: [[MediaWiki:Confirmaccount-welc]]
|-
| Message to blocked users || [[MediaWiki:Blockedtext]]
|-
| Upload page instructions || [[MediaWiki:Uploadtext]]
|-
|}

====Our customized messages====
Automated list:
<div class="mw-allpages-body">
<DPL>
namespace=MediaWiki
ordermethod=title
order=ascending
redirects=exclude
mode=unordered
nottitlematch=%.js%
nottitlematch=%.css%
nottitlematch=%smw-
</DPL>
</div>

===Acronym tooltips===
* Makes use of [https://www.mediawiki.org/wiki/Extension:Lingo Extension:Lingo]
** Usage: The extension takes acronyms and their definitions from the [[Terminology]] article. The rendering of all tooltips on an article can be prevented with the magic word: <nowiki>__NOGLOSSARY__</nowiki>. To prevent tooltips only within a section, use: <nowiki><noglossary>Content</noglossary></nowiki>.
** Our syntax is: <nowiki>;ACRONYM:[[Internal Link]]. Brief description as per the most canonical source available, such as the ICANN Bylaws (''Source'').</nowiki>
** Note: Pluralization is not natively supported by the extension, and acronyms with potential plural forms need to be declared manually.

===Page Notice===
* Provided via [https://www.mediawiki.org/wiki/Extension:PageNotice Extension:PageNotice]. 
* Usage: The syntax is "MediaWiki:''Bottom''/''Top''-notice-''ns-0''/''name''", where a page is created with either the Bottom or Top allocation, and for display either a namespace is chosen by its number, or a name string for a page is specified.
* Currently active (manual list):
** [[MediaWiki:Bottom-notice-ns-0]]: Main Namespace
** [[MediaWiki:Bottom-notice-ns-4]]: ICANNWiki Namespace
** [[MediaWiki:Top-notice-ns-2]]: User Namespace
** [[MediaWiki:Top-notice-ns-102]]: Property Namespace

===Semantics-related===
* [[Special:ProcessingErrorList]]
* [[Special:Categories]]
* [https://www.semantic-mediawiki.org/wiki/Help:Special_properties List of applicable Special properties]

===Gadgets===
Gadgets are powerful self-contained JS actions that are loaded ahead of [[MediaWiki:Common.js]], being loaded almost in tandem with the DOM. They need to be declared individually in [[MediaWiki:Gadgets-definition]], and the most useful arguments to use with them are "default" (which effectively turns them into a ResourceLoader) and "hidden" (cannot be disabled by users).
* '''List''': [[Special:Gadgets]]
* '''Usage''': [[Special:GadgetUsage]]

==List of Lua modules==
Automated list:
{{Special:AllPages/Module:}}

==List of semantic properties==
Automated list:
{{Special:AllPages/Property:}}

==External resources==
===Magic words===
* [https://en.wikipedia.org/wiki/Help:Magic_words Help:Magic words]: Magic words list
** <nowiki>{{NAMESPACENUMBER}}</nowiki>
** <nowiki>{{NUMBEROFARTICLES}}</nowiki>

===MediaWiki Customization===
* [https://en.wikipedia.org/wiki/Wikipedia:Customisation#Tidying_up_the_user_interface Tidying up the user interface]

===Fandom===
* [https://dev.fandom.com/wiki/Global_Lua_Modules Global Lua Modules]
* [https://dev.fandom.com/wiki/JavaScript_Cookbook JavaScript Cookbook]
* [https://dev.fandom.com/wiki/List_of_JavaScript_enhancements JavaScript enhancements]

<!-- Categories -->
[[Category:ICANNWiki]]