Wikipedia:Lua/Modul/Sort/en - Versionsgeschichte

PerfektesChaos: updates

2024-02-04T19:58:28Z

updates

← Nächstältere Version		Version vom 4. Februar 2024, 21:58 Uhr
Zeile 3:		Zeile 3:

	== Functions for templates ==		== Functions for templates ==
	* ~~All~~ functions evaluate the first parameter as term to be sorted.		* The sort functions (Tlatin left only) evaluate the first parameter as term to be sorted.
	** If there is no first parameter provided by <code>#invoke</code> the first parameter of surrounding template transclusion will be used.		** If there is no first parameter provided by <code>#invoke</code> the first parameter of surrounding template transclusion will be used.
	* Optional parameters of <code>#invoke</code> specify input and result format and further capabilities.		* Optional parameters of <code>#invoke</code> specify input and result format and further capabilities.
Zeile 19:		Zeile 19:
	* Multiple whitespace is reduced to single space.		* Multiple whitespace is reduced to single space.
	Casing (upcased/downcased) will remain; that can be eliminated easily from result.		Casing (upcased/downcased) will remain; that can be eliminated easily from result.

			=== textOrder ===
			The value is <code>1</code> if the first string is lexical less than second string else ''empty''.
			; Mandatory parameters, leading whitespace is significant
			:; 1
			:: first string
			:; 2
			:: second string

	=== failsafe ===		=== failsafe ===
			Version management
	; Purpose
			{{Wikipedia:Lua/Modul-Failsafe/en\|Modul=Sort}}
	: Version ID (local): <code>{{#invoke:Sort\|failsafe}}</code>
	: Optional parameter:
	:* <code>1</code> – Minimum version or <code>wikidata</code> <!-- or <code>~</code> -->
	: <code><nowiki>{{#invoke:Sort\|failsafe}}</nowiki></code> yields <code>{{#invoke:Sort\|failsafe}}</code>
	: With a parameter as ISO date it is compared whether the current module satisfies this version or later.
	:* <code><nowiki>{{#invoke:Sort\|failsafe\|2001-01-01}}</nowiki></code> returns: »<code>{{#invoke:Sort\|failsafe\|2001-01-01}}</code>«
	:* <code><nowiki>{{#invoke:Sort\|failsafe\|2099-01-01}}</nowiki></code> returns: »<code>{{#invoke:Sort\|failsafe\|2099-01-01}}</code>« – (empty), if minimal version condition not matched
	:* If keyword is <code>wikidata</code>, result is version ID registered on Wikidata (<code>{{#invoke:Sort\|failsafe\|wikidata}}</code>) or local if not found there.
	:* If keyword is <code>~</code>, result is ''empty'' if local and Wikidata version are the same: (<code>{{#invoke:Sort\|failsafe\|~}}</code>).
	: ''Returns:''
	:* Empty, if minimal version condition not matched, or <code>~</code> and local version is synchronized.
	:* Version ID if no parameter, or if <code>wikidata</code>, or local if not found there, or not synchronized.

	=== Examples (test page) ===		=== Examples (test page) ===
Zeile 46:		Zeile 43:
	local lucky, Sort = pcall( require, "Module:Sort" )		local lucky, Sort = pcall( require, "Module:Sort" )
	if type( Sort ) == "table" then		if type( Sort ) == "table" then
	Sort = ~~Sort.~~Sort()		Sort = Sort()
	else		else
	-- In the event of errors, Sort is an error message.		-- In the event of errors, Sort is an error message.
Zeile 74:		Zeile 71:
	:: ''nil'' or minimum version or <code>wikidata</code> or <code>~</code> for synchronisation		:: ''nil'' or minimum version or <code>wikidata</code> or <code>~</code> for synchronisation
	: ''returns:'' Version ID as ''string'' or <code>false</code>		: ''returns:'' Version ID as ''string'' or <code>false</code>

			Until 2023 <code>Sort = Sort.Sort()</code> has been recommended for initialization.

	== Installation on other WMF projects ==		== Installation on other WMF projects ==

PerfektesChaos: +

2024-01-15T13:26:04Z

← Nächstältere Version		Version vom 15. Januar 2024, 15:26 Uhr
Zeile 84:		Zeile 84:
	# Ready.		# Ready.
	# Consider translation of doc page.		# Consider translation of doc page.
			# Consider [[Module:Sort/local]] [[#Adaption to local wiki\|adaption to local wiki]].

			=== Adaption to local wiki ===
			[[Module:Sort/local]], if present, permits local configuration.
			; simpleDatePattern
			: pattern for <code>#time:</code> – formatting one particular day
			: ''Default:'' <code>j M Y</code>

	== Usage ==		== Usage ==
Zeile 101:		Zeile 108:
	* [[Module:Sort/utf8max2bytes]] containing a collation table only reducing to 2 Bytes in [[UTF-8]].		* [[Module:Sort/utf8max2bytes]] containing a collation table only reducing to 2 Bytes in [[UTF-8]].
	* [[Module:Sort/unquote]] supports discarding of quotation marks.		* [[Module:Sort/unquote]] supports discarding of quotation marks.
			* [[Module:Sort/local]] [[#Adaption to local wiki\|adaption to local wiki]].

	=== Envisioned ===		=== Envisioned ===

PerfektesChaos: -

2021-02-02T19:34:55Z

@@ Zeile 19: / Zeile 19: @@
 * Multiple whitespace is reduced to single space.
 Casing (upcased/downcased) will remain; that can be eliminated easily from result.
 === failsafe ===
@@ Zeile 91: / Zeile 68: @@
 :: variant ''(string, optional)''
 ::* <code>"DIN5007m2"</code>
 ; Sort.failsafe( atleast )
 : Versioning interface similar to [[#failsafe|failsafe]]
@@ Zeile 136: / Zeile 100: @@
 * [[Module:Sort/currency]] containing a collation table for currency symbols.
 * [[Module:Sort/utf8max2bytes]] containing a collation table only reducing to 2 Bytes in [[UTF-8]].
 * [[Module:Sort/unquote]] supports discarding of quotation marks.

PerfektesChaos: Setup

2019-10-28T21:53:59Z

Setup

Neue Seite

{{LuaModuleDoc}}
<onlyinclude>'''<code>Sort</code>''' – module with auxilary functions to create sortable keys.

== Functions for templates ==
* All functions evaluate the first parameter as term to be sorted.
** If there is no first parameter provided by <code>#invoke</code> the first parameter of surrounding template transclusion will be used.
* Optional parameters of <code>#invoke</code> specify input and result format and further capabilities.
Return value is always the sort key.

=== Tlatin ===
Alphanumeric terms in latin based scripts are reduced to basic characters of [[American Standard Code for Information Interchange|ASCII]] set.

; Optional parameters
:; v
:: Variant
:: ''Default:'' ISO (simplify all diacritic characters; ligatures of two letters)
::* <code>DIN5007m2</code> ([[Alphabetische Sortierung|DIN 5007 Variante 2]])
* Various typografic codes for spaces, horizontal dashes and invisible characters are reduced to ASCII.
* Multiple whitespace is reduced to single space.
Casing (upcased/downcased) will remain; that can be eliminated easily from result.

=== Tn ===
Numerical values.

; Remarks
: A sort key shall be inserted into a lexical set and correct order ensured by leading zero digits. Negative values are to be ordered in correct lexical sequence.
: Minus signs may precede as ASCII or Unicode (U+2212, 8722<sub>10</sub>); leading plus sign will be ignored.
; Optional parameters
:; d
:: decimal separator
:: ''Default:'' ASCII dot
:; t
:: grouping separator (one or two).
:: Simultaneous request of dot and apostrophe is possible for German/Swiss segmentation.
:: ''Default:'' none
:; z
:: number of leading digits, die links mit Nullen aufgefüllt werden
:: ''Default:'' 15
:; m
:: Negative Werte zusammenhalten, aber nach Betrag sortieren
:: ''Default:'' Alle Zahlen nach Wert aufsteigend

Siehe auch die Auskopplung [[Wikipedia:Lua/Modul/Sort/N15|Sort/N15]] zur Performance-Optimierung.

=== failsafe ===
; Purpose
: Version ID (local): <code>{{#invoke:Sort|failsafe}}</code>
: Optional parameter:
:* <code>1</code> – Minimum version or <code>wikidata</code> 
: <code><nowiki>{{#invoke:Sort|failsafe}}</nowiki></code> yields <code>{{#invoke:Sort|failsafe}}</code>
: With a parameter as ISO date it is compared whether the current module satisfies this version or later.
:* <code><nowiki>{{#invoke:Sort|failsafe|2001-01-01}}</nowiki></code> returns: »<code>{{#invoke:Sort|failsafe|2001-01-01}}</code>«
:* <code><nowiki>{{#invoke:Sort|failsafe|2099-01-01}}</nowiki></code> returns: »<code>{{#invoke:Sort|failsafe|2099-01-01}}</code>« – (empty), if minimal version condition not matched
:* If keyword is <code>wikidata</code>, result is version ID registered on Wikidata (<code>{{#invoke:Sort|failsafe|wikidata}}</code>) or local if not found there.
:* If keyword is <code>~</code>, result is ''empty'' if local and Wikidata version are the same: (<code>{{#invoke:Sort|failsafe|~}}</code>).
: ''Returns:''
:* Empty, if minimal version condition not matched, or <code>~</code> and local version is synchronized.
:* Version ID if no parameter, or if <code>wikidata</code>, or local if not found there, or not synchronized.

=== Examples (test page) ===
A [[../Test|test page]] illustrates results on input formats.

== Date and time ==
That is implemented by the module [[Wikipedia:Lua/Modul/DateTime/de|DateTime]].
</onlyinclude>
== Functions for Lua modules (API) ==
All functions described above can be used by other modules:
<syntaxhighlight lang="lua">
local lucky, Sort = pcall( require, "Module:Sort" )
if type( Sort ) == "table" then
Sort = Sort.Sort()
else
-- In the event of errors, Sort is an error message.
return "<span class='error'>" .. Sort .. "</span>"
end
</syntaxhighlight>

; Sort.lex( adjust, apply, adapt )
: Similar to [[#Tlatin|Tlatin]].
:; adjust
:: term ''(string)''
:: ''mandatory''
:; apply
:: base script ''(string)''
::* <code>"latin"</code>
::* <code>"cyrillic"</code>
::* <code>"greek"</code>
::* <code>"uni"</code>
:: ''currently'' <code>latin</code> ''available only''
:; adapt
:: variant ''(string, optional)''
::* <code>"DIN5007m2"</code>
; Sort.num( value, d, t, z, m )
: Similar to [[#Tn|Tn]].
:; value
:: numerical value ''(string, number)''
:: ''mandatory''
:; d
:: decimal separator ''(string)''
:; t
:: one or two grouping separators ''(string)''
:; z
:: number of leading digits ''(number)''
:; m
:: numerical values vertically aligned by amount ''(boolean)''
; Sort.failsafe( atleast )
: Versioning interface similar to [[#failsafe|failsafe]]
:; atleast
:: ''optional''
:: ''nil'' or minimum version or <code>wikidata</code> or <code>~</code> for synchronisation
: ''returns:'' Version ID as ''string'' or <code>false</code>

== Installation on other WMF projects ==
Follow the steps:
# Copy main module <code>[[Module:Sort]]</code> into your project.
#* If possible keep the name <code>Sort</code>.
#* If another name is required due to conflict or naming convention or non-latin script then choose a different one.
# Register this module at [[d:Q24205172]].
# Copy desired [[#Sub modules|sub modules]], and keep the chosen root name.
# Ready.
# Consider translation of doc page.

== Usage ==
General library; no limitations.

== Dependencies ==
No other than [[#Sub modules|sub modules]].

== Sub modules ==
* [[Module:Sort/latin]] containing the collation table for latin based scripts.
* [[Module:Sort/latinDIN5007m2]] containing the collation table for DIN 5007 Variante 2.
* [[Module:Sort/latinAT]] containing the collation table specific for Austrian.
* [[Module:Sort/latinCS]] containing the collation table specific for Czechoslovakian.
* [[Module:Sort/latinDA]] containing the collation table specific for Danish.
* [[Module:Sort/latinScand]] containing a collation table specific for scandinavian languages.
* [[Module:Sort/currency]] containing a collation table for currency symbols.
* [[Module:Sort/utf8max2bytes]] containing a collation table only reducing to 2 Bytes in [[UTF-8]].
* [[Module:Sort/N15]] containing a performance optimized version for numeriscal values.
* [[Module:Sort/unquote]] supports discarding of quotation marks.

=== Envisioned ===
* ''Module:Sort/cyrillic'' – containing collation table for cyrillic based scripts (Ukrainian etc.).
* ''Module:Sort/greek'' – containing collation table for greek scripts (polytonic).
* ''Module:Sort/uni'' – containing collation table for all (letter based?) script systems.

== Internationalisation ==
Not necessary.

[[Category:Wikipedia:Lua/Modul/Dokumentation|Sort/en]]