Changeset 320 for trunk/thune/doc

Timestamp:

12/21/06 22:41:25 (2 years ago)

Author:

krobillard

Message:

Thune - Additions to UserManual?

Files:

• trunk/thune/doc/UserManual (modified) (6 diffs)

trunk/thune/doc/UserManual

@@ -263 +263 @@
 Word      Stack Usage                Function
 ========  =========================  ============================
-ift       (logic -- )                Evaluate next value if true.
+ift_      (logic -- )                Evaluate next value if true.
 iff       (logic -- )                Evaluate next value if false.
 if/C      (val val -- )              Evaluate next value if comparison is true.
@@ -271 +271 @@
 iter      (ser body -- )             Iterate over series.
 iter/N    (ser body -- )             Iterate over series with skip.
-proc      (body -- )                 Create procedure.
-func      (sig body -- )             Create function with local values.
+proc      (body -- proc)             Create procedure.
+func      (sig body -- func)         Create function with local values.
 return    ()                         Leave function.
 recurse   ()                         Start function from beginning.
@@ -311 +311 @@
 make        (type proto [p2] -- val)  Create value.
 as          (val type -- val)         View value as a similar type.
+to          (val type -- val)         Convert value to a similar type.
 type?       (val -- type)             Replace value with datatype of value.
 type?.word  (val -- word)             Replace value with datatype word.
@@ -347 +348 @@
 ==========  ======================  =================
 append      (ser val -- ser)        Append value to series.
+append      (bin num bytes -- bin)  Append number to binary.
 append.cat  (ser val -- ser)        Join value to series.
-insert      (ser val -- ser)        Insert value to series.
+insert      (ser val -- ser)        Insert value into series.
 remove      (ser -- ser)            Remove value at current series position.
 clear       (ser -- ser)            Remove all elements.
@@ -370 +372 @@
 find        (ser pat -- ser)        Find pattern in series.
 find.last   (ser pat -- ser)        Find pattern in series starting from end.
-match       (ser pat -- ser)        Move position to end of pattern.
+match_      (ser pat -- end)        Move position to end of matching pattern.
 trim        (str -- str)            Remove whitespace from start and end.
 ==========  ======================  =================
@@ -483 +485 @@
 ==========  ===========================
 
+
+
+Data Stack Functions
+====================
+
+
+
+Flow Control Functions
+=======================
+
+ift
+---
+::
+
+        (logic -- )
+
+Evaluate next value if TOS is true.  To evaluate more than one value use
+a paren!.
+
+Example::
+
+    )> 4 1 gt? ift ("Four is greater than one." print)
+    Four is greater than one.
+
+
+
+Data Manipulation Functions
+===========================
+
+
+
+Series Functions
+================
+
+
+match
+-----
+::
+
+        (ser pat -- end series!/none!)
+
+Move position to end of matching pattern.
+Returns *none* if start of *ser* does not match *pat*.
+
+
+
+Math Functions
+==============
+
+
+
+Input/Output Functions
+======================
+
+