Wikiup:Lua/Modul/Vorlage:Auflistung/en

Vorlagenprogrammierung	Diskussionen	Lua			Unterseiten
		Modul	Deutsch	English	Modul:	Dokumentation

Vorlage:Auflistung – Module to present horizontal lists with separators as continuous text. The list itself is a block element.

Functions for templates

f

Present a list.

1

List of items; each line starting with one of * or #

If there is one item only no additional decoration will be generated.

nowrap

1 – Every item kept on the same line

sep

Contents of a separating <span> between items

styles

Name of a TemplateStyles page

classesBlock

Class(es) for entire block element

classesSep

Class(es) for separating <span>

failsafe

Version management

{{Wikipedia:Lua/Modul-Failsafe/en|Modul=Vorlage:Auflistung}}

Accessibility

Elements can be distinguished and navigated by screenreaders.

Functions for Lua modules (API)

All functions described above can be used by other modules per require():

local lucky, HorizontalList = pcall( require, "Module:Vorlage:Auflistung" )
if type( HorizontalList ) == "table" then
 HorizontalList = HorizontalList.HorizontalList()
else
 -- error case; HorizontalList contains message
 return "<span class=\"error\">" .. HorizontalList .. "</span>"
end

Subsequently there are available:

HorizontalList.f( all, altogether, apart, frame )

Generate horizontal list from wikitext.

• all – string, with wikitext; each line starting with one of * or #
• altogether – boolean, if nowrap applied around each regular item
• apart – string, for separating <span> between items, if desired
• frame – object, if available

Returns: string

HorizontalList.fiat( all, advance, altogether, apart, frame )

Generate horizontal list from table.

• all – table, with sequence of items.
  • Each item is a string or a mw.html object.
• advance – boolean, if <ol> requested
• altogether – boolean, if nowrap applied around each regular item
• apart – string, for separating <span> between items, if desired
• frame – object, if available

Returns: string

HorizontalList.first( arglist )

Configuration of CSS environment

• arglist – table, with optional configuration assignments; components:

  styles

  TemplateStyles page

  • string, with page name
  • mw.title object.

  classesBlock

  class(es) for entire block element

  • string, with class(es)
  • table, with components as string

  classesSep

  class(es) for separating <span>

  • string, with class(es)
  • table, with components as string

HorizontalList.failsafe( atleast )

atleast

optional; see above

Returns: string or boolean

Usage

General library; no limitations.

Dependencies

None.