diff --git a/Documentation/forms-intro.html b/Documentation/forms-intro.html index 63a9a7be1..cb2e0066a 100644 --- a/Documentation/forms-intro.html +++ b/Documentation/forms-intro.html @@ -93,9 +93,11 @@ } table.parameters { background-color: #dddddd; + margin-left: 4em; } /* background-color: #ddddff; */ table.properties { background-color: #ddddff; + margin-left: 4em; } /* background-color: #ddddff; */ td { padding: 0.5em; @@ -240,20 +242,17 @@
| label | -String | -A label for the form field. This is the prompt for the user, e.g., - "Name", "Employer". + "Name", "Employer". If the label is not given in the form, the + system will make one from a label of the property in the ontology. |
| property | -rdf:Property | -
When the user enters the data, it is stored in the web as a triple
with this property as its predicate.
@@ -262,9 +261,7 @@ Form field types |
| default | -[according to field type] Optional | -
The input control is set to this value by default. It is easiest for
the user to enter this value. (This value is not automatically
@@ -272,6 +269,17 @@ Form field typessome way. |
| suppressEmptyUneditable | +Boolean | ++ Setting this flag (on a single form field not a structure) means that when the user is just reading the data, not + editing it, the fields with blank data will be removed completely. + This avoid things like a blank field for a region in an address when there isn't one given. + This can make the UX much cleaner. Defaults to false. + | +
@@ -399,6 +407,24 @@
| weight | + +xsd:integer | +0:lighter than normal, 1: Normal, 2,3: heavier than normal | +
| parts | +rdf:Collection | ++ The form fields, forms, in the group + | +
The user choses an item from a class.
@@ -425,9 +451,7 @@If a new thing is minted, that will be done with a form which is a + ui:creationForm for the class.
| ordered | +Boolean | +If true, the user has an ordered array of things, and the data is in an RDF collection. + If false, the UI is irrelevant and the data is a series of arcs. | +
| property | +rdf:Property | +The API details or query endpoint and query details to be used to search the item in + the databasse. | +
| reverse | +Boolean | +If set, the form will write data triple like X P S instead of the normal S P X. + | +
| part | +Form | +The form to be used for each one. + | +
This form field leverages the ontology heavily. It pulls the subclasses of the given class, and makes a pop-up menu for the user to chose one. If and only if the ontology says that the class is a disjoint union @@ -477,7 +532,7 @@
The classifier pops a menu to allow the user to select a set of values to classify the subject. @@ -517,7 +572,7 @@
and for each case:
| labelProperty | -String | +rdf:Property | The property which will be used to store the name of the selected thing as a separate triple |
| dataSource | -DataSource | -The API details or query endpint and query details to be usde to search of the itemn in the databasse. | |
| targetClass | rdfs:Class | -Is tyhis is specified, it be used to replace any occuurences of + | Is tyhis is specified, it be used to replace any occurrences of "$(targetClass)" in the query template. this allows different instances - of AutocompleteField to share the same DatSource, by specifying different values for targetClass. | + of AutocompleteField to share the same DataSource, by specifying different values for targetClass.
The suppressIfUneditable flag allow you to make a form which + is much cleaner and simpler when the user is just reading information, + not editing it.
+@@ -618,11 +679,16 @@
Future directions include separate implementations of the form UI code in for various platforms, and using various UI frameworks. There may also be extensions of the system with new field types, more options for setting style from various sources, etc. +