Magic words & parser functions

From Redazione
Jump to navigation Jump to search
Line 32: Line 32:
 
|returns the real names from a list of usernames
 
|returns the real names from a list of usernames
 
|-
 
|-
|ci_pageTitlesAttribution
+
|ci_editors_attribution
|returns the string "edited by [real name], affiliated to [organization name]" from a list of usernames of editors of a page
+
|returns the string "edited by [real name], affiliated to [organization name]" from an [https://www.semantic-mediawiki.org/wiki/Help:Inline_queries ask query] returning editors of a page
 
|-
 
|-
 
|ci_noparse_isHTML
 
|ci_noparse_isHTML
Line 102: Line 102:
 
|list
 
|list
 
|-
 
|-
|ci_pageTitlesAttribution
+
|ci_editors_attribution
 
|<nowiki>wikicode with links, in the form [[complete path|page name]] followed by a string in the form "created by [editor real name] affiliated to [editor affiliation]</nowiki>
 
|<nowiki>wikicode with links, in the form [[complete path|page name]] followed by a string in the form "created by [editor real name] affiliated to [editor affiliation]</nowiki>
 
|list, delimiter, kind of output (ul or comma separated values)
 
|list, delimiter, kind of output (ul or comma separated values)
Line 110: Line 110:
  
  
'''ci_pageTitlesAttribution'''
+
'''ci_editors_attribution'''
  
 
<pre class="language-wiki">
 
<pre class="language-wiki">
{{#ci_pageTitlesAttribution: {{#ask:
+
{{#ci_editors_attribution: {{#ask:
 
[[Category:Reading suggestions]]
 
[[Category:Reading suggestions]]
 
|format=array
 
|format=array
Line 142: Line 142:
  
  
'''ci_editors_realnames'''<pre class="language-wiki">
+
'''ci_editors_realnames'''
 +
 
 +
<pre class="language-wiki">
 
{{#ci_editors_realnames: {{#ask:  
 
{{#ci_editors_realnames: {{#ask:  
 
[[{{PAGENAME}}]]  
 
[[{{PAGENAME}}]]  

Revision as of 06:25, 1 September 2020

Parser functions are a way to empower the wiki text (the specific language through which pages of all wikis are written, thus one can also use Visual editor where available) with some programmatic feature, for instance the ability to add the current date to a page (which will update during subsequent access) or to trigger whatever other function available in the wiki on the server side.

Currently this platform offers the following additional parser functions. They are prefixed with the string "ci_" to distinguish them easily from other Mediawiki magic words and parser functions, either standard or provided by other extensions.

Here is a list of the currently available functions

function name what it does
ci_userAffiliatedTo shows the organization to which the logged in user is affiliated
ci_userRealName shows the real name of logged in user (by contrast to the username)
ci_isSysop returns 1 if the logged in user is an admin ("sysop")
ci_loggedIn returns 1 if the page's visitor is logged in
ci_visitorIsoCode returns the iso code of country of the visitor
ci_visitorCountry returns the country name of the visitor
ci_editors_realnames returns the real names from a list of usernames
ci_editors_attribution returns the string "edited by [real name], affiliated to [organization name]" from an ask query returning editors of a page
ci_noparse_isHTML prevents Mediawiki from html encoding output



Instructions of use

(Note: thus the following are formally parser functions, currently they don't expect arguments and therefore they shall be converted to magic words in a second time)

"magic words"

function name return value example result
ci_userAffiliatedTo logged in user affiliation {{#ci_userAffiliatedTo:}}
ci_userRealName logged in user real name {{#ci_userRealName:}}
ci_isSysop whether the logged in user is an administrator or not {{#ci_isSysop:}}
ci_loggedIn whether the user is logged in or not {{#ci_loggedIn:}}
ci_visitorIsoCode country code of user (based on the ip) {{#ci_visitorIsoCode:}} US
ci_visitorCountry country of user (based on the ip) {{#ci_visitorCountry:}} United States


parser functions

(Note: because the structured pages path is a core feature of this forked version of Mediawiki, the output currently produced by the following parser functions should returned as default, and conversely they could be used to retrieve the complete page path)

function return value parameter
ci_editors_realnames comma separated real names list
ci_editors_attribution wikicode with links, in the form [[complete path|page name]] followed by a string in the form "created by [editor real name] affiliated to [editor affiliation] list, delimiter, kind of output (ul or comma separated values)

Examples

ci_editors_attribution

{{#ci_editors_attribution: {{#ask:
[[Category:Reading suggestions]]
|format=array
|?Page creator
|?Page author
|sep=##
}}|##|ul}}

will create the following list:

to be noted that the output returned by the ask query above will be as follows:

Announcements/European Commission - Supporting the cultural and creative sectors in the ACP countries<PROP>User:Luca.speziale<PROP>User:Admin<MANY>User:Luca.speziale##Announcements/General Secretariat of the Council - Traineeships at the General Secretariat of the Council<PROP>User:Luca.speziale<PROP>User:Admin<MANY>User:Luca.speziale##Announcements/Language school "Praticamente" - Lavoro per un insegnante di inglese in Kazakistan per 3 mesi presso la Scuola di lingua Italiana “Praticamente”<PROP>User:Luca.speziale<PROP>User:Admin<MANY>User:Luca.speziale

therefore the function ci_pageTitlesAttribution will parse the output using the standard Semantic Mediawiki <PROP> and <MANY> delimiters and will retrieve the real name and the user affiliation from the username: then, it will return an unordered list as above.


ci_editors_realnames

{{#ci_editors_realnames: {{#ask: 
[[{{PAGENAME}}]] 
|?Page creator
|?Page author
|format=array
|mainlabel=-
|sep=##
}}
}}

will produce the following output:


As above, the output produced by the ask query, will be similar to the following:

User:MediaWiki default<PROP>User:Admin<MANY>User:Luca.speziale<MANY>User:MediaWiki default

and applies as above with the difference that the output produced by the ci_editors_realnames function will be a comma separated list of real names of provided usernames.