Jump to content

ICANNWiki:Documentation: Difference between revisions

From ICANNWiki
← Older edit
VisualWikitext
Christiane (talk | contribs)
Bureaucrats, steward, Administrators, translator
3,421 edits
Added content
 
(144 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This meta space for ICANNWiki Content Planning lists resources and concepts that are being worked on or need work performed in them.
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.


==Draft Content Guide for ICANNWiki==
==Content Guide for ICANNWiki==
Please refer to [[ICANNWiki:Content Guide]].


===Scope===
==ICANNWiki feature documentation==
===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.


ICANNWiki is concerned with all matters related to Internet Governance, not being limited to ICANN. The scope of this coverage is wide, but should not normally encompass subjects that would already be better covered elsewhere.
*'''Audio embedding'''
For a clear-cut example, it might be notable to outline that a person comes from a certain geographical region, for example, if they were responsible for bringing Internet connectivity to the Brazilian city of Embu das Artes. In that case, an external link to Wikipedia’s article on [https://en.wikipedia.org/wiki/Embu_das_Artes] would be ideal, rather than creating an article for ICANNWiki.
** Built-in via MediaWiki.
For a more subjective example, an article on router devices might be better covered by Wikipedia’s article [Router (computing)], although that might not be the case if an ICANNWiki volunteer wants to contribute their expert insights into how this affects Internet Governance. Meanwhile, an article on the practice of routing traffic can be assumed to be better covered by ICANNWiki’s specialized community in our [[Routing]] article.
** 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.


===Notability===
* '''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>.


The criteria for notability of an article are that of being relevant to Internet Governance or ICANN in general. The bar is intentionally set lower than Wikipedia in order to accommodate concepts and community members that would not otherwise be a fit to be included there.  
* '''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>


===Style===
* '''Show a template without invoking its categories'''
** Provided via [https://www.mediawiki.org/wiki/Extension:Scribunto Extension:Scribunto]
** Usage: <nowiki>{{#invoke:ShowTemplateContent|showTemplate|TEMPLATE NAME}}</nowiki>
** Example: <nowiki>{{#invoke:ShowTemplateContent|showTemplate|Template:Articles needing attention}}</nowiki>


Given the global nature of the ICANNWiki project and the diversity of its users, an academic tone is not expected from contributions. However, a professional tone is required. Usage of slang and stylistics outside of common rules is discouraged exactly to ensure an even playing field for all contributors. This normalization will be enforced by community managers and administrators.
* '''External data'''
In the case of companies, NGOs and other programs, writing must be neutral, without marketing. It is valid to say what a company does and how that is related to Internet Governance or how that company participates in ICANN. That is not to say that a company cannot list its services, but that should not be done as a sales pitch.
** 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>


==Requiring revision/Loose initiatives==
* '''Simple external linking'''
* [[ICANNWiki Quick Guide]]
** Makes use of [[Special:Interwiki]].
* [[ICANNWiki Murals]]
** Shortcuts to relevant projects: doi, rfc, wikibooks, wikicities, wikinfo, wikipedia, wikiquote, wikisource, wiktionary.
* [[City Guides]]
 
* [[Caricature Badges]]
* '''Semi-automated wiki maintenance'''
* [[T-Shirts]]
** Usage: These self-updating categories point to varied errors in the wiki that need fixing.
* [[Sponsorship Options]]
** [[:Category:Pages with broken file links]]
* [[ICANN Historical Timeline]]
** [[:Category:Pages using duplicate arguments in template calls]]
** [[:Category:Pages with reference errors]]
 
===SysOps and devs===
* '''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: <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.
* Edit sidebar: [[MediaWiki:Sidebar]]
* Welcome messages are dictated by: [[MediaWiki:Confirmaccount-welc]]
* Captchas are managed and can have their difficulty lowered or increased by: [https://www.mediawiki.org/wiki/Extension:ConfirmEdit]
* [[Special:CheckUser]]: Insights into technical information of users.
* [[Special:Nuke]]: Mass deletion of articles tool, for recent changes only.
* [[Special:ReplaceText]]: Mass text replacement across multiple articles.
* [[Special:BatchUpload]]: Batch file uploading via [https://www.mediawiki.org/wiki/Extension:SimpleBatchUpload Extension:SimpleBatchUpload].
* [https://www.mediawiki.org/wiki/Extension:Approved_Revs Extension:Approved Revs]: Sets an "approved revision" of an article that will display by default to readers instead of the current revision.
* [https://www.mediawiki.org/wiki/Extension:SpamBlacklist Extension:SpamBlacklist]: manual white or black list for URLs and email addresses at: [[MediaWiki:Spam-blacklist]], [[MediaWiki:Spam-whitelist]], [[MediaWiki:Email-blacklist]], [[MediaWiki:Email-whitelist]]
* [[Special:AbuseFilter]]: set specific reactions to actions by users, such as edits, match certain criteria. [https://www.mediawiki.org/wiki/Extension:AbuseFilter]
 
====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
 
==List of Lua modules==
Automated list:
{{Special:AllPages/Module:}}
 
==Wiki resources==
===ICANNWiki presence elsewhere===
* [https://en.wikipedia.org/wiki/ICANNWiki ICANNWiki on Wikipedia]
 
===Wikimedia===
* [https://en.wikipedia.org/wiki/Help:Wikitext Help:Wikitext]: Formatting reference
 
===Magic words===
* [https://en.wikipedia.org/wiki/Help:Magic_words Help:Magic words]: Magic words list
* <nowiki>{{NAMESPACENUMBER}}</nowiki>
* <nowiki>{{NUMBEROFARTICLES}}</nowiki>


==Resources==
===Pages===
===Pages===
* [[Special:AllPages]]
* [[Special:AllPages]]
Line 51: Line 123:
* [[Special:Statistics]]
* [[Special:Statistics]]
* [[Special:Version]]
* [[Special:Version]]
[[Category:ICANNWiki]]

Latest revision as of 18:50, 14 February 2025

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.

Content Guide for ICANNWiki

Please refer to ICANNWiki:Content Guide.

ICANNWiki feature documentation

All users

  • Video embedding
    • Provided via Extension:EmbedVideo.
    • Usage: {{#ev:service|id|dimensions|alignment|description|container|urlargs|autoresize|valignment}}
    • Example: {{#ev:youtube|mQr3zTKvnyE}} embeds a Youtube video of ICANN 40's opening press conference.
  • Audio embedding
    • Built-in via MediaWiki.
    • Usage: [[File:Name.extension|thumb/frameless|left/center/right|autostart=yes/no|loop=yes/no|start=number|end=number|Caption]]
    • Example: [[File:Test.mp3|Test]] embeds a media player for the file.
  • Mathematics
    • Provided via Extension:Math
    • Usage: <math>LaTeX-formatted math expression</math>
    • Example: <math>\frac{1}{2}/math> results in 12.
  • PDF
    • Provided via Extension:PdfHandler
    • Usage: PdfHandler display a PDF file like an image, generating thumbnails of its pages.
    • Example: [[File:Name.pdf|thumb|page=number|0px|Caption]]
  • Show a template without invoking its categories
    • Provided via Extension:Scribunto
    • Usage: {{#invoke:ShowTemplateContent|showTemplate|TEMPLATE NAME}}
    • Example: {{#invoke:ShowTemplateContent|showTemplate|Template:Articles needing attention}}
  • External data
    • Provided via Extension:External Data
    • Usage: See documentation.
    • Example: {{#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}}
  • 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: {{LowercaseTitle}}
  • Simple external linking
    • Makes use of Special:Interwiki.
    • Shortcuts to relevant projects: doi, rfc, wikibooks, wikicities, wikinfo, wikipedia, wikiquote, wikisource, wiktionary.

SysOps and devs

Page Notice

  • Provided via 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):

List of Lua modules

Automated list:

Wiki resources

ICANNWiki presence elsewhere

Wikimedia

Magic words

Pages

Categories

Users

Technical

Retrieved from "https://icannwiki.org/index.php?title=ICANNWiki:Documentation&oldid=1359151"