Skip to content

Commit 601288a

Browse files
authored
Merge pull request #98 from TallTed/patch-1
clean up forms-intro.html
2 parents ac8e82f + 92f0d78 commit 601288a

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

Documentation/forms-intro.html

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -43,34 +43,34 @@ <h2>Using Forms in the UI ontology</h2>
4343

4444
<p>The form system allows you to define a user interface
4545
declaratively in RDF.
46-
Then in your web app, you:
46+
In your web app, you then:
4747
<ol>
48-
<li>make sure the onology files are loaded,</li>
49-
<li>load the file with the fom itself, then</li>
48+
<li>make sure the ontology files are loaded</li>
49+
<li>load the file with the form itself</li>
5050
<li>call <tt>UI.widgets.appendForm(dom, container, {}, subject, form, doc, callback)</tt></li>
5151
</ol>
5252
</p>
5353
<p>
5454
where
5555
<table class="parameters">
56-
<tr><td>dom</td><td>if the DOM HTMLDocument object, aka document</td></tr>
56+
<tr><td>dom</td><td>is the DOM HTMLDocument object, a/k/a document</td></tr>
5757
<tr><td>container</td><td>is a DOM element to contain the form</td></tr>
5858
<tr><td>{}</td><td>are unused at present</td></tr>
59-
<tr><td>subject</td><td>if the RDF thing about which data will be stored</td></tr>
60-
<tr><td>form</td><td>the an RDF object in the store for the form. </td></tr>
61-
<tr><td>doc</td><td>The RDF document oin the web where the dat awill be stored. Often, <tt>subject.doc()</tt></td></tr>
62-
<tr><td>callback</td><td>is a function taking an errors flag and a message (if the error flag is true)</td></tr>
59+
<tr><td>subject</td><td>is the RDF thing about which data will be stored</td></tr>
60+
<tr><td>form</td><td>is the RDF object in the store for the form</td></tr>
61+
<tr><td>doc</td><td>is the RDF document on the web where the data will be stored. Often, <tt>subject.doc()</tt></td></tr>
62+
<tr><td>callback</td><td>is a function taking an error flag and a message (if the error flag is true)</td></tr>
6363
</table>
6464
If the form is a complex form, as the user adds more data, more form UI will be created.
65-
The data is saved back to the web the moment the users has entered it, in each field. There is no general Save Button.
65+
The data in each field is saved back to the web the moment the user has entered it. There is no general Save Button.
6666
</p>
6767
<p>
6868
There is a form form for editing forms.
69-
It is in the form onology itsef.
69+
It is in the form ontology itself.
7070
</p>
7171

7272
<p>
73-
You can of course go and write other implementatioons of the form system using
73+
You can of course go and write other implementations of the form system using
7474
your favorite user interface language.
7575
</p>
7676
<h4>Go to the source</h4><p>
@@ -80,23 +80,23 @@ <h4>Go to the source</h4><p>
8080
</ul>
8181

8282
<h2>Form field types</h2>
83-
<p>Form fields may be named nodes in your file,
84-
or blank nodes... the form system does not mind.
83+
<p>Form fields may be named or blank nodes in your file;
84+
the form system does not care.
8585
It is often useful to name them to keep track of them.
8686
</p>
8787
<p>Below, all Field Classes and Properties are in the UI namespace,
8888
<tt><a href="http://www.w3.org/ns/ui#">http://www.w3.org/ns/ui#</a></tt>, except
89-
the data types like Integer are in the normal <a href="http://www.w3.org/2001/XMLSchema#">XSD</a> namespace.
89+
the data types, like Integer, which are in the normal <a href="http://www.w3.org/2001/XMLSchema#">XSD</a> namespace.
9090
</p>
9191
<p>
92-
Here are some properries which you can use with any field (except the documentations fields).
92+
Here are some properties which you can use with any field (except the documentation fields).
9393
<table class="properties">
94-
<tr><td>label</td><td>String</td><td>A label for the form field. This is the prompt for the user, Eg "Name", "Exmployers"</td></tr>
95-
<tr><td>property</td><td>rdf:Property</td><td>When the user enters the data, it is stored in the web as a triple with this property as its predicate..</td></tr>
96-
<tr><td>default</td><td>[according to field type] Optional</td><td>The input control is by default set to this value.
97-
It is easiest for the user to enter this value. (This value is <b>not</b> stored by the forms syetm automatically if the udser does not select or enter it in some way.</td></tr>
94+
<tr><td>label</td><td>String</td><td>A label for the form field. This is the prompt for the user, e.g., "Name", "Employer".</td></tr>
95+
<tr><td>property</td><td>rdf:Property</td><td>When the user enters the data, it is stored in the web as a triple with this property as its predicate.</td></tr>
96+
<tr><td>default</td><td>[according to field type] Optional</td><td>The input control is set to this value by default.
97+
It is easiest for the user to enter this value. (This value is <b>not</b> automatically stored by the form system if the user does not select or enter it in some way.</td></tr>
9898
</table>
99-
Other propertiues are given for each field type.
99+
Other properties are given for each field type.
100100
</p>
101101
<h4 class="class">Form</h4>
102102
<p>The form itself has a collection of fields.
@@ -107,8 +107,8 @@ <h4 class="class">Form</h4>
107107
<tr><td>parts</td><td>rdf:Collection (aka List, Array) of Field</td><td>The parts of the form in the order in which they are </td></tr>
108108
<tr><td><i>part</i></td><td>Field (Obsolete)</td><td>A field which is a part of the form or group. This property is obsolete. Use parts.</td></tr>
109109
</table>
110-
If you use the obsolete "part" methid for listing the parts of a form, then
111-
each field needs an additional propery:
110+
If you use the obsolete "part" method for listing the parts of a form, then
111+
each field needs an additional property:
112112

113113
<table class="properties">
114114
<tr><td>sequence</td><td>Integer</td><td>The parts of the form in the order in which they are </td></tr>
@@ -118,7 +118,7 @@ <h4 class="class">Form</h4>
118118
</p>
119119
<h4 class="class">Group</h4>
120120
<p>Group is a field which is just a collection of other fields.
121-
It is in fact interchangable with Form.
121+
It is in fact interchangeable with Form.
122122

123123

124124
<h3>Single Value fields - Numeric</h3>
@@ -137,10 +137,10 @@ <h4 class="class"> IntegerField</h4>
137137
<p>An RDF integer value</p>
138138

139139
<h4 class="class"> DecimalField</h4>
140-
<p>An RDF decimal value. Useful for montary amounts</p>
140+
<p>An RDF decimal value. Useful for monetary amounts</p>
141141

142142
<h4 class="class"> FloatField</h4>
143-
<p>A floatinhg point number</p>
143+
<p>A floating point number</p>
144144

145145

146146
<h3>Single Value fields: Special Types </h3>
@@ -196,13 +196,13 @@ <h4 class="class"> Multiple</h4>
196196
<p></p>
197197

198198
<p>When the subject can have several of the same thing,
199-
like friends, ro phone numers, then the Multiple field
200-
allows this. The user clicks on the grren plus icon, and is prompted
199+
like friends, ro phone numbers, then the Multiple field
200+
allows this. The user clicks on the green plus icon, and is prompted
201201
for a subform for the related thing.
202202
The user can also delete existing ones.</p>
203-
<p>For each new thing, the system generatees an arbitrary (timestamp) URI within the file
203+
<p>For each new thing, the system generates an arbitrary (timestamp) URI within the file
204204
where the data is being stored. The subform is then about that thing: the subject of the subform is not
205-
the subject of the original form. It is the fielnd, or the address, and so on.
205+
the subject of the original form. It is the field, or the address, and so on.
206206
</p>
207207
<h4 class="class"> Classifier</h4>
208208
<p>
@@ -212,10 +212,10 @@ <h4 class="class"> Classifier</h4>
212212
</table>
213213
This form field leverages the ontology heavily.
214214
It pulls the subclasses of the given class, and makes a pop-up menu
215-
for the useer to chose one.
215+
for the user to chose one.
216216
If and only if the ontology says that the class is a disjoint union (owl:disjointUnionOf) of the subclasses, then the
217217
user interface will only allow the user to pick one.
218-
If the user picks a subclass, and the ontolog shows that that subclass has its own subclassdes, then the
218+
If the user picks a subclass, and the ontology shows that that subclass has its own subclasses, then the
219219
user will be prompted to pick one of those, to (if they like) further refine the selection. And so on.
220220
</p>
221221

@@ -265,16 +265,16 @@ <h4 class="class"> Comment</h4>
265265

266266

267267
<h2>Conclusion</h2>
268-
<p>The form language and the form implementaionin solid-ui
269-
can't do everyhing, but it can handle
268+
<p>The form language and the form implementation in solid-ui
269+
can't do everything, but it can handle
270270
a pretty wide selection of tasks in common
271271
daily life at home and at work.
272-
It can be vary efficneint as dev elopers can resuse mterial between forms.
272+
It can be vary efficient as developers can reuse material between forms.
273273
Users can even generate their own forms.
274274
</p>
275275
Future directions include separate implementations of the form UI code in
276276
for various platforms, and using various UI frameworks.
277-
There may also be extention of the system with new field types,
277+
There may also be extension of the system with new field types,
278278
more options for setting style from various sources,
279279
<p>
280280

0 commit comments

Comments
 (0)