Class:Chapter

CamNet - das Wiki
ClassChapter
Class
TitleKapitel
Änderungsdatum08.03.2016 14:34:43
Store availablesmw
Smw classChapter
NamespaceMAIN
Ein Kapitel ist eine Spielsitzung. Neben Charaktere ist dies der Kernpunkt aller Aufzeichnungen. Hier wird neben ein paar Kerndaten das komplette Spielgeschehen (so detailliert wie möglich und gewünscht) eingetragen, um das kollektive Gedächtnis zu unterstützen.
Pages
ModuleModule:Chapter
ClassModule:Chapter/class
ConfigModule:Chapter/config
TemplateTemplate:Chapter
FormForm:Kapitel
CategoryCategory:Kapitel
GardeningCategory:Chapter with errors
Identity
titleTitel
numberKapitelnummer
start_dateStartdatum
end_dateEnddatum
cityAustragungsort
auxiliary_settingsWeitere Orte
pcsKlüngelmitglieder
npcsWeitere Teilnehmer
artefactsArtefakte
session_dateSpieldatum
session_durationSpieldauer
session_locationSpielort
descriptionBeschreibung
gathered_informationInformationen
associated_eventsEreignisse
additional_map_markerKartenmarkierungen
displaytitleAnzeigename
subnumberUnterkapitelnummer
Properties
PageHas_auxilliary_settings
NumberHas_chapter_number
TextHas_display_title
PageHas_maincast
TextHas_short_description
NumberHas_subchapter_number
PageHas_supporting_cast
TextIs_identified_by_classengine_through
TextIs_member_of_class
TextIs_titled
PageSaw_the_use_of
PageTook_place_in
DateTook_place_on
DateTook_place_until
NumberWas_written_during
TextWas_written_in
DateWas_written_on

Ein Kapitel ist eine Spielsitzung. Neben Charaktere ist dies der Kernpunkt aller Aufzeichnungen. Hier wird neben ein paar Kerndaten das komplette Spielgeschehen

(so detailliert wie möglich und gewünscht) eingetragen, um das kollektive Gedächtnis zu unterstützen.

Class identity

Parameter Label Severity Cardinality Description
title Titel mandatory single Der Titel / Name der Spielsitzung. Im Zweifelsfall bei der Spielleitung nachfragen, die wird sich wahrscheinlich was ausgedacht haben.
number Kapitelnummer mandatory single Die Kapitelnummer der Sitzung. Bein einem "Kleinspiel" bitte eine Unterkapielnummer erstellen, z.B. 14.1
start_date Startdatum mandatory single Ingamedatum, an dem die Spielsitzung angefangen hat. Im Zweifelsfall verwenden wir das Datum, an dem die erste Nacht im Spiel begonnen hat.
end_date Enddatum mandatory single Ingamedatum, an dem die Spielsitzung beendet worden ist. Im Zweifelsfall verwenden wir das Datum, am dem die letzte Spielnacht geendet hat.
city Austragungsort mandatory single Die Stadt, die als Hauptaustragungsort des Kapitels dient. Im Zweifel den Ort wählen, an dem der Kapitelhöhepunkt statt gefunden hat.
auxiliary_settings Weitere Orte suggested list Weitere (namhafte) Austragungsorte des Spiels.
pcs Klüngelmitglieder mandatory list Die Liste der teilnehmenden Klüngelmitglieder (zumindest der Charaktere, die zum Zeitpunkt des Spiels teil des Klüngels waren).
npcs Weitere Teilnehmer mandatory list Die Liste der teilnehmenden restlichen Charaktere (Nicht-Klüngelmitglieder).
artefacts Artefakte suggested list Diese Artefakte spielten in diesem Kapitel eine Rolle.
session_date Spieldatum mandatory single Das outgame Datum, an dem das Spiel statt gefunden hat.
session_duration Spieldauer mandatory single Die Dauer der Spielsitzung in Tagen. Es darf aufgerundet werden! :)
session_location Spielort mandatory single Der Ort, an dem die Spielsitzung statt gefunden hat.
description Beschreibung mandatory single Hier bitte eine Kurzzusammenfassung in zwei bis drei Sätzen angeben. Wird für Übersichten verwendet um neben dem Titel einen Hinweis zu geben, worum es in dem Spiel ging.
gathered_information Informationen suggested single Habt ihr wichtige Informationen erhalten, die ihr lieber kondensiert hinterlegen wollt?
associated_events Ereignisse suggested single Wenn im Kapitel bemerkenswerten Ereignisse statt gefunden haben, die so wichtig erscheinen, dass sie eine Erwähnung auf der Zeitlinie (und ggf. eine Platzierung auf der Karte) wert sind, diese bitte hier eintragen.
additional_map_marker Kartenmarkierungen suggested single Neben den Eventmarkierungen die automatisch gesetzt werden, können hier noch weitere Kartenmarkierungen für wichtige Orte gesetzt werden.
displaytitle Anzeigename mandatory single Der Name, der als Linktext für die Kapitelseite verwendet wird
subnumber Unterkapitelnummer suggested single Speichert die Unterkapitelnummer

Data Storage

Semantic properties used in this class:

Hier klicken für eine tabellarische Übersicht!

Page status

This status may be inaccurate, if you just created pages. In that case, run jobs and clear cache of this page.

Module:Chapter Yes
Module:Chapter/doc Yes
Module:Chapter/class Yes
Module:Chapter/class/doc Yes
Module:Chapter/config Yes
Module:Chapter/config/doc Yes
Template:Chapter Yes
Template:Chapter/doc Yes
Form:Kapitel Yes
Category:Kapitel Yes
Category:Chapter with errors Yes
Property pages for your smw store
Property:Has_auxilliary_settings Yes
Property:Has_chapter_number Yes
Property:Has_display_title Yes
Property:Has_maincast Yes
Property:Has_short_description Yes
Property:Has_subchapter_number Yes
Property:Has_supporting_cast Yes
Property:Is_identified_by_classengine_through Yes
Property:Is_member_of_class Yes
Property:Is_titled Yes
Property:Saw_the_use_of Yes
Property:Took_place_in Yes
Property:Took_place_on Yes
Property:Took_place_until Yes
Property:Was_written_during Yes
Property:Was_written_in Yes
Property:Was_written_on Yes

Page autocreation

All pages present!

Note: Creation of module pages is impossible due to an incompatibility issue.

Page contents

Contents of Module:Chapter [EDIT]
local p = {}
local Class = require('Module:Chapter/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:Chapter/doc [EDIT]
{{documentation subpage}}
{{module rating|protected}}{{lua|Module:Arguments|Module:Chapter/class}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->

This module implements template {{tl|Chapter}}.

== Usage ==
{{pre|
{{tli|Chapter|''main''}}
}}

It also provides some additional "gateways" to some of [[Module:Chapter/class]]'s static methods:
{{pre|
{{tli|Chapter|''categorize''}}
{{tli|Chapter|''categoryPage''}}
{{tli|Chapter|''explainDataStore''}}
{{tli|Chapter|''gardeningCategoryPage''}}
{{tli|Chapter|''sfGenerateForm''}}
{{tli|Chapter|''sfGenerateFormEntry''}}
{{tli|Chapter|''sfGenerateFormLink''}}
{{tli|Chapter|''templateDocumentation''}}
}}

{{#invoke:Chapter|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:Chapter]].

local FoundationClass = require('Module:Foundationclass')
local ClassDebug = require('Module:Debug/class')

-- ****************************************************************
-- *                         inheritance                          *
-- ****************************************************************
local ClassChapter = FoundationClass:subclass('Chapter')
-- setting class's configuration data
ClassChapter.static.myConfiguration = mw.loadData('Module:Chapter/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
-- ClassChapter.static.myPropertyModule = require('Module:extern')
-- ClassChapter.static.staticProperty = ' '

-- remember the static classes provided by Foundationclass:
-- ClassChapter.globalConfig
-- ClassChapter.myCargoUtil
-- ClassChapter.mySmwUtil
-- ClassChapter.myTableTools
-- ClassChapter.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 ClassChapter: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, ' ClassChapter: done initializing object "' .. uid ..'", from ' .. tostring(self))
end

-- use use self.myConfiguration to access your configuration in a static method
function ClassChapter.static:aStaticMethod(var)
	_debug(self, 1, 'entering ClassChapter.static:aStaticMethod() to do something, from ' .. tostring(self))
end

function ClassChapter.static:mySfDynamicFieldAttribute(fieldname, attribute, value)
	_debug(self, 1, 'entering ClassChapter.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 ClassChapter:addInfobox()
	_debug(self, 1, 'entering ClassChapter: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 ClassChapter:addPageBody()
	_debug(self, 1, 'entering ClassChapter: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 ClassChapter:myArgumentProcessing(coreData)
	_debug(self, 1, 'entering ClassChapter: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 ClassChapter:myDataAdjustments(data)
	_debug(self, 1, 'entering ClassChapter: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 ClassChapter:myPlausibilityTest(args)
	_debug(self, 1, 'entering ClassChapter: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 ClassChapter:myStashAdjustments(stash, storeType)
	_debug(self, 1, 'entering ClassChapter: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 ClassChapter:method()
	_debug(self, 1, 'entering ClassChapter:method() to do something, from ' .. tostring(self))
	return true
end

return ClassChapter

{{documentation subpage}}
{{module rating|protected}}{{lua|Module:Debug/class|Module:Foundationclass|Module:Chapter/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:Chapter/class')
local me = Class:new(mw.title.getCurrentTitle().prefixedText)
me:initFromArgs(args)
me:storeData()
me:addInfobox()
me:addPageBody()
return me:render()
}}

{{#invoke:Chapter|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 ===
==== ClassChapter: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]]
;ClassChapter.myConfiguration
:this is your configuration. It is devided in several section, each a
:table, holds configuration data found in Module:Chapter/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>
;ClassChapter.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 ClassChapter:staticMethod() and ClassChapter.staticProperty respectively!
=== Methods ===
{{MediaWiki:Classengine-content-documentation-methods}}
=== Static Properties ===
{{MediaWiki:Classengine-content-documentation-properties}}

{{#invoke:Chapter|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:Chapter]].

-- This is the configuration for ClassChapter. 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 = 'Kapitel',
	description = 'Ein Kapitel ist eine Spielsitzung. Neben Charaktere ist dies der Kernpunkt aller Aufzeichnungen. Hier wird neben ein paar Kerndaten das komplette Spielgeschehen\n' ..
		'(so detailliert wie möglich und gewünscht) eingetragen, um das kollektive Gedächtnis zu unterstützen.',
	category = 'Kapitel',
	gardeningCategory = 'Chapter with errors',
	namespace = nil,
	cargoTable = nil,
	smwUseStorage = true,
	smwIsSubobject = false,
	restrictedTo = nil,
	delimiter = ',',
}

local form = {
	enable = true,
	name = 'Kapitel',
	teaserText = 'Um ein Kapitel zu erstellen, bitte den Namen/Titel des Spiels eingeben. Sollte bereits ein Kapitel mit dem Titel vorhanden sein, wirst du auf die ensprechende Seite weitergeleitet und kannst sie bearbeiten.',
	typeCreateLink = 'forminput',
	createInfotext = 'Bitte den Titel des Spiels eingeben (ohne Kapitelnummer): ',
	createInputPlaceholder = nil,
	createInputQueryString = nil,
	createLinkPageName = nil,
	createLinkQueryString = nil,
	createLinkType = nil,
	labelCreate = 'Kapitel erzeugen',
	labelEdit = 'Kapitel bearbeiten',
	headerText = 'Hier wird neben ein paar Kerndaten das komplette Spielgeschehen (so detailliert wie möglich und gewünscht) eingetragen, um das kollektive Gedächtnis zu unterstützen.',
	notification = nil,
	sectionList = nil,
	allowsFreeText = true,
	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', 'number', 'start_date', 'end_date', 'city', 'auxiliary_settings', 'pcs', 'npcs', 'artefacts', 'session_date', 'session_duration', 'session_location', 'description', 'gathered_information', 'associated_events', 'additional_map_marker', },
	tab_maindata = { 'title', 'number', 'start_date', 'end_date', 'city', 'auxiliary_settings', 'pcs', 'npcs', 'session_date', 'session_duration', 'session_location', 'description', },
	freetextPreload = 'Template:Boilerplate chapter',
}

local template = {
	name = 'Chapter',
	templateDocumentationSeeAlso = { 'Vorlage:Person', },
}

local parameter = {
	title = {
		cardinality = 'single',
		description = 'Der Titel / Name der Spielsitzung. Im Zweifelsfall bei der Spielleitung nachfragen, die wird sich wahrscheinlich was ausgedacht haben.',
		label = 'Titel',
		property_name = 'Is_titled',
		property_type = 'Text',
		severity = 'mandatory',
		sf = {
			input_type = 'text',
			placeholder = 'Title der Spielsitzung',
		},
		td_type = 'line',
	},
	displaytitle = {
		cardinality = 'single',
		description = 'Der Name, der als Linktext für die Kapitelseite verwendet wird',
		label = 'Anzeigename',
		property_name = 'Has_display_title',
		property_type = 'Text',
		severity = 'mandatory',
	},
	number = {
		cardinality = 'single',
		description = 'Die Kapitelnummer der Sitzung. Bein einem "Kleinspiel" bitte eine Unterkapielnummer erstellen, z.B. 14.1',
		label = 'Kapitelnummer',
		property_name = 'Has_chapter_number',
		property_type = 'Number',
		severity = 'mandatory',
		sf = {
			base_type = 'text',
			default = false,
			input_type = 'regexp',
			regexp = '^[0-9]*[^0-9]1?[0-9]+$',
		},
		td_type = 'number',
	},
	subnumber = {
		cardinality = 'single',
		description = 'Speichert die Unterkapitelnummer',
		label = 'Unterkapitelnummer',
		property_name = 'Has_subchapter_number',
		property_type = 'Number',
		severity = 'suggested',
	},
	start_date = {
		cardinality = 'single',
		description = 'Ingamedatum, an dem die Spielsitzung angefangen hat. Im Zweifelsfall verwenden wir das Datum, an dem die erste Nacht im Spiel begonnen hat.',
		label = 'Startdatum',
		property_name = 'Took_place_on',
		property_type = 'Date',
		severity = 'mandatory',
		sf = {
			date_format = 'dd.mm.yy',
			default = '2000/06/01',
			disable_input_field = false,
			enable_input_field = true,
			first_date = '1999/09/01',
			hide_reset_button = true,
			highlight_days_of_week = { 0, 6, },
			input_type = 'datepicker',
			last_date = '2001/12/31',
			maxlength = 13,
			show_week_numbers = true,
			size = 16,
			week_start = 1,
		},
		td_type = 'date',
	},
	end_date = {
		cardinality = 'single',
		description = 'Ingamedatum, an dem die Spielsitzung beendet worden ist. Im Zweifelsfall verwenden wir das Datum, am dem die letzte Spielnacht geendet hat.',
		label = 'Enddatum',
		property_name = 'Took_place_until',
		property_type = 'Date',
		severity = 'mandatory',
		sf = {
			date_format = 'dd.mm.yy',
			default = '2000/06/01',
			disable_input_field = false,
			enable_input_field = true,
			first_date = '1999/09/01',
			hide_reset_button = true,
			highlight_days_of_week = { 0, 6, },
			input_type = 'datepicker',
			last_date = '2001/12/31',
			maxlength = 13,
			show_week_numbers = true,
			size = 16,
			week_start = 1,
		},
		td_type = 'date',
	},
	city = {
		cardinality = 'single',
		description = 'Die Stadt, die als Hauptaustragungsort des Kapitels dient. Im Zweifel den Ort wählen, an dem der Kapitelhöhepunkt statt gefunden hat.',
		label = 'Austragungsort',
		property_name = 'Took_place_in',
		property_type = 'Page',
		severity = 'mandatory',
		sf = {
			default = 'New York',
			existing_values_only = false,
			input_type = 'combobox',
			values_from_category = 'Städte',
		},
		td_type = 'wiki-page-name',
	},
	auxiliary_settings = {
		cardinality = 'list',
		description = 'Weitere (namhafte) Austragungsorte des Spiels.',
		label = 'Weitere Orte',
		property_name = 'Has_auxilliary_settings',
		property_type = 'Page',
		severity = 'suggested',
		sf = {
			existing_values_only = false,
			input_type = 'tokens',
			mapping_property = 'Has display title',
			values_from_concept = 'Places',
		},
		td_type = 'wiki-page-name',
	},
	pcs = {
		cardinality = 'list',
		description = 'Die Liste der teilnehmenden Klüngelmitglieder (zumindest der Charaktere, die zum Zeitpunkt des Spiels teil des Klüngels waren).',
		label = 'Klüngelmitglieder',
		property_name = 'Has_maincast',
		property_type = 'Page',
		severity = 'mandatory',
		sf = {
			default = 'Franzi, Liz, Mark, Neil, Olaf, Peter, Susan',
			existing_values_only = true,
			input_type = 'tokens',
			mapping_property = 'Has display title',
		},
		td_type = 'wiki-page-name',
		values = { 'Andrew', 'Franzi', 'Liz', 'Mark', 'Neil', 'Olaf', 'Peter', 'Sebak', 'Susan', 'Vincenzo', },
	},
	npcs = {
		cardinality = 'list',
		description = 'Die Liste der teilnehmenden restlichen Charaktere (Nicht-Klüngelmitglieder).',
		label = 'Weitere Teilnehmer',
		property_name = 'Has_supporting_cast',
		property_type = 'Page',
		severity = 'mandatory',
		sf = {
			existing_values_only = false,
			input_type = 'tokens',
			mapping_property = 'Has display title',
			placeholder = 'Bitte auswählen!',
			values_from_category = 'Personen',
		},
		td_type = 'wiki-page-name',
	},
	artefacts = {
		cardinality = 'single',
		description = 'Diese Artefakte spielten in diesem Kapitel eine Rolle.',
		label = 'Artefakte',
		property_name = 'Saw_the_use_of',
		property_type = 'Page',
		severity = 'suggested',
		sf = {
			existing_values_only = false,
			input_type = 'tokens',
			mapping_property = 'Has display title',
			values_from_category = 'Artefakte',
		},
		td_type = 'wiki-page-name',
	},
	session_date = {
		cardinality = 'single',
		description = 'Das outgame Datum, an dem das Spiel statt gefunden hat.',
		label = 'Spieldatum',
		property_name = 'Was_written_on',
		property_type = 'Date',
		severity = 'mandatory',
		sf = {
			date_format = 'dd.mm.yy',
			disable_input_field = false,
			enable_input_field = true,
			hide_reset_button = true,
			highlight_days_of_week = { 0, 6, },
			input_type = 'datepicker',
			maxlength = 13,
			show_week_numbers = true,
			size = 16,
			week_start = 1,
		},
		td_type = 'date',
	},
	session_duration = {
		cardinality = 'single',
		description = 'Die Dauer der Spielsitzung in Tagen. Es darf aufgerundet werden! :)',
		label = 'Spieldauer',
		property_name = 'Was_written_during',
		property_type = 'Number',
		severity = 'mandatory',
		sf = {
			base_type = 'text',
			input_type = 'regexp',
			message = 'Bitte eine Zahl zwischen 1 und 19 angeben',
			regexp = '/^1?[0-9]$/',
			size = 2,
		},
		td_type = 'number',
	},
	session_location = {
		cardinality = 'single',
		description = 'Der Ort, an dem die Spielsitzung statt gefunden hat.',
		label = 'Spielort',
		property_name = 'Was_written_in',
		property_type = 'Text',
		severity = 'mandatory',
		sf = {
			default = 'Paderborn',
			input_type = 'text',
		},
		td_type = 'line',
	},
	description = {
		cardinality = 'single',
		description = 'Hier bitte eine Kurzzusammenfassung in zwei bis drei Sätzen angeben. Wird für Übersichten verwendet um neben dem Titel einen Hinweis zu geben, worum es in dem Spiel ging.',
		label = 'Beschreibung',
		property_name = 'Has_short_description',
		property_type = 'Text',
		severity = 'mandatory',
		sf = {
			editor = 'wikieditor',
			input_type = 'textarea',
			rows = 10,
		},
		td_type = 'string',
	},
	gathered_information = {
		cardinality = 'single',
		description = 'Habt ihr wichtige Informationen erhalten, die ihr lieber kondensiert hinterlegen wollt?',
		label = 'Informationen',
		severity = 'suggested',
		sf = {
			holds_template = true,
		},
		td_type = 'string',
	},
	associated_events = {
		cardinality = 'single',
		description = 'Wenn im Kapitel bemerkenswerten Ereignisse statt gefunden haben, die so wichtig erscheinen, dass sie eine Erwähnung auf der Zeitlinie (und ggf. eine Platzierung auf der Karte) wert sind, diese bitte hier eintragen.',
		label = 'Ereignisse',
		severity = 'suggested',
		sf = {
			holds_template = true,
		},
		td_type = 'string',
	},
	additional_map_marker = {
		cardinality = 'single',
		description = 'Neben den Eventmarkierungen die automatisch gesetzt werden, können hier noch weitere Kartenmarkierungen für wichtige Orte gesetzt werden.',
		label = 'Kartenmarkierungen',
		severity = 'suggested',
		sf = {
			holds_template = true,
		},
		td_type = 'string',
	},
}

return {
	form = form,
	global = global,
	parameter = parameter,
	template = template,
}

{{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:Chapter/class]]

== Usage ==

{{code|lang=lua|code=local cfg = mw.loadData('Module:Chapter/config')}}

{{#invoke:Chapter|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:Chapter]].

{{ombox| type=content | text = It is strongly advised, to not edit this page but to use [https://{{SERVERNAME}}{{SCRIPTPATH}}/Special:FormEdit/Classgenerator/Class%3AChapter the Classgenerator form] instead! After that, use your new configuration to replace the contents of this page.}}
Contents of Template:Chapter [EDIT]
{{#invoke:Chapter|main|{{BASEPAGENAME}}}}<noinclude>
{{documentation}}

</noinclude>
{{Documentation subpage}}
<!-- Categories go at the bottom of this page. -->

{{#invoke:Chapter|templateDocumentation}}

{{#invoke:Chapter|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:Chapter]].
Contents of Form:Kapitel [EDIT]
<noinclude>{{#invoke:Chapter|sfGenerateFormEntry}}{{#invoke:Chapter|categorize}}</noinclude>
<includeonly>{{#invoke:Chapter|sfGenerateForm}}</includeonly>
<!-- Note: The class engine sets category "CamNet forms" automatically in function categorize -->
Contents of Category:Kapitel [EDIT]
{{#invoke:Chapter|categoryPage}}{{#invoke:Chapter|categorize}}
<!-- Note: The class engine sets category "CamNet" automatically in function categorize -->
{{#invoke:Chapter|gardeningCategoryPage}}{{#invoke:Chapter|categorize}}
<!-- Note: The class engine sets category "CamNet entities with erroneous input" automatically in function categorize -->

All property pages

== Description ==
<div class="description-box">Weitere (namhafte) Austragungsorte des Spiels.</div>

== Type ==
* This is an attribute of the datatype [[Has type::Page]].

== Allowed values ==
No restriction given

{{#invoke:Chapter|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize -->
== Description ==
<div class="description-box">Die Kapitelnummer der Sitzung. Bein einem &quot;Kleinspiel&quot; bitte eine Unterkapielnummer erstellen, z.B. 14.1</div>

== Type ==
* This is an attribute of the datatype [[Has type::Number]].

== Allowed values ==
No restriction given

{{#invoke:Chapter|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize -->
== Description ==
<div class="description-box">Der Name, der als Linktext für die Kapitelseite verwendet wird</div>

== Type ==
* This is an attribute of the datatype [[Has type::Text]].

== Allowed values ==
No restriction given

{{#invoke:Chapter|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize -->
== Description ==
<div class="description-box">Die Liste der teilnehmenden Klüngelmitglieder (zumindest der Charaktere, die zum Zeitpunkt des Spiels teil des Klüngels waren).</div>

== Type ==
* This is an attribute of the datatype [[Has type::Page]].

== Allowed values ==
The allowed values are:
* [[Allows value::Andrew]]
* [[Allows value::Ewe]]
* [[Allows value::Franzi]]
* [[Allows value::Liz]]
* [[Allows value::Mark]]
* [[Allows value::Neil]]
* [[Allows value::Olaf]]
* [[Allows value::Peter]]
* [[Allows value::Sebak]]
* [[Allows value::Susan]]
* [[Allows value::Vincenzo]]

{{#invoke:Chapter|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize -->
== Description ==
<div class="description-box">Hier bitte eine Kurzzusammenfassung in zwei bis drei Sätzen angeben. Wird für Übersichten verwendet um neben dem Titel einen Hinweis zu geben, worum es in dem Spiel ging.</div>

== Type ==
* This is an attribute of the datatype [[Has type::Text]].

== Allowed values ==
No restriction given

{{#invoke:Chapter|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize -->
== Description ==
<div class="description-box">Speichert die Unterkapitelnummer</div>

== Type ==
* This is an attribute of the datatype [[Has type::Number]].

== Allowed values ==
No restriction given

{{#invoke:Chapter|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize -->
== Description ==
<div class="description-box">Die Liste der teilnehmenden restlichen Charaktere (Nicht-Klüngelmitglieder).</div>

== Type ==
* This is an attribute of the datatype [[Has type::Page]].

== Allowed values ==
No restriction given

{{#invoke:Chapter|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize -->
== 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:Chapter|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize -->
== 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:Chapter|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 / Name der Spielsitzung. Im Zweifelsfall bei der Spielleitung nachfragen, die wird sich wahrscheinlich was ausgedacht haben.</div>

== Type ==
* This is an attribute of the datatype [[Has type::Text]].

== Allowed values ==
No restriction given

{{#invoke:Chapter|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize -->
== Description ==
<div class="description-box">Diese Artefakte spielten in diesem Kapitel eine Rolle.</div>

== Type ==
* This is an attribute of the datatype [[Has type::Page]].

== Allowed values ==
No restriction given

{{#invoke:Chapter|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize -->
== Description ==
<div class="description-box">Die Stadt, die als Hauptaustragungsort des Kapitels dient. Im Zweifel den Ort wählen, an dem der Kapitelhöhepunkt statt gefunden hat.</div>

== Type ==
* This is an attribute of the datatype [[Has type::Page]].

== Allowed values ==
No restriction given

{{#invoke:Chapter|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize -->
== Description ==
<div class="description-box">Ingamedatum, an dem die Spielsitzung angefangen hat. Im Zweifelsfall verwenden wir das Datum, an dem die erste Nacht im Spiel begonnen hat.</div>

== Type ==
* This is an attribute of the datatype [[Has type::Date]].

== Allowed values ==
No restriction given

{{#invoke:Chapter|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize -->
== Description ==
<div class="description-box">Ingamedatum, an dem die Spielsitzung beendet worden ist. Im Zweifelsfall verwenden wir das Datum, am dem die letzte Spielnacht geendet hat.</div>

== Type ==
* This is an attribute of the datatype [[Has type::Date]].

== Allowed values ==
No restriction given

{{#invoke:Chapter|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize -->
== Description ==
<div class="description-box">Die Dauer der Spielsitzung in Tagen. Es darf aufgerundet werden! :)</div>

== Type ==
* This is an attribute of the datatype [[Has type::Number]].

== Allowed values ==
No restriction given

{{#invoke:Chapter|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize -->
== Description ==
<div class="description-box">Der Ort, an dem die Spielsitzung statt gefunden hat.</div>

== Type ==
* This is an attribute of the datatype [[Has type::Text]].

== Allowed values ==
No restriction given

{{#invoke:Chapter|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize -->
== Description ==
<div class="description-box">Das outgame Datum, an dem das Spiel statt gefunden hat.</div>

== Type ==
* This is an attribute of the datatype [[Has type::Date]].

== Allowed values ==
No restriction given

{{#invoke:Chapter|categorize}}
<!-- Note: The class engine sets category "CamNet properties" automatically in function categorize -->
Abgerufen von „https://camnet.oetterer.eu/index.php?title=Class:Chapter&oldid=3685“