Class:Event: Unterschied zwischen den Versionen
Noémi (Diskussion | Beiträge) (Requesting the autocreation of ClassEvent for pages of type property) |
Noémi (Diskussion | Beiträge) K (Textersetzung - „date_format=dd.mm.yyyy“ durch „date_format=dd.mm.yy“) |
||
| (5 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
| Zeile 25: | Zeile 25: | ||
|form_textareaAttributes_editor=wikieditor | |form_textareaAttributes_editor=wikieditor | ||
|template_name=Event | |template_name=Event | ||
|parameter_parameter={{Classgenerator/parameter}} | |parameter_parameter={{Classgenerator/parameter | ||
|name=title | |||
|cardinality=single | |||
|description=Der Titel des Ereignisses. Sollte bereits Kerninformationen enthalten, so dass man beim Lesen des Titels schon weiß, worum es sich handelt. | |||
Wichtig: keine Generika verwenden. | |||
|label=Titel | |||
|property=Yes | |||
|property_name=is titled | |||
|property_type=Text | |||
|severity=mandatory | |||
|sf=Yes | |||
|td_type=line | |||
|input_type=text | |||
|placeholder=Kurzbeschreibung | |||
}}{{Classgenerator/parameter | |||
|name=event_date | |||
|cardinality=single | |||
|description=Das Datum des Ereignisses. Sollte sich ein Ereignis über mehrere Tage erstrecken, bitte den Anfangstag angeben. | |||
|label=Datum | |||
|property=Yes | |||
|property_name=took place on | |||
|property_type=Date | |||
|severity=mandatory | |||
|sf=Yes | |||
|td_type=date | |||
|input_type=datepicker | |||
|default=01.06.2000 | |||
|date_format=dd.mm.yy | |||
|disable_input_field=false | |||
|enable_input_field=true | |||
|highlight_days_of_week=0, 6 | |||
|show_reset_button=true | |||
|show_week_numbers=true | |||
|week_start=1 | |||
}}{{Classgenerator/parameter | |||
|name=event_placing | |||
|cardinality=single | |||
|description=Fand das Ereignis an einem uns bekannten (und vielleicht im CamNet eingetragenen) Schauplatz statt oder ist die Verortung frei? | |||
|label=Verortung | |||
|property=No | |||
|severity=mandatory | |||
|sf=Yes | |||
|td_type=line | |||
|values=Schauplatz, frei, | |||
|input_type=radiobutton | |||
|default=frei | |||
|show_on_select=Schauplatz=event_location, frei=event_address, frei=event_coordinates, frei=event_incity, | |||
}}{{Classgenerator/parameter | |||
|name=event_location | |||
|cardinality=single | |||
|description=Hier bitte den Schauplatz angeben, an dem das Ereignis statt gefunden hat. | |||
|label=Schauplatz | |||
|property=Yes | |||
|property_name=took place at location | |||
|property_type=Page | |||
|severity=mandatory | |||
|sf=Yes | |||
|td_type=line | |||
|input_type=combobox | |||
|existing_values_only=false | |||
|values_from_category=Schauplätze | |||
}}{{Classgenerator/parameter | |||
|name=event_address | |||
|cardinality=single | |||
|description=Falls man das Ereignis verorten kann und der Ort bekannt ist, können eine Adresse oder die Koordinaten angeben werden. | |||
In dem Fall taucht das Ereignis ebenfalls auf der Kartenansicht auf. Wird beides angegeben, wird die Eingabe für Koordinaten bevorzugt. | |||
Allerdings ist uns die Angabe einer Adresse lieber: Lässt sich für Nutzer einfacher lesen! :) | |||
|label=Adresse | |||
|property=Yes | |||
|property_name=has address | |||
|property_type=Text | |||
|severity=suggested | |||
|sf=Yes | |||
|td_type=line | |||
|input_type=text | |||
}}{{Classgenerator/parameter | |||
|name=event_coordinates | |||
|cardinality=single | |||
|description=Falls man das Ereignis verorten kann und der Ort bekannt ist, können eine Adresse oder die Koordinaten angeben werden. | |||
In dem Fall taucht das Ereignis ebenfalls auf der Kartenansicht auf. Wird beides angegeben, wird die Eingabe für Koordinaten bevorzugt. | |||
|label=Koordinaten | |||
|property=Yes | |||
|property_name=has geo coordinates | |||
|property_type=Geographic coordinate | |||
|severity=suggested | |||
|sf=Yes | |||
|td_type=line | |||
|input_type=googlemaps | |||
|center=40.7412551,-73.9940724 | |||
|geoservice=googlemaps | |||
|height=300 | |||
|width=400 | |||
|zoom=13 | |||
}}{{Classgenerator/parameter | |||
|name=event_incity | |||
|cardinality=single | |||
|description=Die Stadt, in der das Ereignis statt fand. | |||
|label=Stadt | |||
|property=Yes | |||
|property_name=Is located in city | |||
|property_type=Page | |||
|severity=suggested | |||
|sf=Yes | |||
|td_type=wiki-page-name | |||
|input_type=combobox | |||
|placeholder=Stadtname | |||
|existing_values_only=false | |||
|values_from_category=Städte | |||
}}{{Classgenerator/parameter | |||
|name=event_incity2 | |||
|cardinality=single | |||
|description=Die Stadt, in der das Ereignis statt fand. Wird in attribut "took place in city" abgelegt, welches für zeitliche abläufe den Stadtbezug herstellt. | |||
Das oben verwendete "Is located in city" wird im geographischen Kontext genutzt. | |||
|label=Stadt | |||
|property=Yes | |||
|property_name=Took place in | |||
|property_type=Page | |||
|severity=suggested | |||
|sf=No | |||
}}{{Classgenerator/parameter | |||
|name=event_persons | |||
|cardinality=list | |||
|description=Involvierte Personen | |||
|label=Personen | |||
|property=Yes | |||
|property_name=has cast | |||
|property_type=Page | |||
|severity=suggested | |||
|sf=Yes | |||
|td_type=wiki-page-name | |||
|input_type=tokens | |||
|placeholder=Namen | |||
|existing_values_only=false | |||
|mapping_property=Has display title | |||
|values_from_category=Personen | |||
}}{{Classgenerator/parameter | |||
|name=event_description | |||
|cardinality=single | |||
|description=Eine (kurze) Beschreibung des Ereignisses mit allen wichtigen Informationen. Im Text kann auf andere Seiten wikitypisch verlinkt werden. | |||
|label=Beschreibung | |||
|property=Yes | |||
|property_name=has short description | |||
|property_type=Text | |||
|severity=mandatory | |||
|sf=Yes | |||
|td_type=string | |||
|input_type=textarea | |||
|editor=wikieditor | |||
|rows=10 | |||
}}{{Classgenerator/parameter | |||
|name=on_page | |||
|cardinality=single | |||
|description=Auf welcher CamNet-Seite wurde dieses Ereignis hinzugefügt | |||
|label=Seite | |||
|property=Yes | |||
|property_name=Is associated to page | |||
|property_type=Page | |||
|severity=mandatory | |||
|sf=No | |||
}} | |||
}} | }} | ||
Aktuelle Version vom 16. Februar 2016, 19:44 Uhr
| Class | |
|---|---|
| Title | Ereignis |
| Änderungsdatum | 16.02.2016 19:44:05 |
| Store available | smw |
| Smw class | Event |
| Namespace | MAIN |
| Beschreibt ein bemerkenswertes Ereignis im Spielgeschehen. Etwas so wichtiges, dass man es auf der Timeline angeführt haben möchte. | |
| Pages | |
| Module | Module:Event |
| Class | Module:Event/class |
| Config | Module:Event/config |
| Template | Template:Event |
| Identity | |
| title | Titel |
| event_date | Datum |
| event_placing | Verortung |
| event_location | Schauplatz |
| event_address | Adresse |
| event_coordinates | Koordinaten |
| event_incity | Stadt |
| event_persons | Personen |
| event_description | Beschreibung |
| event_incity2 | Stadt |
| on_page | Seite |
| Properties | |
| Text | Has_address |
| Page | Has_cast |
| Geographic coordinate | Has_geo_coordinates |
| Text | Has_short_description |
| Page | Is_associated_to_page |
| Text | Is_identified_by_classengine_through |
| Page | Is_located_in_city |
| Text | Is_member_of_class |
| Text | Is_titled |
| Page | Took_place_at_location |
| Page | Took_place_in |
| Date | Took_place_on |
Beschreibt ein bemerkenswertes Ereignis im Spielgeschehen. Etwas so wichtiges, dass man es auf der Timeline angeführt haben möchte.
Class identity
| Parameter | Label | Severity | Cardinality | Description |
|---|---|---|---|---|
| title | Titel | mandatory | single | Der Titel des Ereignisses. Sollte bereits Kerninformationen enthalten, so dass man beim Lesen des Titels schon weiß, worum es sich handelt.
Wichtig: keine Generika verwenden. |
| event_date | Datum | mandatory | single | Das Datum des Ereignisses. Sollte sich ein Ereignis über mehrere Tage erstrecken, bitte den Anfangstag angeben. |
| event_placing | Verortung | mandatory | single | Fand das Ereignis an einem uns bekannten (und vielleicht im CamNet eingetragenen) Schauplatz statt oder ist die Verortung frei? |
| event_location | Schauplatz | mandatory | single | Hier bitte den Schauplatz angeben, an dem das Ereignis statt gefunden hat. |
| event_address | Adresse | suggested | single | Falls man das Ereignis verorten kann und der Ort bekannt ist, können eine Adresse oder die Koordinaten angeben werden.
In dem Fall taucht das Ereignis ebenfalls auf der Kartenansicht auf. Wird beides angegeben, wird die Eingabe für Koordinaten bevorzugt. Allerdings ist uns die Angabe einer Adresse lieber: Lässt sich für Nutzer einfacher lesen! :) |
| event_coordinates | Koordinaten | suggested | single | Falls man das Ereignis verorten kann und der Ort bekannt ist, können eine Adresse oder die Koordinaten angeben werden.
In dem Fall taucht das Ereignis ebenfalls auf der Kartenansicht auf. Wird beides angegeben, wird die Eingabe für Koordinaten bevorzugt. |
| event_incity | Stadt | suggested | single | Die Stadt, in der das Ereignis statt fand. |
| event_persons | Personen | suggested | list | Involvierte Personen |
| event_description | Beschreibung | mandatory | single | Eine (kurze) Beschreibung des Ereignisses mit allen wichtigen Informationen. Im Text kann auf andere Seiten wikitypisch verlinkt werden. |
| event_incity2 | Stadt | suggested | single | Die Stadt, in der das Ereignis statt fand. Wird in attribut "took place in city" abgelegt, welches für zeitliche abläufe den Stadtbezug herstellt.
Das oben verwendete "Is located in city" wird im geographischen Kontext genutzt. |
| on_page | Seite | mandatory | single | Auf welcher CamNet-Seite wurde dieses Ereignis hinzugefügt |
Data Storage
Semantic properties used in this class: |
|---|
|
Page status
This status may be inaccurate, if you just created pages. In that case, run jobs and clear cache of this page.
| Module:Event | |
|---|---|
| Module:Event/doc | |
| Module:Event/class | |
| Module:Event/class/doc | |
| Module:Event/config | |
| Module:Event/config/doc | |
| Template:Event | |
| Template:Event/doc | |
| Property pages for your smw store | |
| Property:Has_address | |
| Property:Has_cast | |
| Property:Has_geo_coordinates | |
| Property:Has_short_description | |
| Property:Is_associated_to_page | |
| Property:Is_identified_by_classengine_through | |
| Property:Is_located_in_city | |
| Property:Is_member_of_class | |
| Property:Is_titled | |
| Property:Took_place_at_location | |
| Property:Took_place_in | |
| Property:Took_place_on | |
Page autocreation
All pages present!
Note: Creation of module pages is impossible due to an incompatibility issue.
Page contents
Contents of Module:Event [EDIT] |
|---|
local p = {}
local Class = require('Module:Event/class')
local getArgs = require('Module:Arguments').getArgs
function p.categorize(frame)
return tostring(Class:categorize())
end
function p.categoryPage(frame)
return tostring(Class:categoryPage())
end
function p.explainDataStore(frame)
return tostring(Class:explainDataStore())
end
function p.gardeningCategoryPage(frame)
return tostring(Class:gardeningCategoryPage())
end
function p.sfGenerateForm(frame)
return tostring(Class:sfGenerateForm())
end
function p.sfGenerateFormEntry(frame)
return tostring(Class:sfGenerateFormEntry())
end
function p.sfGenerateFormLink(frame)
return tostring(Class:sfGenerateFormLink())
end
function p.templateDocumentation(frame)
return tostring(Class:templateDocumentation())
end
function p.main(frame)
local args = getArgs(frame)
local me = Class:new(mw.title.getCurrentTitle().prefixedText)
me:initFromArgs(args)
me:storeData()
me:addInfobox()
me:addPageBody()
return me:render()
end
return p
|
Contents of Module:Event/doc [EDIT] |
|---|
{{documentation subpage}}
{{module rating|protected}}{{lua|Module:Arguments|Module:Event/class}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
This module implements template {{tl|Event}}.
== Usage ==
{{pre|
{{tli|Event|''main''}}
}}
It also provides some additional "gateways" to some of [[Module:Event/class]]'s static methods:
{{pre|
{{tli|Event|''categorize''}}
{{tli|Event|''categoryPage''}}
{{tli|Event|''explainDataStore''}}
{{tli|Event|''gardeningCategoryPage''}}
{{tli|Event|''sfGenerateForm''}}
{{tli|Event|''sfGenerateFormEntry''}}
{{tli|Event|''sfGenerateFormLink''}}
{{tli|Event|''templateDocumentation''}}
}}
{{#invoke:Event|categorize}}<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Note: The class engine sets the category "CamNet modules" automatically in function categorize -->
<!-- Categories go here if you wish an additional category to that set in {{module rating}} above automatically. -->
}}</includeonly><h2>Maintenanace notes</h2>
This page was created by [[Module:Classgenerator]] and belongs to [[Class:Event]].
|
Contents of Module:Event/class [EDIT] |
|---|
local FoundationClass = require('Module:Foundationclass')
local ClassDebug = require('Module:Debug/class')
-- ****************************************************************
-- * inheritance *
-- ****************************************************************
local ClassEvent = FoundationClass:subclass('Event')
-- setting class's configuration data
ClassEvent.static.myConfiguration = mw.loadData('Module:Event/config') -- this means, modules on subpages have a / in their names
-- being in a static method, use self.myConfiguration
-- being in a private method, that knows self or in a public method, use self.class.myConfiguration
-- ****************************************************************
-- * properties *
-- ****************************************************************
-- **************** initialization of table for private properties
local _private = setmetatable({}, {__mode = 'k'}) -- weak table storing all private attributes
-- **************** declaration of public static properties
-- ClassEvent.static.myPropertyModule = require('Module:extern')
-- ClassEvent.static.staticProperty = ' '
-- remember the static classes provided by Foundationclass:
-- ClassEvent.globalConfig
-- ClassEvent.myCargoUtil
-- ClassEvent.mySmwUtil
-- ClassEvent.myTableTools
-- ClassEvent.myYesno
-- **************** declaration of (global) private properties
-- for properties you should rather use constructor and _private[self]. this only, if you need a private class property
-- you should, however predeclare private methods here
local _debug -- private method declared later
local _privateMethodAhead -- declaration ahead, so this private method can be used in the constructor and in other private methods
-- ***************************************************************
-- * methods *
-- ***************************************************************
-- **************** declaration of static methods
function ClassEvent:initialize(uid, superhandler)
local _CFG = self.class.myConfiguration
FoundationClass.initialize(self, uid, superhandler)
_private[self] = {
dbg = ClassDebug:new(tostring(self.class) .. ': id ' .. uid),
}
_debug(self, 1, ' ClassEvent: done initializing object "' .. uid ..'", from ' .. tostring(self))
end
-- use use self.myConfiguration to access your configuration in a static method
function ClassEvent.static:aStaticMethod(var)
_debug(self, 1, 'entering ClassEvent.static:aStaticMethod() to do something, from ' .. tostring(self))
end
function ClassEvent.static:mySfDynamicFieldAttribute(fieldname, attribute, value)
_debug(self, 1, 'entering ClassEvent.static:mySfDynamicFieldAttribute(fieldname, attribute, value), from ' .. tostring(self))
_debug(self, 2, ' with parameters "' .. fieldname .. '", "' .. attribute .. '" and a ' .. type(value) .. ' value')
-- function that can process any attribute/value pair just before rendering the semantic forms field
-- usually done, to generate a dynamic 'default' value
-- keep in mind: you can completely disable a form field, if you return true on attribute "disable".
-- however, this causes the parameter to not show at all, neither in the form, nor in processing
local val = value
if fieldname == 'this' and attribute == 'that' then
val = 'whatever ' .. val
end
return val -- this value will be used as new value for field's attribute
end
-- **************** declaration of private methods
-- use self.class.myConfiguration to access your configuration in a public or a private method that is called by a public method
_debug = function (self, level, text)
if _private[self] and _private[self].dbg then
local debugLevel = FoundationClass.globalConfig.debugLevel or self.class.myConfiguration.global.debugLevel
if debugLevel and level <= debugLevel then
_private[self].dbg:log(level, text)
end
else
local debugLevel = FoundationClass.globalConfig.debugLevel or self.myConfiguration.global.debugLevel
if debugLevel and level <= debugLevel then
ClassDebug:log(level, text, tostring(self) .. '.static')
end
end
end
local _privateMethod = function (self)
_debug(self, 1, 'entering private _privateMethod() to do something, from ' .. tostring(self))
end
-- **************** declaration of public methods
-- use self.class.myConfiguration to access your configuration in a public method
function ClassEvent:addInfobox()
_debug(self, 1, 'entering ClassEvent:addInfobox(), from ' .. tostring(self))
if self:goodToGo() then
local _CFG = self.class.myConfiguration
local coreData = self:getCoreData()
local ib_args = {
bodyclass = 'infobox_name',
aboveclass = 'objtitle titletext',
headerclass = 'headertext',
labelstyle = 'width: 30%;',
datastyle = 'width: 70%;',
title = self:getUid(),
above = _CFG.global.entityTitle,
subheader = nil,
label1 = _CFG.parameter.name.label,
data1 = coreData.name and coreData.name or nil,
header1 = nil,
}
self:addOutput(require('Module:Infobox').infobox(ib_args))
return true
end
return false
end
function ClassEvent:addPageBody()
_debug(self, 1, 'entering ClassEvent:addPageBody(), from ' .. tostring(self))
_debug(self, 2, ' rendering errors and warnings and adding them to output')
local frame = mw.getCurrentFrame()
self:addOutput(self:renderErrors())
self:addOutput(self:renderWarnings())
if self:goodToGo() then
self:addOutput('No output yet')
return true
end
return false
end
function ClassEvent:myArgumentProcessing(coreData)
_debug(self, 1, 'entering ClassEvent:myArgumentProcessing(args) to process coreData, from ' .. tostring(self))
-- function that performs some individual transformation args --> coreData
-- remember: you can add warnings to your output with self:addWarning(warning). the page, however, will not be put in any gardening category. for that, use self:addError()
-- hint: for conversion bool values, this is useful: FoundationClass.myYesno
local coreData = coreData
return coreData -- this is your new coreData.
end
function ClassEvent:myDataAdjustments(data)
_debug(self, 1, 'entering ClassEvent:myDataAdjustments(data) to convert data from data store into data suitable for argument processing, from ' .. tostring(self))
-- function that performs some individual transformation datastore data into argument data
-- keep in mind, when using smw data store, that data is indexed by parameter names, not properties
-- hint: for conversion bool values, this is useful: FoundationClass.myYesno
local data = data
return data -- this is your new data table, being passed on to initFromArgs and subsequently to plausibility testing
end
function ClassEvent:myPlausibilityTest(args)
_debug(self, 1, 'entering ClassEvent:myPlausibilityTest(args) to test arguments, from ' .. tostring(self))
-- function that performs the individual plausibility tests
-- note: before you access a field args.fieldname you should check for existance
-- use self:addError(text); this also puts the page in its class's gardening category
return false -- return value will be ignored. but if you add any error, the object's initialization will fail with the error
end
function ClassEvent:myStashAdjustments(stash, storeType)
_debug(self, 1, 'entering ClassEvent:myStashAdjustments(stash) to do some minor adjustments on data before storing, from ' .. tostring(self))
-- function that alters the stash before storing the data. if necessary, you can complate skip storing this stash, if you return false or the empty table {}
-- storeType is the actual method of storage for this call. either 'cargo', or 'smw'
-- hint: for conversion bool values, this is useful: FoundationClass.myYesno
local stash = stash
return stash -- this is your new stash. this will be stored. it has format (fieldname: value)
end
function ClassEvent:method()
_debug(self, 1, 'entering ClassEvent:method() to do something, from ' .. tostring(self))
return true
end
return ClassEvent
|
Contents of Module:Event/class/doc [EDIT] |
|---|
{{documentation subpage}}
{{module rating|protected}}{{lua|Module:Debug/class|Module:Foundationclass|Module:Event/config}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
This is a Class Module. It implements a class in Lua using [[Module:Middleclass]] and the template class [[Module:Foundationclass]]. This class provides methods for PURPOSE.
== Usage ==
{{code|lang=lua|code=
local name = args[1] or args.name or mw.title.getCurrentTitle().rootText
local Class = require('Module:Event/class')
local me = Class:new(mw.title.getCurrentTitle().prefixedText)
me:initFromArgs(args)
me:storeData()
me:addInfobox()
me:addPageBody()
return me:render()
}}
{{#invoke:Event|explainDataStore}}
== Methods ==
=== Constructor ===
==== new(uid, superhandler) ====
Creates a new Object for the class.
;uid
:variable, optional
:used to identify the object
;superhandler
:object of childclass of Foundationclass, optional
:supply the superhandler, if you instanciate this object within another object. the instanciated object will pass errors and warnings to the superhandler and forgo adding the object category
;return
:object, of the class
=== public methods ===
==== addInfobox() ====
If no errors and data is present, adds an infobox to the object's output.
{{small|
;return
:boolean, whether adding was successful or not
}}
==== addPageBody() ====
Adds a page body (all content besides the infobox) to the object's output: Errors and Warnings, sample configuration, statistics, ... Of course, only if there is data.
{{small|
;return
:boolean, whether adding was successful or not
}}
==== myArgumentProcessing(coreData) ====
Performs the individual argument processing in [[#initFromArgs(args)|initFromArgs(args)]] right before inititializing it.
{{small|
;coreData
:table, mandatory
:the core data of the object. the one to process individually before initialization
;return
:table, the new core data array to be used
}}
==== myDataAdjustments(data) ====
Performs a transformation form data (coming from the datastore) into data used for argument processing. This is called by [[#initFromData(data)|initFromData(data)]] (for smw: after property to parameter conversion)
and is directly passed to [[#initFromArgs(args)|initFromArgs(args)]] and subsequently plausibility test.
{{small|
;data
:table, mandatory
:a data table coming directly from the data store
;return
:table, the new data table suiteable for argument processing
}}
==== myPlausibilityTest(args) ====
Performs the individual plausibility tests in [[#initFromArgs(args)|initFromArgs(args)]] before entering the initialization part.
NOTE: The return value will be ignored. If this finds errors, it must add them to the list of errors via [[#addError(errortext)|addError(errortext)]].
{{small|
;args
:table, mandatory
:arguments passed to the template to be checked
;return
:boolean, whether the object is plausible or not.
}}
==== myStashAdjustments(stash, storeType) ====
Performs the adjusts the stash in [[#storeData()|storeData()]] right before storing it.
{{small|
;stash
:table, mandatory
:the array of data to be saved (in the form fieldname: value)
;storeType
:string, mandatory
:type of storage method used with the current call (either 'cargo' or 'swm'). In case you use both stores and your stash adjustment differs with each of this methods
;return
:boolean, the new stash
}}
=== static methods ===
==== ClassEvent:mySfDynamicFieldAttribute(fieldname, attribute, value) ====
For some semantic form fields there are attribute values, that are not static, thus can not be provided at forehand in the [[#Configuration Data|configuration file]]. This method does the trick to adapt them at runtime shortly before the field is rendered.
Essentially: the method checks, if it has a special rule for the pair fieldname:attribute and if so, calculates the new value. if not, the old value is returned. Note, that you can completely disable a form field with this when you
return false on attribute "disable".
{{small|
;fieldname
:string, mandatory
:the form field's name, needed to match current paring to an existing special treatment rule
;attribute
:string, mandatory
:the form field's attribute, needed to match current paring to an existing special treatment rule
;value
:variable, mandatory
:the value, that is already provided in the [[#Configuration Data|configuration file]]. this will be adapted by the method, if there is a special rule for the pair fieldname:attribute.
;return
:string, the value to be used forthwith (which can be the old one or a freshly calculated)
}}
=== private methods ===
==== _debug(self, level, text) ====
Adds output to the internal debug log.
{{small|
;self
:object, me
;level
:int; mandatory
:debug level for the message
;text
:string; mandatory
:debug message text
;return
:void
}}
== Properties ==
=== static ===
See also [[#Static Properties|Static Properties]]
;ClassEvent.myConfiguration
:this is your configuration. It is devided in several section, each a
:table, holds configuration data found in Module:Event/config
::'''WARNING:''' This is a read only table and besides functions ''pairs()'' and ''ipairs()'' nothing else will work on it, especially not the functions of the table library!
<ul>
* form, table, holds data used to create the form. here are some of them:
** formButtons, table, which buttons should be printed at the bottom
** fieldOrder, table, in which order the form fields should appear (note: only fields listed here will be added to the form)
* global, table, holds some global configuration data
* parameter, table, holds all data about all parameter used in the module (be they form only, data store only or normal). The table has the form ''paramname = { table of paramdata }''. The tables for the parameter have data as follows:
** cardinality, string, mandatory, one of singe or list
** cargo_type, string, optional, if the parameter is to be stored in cargo, add the field type here (one of Page, Text, Integer, Float, Date, Datetime, Boolean (which should be provided as 1 or 0), Coordinates, Wikitext, File, String, URL, or Email)
** description, string, mandatory, a description of this parameter
** label, string, mandatory, the label used in the form and the template documentation
** property_name, string, optional, if the parameter is to be stored in smw, add the property name here
** property_type, string, optional, if the parameter is to be stored in smw, add the property type here (defaults to page)
** severity, string, optional, if provided one of mandatory, suggested
** sf, table, optional, used to add more attributes to the semantic forms field. ref [[Module:SFfield/config]] for all possible attributes. Note that the table is of type attribute_name : value. Value can be of type string, integer, boolean, and (in case of 'show on select') a table. Please note, that the attribute name cannot contain a " " (space). Use the underscore instead.
** td_default, string, optional, if you want a default value to be indicated in the template data section on the documentation page, add it here
** td_type, string, optional, if the parameter should be present in the template documentation page, fill this field. all possible values are listed [https://www.mediawiki.org/wiki/Extension:TemplateData#Format here]
** values, table, optional, if you want the possible values to be restricted to a specific set, fill this table
* template, table, holds some data used only in the template
</ul>
;ClassEvent.publicStaticProperty
:type, explanation
;_privateStaticProperty
:type, explanation
=== private ===
Note: all private properties are stored in table ''_private[self]''. _private is a static array that is indexed by ''self'', so the table ''_private[self]'' holds all properties for instance ''self''.
;dbg
:object, my instance of [[Module:Debug/class]] for debugging purposes. only present afer first call of [[#_debug(self, level, text)|_debug(self, level, text)]]
== Configuration Data ==
This class holds its control data in [[Module:{{ROOTPAGENAME}}/config]].
== Inheritance ==
'''Note:''' You still reference those either by self:publicMethod() or ClassEvent:staticMethod() and ClassEvent.staticProperty respectively!
=== Methods ===
{{MediaWiki:Classengine-content-documentation-methods}}
=== Static Properties ===
{{MediaWiki:Classengine-content-documentation-properties}}
{{#invoke:Event|categorize}}<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Note: the class engine sets the categories "CamNet modules" and "Lua class modules" automatically in categorize -->
<!-- Categories go here if you wish an additional category to that set in {{module rating}} above automatically. -->
}}</includeonly><h2>Maintenanace notes</h2>
This page was created by [[Module:Classgenerator]] and belongs to [[Class:Event]].
|
Contents of Module:Event/config [EDIT] |
|---|
-- This is the configuration for ClassEvent. It has been autocreated by Module:Classgenerator.
-- It is strongly suggested, you use the form to make alterations and copy the new configuration an this page!
local superglobal = mw.loadData('Module:Foundationclass/globalconfig')
local global = {
debugLevel = false,
entityTitle = 'Ereignis',
description = 'Beschreibt ein bemerkenswertes Ereignis im Spielgeschehen. Etwas so wichtiges, dass man es auf der Timeline angeführt haben möchte.',
category = nil,
gardeningCategory = nil,
namespace = nil,
cargoTable = nil,
smwUseStorage = true,
smwIsSubobject = true,
restrictedTo = nil,
delimiter = ',',
}
local form = {
enable = true,
name = nil,
teaserText = nil,
typeCreateLink = 'none',
createInfotext = nil,
createInputPlaceholder = nil,
createInputQueryString = nil,
createLinkPageName = nil,
createLinkQueryString = nil,
createLinkType = nil,
labelCreate = 'Ereignis anlegen',
labelEdit = 'Ereignis bearbeiten',
headerText = 'Ein Ereignis ist essenziell ein Eintrag auf der Zeilinie. Es sollten also nur wichtige und bedeutsame Dinge erfasst werden.',
notification = nil,
sectionList = nil,
allowsFreeText = false,
freeTextPreload = nil,
buttons = { 'save', 'preview', 'changes', 'cancel', },
fieldSize = 80,
textareaAttributes = { -- the defaults for your textarea fields
cols = 80,
rows = 4,
autogrow = true,
editor = 'wikieditor',
},
fieldOrder = { 'title', 'event_date', 'event_placing', 'event_location', 'event_address', 'event_coordinates', 'event_incity', 'event_persons', 'event_description', },
}
local template = {
name = 'Event',
templateDocumentationSeeAlso = nil,
}
local parameter = {
title = {
cardinality = 'single',
description = 'Der Titel des Ereignisses. Sollte bereits Kerninformationen enthalten, so dass man beim Lesen des Titels schon weiß, worum es sich handelt.\n' ..
'Wichtig: keine Generika verwenden.',
label = 'Titel',
property_name = 'Is_titled',
property_type = 'Text',
severity = 'mandatory',
sf = {
input_type = 'text',
placeholder = 'Kurzbeschreibung',
},
td_type = 'line',
},
event_date = {
cardinality = 'single',
description = 'Das Datum des Ereignisses. Sollte sich ein Ereignis über mehrere Tage erstrecken, bitte den Anfangstag angeben.',
label = 'Datum',
property_name = 'Took_place_on',
property_type = 'Date',
severity = 'mandatory',
sf = {
date_format = 'dd.mm.yy',
default = '01.06.2000',
disable_input_field = false,
enable_input_field = true,
highlight_days_of_week = { 0, 6, },
input_type = 'datepicker',
show_reset_button = true,
show_week_numbers = true,
week_start = 1,
},
td_type = 'date',
},
event_placing = {
cardinality = 'single',
description = 'Fand das Ereignis an einem uns bekannten (und vielleicht im CamNet eingetragenen) Schauplatz statt oder ist die Verortung frei?',
label = 'Verortung',
severity = 'mandatory',
sf = {
default = 'frei',
input_type = 'radiobutton',
show_on_select = { Schauplatz = { 'event_location', }, frei = { 'event_address', 'event_coordinates', 'event_incity', }, },
},
td_type = 'line',
values = { 'Schauplatz', 'frei', },
},
event_location = {
cardinality = 'single',
description = 'Hier bitte den Schauplatz angeben, an dem das Ereignis statt gefunden hat.',
label = 'Schauplatz',
property_name = 'Took_place_at_location',
property_type = 'Page',
severity = 'mandatory',
sf = {
existing_values_only = false,
input_type = 'combobox',
values_from_category = 'Schauplätze',
},
td_type = 'line',
},
event_address = {
cardinality = 'single',
description = 'Falls man das Ereignis verorten kann und der Ort bekannt ist, können eine Adresse oder die Koordinaten angeben werden.\n' ..
'In dem Fall taucht das Ereignis ebenfalls auf der Kartenansicht auf. Wird beides angegeben, wird die Eingabe für Koordinaten bevorzugt.\n' ..
'Allerdings ist uns die Angabe einer Adresse lieber: Lässt sich für Nutzer einfacher lesen! :)',
label = 'Adresse',
property_name = 'Has_address',
property_type = 'Text',
severity = 'suggested',
sf = {
input_type = 'text',
},
td_type = 'line',
},
event_coordinates = {
cardinality = 'single',
description = 'Falls man das Ereignis verorten kann und der Ort bekannt ist, können eine Adresse oder die Koordinaten angeben werden.\n' ..
'In dem Fall taucht das Ereignis ebenfalls auf der Kartenansicht auf. Wird beides angegeben, wird die Eingabe für Koordinaten bevorzugt.',
label = 'Koordinaten',
property_name = 'Has_geo_coordinates',
property_type = 'Geographic coordinate',
severity = 'suggested',
sf = {
center = '40.7412551,-73.9940724',
geoservice = 'googlemaps',
height = 300,
input_type = 'googlemaps',
width = 400,
zoom = 13,
},
td_type = 'line',
},
event_incity = {
cardinality = 'single',
description = 'Die Stadt, in der das Ereignis statt fand.',
label = 'Stadt',
property_name = 'Is_located_in_city',
property_type = 'Page',
severity = 'suggested',
sf = {
existing_values_only = false,
input_type = 'combobox',
placeholder = 'Stadtname',
values_from_category = 'Städte',
},
td_type = 'wiki-page-name',
},
event_incity2 = {
cardinality = 'single',
description = 'Die Stadt, in der das Ereignis statt fand. Wird in attribut "took place in city" abgelegt, welches für zeitliche abläufe den Stadtbezug herstellt.\n' ..
'Das oben verwendete "Is located in city" wird im geographischen Kontext genutzt.',
label = 'Stadt',
property_name = 'Took_place_in',
property_type = 'Page',
severity = 'suggested',
},
event_persons = {
cardinality = 'list',
description = 'Involvierte Personen',
label = 'Personen',
property_name = 'Has_cast',
property_type = 'Page',
severity = 'suggested',
sf = {
existing_values_only = false,
input_type = 'tokens',
mapping_property = 'Has display title',
placeholder = 'Namen',
values_from_category = 'Personen',
},
td_type = 'wiki-page-name',
},
event_description = {
cardinality = 'single',
description = 'Eine (kurze) Beschreibung des Ereignisses mit allen wichtigen Informationen. Im Text kann auf andere Seiten wikitypisch verlinkt werden.',
label = 'Beschreibung',
property_name = 'Has_short_description',
property_type = 'Text',
severity = 'mandatory',
sf = {
editor = 'wikieditor',
input_type = 'textarea',
rows = 10,
},
td_type = 'string',
},
on_page = {
cardinality = 'single',
description = 'Auf welcher CamNet-Seite wurde dieses Ereignis hinzugefügt',
label = 'Seite',
property_name = 'Is_associated_to_page',
property_type = 'Page',
severity = 'mandatory',
},
}
return {
form = form,
global = global,
parameter = parameter,
template = template,
}
|
Contents of Module:Event/config/doc [EDIT] |
|---|
{{documentation subpage}}
{{module rating|protected}}{{lua|Module:Foundationclass/globalconfig}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
This module provides data for [[Module:Event/class]]
== Usage ==
{{code|lang=lua|code=local cfg = mw.loadData('Module:Event/config')}}
{{#invoke:Event|categorize}}<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Note: The class engine sets the categories "CamNet modules" and "Lua class modules" automatically in function categorize -->
<!-- Categories go here if you wish an additional category to that set in {{module rating}} above automatically. -->
}}</includeonly><h2>Maintenanace notes</h2>
This page was created by [[Module:Classgenerator]] and belongs to [[Class:Event]].
{{ombox| type=content | text = It is strongly advised, to not edit this page but to use [https://{{SERVERNAME}}{{SCRIPTPATH}}/Special:FormEdit/Classgenerator/Class%3AEvent the Classgenerator form] instead! After that, use your new configuration to replace the contents of this page.}} |
Contents of Template:Event [EDIT] |
|---|
{{#invoke:Event|main|{{BASEPAGENAME}}}}<noinclude>
{{documentation}}
</noinclude> |
Contents of Template:Event/doc [EDIT] |
|---|
{{Documentation subpage}}
<!-- Categories go at the bottom of this page. -->
{{#invoke:Event|templateDocumentation}}
{{#invoke:Event|categorize}}<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Note: The class engine sets the category "CamNet templates" automatically in function categorize -->
<!-- ADD CATEGORIES AFTER THIS LINE -->
}}</includeonly><h2>Maintenanace notes</h2>
This page was created by [[Module:Classgenerator]] and belongs to [[Class:Event]].
|
All property pages
Contents of Property:Has_address [EDIT] |
|---|
== Description ==
<div class="description-box">Falls man das Ereignis verorten kann und der Ort bekannt ist, können eine Adresse oder die Koordinaten angeben werden.
In dem Fall taucht das Ereignis ebenfalls auf der Kartenansicht auf. Wird beides angegeben, wird die Eingabe für Koordinaten bevorzugt.
Allerdings ist uns die Angabe einer Adresse lieber: Lässt sich für Nutzer einfacher lesen! :)</div>
== Type ==
* This is an attribute of the datatype [[Has type::Text]].
== Allowed values ==
No restriction given
{{#invoke:Event|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize --> |
Contents of Property:Has_cast [EDIT] |
|---|
== Description ==
<div class="description-box">Involvierte Personen</div>
== Type ==
* This is an attribute of the datatype [[Has type::Page]].
== Allowed values ==
No restriction given
{{#invoke:Event|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize --> |
Contents of Property:Has_geo_coordinates [EDIT] |
|---|
== Description ==
<div class="description-box">Falls man das Ereignis verorten kann und der Ort bekannt ist, können eine Adresse oder die Koordinaten angeben werden.
In dem Fall taucht das Ereignis ebenfalls auf der Kartenansicht auf. Wird beides angegeben, wird die Eingabe für Koordinaten bevorzugt.</div>
== Type ==
* This is an attribute of the datatype [[Has type::Geographic coordinate]].
== Allowed values ==
No restriction given
{{#invoke:Event|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize --> |
Contents of Property:Has_short_description [EDIT] |
|---|
== Description ==
<div class="description-box">Eine (kurze) Beschreibung des Ereignisses mit allen wichtigen Informationen. Im Text kann auf andere Seiten wikitypisch verlinkt werden.</div>
== Type ==
* This is an attribute of the datatype [[Has type::Text]].
== Allowed values ==
No restriction given
{{#invoke:Event|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize --> |
Contents of Property:Is_associated_to_page [EDIT] |
|---|
== Description ==
<div class="description-box">Auf welcher CamNet-Seite wurde dieses Ereignis hinzugefügt</div>
== Type ==
* This is an attribute of the datatype [[Has type::Page]].
== Allowed values ==
No restriction given
{{#invoke:Event|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize --> |
Contents of Property:Is_identified_by_classengine_through [EDIT] |
|---|
== Description ==
<div class="description-box">Automatisch hinzugefügt! Wird verwendet, um individuelle Objekte innerhalb der Klasse zu identifizieren.</div>
== Type ==
* This is an attribute of the datatype [[Has type::Text]].
== Allowed values ==
No restriction given
{{#invoke:Event|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize --> |
Contents of Property:Is_located_in_city [EDIT] |
|---|
== Description ==
<div class="description-box">Die Stadt, in der das Ereignis statt fand.</div>
== Type ==
* This is an attribute of the datatype [[Has type::Page]].
== Allowed values ==
No restriction given
{{#invoke:Event|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize --> |
Contents of Property:Is_member_of_class [EDIT] |
|---|
== Description ==
<div class="description-box">Automatisch hinzugefügt! Wird verwendet, um Mitglieder dieser Klasse zu finden (funktioniert auch, ohne dass eine Kategorie definiert wird und auch fur subobjects)</div>
== Type ==
* This is an attribute of the datatype [[Has type::Text]].
== Allowed values ==
No restriction given
{{#invoke:Event|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize --> |
Contents of Property:Is_titled [EDIT] |
|---|
== Description ==
<div class="description-box">Der Titel des Ereignisses. Sollte bereits Kerninformationen enthalten, so dass man beim Lesen des Titels schon weiß, worum es sich handelt.
Wichtig: keine Generika verwenden.</div>
== Type ==
* This is an attribute of the datatype [[Has type::Text]].
== Allowed values ==
No restriction given
{{#invoke:Event|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize --> |
Contents of Property:Took_place_at_location [EDIT] |
|---|
== Description ==
<div class="description-box">Hier bitte den Schauplatz angeben, an dem das Ereignis statt gefunden hat.</div>
== Type ==
* This is an attribute of the datatype [[Has type::Page]].
== Allowed values ==
No restriction given
{{#invoke:Event|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize --> |
Contents of Property:Took_place_in [EDIT] |
|---|
== Description ==
<div class="description-box">Die Stadt, in der das Ereignis statt fand. Wird in attribut "took place in city" abgelegt, welches für zeitliche abläufe den Stadtbezug herstellt.
Das oben verwendete "Is located in city" wird im geographischen Kontext genutzt.</div>
== Type ==
* This is an attribute of the datatype [[Has type::Page]].
== Allowed values ==
No restriction given
{{#invoke:Event|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize --> |
Contents of Property:Took_place_on [EDIT] |
|---|
== Description ==
<div class="description-box">Das Datum des Ereignisses. Sollte sich ein Ereignis über mehrere Tage erstrecken, bitte den Anfangstag angeben.</div>
== Type ==
* This is an attribute of the datatype [[Has type::Date]].
== Allowed values ==
No restriction given
{{#invoke:Event|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize --> |