Vorlage:Classgenerator/doc

Description

An object class used on this wiki. The object class complex encompasses a base module, a class module, a template, a category page (if desired) and a form. Including documentation if necessary.

Kategorie: Category:Generated classes

Data Storage

This template does not store any persistent data.

Parameters

An object class used on this wiki. The object class complex encompasses a base module, a class module, a template, a category page (if desired) and a form. Including documentation if necessary.

Vorlagenparameter

Parameter		Beschreibung	Typ	Status
Änderungsdatum	global_edit_timestamp	Das Datum der entsprechenden Revision. Womit das Datum der aktuellen Revision das Datum der letzten Änderung ist. Standard {{REVISIONTIMESTAMP}}	Datum	erforderlich
Title	global_entityTitle	Generic title for the entity.	Einzeiliger Text	erforderlich
Description	global_description	A short description of the entity. Will be displayed on the template documentation page, for example.	Mehrzeiliger Text	erforderlich
Category	global_category	The mediawiki category, the entity is placed into. If left empty or set to NIL, no categegory tag will be placed an object page. No category page will be created.	Einzeiliger Text	vorgeschlagen
Gardening category	global_gardeningCategory_chooser	This field lets you choose, whether you want to have a gardening category for this class and - if so - if you want an individual one or the global category.	Einzeiliger Text	erforderlich
Gardening category name	global_gardeningCategory	This is the name of the class's gardning category. Objects/class entities with implausible/erroneous input will be placed in this category automatically.	Einzeiliger Text	erforderlich
Namespace	global_namespace	If you put this entity on a special namespace, name it here. NOTE: You have to be precise. This is case sensitive. But omit the colon. NOTE: Remember to add the namespace in your LocalSettings.php.	Einzeiliger Text	vorgeschlagen
Cargo table	global_cargoTable	The name of the cargo table to store class's data in, if you use data store cargo.	Einzeiliger Text	vorgeschlagen
Store objects semantically	global_smwUseStorage	If you use dataStore smw, set this to true if you actually want persistant smw data to be stored for that class!	Wahrheitswert	erforderlich
Is subobject	global_smwIsSubobject	When using datastore smw, should this be stored as subobject (and not as normal data)?	Wahrheitswert	erforderlich
Default restricted	global_restrictedTo	You can define a default for the 'restricted' attribute of your fields here.	Einzeiliger Text	vorgeschlagen
Default delimiter	global_delimiter	The default delimiter used on multivalue fields. Can be overwritten by each paramter.	Einzeiliger Text	erforderlich
Module autocreation	global_autocreate_module	Should the module pages and their documentation page be created automatically by the template	Einzeiliger Text	erforderlich
Template autocreation	global_autocreate_template	Should the template page and its documentation page be created automatically by the template	Einzeiliger Text	erforderlich
Form autocreation	global_autocreate_form	Should the form page be created automatically by the template	Einzeiliger Text	erforderlich
Category autocreation	global_autocreate_category	Should the category page - if there is any - be created automatically by the template	Einzeiliger Text	erforderlich
Property autocreation	global_autocreate_property	Should the property pages - if store smw is active and the class stores its data sematically - be created automatically by the template	Einzeiliger Text	erforderlich
Global costum config	global_customization	This field allows you to add custimized entries to your global-configuration. Use one 'fieldname = value,' entry per line.	Mehrzeiliger Text	vorgeschlagen
Create form	form_enable	Do you want to create a form for this class? Note: When you don't want to have a form _page_, but need this to be a part of another form (as a holds-template form), set this to true!	Wahrheitswert	erforderlich
Form name	form_name	The name of the form, i.e. the form will be placed an page [[Form:Formname]]. If you don't need an actual form page, leave this empty (e.g. if this is a prot of another form as holds-template or such).	Einzeiliger Text	vorgeschlagen
Form teaser text	form_teaserText	This is the text displayed on the form:name page (before you see the actual form)	Mehrzeiliger Text	vorgeschlagen
Form create link	form_typeCreateLink	This field lets you choose, what kind of object create link is provided to the user on the form page: is there none, a formlink, or a forminput field?	Einzeiliger Text	erforderlich
Inputfield Infotext	form_createInfotext	This is the short text that appears right above the input field. Short being the important part. Please limit yourself to a short sentence.	Einzeiliger Text	erforderlich
Placeholder text	form_createInputPlaceholder	Placeholder text that is shwon in the form create input field	Einzeiliger Text	vorgeschlagen
Create input query string	form_createInputQueryString	You can use this option to pass information to the form; this information generally takes the form of ''templateName[fieldName]=value''. It should look like a typical URL query string; an example would be ''query string=namespace=User&User[Is_employee]=yes''.	Einzeiliger Text	vorgeschlagen
Create link page name	form_createLinkPageName	With this, you can have the name of the page created by the form to be set automatically. You can use any of the parameters ''<template-name[field-name]>'' or ''<unique number>''. The latter takes options start=x, unique, random, and a number (length of id string, default 6). Note: this cannot start with the UNIQUE NUMBER tag due to a bug in Semantic Forms!IMPORTANT: If you want to use this, you have to add the output of your class's sfGenerateFormInfoTag() in comments to your form page!!!. Class generator produces the appropriate content, you have to paste it into your form page anew, every time you change this value here. This is a workaround for a semantic forms bug. see https://phabricator.wikimedia.org/T123230 for more information	Einzeiliger Text	vorgeschlagen
Create link query string	form_createLinkQueryString	You can use this option to pass information to the form; this information generally takes the form of ''templateName[fieldName]=value''. It should look like a typical URL query string; an example would be ''query string=namespace=User&User[Is_employee]=yes''.	Einzeiliger Text	vorgeschlagen
Create link type	form_createLinkType	This field lets you choose, what kind of form link is used to link to the form page: is it a plain link or a button (with parameter submission via get or post)	Einzeiliger Text	erforderlich
Create entity	form_labelCreate	Label for the signal/action for 'create entity'. Shows on buttons and and the form label.	Einzeiliger Text	erforderlich
Edit entity	form_labelEdit	Label for the signal/action for 'edit entity'. Shows on buttons and and the form label.	Einzeiliger Text	erforderlich
Header text	form_headerText	This is the text displayed above the form	Mehrzeiliger Text	erforderlich
Notification	form_notification	this notification test will be displayed above your form	Mehrzeiliger Text	optional
Sections	form_sectionList	If you want to have hl2 sections of text after the datafields and before the freetext/formbutton, name them here. Use strings for names of section headlines	Einzeiliger Text	vorgeschlagen
Allow free text field	form_allowsFreeText	Should there be a free text field right before the form buttons?	Wahrheitswert	erforderlich
Free text preload	form_freeTextPreload	When this is set your free text will have a preload= statement. The contents of the page you enter here will be used as preload template text for the free text field.	Einzeiliger Text	vorgeschlagen
Form Buttons	form_buttons	Which buttons other than 'save' and 'cancel' should appera below the form	Einzeiliger Text	vorgeschlagen
Default size	form_fieldSize	Here, you define a default 'size' for input fields. You will still be able to overwrite this in your parameter definition.	Zahlenwert	erforderlich
textarea default cols	form_textareaAttributes_cols	You can set a default for the columns attribute of your textarea fields	Zahlenwert	erforderlich
textarea default rows	form_textareaAttributes_rows	You can set a default for the rows attribute of your textarea fields	Zahlenwert	erforderlich
textarea default autogrow	form_textareaAttributes_autogrow	You can set a default for the autogrow attribute of your textarea fields	Wahrheitswert	erforderlich
textarea default editor	form_textareaAttributes_editor	You can set a default for the editor attribute of your textarea fields. As of now, semantic forms only supports wikieditor (or none).	Einzeiliger Text	erforderlich
Form custom config	form_customization	This field allows you to add customized entries to your form-configuration. Use one 'fieldname = value,' entry per line.	Mehrzeiliger Text	vorgeschlagen
Template name	template_name	The name of your template. i.e.: your template can be found on the page [[Template:nameOfYourTemplate]]. Unless there is a very good reason, this should be the same as your class's name!	Einzeiliger Text	erforderlich
Related templates	template_templateDocumentationSeeAlso	Used in the see also-section of your template documentation. Please omit the template: from each entry!	Einzeiliger Text	vorgeschlagen
Template costum config	template_customization	This field allows you to add custimized entries to your template-configuration. Use one 'fieldname = value,' entry per line.	Mehrzeiliger Text	vorgeschlagen
Parameters	parameter_parameter	This is your list of parameters. You put all data here, that you would like to handle - be it data you process normally, data you would only like to gather vai form or data you simply want to store	Mehrzeiliger Text	erforderlich

Usage

{{Classgenerator
|global_edit_timestamp=
|global_entityTitle=
|global_description=
|global_category=
|global_gardeningCategory_chooser=
|global_gardeningCategory=
|global_namespace=
|global_cargoTable=
|global_smwUseStorage=
|global_smwIsSubobject=
|global_restrictedTo=
|global_delimiter=
|global_autocreate_module=
|global_autocreate_template=
|global_autocreate_form=
|global_autocreate_category=
|global_autocreate_property=
|global_customization=
|form_enable=
|form_name=
|form_teaserText=
|form_typeCreateLink=
|form_createInfotext=
|form_createInputPlaceholder=
|form_createInputQueryString=
|form_createLinkPageName=
|form_createLinkQueryString=
|form_createLinkType=
|form_labelCreate=
|form_labelEdit=
|form_headerText=
|form_notification=
|form_sectionList=
|form_allowsFreeText=
|form_freeTextPreload=
|form_buttons=
|form_fieldSize=
|form_textareaAttributes_cols=
|form_textareaAttributes_rows=
|form_textareaAttributes_autogrow=
|form_textareaAttributes_editor=
|form_customization=
|template_name=
|template_templateDocumentationSeeAlso=
|template_customization=
|parameter_parameter=
}}

See also

• {{Classgenerator/parameter}}