diff --git a/Documentation/forms-intro.html b/Documentation/forms-intro.html index 8fa111e0f..806184738 100644 --- a/Documentation/forms-intro.html +++ b/Documentation/forms-intro.html @@ -43,34 +43,34 @@

Using Forms in the UI ontology

The form system allows you to define a user interface declaratively in RDF. - Then in your web app, you: + In your web app, you then:

    -
  1. make sure the onology files are loaded,
  2. -
  3. load the file with the fom itself, then
  4. +
  5. make sure the ontology files are loaded
  6. +
  7. load the file with the form itself
  8. call UI.widgets.appendForm(dom, container, {}, subject, form, doc, callback)

where - + - - - - + + + +
domif the DOM HTMLDocument object, aka document
domis the DOM HTMLDocument object, a/k/a document
containeris a DOM element to contain the form
{}are unused at present
subjectif the RDF thing about which data will be stored
formthe an RDF object in the store for the form.
docThe RDF document oin the web where the dat awill be stored. Often, subject.doc()
callbackis a function taking an errors flag and a message (if the error flag is true)
subjectis the RDF thing about which data will be stored
formis the RDF object in the store for the form
docis the RDF document on the web where the data will be stored. Often, subject.doc()
callbackis a function taking an error flag and a message (if the error flag is true)
If the form is a complex form, as the user adds more data, more form UI will be created. - The data is saved back to the web the moment the users has entered it, in each field. There is no general Save Button. + The data in each field is saved back to the web the moment the user has entered it. There is no general Save Button.

There is a form form for editing forms. -It is in the form onology itsef. +It is in the form ontology itself.

-You can of course go and write other implementatioons of the form system using +You can of course go and write other implementations of the form system using your favorite user interface language.

Go to the source

@@ -80,23 +80,23 @@

Go to the source

Form field types

-

Form fields may be named nodes in your file, -or blank nodes... the form system does not mind. +

Form fields may be named or blank nodes in your file; +the form system does not care. It is often useful to name them to keep track of them.

Below, all Field Classes and Properties are in the UI namespace, http://www.w3.org/ns/ui#, except - the data types like Integer are in the normal XSD namespace. + the data types, like Integer, which are in the normal XSD namespace.

- Here are some properries which you can use with any field (except the documentations fields). + Here are some properties which you can use with any field (except the documentation fields). - - - + + +
labelStringA label for the form field. This is the prompt for the user, Eg "Name", "Exmployers"
propertyrdf:PropertyWhen the user enters the data, it is stored in the web as a triple with this property as its predicate..
default[according to field type] OptionalThe input control is by default set to this value. - It is easiest for the user to enter this value. (This value is not stored by the forms syetm automatically if the udser does not select or enter it in some way.
labelStringA label for the form field. This is the prompt for the user, e.g., "Name", "Employer".
propertyrdf:PropertyWhen the user enters the data, it is stored in the web as a triple with this property as its predicate.
default[according to field type] OptionalThe input control is set to this value by default. + It is easiest for the user to enter this value. (This value is not automatically stored by the form system if the user does not select or enter it in some way.
-Other propertiues are given for each field type. +Other properties are given for each field type.

Form

The form itself has a collection of fields. @@ -107,8 +107,8 @@

Form

partsrdf:Collection (aka List, Array) of FieldThe parts of the form in the order in which they are partField (Obsolete)A field which is a part of the form or group. This property is obsolete. Use parts. -If you use the obsolete "part" methid for listing the parts of a form, then -each field needs an additional propery: +If you use the obsolete "part" method for listing the parts of a form, then +each field needs an additional property: @@ -118,7 +118,7 @@

Form

Group

Group is a field which is just a collection of other fields. - It is in fact interchangable with Form. + It is in fact interchangeable with Form.

Single Value fields - Numeric

@@ -137,10 +137,10 @@

IntegerField

An RDF integer value

DecimalField

-

An RDF decimal value. Useful for montary amounts

+

An RDF decimal value. Useful for monetary amounts

FloatField

-

A floatinhg point number

+

A floating point number

Single Value fields: Special Types

@@ -196,13 +196,13 @@

Multiple

When the subject can have several of the same thing, -like friends, ro phone numers, then the Multiple field -allows this. The user clicks on the grren plus icon, and is prompted +like friends, ro phone numbers, then the Multiple field +allows this. The user clicks on the green plus icon, and is prompted for a subform for the related thing. The user can also delete existing ones.

-

For each new thing, the system generatees an arbitrary (timestamp) URI within the file +

For each new thing, the system generates an arbitrary (timestamp) URI within the file where the data is being stored. The subform is then about that thing: the subject of the subform is not -the subject of the original form. It is the fielnd, or the address, and so on. +the subject of the original form. It is the field, or the address, and so on.

Classifier

@@ -212,10 +212,10 @@

Classifier

sequenceIntegerThe parts of the form in the order in which they are
This form field leverages the ontology heavily. It pulls the subclasses of the given class, and makes a pop-up menu -for the useer to chose one. +for the user to chose one. If and only if the ontology says that the class is a disjoint union (owl:disjointUnionOf) of the subclasses, then the user interface will only allow the user to pick one. -If the user picks a subclass, and the ontolog shows that that subclass has its own subclassdes, then the +If the user picks a subclass, and the ontology shows that that subclass has its own subclasses, then the user will be prompted to pick one of those, to (if they like) further refine the selection. And so on.

@@ -265,16 +265,16 @@

Comment

Conclusion

-

The form language and the form implementaionin solid-ui - can't do everyhing, but it can handle +

The form language and the form implementation in solid-ui + can't do everything, but it can handle a pretty wide selection of tasks in common daily life at home and at work. -It can be vary efficneint as dev elopers can resuse mterial between forms. +It can be vary efficient as developers can reuse material between forms. Users can even generate their own forms.

Future directions include separate implementations of the form UI code in for various platforms, and using various UI frameworks. -There may also be extention of the system with new field types, +There may also be extension of the system with new field types, more options for setting style from various sources,