Modul:h3/dok

Syfte

Modulens syfte är att bistå andra moduler med information om h3-koder. Att konvertera mellan kortformer och olika långformer. "H3" kommer från rubriknivån som används på uppslag, vilket är den rubriknivå som brukar ange ordklass eller motsvarande. Se Wiktionary:Stilguide#Ordklassrubriken respektive Wiktionary:Stilguide#Ordklasskategorisering.

Användning

Den här modulen bör bara användas av andra moduler, inte direkt från mallar.

local h3 = require("Modul:h3")

local short_h3 = h3.getShort("preposition")
local singular_h3 = h3.getLongSing("prep")
local singular_first_letter_capitalized_h3 = h3.getLongSingUCFirst("prep")
local plural_h3 = h3.getLongPlur("prep")
local plural_first_letter_capitalized_h3 = h3.getLongPlurUCFirst("prep")
local determined_form_singular_h3 = h3.getLongDetSing("prep")
local determined_form_singular_first_letter_capitalized_h3 = h3.getLongDetSingUCFirst("prep")
local is_prep_a_h3_code = h3.hasH3("prep")
local is_prepositioner_a_plural_form_of_h3 = h3.hasH3("Prepositioner")

Specifikation

getShort

1= h3-kod eller valfri långform (i.e. "prep" eller "preposition", "prepositioner", "prepositionen"), inte skiftlägeskänsligt

Returnerar h3-koden.

Default-värde: "".

getLongSing

1= h3-kod eller valfri långform, inte skiftlägeskänsligt

Default-värde: "".

Returnerar långformen i singular, t.ex. "preposition" för h3-koden "prep".

getLongSingUCFirst

1= h3-kod eller valfri långform, inte skiftlägeskänsligt

Returnerar långformen i singular med första bokstaven versaliserad, t.ex. "Preposition" för h3-koden "prep".

Default-värde: "".

getLongPlur

1= h3-kod eller valfri långform, inte skiftlägeskänsligt

Returnerar långformen i plural, t.ex. "prepositioner" för h3-koden "prep".

Default-värde: "".

getLongPlurUCFirst

1= h3-kod eller valfri långform, inte skiftlägeskänsligt

Returnerar långformen i plural med första bokstaven versaliserad, t.ex. "Prepositioner" för h3-koden "prep".

Default-värde: "".

getLongDetSing

1= h3-kod eller valfri långform, inte skiftlägeskänsligt

Returnerar långformen i bestämd form singular, t.ex. "prepositionen" för h3-koden "prep".

Default-värde: "".

getLongDetSingUCFirst

1= h3-kod eller valfri långform, inte skiftlägeskänsligt

Returnerar långformen i bestämd form singular med första bokstaven versaliserad, t.ex. "Prepositionen" för h3-koden "prep".

Default-värde: "".

hasH3

1= h3-kod eller valfri långform, inte skiftlägeskänsligt

Returnerar ett booleskt värde för om h3-objektet kan hittas.

Default-värde: false.

Tester

All tests passed. (refresh)

test1_get_long_sing:

	Text	Expected	Actual
	h3.getLongSing("subst")	substantiv	substantiv
	h3.getLongSing("prep")	preposition	preposition
	h3.getLongSing("Preposition")	preposition	preposition
	h3.getLongSing("Prepositioner")	preposition	preposition
	h3.getLongSing("Prepositionen")	preposition	preposition

test2_get_long_sing_ucfirst:

	Text	Expected	Actual
	h3.getLongSingUCFirst("subst")	Substantiv	Substantiv
	h3.getLongSingUCFirst("prep")	Preposition	Preposition
	h3.getLongSingUCFirst("preposition")	Preposition	Preposition

test3_get_long_plur:

	Text	Expected	Actual
	h3.getLongPlur("subst")	substantiv	substantiv
	h3.getLongPlur("prep")	prepositioner	prepositioner
	h3.getLongPlur("Preposition")	prepositioner	prepositioner

test4_get_long_plur_ucfirst:

	Text	Expected	Actual
	h3.getLongPlurUCFirst("subst")	Substantiv	Substantiv
	h3.getLongPlurUCFirst("prep")	Prepositioner	Prepositioner
	h3.getLongPlurUCFirst("preposition")	Prepositioner	Prepositioner

test5_get_short:

	Text	Expected	Actual
	h3.getShort("subst")	subst	subst
	h3.getShort("prep")	prep	prep
	h3.getShort("preposition")	prep	prep
	h3.getShort("Preposition")	prep	prep

test6_get_long_det_sing:

	Text	Expected	Actual
	h3.getLongDetSing("subst")	substantivet	substantivet
	h3.getLongDetSing("prep")	prepositionen	prepositionen
	h3.getLongDetSing("Preposition")	prepositionen	prepositionen

test7_get_long_det_sing_ucfirst:

	Text	Expected	Actual
	h3.getLongDetSingUCFirst("subst")	Substantivet	Substantivet
	h3.getLongDetSingUCFirst("prep")	Prepositionen	Prepositionen
	h3.getLongDetSingUCFirst("preposition")	Prepositionen	Prepositionen

test8_has_h3:

	Text	Expected	Actual
	h3.hasH3("subst")	true	true
	h3.hasH3("Substantiv")	true	true
	h3.hasH3("xyz")	false	false

test9_return_default:

	Text	Expected	Actual
	h3.getShort("wrongh3short")
	h3.getLongSing("wrongh3long")
	h3.getLongPlur("wrongh3long")
	h3.getLongDetSing("wrongh3long")