Difference between revisions of "Help:Property"

From BITPlan E-Bike Wiki
Jump to navigation Jump to search
(created by WikiTask 2018-06-18T23:09:37Z)
 
(modified by py-yprinciple-gen 0.3.4)
 
Line 9: Line 9:
 
|?Topic documentation = documentation
 
|?Topic documentation = documentation
 
}}
 
}}
 +
 
=== Documentation ===
 
=== Documentation ===
 
see
 
see
Line 29: Line 30:
 
|format=table
 
|format=table
 
}}
 
}}
 
 
=== uml ===
 
=== uml ===
<uml>
+
<uml format='svg'>
 
title Property
 
title Property
 
note as PropertyDiagramNote
 
note as PropertyDiagramNote
Copyright (c) 2015-2017 BITPlan GmbH
+
Copyright (c) 2015-2024 BITPlan GmbH
 
[[http://www.bitplan.com]]
 
[[http://www.bitplan.com]]
 
end note
 
end note
Line 44: Line 44:
 
   Text label
 
   Text label
 
   Page type
 
   Page type
 +
  Text scope
 
   Number index
 
   Number index
 
   Number sortPos
 
   Number sortPos
Line 56: Line 57:
 
   Text documentation
 
   Text documentation
 
   Code values_from
 
   Code values_from
 +
  Text externalFormatterURI
 
   Boolean showInGrid
 
   Boolean showInGrid
 
   Boolean isLink
 
   Boolean isLink
Line 62: Line 64:
 
}
 
}
 
PropertyNote .. Property
 
PropertyNote .. Property
 
 
Property "usedByProperties (*)" -- "smw_type(1)" SMW_Type
 
Property "usedByProperties (*)" -- "smw_type(1)" SMW_Type
 
+
Property "usedByProperties (*)" -- "smw_type(1)" SMW_Type
Topic "topic (1)" -- "properties(*)" Property
 
 
' BITPlan Corporate identity skin params
 
' BITPlan Corporate identity skin params
' Copyright (c) 2015-2017 BITPlan GmbH
+
' Copyright (c) 2015-2024 BITPlan GmbH
' see http://wiki.bitplan.com/PlantUmlSkinParams#BITPlanCI
+
' see https://wiki.bitplan.com/index.php/PlantUmlSkinParams#BITPlanCI
' skinparams generated by com.bitplan.restmodelmanager
+
' skinparams generated by py-yprinciple-gen
 
skinparam note {
 
skinparam note {
 
   BackGroundColor #FFFFFF
 
   BackGroundColor #FFFFFF
Line 145: Line 145:
 
' end of skinparams '
 
' end of skinparams '
 
</uml>
 
</uml>
 
 
see also
 
see also
 
* [[List of Properties]]
 
* [[List of Properties]]
Line 153: Line 152:
 
* [[:Template:Property]]
 
* [[:Template:Property]]
 
* [[:Form:Property]]
 
* [[:Form:Property]]
topic links:
+
related topics:
* [[:Category:SMW_Type]]
+
* [[Concept:SMW_Type]]
  
 
[[Category:Property]]
 
[[Category:Property]]

Latest revision as of 09:53, 27 November 2024

Help Icon.png

Help for Property

iconTopicnamepluralNamedocumentation
Element into input.pngPropertyPropertyPropertiesa Property is a Feature/Attribute of a Topic

Documentation

see

Example Properties

Action actionpage, Action author, Action comment, Action engine, Action input, Action inputtype, Action name, Action output, Action service, Action servicetype, Action since, Context copyright, Context demo, Context master, Context name, Context since, Context updated, Fixme done, Fixme todo, Leg from, Leg to, Leg wp num, Loc category, Loc from, Loc id, Loc latlon, Loc name, Loc notes, Loc to, Property allowedValues, Property defaultValue, Property documentation, Property externalFormatterURI, Property index, Property inputType, Property isLink, Property label, Property mandatory, Property name, Property namespace, Property nullable, Property primaryKey, Property scope, Property showInGrid, Property size, Property sortPos, Property topic, Property type, Property uploadable, Property values from... further results

Properties

 documentationtypenamelabelallowedValuesmandatoryuploadable
Property allowedValuesThere are two ways to specified allowed Values:
  1. https://semantic-mediawiki.org/wiki/Help:Special_property_Allows_value.
    Use Property:Allows_value to see which values are allowed for certain properties
  2. http://www.mediawiki.org/wiki/Extension:Semantic_Forms/Defining_forms#.27field.27_tag
    values=possible values - Specifies a set of either possible values or autocompletion values (depending on the input type) that this field can have, overriding whatever set of values may have been set from the Semantic MediaWiki property. This set of values is separated by commas by default, but the delimiter can be modified using the delimiter= parameter.
If you specify any values method number 2 will be used here which might override any allowed Values specified with method number 1.
Types/TextallowedValuesallowedValuesfalsefalse
Property defaultValuedefault value - Specifies a default value for this field. For date-related fields, default=now will set the value to the current date and possibly time. For text fields, default=current user will set the value to the username of the user adding this page. For the checkbox input type, default=yes will check the checkbox by default. (The 'checkboxes' input type, on the other hand, like the 'listbox' type, requires specifying the actual values, like default=Value A, Value C.) You can also include templates, parser functions, and magic words within the 'default=' value. see http://www.mediawiki.org/wiki/Extension:Semantic_Forms/Defining_forms#.27field.27_tag (default)Types/CodedefaultValuedefaultfalsefalse
Property documentationThe documentation for a propertyTypes/Textdocumentationdocumentationfalsefalse
Property externalFormatterURIsee https://www.semantic-mediawiki.org/wiki/Help:Special_property_External_formatter_URI
When using this property the type of the property should be set to https://www.semantic-mediawiki.org/wiki/Help:Type_External_identifier automatically by the generator
Types/TextexternalFormatterURIexternal formatter URIfalsefalse
Property indexA positive number that specifies at which position of a Topic the given property should show. The first property to show has the index 1 each following property has an index that is +1 of the previous.Types/Numberindexindexfalsefalse
Property inputTypesee Types/TextinputTypeinputTypetext, combobox, dropdown, textarea, tree, datetime, datepicker, timepicker, datetimepicker, menuselect,two listboxes, datecheck, regexp, radiobutton, googlemapsfalsefalse
Property isLinktrue if this Property is derived form a Link. It will not be exported to SiDIF separately and automatically be added by the Property GeneratorTypes/BooleanisLinkisLinkfalsefalse
Property labelThe label to be shown when in a formTypes/Textlabellabelfalsefalse
Property mandatorySpecifies that this field must be filled in by the user. Note: mandatory should not be used in conjunction with hidden. Use of both in any field will cause the mandatory check on any field to fail when the form is saved. see http://www.mediawiki.org/wiki/Extension:Semantic_Forms/Defining_forms#.27field.27_tagTypes/Booleanmandatorymandatoryfalsefalse
Property nameThe name of the propertyTypes/Textnamenametruefalse
Property namespacenamespace prefixTypes/Textnamespacenamespacefalsefalse
Property nullableshould nullvalues be allowed and value set to NULL when empty?Types/Booleannullableallow nulls?falsefalse
Property primaryKeyis this property a primary key of it's topic?Types/BooleanprimaryKeyprimary keyfalsefalse
Property scopeThe scope of the propertyTypes/TextscopescopeRoot,Override,Globaltruefalse
Property showInGridI am true if this property is displayed in the default list of properties for my topic as a columnTypes/BooleanshowInGridshowInGridfalsefalse
Property sizethe display size of the field for the propertyTypes/Numbersizesizefalsefalse
Property sortPosIf none empty >0 this is the position in the sort clause of this

property. This is used when displaying list of the topic as the default sort order and it is used for selecting topics .

E.g.

Sortpos 1 for attribute lastname and sortpos 2 for attribute firstname leads to sort by lastname,firstname
Types/NumbersortPossortPosfalsefalse
Property topictopicTypes/Pagetopictopic
Property typeThe type of a PropertyTypes/Pagetypetypefalsefalse
Property uploadableSpecifies that a link should be placed next to this field, that opens a popup window to let the user upload a file; see 'Uploading files', below. See The type of the target property needs to be Page for this to workTypes/Booleanuploadableuploadablefalsefalse
Property values fromSpecifies where to get the possible values to be displayed in a form from see

http://www.mediawiki.org/wiki/Extension:Semantic_Forms/Defining_forms#.27field.27_tag

  • values from property=property name - Similar to values=, but gets its values from the the set of all values that a certain SMW property points to.
  • values from category=category name - Similar to values=, but gets its values from the names of all pages belonging to a specific category.
  • values from concept=concept name - Similar to values=, but gets its values from the names of all pages belonging to a specific concept.
  • values from namespace=namespace name - Similar to values=, but gets its values from the names of all pages belonging to a specific namespace. (To get values from the main namespace, use 'Main' for the namespace name, or just leave it blank.)
  • values from url=URL identifier - Used only for autocompletion. Specifies that autocompletion should be based on the values retrieved from an outside URL; see Autocompleting on outside values for how to do this.
  • values from external data=variable name - Used for autocompletion. You need to have theExternal Data extension installed to be able to use this parameter. It specifies that autocompletion should be based on the data retrieved from an outside source. A large number of data sources are supported, including web APIs, regular wiki pages, files on the local server, databases and LDAP directories. See Autocompletion using External Data.
Types/Codevalues_fromvalues fromfalsefalse

uml

see also

related topics: