Vorlage:Classgenerator/parameter/doc

IMT HilfeWiki - das Wiki

Description

This is the list of parameters for the class. All data is represented here, be it data processed normally, data only to gatherd via form or data that is simply stored.

Data Storage

This template does not store any persistent data.

Parameters

This is the list of parameters for the class. All data is represented here, be it data processed normally, data only to gatherd via form or data that is simply stored.

Vorlagenparameter

ParameterBeschreibungTypStatus
Parametername

The name of the parameter. Use only upper and lowercase characters, numbers (not the first symbol), dash and underscore.

Zeileerforderlich
Cardinalitycardinality

Is this a single or a multivalue field?

Standard
single
Zeileerforderlich
Store in cargocargo

Do you want to store this parameter in a cargo field? Works only, if you have a cargo table name specified in the GLOBAL section.

Standard
Yes
Boolescherforderlich
Cargo hiddencargo_hidden

If set, the field is not listed in either Special:ViewTable or Special:Drilldown, although it is still queriable.

Booleschvorgeschlagen
Cargo sizecargo_size

for fields of type Text, Wikitext or String, sets the size of this field, i.e. the number of characters; default is 300

Nummervorgeschlagen
Cargo field type <small>[https://www.mediawiki.org/wiki/Extension:Cargo/Storing_data#Declaring_a_table &#91;help&#93;]</small>cargo_type

Which type will this parameter be stored in. If you don whish to store this parameter, leave this empty.

Zeileerforderlich
Descriptiondescription

A short description of this paramter. Serves mainly as a hint via tooltip to users of the form to help them fill the parameter.

Zeichenfolgeerforderlich
Labellabel

The label for this parameter. Use short but descriptive text (~1-3 words). This will be placed next to the input field in the form.

Zeileerforderlich
Store semanticallyproperty

Do you want to store this parameter semantically? Works only, if you have switched semantic store on in the GLOBAL section.

Standard
Yes
Boolescherforderlich
Property nameproperty_name

The name of your property this date is stored in - if you are using data store smw that is. NOTE: Do not use spaces, use underscrores (_) instead.

Zeileerforderlich
Property type <small>[https://semantic-mediawiki.org/wiki/Help:List_of_datatypes &#91;help&#93;]</small>property_type

The type of your property this date is stored in - if you are using data store smw that is.

Zeileerforderlich
Severityseverity

Is this field mandatory, suggested or optional

Zeileerforderlich
List of valuesvalues

A list of values for this parameter. Depending on SEVERITY and EXISTING VALUES ONLY, the parameter maybe is restricted to this values.

Zeilevorgeschlagen
Regular form parametersf

Should this field be present (not necessary visible, see #hidden) on the form (and therefore be available as parameter in the template)?

Boolescherforderlich
Template doc defaulttd_default

Information only present on the template documentation: to what default value will this be set?

Zeilevorgeschlagen
Template doc parameter type <small>[https://www.mediawiki.org/wiki/Extension:TemplateData#Format &#91;help&#93;]</small>td_type

What type should be used on the template documentation page?

Zeileerforderlich
Add cargo linkingadd_cargo_table_and_field

Should the 'cargo table=' and 'cargo field=' statements be added to this? Fails, if no table is secified in GENERAL-Section!

Standard
No
Booleschvorgeschlagen
CSS classclass

The css class for the input field for this parameter

Zeilevorgeschlagen
Defaultdefault

Default value. Preset for this input field.

Zeilevorgeschlagen
Hiddenhidden

Specifies that this field will be hidden in the form: used to preserve values in edited pages.

Booleschvorgeschlagen
Input typeinput_type

Specifies the type of input this field will have in the form.

Zeilevorgeschlagen
Placeholderplaceholder

Used for the text, textarea, combobox and tokens fields. Specifies help text that is displayed in the input until the user clicks on it.

Zeilevorgeschlagen
Restrictedrestricted

Specifies that this field will be editable only by this user group. Use 'DEFAULT' if you want this to be the globally defined restriction group.

Zeilevorgeschlagen
Uniqueunique

Specifies that the value entered for this field must be unique, i.e. must not be the same as any value for the SMW property (if SMW is being used) or Cargo field (if Cargo is being used) corresponding to this form field.

Booleschvorgeschlagen
Unique for categoryunique_for_category

Specifies that the value entered for this field must not be the same as the name of any page in the given category.

Zeilevorgeschlagen
Unique for conceptunique_for_concept

Specifies that the value entered for this field must not be the same as the name of any page in the given SMW concept.

Zeilevorgeschlagen
Unique for namespaceunique_for_namespace

Specifies that the value entered for this field must not be the same as the name of any page in the given namespace.

Booleschvorgeschlagen
Uploadableuploadable

Is this a text input field that refers to a file and do you want the user to be able to upload that file right here?

Booleschvorgeschlagen
Default filenamedefault_filename

Specifies the default filename for files uploaded with this field.

Zeilevorgeschlagen
Image previewimage_preview

Specifies that a thumbnail of the uploaded image should be placed under the field in the form.

Booleschvorgeschlagen
textarea autogrowautogrow

You can set a default for the autogrow attribute of your textarea fields

Booleschvorgeschlagen
Autozoomautozoom

Turns autozoom feature on or off.

Zeilevorgeschlagen
Base typebase_type

The base type for this regular expression field

Zeilevorgeschlagen
Centercenter

Allows to set the coordinates of the map's centre. When this parameter is not provided, the map will centre itself on the current location, or when not set, to coordinates 0,0.

Zeilevorgeschlagen
textarea colscols

You can set a default for the columns attribute of your textarea fields

Nummervorgeschlagen
date formatdate_format

The date format string. It is only used for date display in the input field. See https://www.mediawiki.org/wiki/Extension:Semantic_Forms_Inputs#Parameters for more information.

Zeilevorgeschlagen
disabled datesdisable_dates

Comma-separated list of disabled dates/date ranges (dates in yyyy/mm/dd format, ranges in yyyy/mm/dd-yyyy/mm/dd format)

Zeilevorgeschlagen
disabled days of weekdisable_days_of_week

List of days that can not be selected (e.g. weekend: 6, 0)

Zeilevorgeschlagen
Disable input fielddisable_input_field

If the user shall be able to fill the input field directly or only via the menu.

Booleschvorgeschlagen
textarea editoreditor

You can set a default for the editor attribute of your textarea fields. As of now, semantic forms only supports wikieditor (or none).

Zeilevorgeschlagen
Enable input fieldenable_input_field

If the user shall be able to fill the input field directly or only via the menu.

Booleschvorgeschlagen
Existing values onlyexisting_values_only

Set a combo box or tokens to only allow the autocomplete values, and not any arbitrary values, thus having it function even more like a dropdown.

Booleschvorgeschlagen
first datefirst_date

The first date that can be chosen (in yyyy/mm/dd format)

Zeilevorgeschlagen
Geoservicegeoservice

Allows to set the geocoding service used to turn addresses into coordinates.

Zeilevorgeschlagen
Heightheight

Allows to set the height of the map, in pixels.

Nummervorgeschlagen
hide reset buttonhide_reset_button

If a reset button shall be shown. This is the only way for the user to erase the input field if it is disabled for direct input.

Booleschvorgeschlagen
hide week numbershide_week_numbers

If week numbers shall be shown left of the week.

Booleschvorgeschlagen
highlighted dateshighlight_dates

Comma-separated list of disabled dates/date ranges that shall appear highlighted (dates in yyyy/mm/dd format, ranges in yyyy/mm/dd-yyyy/mm/dd format)

Zeilevorgeschlagen
highlighted days of weekhighlight_days_of_week

List of days that shall appear highlighted (e.g. weekend: 6, 0)

Zeilevorgeschlagen
include timezoneinclude_timezone

Specifies that a time zone field should be included.

Booleschvorgeschlagen
last datelast_date

The last date that can be chosen (in yyyy/mm/dd format)

Zeilevorgeschlagen
Mapping cargo fieldmapping_cargo_field

Tries to map autocomplete values via cargo. Can only be used for fields that select pages. You have to specifiy CARGO_TABLE for this to work, as well!

Zeilevorgeschlagen
Mapping cargo tablemapping_cargo_table

Tries to map autocomplete values via cargo. Can only be used for fields that select pages. You have to specifiy CARGO_FIELD for this to work, as well!

Zeilevorgeschlagen
Mapping propertymapping_property

Tries to map autocomplete values via smw. Can only be used for fields that select pages.

Zeilevorgeschlagen
Mapping templatemapping_template

Takes in the name of a 'mapping template' (a template that takes in a single, unnamed parameter, i.e. {{{1|}}}, and displays a 'mapped' string as a result), and uses that template to map every potential value, so that the values' 'aliases' appear on the screen, and not the values themselves. Takes only the name of the template w/o namespace.

Zeilevorgeschlagen
Max valuesmax_values

Used for input type tokens; specifies the maximum number of values that can be entered in a field that holds multiple values.

Nummervorgeschlagen
Maxlengthmaxlength

Used for text and textarea fields. Specifies the maximum allowed length of the input.

Nummervorgeschlagen
Messagemessage

Used as user feedback message in case the regex did not match with the input.

Zeilevorgeschlagen
Regexpregexp

If you set 'input type' to regexp, this specifies your regular expression the input has to match to be valid. This must be given including the slashes, e.g. '/^[0-9]+/'! Defaults to /.*/, i.e. any value.

Zeileerforderlich
textarea rowsrows

You can set a default for the rows attribute of your textarea fields

Nummervorgeschlagen
show reset buttonshow_reset_button

If a reset button shall be shown. This is the only way for the user to erase the input field if it is disabled for direct input.

Booleschvorgeschlagen
Show on selectshow_on_select

Can be used for inputs of type 'checkbox', 'checkboxes', 'radiobutton', 'dropdown' and 'listbox' to specify that one or more tags with a certain ID should only be displayed to the user if a certain value (or values) is selected within that input. Use entries in the form 'value=field'. Hint: If you want to calculate this dynamically later, set this field to 'false'! All fields will be prefixed by a globaly configured prefix string. See Module:SFfield/class for more information.

Zeichenfolgevorgeschlagen
show week numbersshow_week_numbers

If week numbers shall be shown left of the week.

Booleschvorgeschlagen
Sizesize

Used for text entries, combobox, tokens and listbox. For the first three it specifies the width, in characters; for a listbox it specifies the height. If not set, will be defaulted as set in FORM-Section.

Nummervorgeschlagen
Structurestructure

The structure of your menu. Please use mediawiki ul notation. * for first lavel, ** for second, ... One entry per line

Zeichenfolgeerforderlich
Values dependent onvalues_dependent_on

Can be used for inputs of type 'combobox', 'text with autocomplete', 'textarea with autocomplete' and 'tokens'. Specifies that the current set of allowed values for this field are all the values taken by this same field from pages where 'field name' is equal to the value selected for 'field name' in the current form.

Zeilevorgeschlagen
Values from categoryvalues_from_category

Similar to values=, but gets its values from the names of all pages belonging to a specific category.

Zeilevorgeschlagen
Values from conceptvalues_from_concept

Similar to values=, but gets its values from the names of all pages belonging to a specific SMW concept.

Zeilevorgeschlagen
Values from namespacevalues_from_namespace

Similar to values=, but gets its values from the names of all pages belonging to a specific namespace.

Zeilevorgeschlagen
Week startweek_start

The first day of the week (0 - Sunday, 1 - Monday, ...)

Nummervorgeschlagen
Widthwidth

Allows to set the width of the map, in pixels.

Nummervorgeschlagen
Zoomzoom

Allows to set the zoom level of the map. When not provided , the zoom will be set so you can see the entire planet.

Nummervorgeschlagen

Usage

{{Classgenerator
|name=
|cardinality=
|cargo=
|cargo_hidden=
|cargo_size=
|cargo_type=
|description=
|label=
|property=
|property_name=
|property_type=
|severity=
|values=
|sf=
|td_default=
|td_type=
|add_cargo_table_and_field=
|class=
|default=
|hidden=
|input_type=
|placeholder=
|restricted=
|unique=
|unique_for_category=
|unique_for_concept=
|unique_for_namespace=
|uploadable=
|default_filename=
|image_preview=
|autogrow=
|autozoom=
|base_type=
|center=
|cols=
|date_format=
|disable_dates=
|disable_days_of_week=
|disable_input_field=
|editor=
|enable_input_field=
|existing_values_only=
|first_date=
|geoservice=
|height=
|hide_reset_button=
|hide_week_numbers=
|highlight_dates=
|highlight_days_of_week=
|include_timezone=
|last_date=
|mapping_cargo_field=
|mapping_cargo_table=
|mapping_property=
|mapping_template=
|max_values=
|maxlength=
|message=
|regexp=
|rows=
|show_reset_button=
|show_on_select=
|show_week_numbers=
|size=
|structure=
|values_dependent_on=
|values_from_category=
|values_from_concept=
|values_from_namespace=
|week_start=
|width=
|zoom=
}}

See also

Cookies helfen uns bei der Bereitstellung des IMT HilfeWikis. Bei der Nutzung vom IMT HilfeWiki werden die in der Datenschutzerklärung beschriebenen Cookies gespeichert.