Skip to content

Commit cf518b8

Browse files
author
Richard Jones
committed
Added some more doc.
1 parent 6e941f1 commit cf518b8

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

doc/index.html

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -413,6 +413,7 @@ <h2><a name="cmd">Command Line Tool</a></h2>
413413
printed results:
414414
<ul>
415415
<li>Strings are, well, strings.
416+
<li>Password values will display as their encoded value.
416417
<li>Date values are printed in the full date format in the local time zone, and
417418
accepted in the full format or any of the partial formats explained below.
418419
<table>
@@ -672,6 +673,28 @@ <h3>Class, FileClass, IssueClass - creating a new information store</h3>
672673
<br>
673674
Class is the basic store of information.
674675

676+
<p>
677+
A class is comprised of one or more properties of the following type:
678+
679+
<ul>
680+
<li><em>String</em> properties are for storing arbitrary-length
681+
strings.
682+
683+
<li><em>Password</em> properties are for storing encoded arbitrary-length
684+
strings. The default encoding is defined on the roundup.password.Password
685+
class.
686+
687+
<li><em>Date</em> properties store date-and-time stamps.
688+
Their values are Timestamp objects.
689+
690+
<li>A <em>Link</em> property refers to a single other node
691+
selected from a specified class. The class is part of the property;
692+
the value is an integer, the id of the chosen node.
693+
694+
<li>A <em>Multilink</em> property refers to possibly many nodes
695+
in a specified class. The value is a list of integers.
696+
</ul>
697+
675698
<p>
676699

677700
<strong>FileClass</strong>
@@ -1103,7 +1126,7 @@ <h1><a name="ack">Acknowledgements</a></h1>
11031126

11041127
<p>&nbsp;</p>
11051128
<hr>
1106-
$Id: index.html,v 1.11 2001-10-09 07:25:59 richard Exp $
1129+
$Id: index.html,v 1.12 2001-10-09 07:31:02 richard Exp $
11071130
<p>&nbsp;</p>
11081131

11091132
</body></html>

0 commit comments

Comments
 (0)