Difference between revisions of "Help:Property"

From OPENRESEARCH th copy Wiki
Jump to navigation Jump to search
(pushed from test by wikipush)
 
(Created with the template CreateHelpPageTest by Tim Holzheim through LambdaActions)
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
 +
 +
 
[[File:Help_Icon.png|right]]
 
[[File:Help_Icon.png|right]]
 
== Help for Property ==
 
== Help for Property ==
Line 10: Line 13:
 
}}
 
}}
 
=== Documentation ===
 
=== Documentation ===
see
+
a Property is a Feature/Attribute of a Topic
 
 
* https://semantic-mediawiki.org/wiki/Help:Properties_and_types
 
* https://semantic-mediawiki.org/wiki/Help:Special_properties
 
* https://semantic-mediawiki.org/wiki/Help:List_of_datatypes
 
 
=== Example Properties ===
 
=== Example Properties ===
{{#ask: [[Concept:Property]]
+
{{#ask: [[Concept:Property]]}}
}}
 
 
=== Properties ===
 
=== Properties ===
{{#ask: [[Concept:Property]][[Property topic::Concept:Property]]
 
| ?Property documentation = documentation
 
| ?Property type = type
 
| ?Property name = name
 
| ?Property label = label
 
| ?Property allowedValues = allowedValues
 
| ?Property mandatory = mandatory
 
| ?Property uploadable = uploadable
 
|format=table
 
}}
 
  
=== uml ===
+
{{ #ask: [[Concept:Property]][[Property topic::Concept:Property]]
<uml>
+
|mainlabel=Property
title Property
+
 
note as PropertyDiagramNote
+
| ?Property allowedValues = allowedValues
Copyright (c) 2015-2020 BITPlan GmbH
+
 
[[http://www.bitplan.com]]
+
| ?Property defaultValue = defaultValue
end note
+
 
note as PropertyNote
+
| ?Property documentation = documentation
a Property is a Feature/Attribute of a Topic
+
 
end note
+
| ?Property index = index
class Property {
+
 
  Text name
+
| ?Property inputType = inputType
  Text label
+
 
  Page type
+
| ?Property isLink = isLink
  Number index
+
 
  Number sortPos
+
| ?Property label = label
  Boolean primaryKey
+
 
  Boolean mandatory
+
| ?Property mandatory = mandatory
  Text namespace
+
 
  Number size
+
| ?Property name = name
  Boolean uploadable
+
 
  Code defaultValue
+
| ?Property namespace = namespace
  Text inputType
+
 
  Text allowedValues
+
| ?Property nullable = nullable
  Text documentation
+
 
  Code values_from
+
| ?Property primaryKey = primaryKey  
  Boolean showInGrid
+
 
  Boolean isLink
+
| ?Property showInGrid = showInGrid
  Boolean nullable
+
 
  Page topic
+
| ?Property size = size  
}
+
 
PropertyNote .. Property
+
| ?Property sortPos = sortPos
 +
 
 +
| ?Property topic = topic
 +
 
 +
| ?Property type = type
 +
 
 +
| ?Property uploadable = uploadable
 +
 
 +
| ?Property values_from = values_from
  
Property "usedByProperties (*)" -- "smw_type(1)" SMW_Type
+
|order=ascending
 +
| limit= 200
 +
}}
  
Topic "topic (1)" -- "properties(*)" Property
 
' BITPlan Corporate identity skin params
 
' Copyright (c) 2015-2020 BITPlan GmbH
 
' see http://wiki.bitplan.com/PlantUmlSkinParams#BITPlanCI
 
' skinparams generated by com.bitplan.restmodelmanager
 
skinparam note {
 
  BackGroundColor #FFFFFF
 
  FontSize 12
 
  ArrowColor #FF8000
 
  BorderColor #FF8000
 
  FontColor black
 
  FontName Technical
 
}
 
skinparam component {
 
  BackGroundColor #FFFFFF
 
  FontSize 12
 
  ArrowColor #FF8000
 
  BorderColor #FF8000
 
  FontColor black
 
  FontName Technical
 
}
 
skinparam package {
 
  BackGroundColor #FFFFFF
 
  FontSize 12
 
  ArrowColor #FF8000
 
  BorderColor #FF8000
 
  FontColor black
 
  FontName Technical
 
}
 
skinparam usecase {
 
  BackGroundColor #FFFFFF
 
  FontSize 12
 
  ArrowColor #FF8000
 
  BorderColor #FF8000
 
  FontColor black
 
  FontName Technical
 
}
 
skinparam activity {
 
  BackGroundColor #FFFFFF
 
  FontSize 12
 
  ArrowColor #FF8000
 
  BorderColor #FF8000
 
  FontColor black
 
  FontName Technical
 
}
 
skinparam classAttribute {
 
  BackGroundColor #FFFFFF
 
  FontSize 12
 
  ArrowColor #FF8000
 
  BorderColor #FF8000
 
  FontColor black
 
  FontName Technical
 
}
 
skinparam interface {
 
  BackGroundColor #FFFFFF
 
  FontSize 12
 
  ArrowColor #FF8000
 
  BorderColor #FF8000
 
  FontColor black
 
  FontName Technical
 
}
 
skinparam class {
 
  BackGroundColor #FFFFFF
 
  FontSize 12
 
  ArrowColor #FF8000
 
  BorderColor #FF8000
 
  FontColor black
 
  FontName Technical
 
}
 
skinparam object {
 
  BackGroundColor #FFFFFF
 
  FontSize 12
 
  ArrowColor #FF8000
 
  BorderColor #FF8000
 
  FontColor black
 
  FontName Technical
 
}
 
hide Circle
 
' end of skinparams '
 
</uml>
 
  
see also
 
* [[List of Properties]]
 
* [[Help:Property]]
 
* [[Concept:Property]]
 
* [[:Category:Property]]
 
* [[:Template:Property]]
 
* [[:Form:Property]]
 
topic links:
 
* [[:Category:SMW_Type]]
 
  
[[Category:Property]]
+
[[Category:Concept:Property]]

Latest revision as of 17:28, 9 February 2021


Help Icon.png

Help for Property

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

Documentation

a Property is a Feature/Attribute of a Topic

Example Properties

Abstract deadline, Acceptance rate, Accepted papers, Accepted short papers, Acronym, Action actionpage, Action author, Action comment, Action engine, Action input, Action inputtype, Action name, Action output, Action service, Action servicetype, Action since, Attendance fee, Attendance fee currency, Attendance fee reduced, Bigstock file, Bigstock id, BlogEntry author, BlogEntry date, BlogEntry pdf, BlogEntry title, Bogensportverein lat, Bogensportverein lon, Bogensportverein name, Bogensportverein url, Bogenturnier date, Bogenturnier name, Bogenturnier url, Bogenturnier veranstalter, Brainteaser date, Brainteaser finishDate, Brainteaser issue, Brainteaser page, Brainteaser pdf, Brainteaser problem, Brainteaser solution, CANInfo description, CANInfo name, CANInfo pid, CANInfo unit, Camera ready due, City name, City wikidataid, Commit date, Commit hash, Commit host... further results

Properties

PropertyallowedValuesdefaultValuedocumentationindexinputTypeisLinklabelmandatorynamenamespacenullableprimaryKeyshowInGridsizesortPostopictypeuploadablevalues_from
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.
13allowedValuesfalseallowedValuesfalse50PropertyTypes/Textfalse
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)11defaultfalsedefaultValuefalsefalsefalse80PropertyTypes/Textfalse
Property documentationThe documentation for a property14textareadocumentationfalsedocumentationfalse500PropertyTypes/Textfalse
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.4indexfalseindexfalsetruePropertyTypes/Numberfalse
Property inputTypetext, combobox, dropdown, textarea, tree, datetime, datepicker, timepicker, datetimepicker, menuselect,two listboxes, datecheck, regexp, radiobutton, googlemaps,checkbox,tokenssee 12dropdowninputTypefalseinputTypefalsefalsefalse50PropertyTypes/Textfalse
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 Generator17isLinkfalseisLinkfalsefalsePropertyTypes/Booleanfalse
Property labelThe label to be shown when in a form2labelfalselabelfalse50PropertyTypes/Textfalse
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_tag7mandatoryfalsemandatoryfalse4PropertyTypes/Booleanfalse
Property nameThe name of the property1nametruenametrue501PropertyTypes/Textfalse
Property namespacenamespace prefix8namespacefalsenamespacefalse20PropertyTypes/Textfalse
Property nullablefalseshould nullvalues be allowed and value set to NULL when empty?18allow nulls?falsenullablefalsefalsePropertyTypes/Booleanfalse
Property placeholder50textplaceholderfalseplaceholderfalse50PropertyTypes/Textfalse
Property primaryKeyis this property a primary key of it's topic?6primary keyfalseprimaryKeyfalse4PropertyTypes/Booleanfalse
Property regexRegular expression Example use case: A property has the regular expression to only allow integer values and inputType regex. Regex value is then used in the forms to restrict the inputregexfalseregexfalsefalsefalsePropertyTypes/Pagefalse
Property showInGridtrueI am true if this property is displayed in the default list of properties for my topic as a column16showInGridfalseshowInGridfalsetruePropertyTypes/Booleanfalse
Property sizethe display size of the field for the property9sizefalsesizefalse3PropertyTypes/Numberfalse
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
5sortPosfalsesortPosfalse3PropertyTypes/Numberfalse
Property topicdropdowntopictopicPropertyTypes/Pageconcept=Topic
Property typeSpecial:Types/TextThe type of a Property3dropdowntypefalsetypefalsetruePropertyTypes/Pagefalseproperty=Property_type
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 work10uploadablefalseuploadablefalse4PropertyTypes/Booleanfalse
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.
15textvalues fromfalsevalues_fromfalsefalsefalse200PropertyTypes/textfalse
Used fortokensUsed forfalseUsed forfalsefalsefalsePropertyTypes/Pagefalse