Difference between revisions of "Module:Diacritics/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>RexxS
(examples)
 
blackwiki>RexxS
(documentation)
Line 1: Line 1:
{{tl|Module rating |<!-- Values:  pre-alpha • alpha • beta • release • protected  --  If a rating not needed/relevant, delete this template call -->}}
+
{{Module rating |release }}
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
  
 +
== Functions ==
 +
 +
* convertChar returns the non-diacritic version of the supplied character.
 +
* stripDiacrits replaces words containing diacritical characters with their non-diacritic equivalent.
 +
* isLike tests two words, returning true if they only differ in diacritics, nothing otherwise.
 +
* strip_diacrits is available for export to other modules.
 +
* is_like is available for export to other modules.
 +
 +
== Usage ==
 +
 +
* <code><nowiki>{{#invoke:Diacritics |convertChar | single-character }}</nowiki></code>
 +
* <code><nowiki>{{#invoke:Diacritics |convertChar |char=single-character}}</nowiki></code>
 +
* <code><nowiki>{{#invoke:Diacritics |stripDiacrits |word or words }}</nowiki></code>
 +
* <code><nowiki>{{#invoke:Diacritics |stripDiacrits |word=word or words}}</nowiki></code>
 +
* <code><nowiki>{{#invoke:Diacritics |isLike | word1 or words1 | word2 or words2 }}</nowiki></code>
 +
* <code><nowiki>{{#invoke:Diacritics |isLike |word1=word1 or words1 |word2=word2 or words2}}</nowiki></code>
  
 
== Examples ==
 
== Examples ==
Line 19: Line 35:
 
* <code><nowiki>{{#invoke: Diacritics |isLike | Álvar Núñez | Alvar Nunez }}</nowiki></code> → {{#invoke: Diacritics |isLike | Álvar Núñez | Alvar Nunez }}
 
* <code><nowiki>{{#invoke: Diacritics |isLike | Álvar Núñez | Alvar Nunez }}</nowiki></code> → {{#invoke: Diacritics |isLike | Álvar Núñez | Alvar Nunez }}
 
* <code><nowiki>{{#invoke: Diacritics |isLike | Álvar | Núñez }}</nowiki></code> → {{#invoke: Diacritics |isLike | Álvar | Núñez }}
 
* <code><nowiki>{{#invoke: Diacritics |isLike | Álvar | Núñez }}</nowiki></code> → {{#invoke: Diacritics |isLike | Álvar | Núñez }}
 
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|''function_name''}}</code>
 
  
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |

Revision as of 13:42, 17 November 2018

Functions

  • convertChar returns the non-diacritic version of the supplied character.
  • stripDiacrits replaces words containing diacritical characters with their non-diacritic equivalent.
  • isLike tests two words, returning true if they only differ in diacritics, nothing otherwise.
  • strip_diacrits is available for export to other modules.
  • is_like is available for export to other modules.

Usage

  • {{#invoke:Diacritics |convertChar | single-character }}
  • {{#invoke:Diacritics |convertChar |char=single-character}}
  • {{#invoke:Diacritics |stripDiacrits |word or words }}
  • {{#invoke:Diacritics |stripDiacrits |word=word or words}}
  • {{#invoke:Diacritics |isLike | word1 or words1 | word2 or words2 }}
  • {{#invoke:Diacritics |isLike |word1=word1 or words1 |word2=word2 or words2}}

Examples

  • {{#invoke: Diacritics |convertChar |char=è }} → e
  • {{#invoke: Diacritics |convertChar | ß }} → ss
  • {{#invoke: Diacritics |stripDiacrits |word = Fred}} → Fred
  • {{#invoke: Diacritics |stripDiacrits | Fred }} → Fred
  • {{#invoke: Diacritics |stripDiacrits | café }} → cafe
  • {{#invoke: Diacritics |stripDiacrits | décidé }} → decide
  • {{#invoke: Diacritics |stripDiacrits | chère }} → chere
  • {{#invoke: Diacritics |stripDiacrits | Übersetzung }} → Ubersetzung
  • {{#invoke: Diacritics |stripDiacrits | Álvar Núñez Cabeza de Vaca }} → Alvar Nunez Cabeza de Vaca
  • {{#invoke: Diacritics |isLike | Núñez | Nunez }} → true
  • {{#invoke: Diacritics |isLike | Núñez | Núñez }} → true
  • {{#invoke: Diacritics |isLike | Nunez | Nunez }} → true
  • {{#invoke: Diacritics |isLike | Álvar Núñez | Alvar Nunez }} → true
  • {{#invoke: Diacritics |isLike | Álvar | Núñez }}