Wikipedia:Lua/Modul/Vorlage:Runeberg/en

aus Wikipedia, der freien Enzyklopädie
Zur Navigation springen Zur Suche springen
Vorlagenprogrammierung Diskussionen Lua Unterseiten
Modul Deutsch English

Modul: Dokumentation

Vorlage:Runeberg – Module to support templates referring to runeberg.org projects.

Functions for templates

[Quelltext bearbeiten]
range
Volume title
Parameter:
suite
Code of digitalisation project
DBL or NF or Salmonsen
ed
Edition (1 or 2 if needed)
optional
vol
Volume number (1–…)
suppl
Supplement
optional boolean
1 or 0 or empty
wwwLink
External link to text reproduction
Parameter:
suite
Code of digitalisation project
DBL or NF or Salmonsen
ed
Edition (1 or 2 if needed)
optional
vol
Volume number (1–…)
optional, if required edition number provided.
sub
Column number or printed page number
optional, if volume number provided.
page
Scanned sheet number
optional, if volume number provided.
Must not be specified together with sub.
suppl
Supplement
optional boolean
1 or 0 or empty
failsafe
Version management

The Failsafe interface is heading for version management of globally distributed Lua modules. It enables modules equipped with this interface to

  • ensure, that a library module required by a template or another module available as local copy does support certain functionality, or complain if not.
  • administrate global updating and linking of module codes via Wikidata.

The Failsafe interface is present both at template level and for direct Lua access.

The functions in detail are (not all supported yet completely by every library):

Parameter
Value Result current
nothing
false
local version ID »2023-12-18«
Minimal version version ID required at least
date in ISO format

It will be compared whether the current local implementation matches this version or later.

  • empty, if minimal version not achieved
  • 2001-01-01 → »2023-12-18«
  • 2099-01-01 → »«
wikidata version ID of global upstream
  • version ID at Wikidata
  • local, if not found there
»2023-12-18«
item ID of the Wikidata item
  • empty if not defined
Q123906537
~ Corresponding version ID locally and registered at Wikidata
  • empty, if up to date
  • version ID at Wikidata, if not equal
»«
@ Is the current (module) page linked correctly with Wikidata item?
  • empty, if linked to the item which is supposed
  • Iitem ID, if not
»Q123906537«
The return value is in template programming empty or under Lua false, otherwis a non-empty string as described.

Digitalisation projects

[Quelltext bearbeiten]

The following digitalisation projects are currently supported:

  • DBL – Dansk biografisk Lexikon (1887…1905)
  • NF – Nordisk familjebok (1876…1926)
  • Salmonsen – Salmonsen, 2nd edition

Error management

[Quelltext bearbeiten]

On parameter errors in a productive function the following parameters will be considered:

errCat
Title of a maintenance category in case of error
optional
errClass
Class (additional to error) for error message
optional
errStyle
CSS style definition for error message
optional
errText
Text of error message
optional

Dependencies

[Quelltext bearbeiten]

None.

Functions for Lua modules (API)

[Quelltext bearbeiten]

Some functions described above can be used by other modules:

local lucky, Runeberg = pcall( require, "Modul:Vorlage:Runeberg" )
if type( Runeberg ) == "table" then
    Runeberg = Runeberg.Runeberg()
else
    -- failure; Runeberg is the error message
    return "<span class='error'>" .. Runeberg .. "</span>"
end
Runeberg.failsafe(atleast)
  1. atleast
    optional
    nil or minimal version request or "wikidata"
Returns: string or false