Changes between Version 1 and Version 2 of kmk Quick Reference

Timestamp:

Dec 30, 2008, 1:22:04 AM (15 years ago)

Author:

bird

Comment:

--

kmk Quick Reference

@@ -342 +342 @@
         $(printf fmt, arg...)
 
+    Return the length of a string or a (unexpanded) variable::
+
+        $(length string)
+        $(length-var var)
+
+    Find the position of ``needle`` in ``haystack``, returns 0 if not found.
+    Negative ``start`` indices are relative to the end of ``haystack``, while
+    positive ones are one based::
+
+        $(pos needle, haystack[, start])
+        $(lastpos needle, haystack[, start])
+
+    Returns the specified substring. The ``start`` works like with ``$(pos )``.
+    If the substring is partially outside the ``string`` the result will be
+    padded with ``pad`` if present::
+
+        $(substr string, start[, length[, pad]])
+
+    Insert ``in`` into ``str`` at the specified position. ``n`` works like with
+    ``$(pos )``, except that ``0`` is the end of the string::
+
+        $(insert in, str[, n[, length[, pad]]])
+
+    Translate ``string`` exchanging characters in ``from-set`` with ``to-set``,
+    optionally completing ``to-set`` with ``pad-char`` if specified. If no
+    ``pad-char`` characters absent in ``to-set`` will be deleted::
+
+        $(translate string, from-set[, to-set[, pad-char]])
+
 
 Functions for file names:
@@ -455 +484 @@
 
 
-(Mostly) Boolean Functions:
+Boolean and Conditional Functions:
 
     Condition is false if the ``condition`` evaluates to an empty string
@@ -494 +523 @@
     Same as ``$(if )`` execpt that the condition is a ``kmk`` expression::
 
-        $(if kmk-expression,true-part[,false-part])
+        $(if-expr kmk-expression,true-part[,false-part])
+
+    Select the first true condition (``kmk`` expression) and expand the
+    following body. Special condition strings ``default`` and ``otherwise``::
+
+        $(select when1-cond, when1-body[, whenN-cond, whenN-body])
 
     Evalutate the ``kmk`` expression returning what it evalues as. This is
@@ -528 +562 @@
         $(value var)
 
-    Evaluate ``text`` with ``var`` bound to each word in ``words``, and
+    Evaluate ``body`` with ``var`` bound to each word in ``words``, and
     concatenate the results (spaced)::
 
-        $(foreach var,words,text)
+        $(foreach var,words,body)
+
+    C-style for-loop. Start by evaluating ``init``. Each iteration will
+    first check whether the ``condition`` (``kmk``-expression) is true,
+    then expand ``body`` concatenating the result to the previous iterations
+    (spaced), and finally evaluate ``next``::
+
+        $(for init,conditions,next,body)
+
+    C-style while-loop. Each iteration will check whether the ``condition``
+    (``kmk``-expression) is true, then expand ``body`` concatenating the
+    result to the previous iterations::
+
+        $(while conditions,body)
 
     Evaluate the variable ``var`` replacing any references to ``$(1)``,
@@ -704 +751 @@
 
 
-Special targets
+Special Targets
 ---------------
 
@@ -710 +757 @@
 
 
+
+Built-in Commands
+-----------------
+
+todo
+
+
+
+kmk-expression
+--------------
+
+todo
+
+
+
 -----
 
-:Status: $Id: QuickReference-kmk.txt 2146 2008-12-27 20:22:53Z bird $
+:Status: $Id: QuickReference-kmk.txt 2163 2008-12-30 00:57:13Z bird $
 :Copyright: Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
             1996, 1997, 1998, 1999, 2000, 2002, 2003, 2004, 2005, 2006,