Oa10712: 1 revision imported

2022-09-06T03:36:01Z

1 revision imported

← Older revision	Revision as of 22:36, 5 September 2022
(No difference)

en>WingerBot: Semi-manually rename category refs named "LANG terms .* script" to "Requests for .* script for LANG terms"

2019-10-29T04:57:52Z

Semi-manually rename category refs named "LANG terms .* script" to "Requests for .* script for LANG terms"

New page

This module provides access to [[Module:scripts]] from templates, so that they can make use of the information stored there. It also provides a number of functions that can be used by other modules.

Data is found in [[Module:script utilities/data]].

== Exported functions ==

=== lang_t ===
<code><nowiki>{{#invoke:script utilities|lang_t}}</nowiki></code>

This is used by {{temp|lang}} to wrap portions of text in a language tag. See there for more information.

=== tag_text ===
<code>tag_text(text, lang, sc, face, class)</code>

Wraps the given text in HTML tags with appropriate CSS classes (see [[WT:CSS]]) for the [[Module:languages#Language objects|language]] and script. This is required for all non-English text on Wiktionary.

The actual tags and CSS classes that are added are determined by the <code>face</code> parameter. It can be one of the following:
; {{code|lua|"term"}}
: The text is wrapped in {{code|html|2=...}}.
; {{code|lua|"head"}}
: The text is wrapped in {{code|html|2=...}}.
; {{code|lua|"hypothetical"}}
: The text is wrapped in {{code|html|2=*...}}.
; {{code|lua|"bold"}}
: The text is wrapped in {{code|html|2=...}}.
; {{code|lua|nil}}
: The text is wrapped in {{code|html|2=...}}.

The optional <code>class</code> parameter can be used to specify an additional CSS class to be added to the tag.

=== tag_translit ===
<code>tag_translit(translit, lang, kind, attributes)</code>

Tags the transliteration for given text <code>translit</code> and language <code>lang</code>. It will add the language, script subtag (as defined in [https://www.rfc-editor.org/rfc/bcp/bcp47.txt BCP 47 2.2.3]) and [https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir dir] (directional) attributes as needed.

The optional <code>kind</code> parameter can be one of the following:
; {{code|lua|"term"}}
: tag transliteration for {{temp|mention}}
; {{code|lua|"usex"}}
: tag transliteration for {{temp|usex}}
; {{code|lua|"head"}}
: tag transliteration for {{temp|head}}
; {{code|lua|"default"}}
: default

The optional <code>attributes</code> parameter is used to specify additional HTML attributes for the tag.

=== request_script ===
<code>request_script(lang, sc)</code>

Generates a request to provide a term in its native script, if it is missing. This is used by the {{temp|rfscript}} template as well as by the functions in [[Module:links]].

The function will add entries to one of the subcategories of [[:Category:Requests for native script by language]], and do several checks on the given language and script. In particular:
* If the script was given, a subcategory named "Requests for (script) script" is added, but only if the language has more than one script. Otherwise, the main "Requests for native script" category is used.
* Nothing is added at all if the language has no scripts other than Latin and its varieties.

=== template_rfscript ===
<code><nowiki>{{#invoke:script utilities|template_rfscript}}</nowiki></code>

This is used by {{temp|rfscript}}. See there for more information.

== See also ==
* [[Module:scripts]] — script related code
* [[Module:scripts/data]] — script data module
* [[Module:JSON data]] — for exporting all the script data at once

<includeonly>
[[Category:General utility modules]]
</includeonly>

Module:Script utilities/documentation - Revision history

Oa10712: 1 revision imported

en>WingerBot: Semi-manually rename category refs named "LANG terms .* script" to "Requests for .* script for LANG terms"