Code

Added some more doc.
authorrichard <richard@57a73879-2fb5-44c3-a270-3262357dd7e2>
Tue, 9 Oct 2001 07:31:02 +0000 (07:31 +0000)
committerrichard <richard@57a73879-2fb5-44c3-a270-3262357dd7e2>
Tue, 9 Oct 2001 07:31:02 +0000 (07:31 +0000)
git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/trunk@279 57a73879-2fb5-44c3-a270-3262357dd7e2

doc/index.html

index bbf54e2cc18e96433965de8e1fc66ac0a6635ca3..d8759a47d7fe4b89c8723dbb489382c3a6fc6952 100644 (file)
@@ -413,6 +413,7 @@ Property values are represented as strings in command arguments and in the
 printed results:
 <ul>
     <li>Strings are, well, strings.
+    <li>Password values will display as their encoded value.
     <li>Date values are printed in the full date format in the local time zone, and
    accepted in the full format or any of the partial formats explained below.
 <table>
@@ -672,6 +673,28 @@ up.
 <br>
 Class is the basic store of information.
 
+<p>
+A class is comprised of one or more properties of the following type:
+
+<ul>
+<li><em>String</em> properties are for storing arbitrary-length
+strings.
+
+<li><em>Password</em> properties are for storing encoded arbitrary-length
+strings. The default encoding is defined on the roundup.password.Password
+class.
+
+<li><em>Date</em> properties store date-and-time stamps.
+Their values are Timestamp objects.
+
+<li>A <em>Link</em> property refers to a single other node
+selected from a specified class.  The class is part of the property;
+the value is an integer, the id of the chosen node.
+
+<li>A <em>Multilink</em> property refers to possibly many nodes
+in a specified class.  The value is a list of integers.
+</ul>
+
 <p>
 
 <strong>FileClass</strong>
@@ -1103,7 +1126,7 @@ system on their time.
 
 <p>&nbsp;</p>
 <hr>
-$Id: index.html,v 1.11 2001-10-09 07:25:59 richard Exp $
+$Id: index.html,v 1.12 2001-10-09 07:31:02 richard Exp $
 <p>&nbsp;</p>
 
 </body></html>