[clfswm-cvs] r131 - in clfswm: . doc src
pbrochard at common-lisp.net
pbrochard at common-lisp.net
Sat May 17 22:09:41 UTC 2008
Author: pbrochard
Date: Sat May 17 18:09:40 2008
New Revision: 131
Modified:
clfswm/ChangeLog
clfswm/doc/keys.html
clfswm/doc/keys.txt
clfswm/doc/menu.html
clfswm/doc/menu.txt
clfswm/src/clfswm-autodoc.lisp
Log:
Autodoc: produce-*-doc-*: Add a note to use the autodoc functions.
Modified: clfswm/ChangeLog
==============================================================================
--- clfswm/ChangeLog (original)
+++ clfswm/ChangeLog Sat May 17 18:09:40 2008
@@ -1,3 +1,8 @@
+2008-05-18 Philippe Brochard <pbrochard at common-lisp.net>
+
+ * src/clfswm-autodoc.lisp (produce-*-doc-*): Add a note to use the
+ autodoc functions.
+
2008-05-17 Philippe Brochard <pbrochard at common-lisp.net>
* src/clfswm-nw-hooks.lisp (default-frame-nw-hook): Do not handle
Modified: clfswm/doc/keys.html
==============================================================================
--- clfswm/doc/keys.html (original)
+++ clfswm/doc/keys.html Sat May 17 18:09:40 2008
@@ -1507,5 +1507,19 @@
</td>
</tr>
</table>
+ <p>
+ <small>
+ This documentation was produced with the CLFSWM auto-doc functions. To reproduce it, use the produce-doc-html-in-file or
+the produce-all-docs function from the Lisp REPL.
+ </small>
+ </p>
+ <p>
+ <small>
+ Something like this:<br>
+LISP> (in-package :clfswm)<br>
+CLFSWM> (produce-doc-html-in-file "my-keys.html")<br>
+or<br> CLFSWM> (produce-all-docs)
+ </small>
+ </p>
</body>
</html>
Modified: clfswm/doc/keys.txt
==============================================================================
--- clfswm/doc/keys.txt (original)
+++ clfswm/doc/keys.txt Sat May 17 18:09:40 2008
@@ -158,3 +158,14 @@
5 Move one line down
Motion Grab text
+
+
+This documentation was produced with the CLFSWM auto-doc functions. To reproduce it, use the produce-doc-in-file or
+the produce-all-docs function from the Lisp REPL.
+
+Something like this:
+LISP> (in-package :clfswm)
+CLFSWM> (produce-doc-in-file "my-keys.txt")
+or
+CLFSWM> (produce-all-docs)
+
Modified: clfswm/doc/menu.html
==============================================================================
--- clfswm/doc/menu.html (original)
+++ clfswm/doc/menu.html Sat May 17 18:09:40 2008
@@ -104,6 +104,9 @@
<p>
g: Tile Space: tile child in its frame leaving spaces between them
</p>
+ <p>
+ h: Tile Left Space: main child on left and others on right. Leave some space on the left.
+ </p>
<hr>
<h3>
<a name="FRAME-LAYOUT-ONCE-MENU"></a><a href="#FRAME-MENU">Frame-Layout-Once-Menu</a>
@@ -129,6 +132,9 @@
<p>
g: Tile Space: tile child in its frame leaving spaces between them
</p>
+ <p>
+ h: Tile Left Space: main child on left and others on right. Leave some space on the left.
+ </p>
<hr>
<h3>
<a name="FRAME-NW-HOOK-MENU"></a><a href="#FRAME-MENU">Frame-Nw-Hook-Menu</a>
@@ -358,5 +364,19 @@
exclam: Run a program from the query input
</p>
<hr>
+ <p>
+ <small>
+ This documentation was produced with the CLFSWM auto-doc functions. To reproduce it, use the produce-menu-doc-html-in-file or
+the produce-all-docs function from the Lisp REPL.
+ </small>
+ </p>
+ <p>
+ <small>
+ Something like this:<br>
+LISP> (in-package :clfswm)<br>
+CLFSWM> (produce-menu-doc-html-in-file "my-menu.html")<br>
+or<br> CLFSWM> (produce-all-docs)
+ </small>
+ </p>
</body>
</html>
Modified: clfswm/doc/menu.txt
==============================================================================
--- clfswm/doc/menu.txt (original)
+++ clfswm/doc/menu.txt Sat May 17 18:09:40 2008
@@ -33,6 +33,7 @@
e: Tile Top: main child on top and others on bottom
f: Tile Bottom: main child on bottom and others on top
g: Tile Space: tile child in its frame leaving spaces between them
+h: Tile Left Space: main child on left and others on right. Leave some space on the left.
Frame-Layout-Once-Menu
a: Maximize windows in there frame - leave frame to there size (no layout)
@@ -42,6 +43,7 @@
e: Tile Top: main child on top and others on bottom
f: Tile Bottom: main child on bottom and others on top
g: Tile Space: tile child in its frame leaving spaces between them
+h: Tile Left Space: main child on left and others on right. Leave some space on the left.
Frame-Nw-Hook-Menu
a: Open the next window in the current frame
@@ -126,3 +128,14 @@
i: Identify a key
colon: Eval a lisp form from the query input
exclam: Run a program from the query input
+
+
+This documentation was produced with the CLFSWM auto-doc functions. To reproduce it, use the produce-menu-doc-in-file or
+the produce-all-docs function from the Lisp REPL.
+
+Something like this:
+LISP> (in-package :clfswm)
+CLFSWM> (produce-menu-doc-in-file "my-menu.txt")
+or
+CLFSWM> (produce-all-docs)
+
Modified: clfswm/src/clfswm-autodoc.lisp
==============================================================================
--- clfswm/src/clfswm-autodoc.lisp (original)
+++ clfswm/src/clfswm-autodoc.lisp Sat May 17 18:09:40 2008
@@ -66,7 +66,13 @@
(dolist (hk hash-table-key-list)
(push `(h3 (u ,(gethash 'name hk))) acc)
(push (produce-keys hk) acc))
- (nreverse acc))))
+ (nreverse acc))
+ (p (small "This documentation was produced with the CLFSWM auto-doc functions. To reproduce it, use the produce-doc-html-in-file or
+the produce-all-docs function from the Lisp REPL."))
+ (p (small "Something like this:<br>
+LISP> (in-package :clfswm)<br>
+CLFSWM> (produce-doc-html-in-file \"my-keys.html\")<br>
+or<br> CLFSWM> (produce-all-docs)"))))
0 stream)))
@@ -100,7 +106,15 @@
(first k)))))
(documentation (or (first v) (third v)) 'function))))
hk)
- (format stream "~2&")))
+ (format stream "~2&"))
+ (format stream "~2%This documentation was produced with the CLFSWM auto-doc functions. To reproduce it, use the produce-doc-in-file or
+the produce-all-docs function from the Lisp REPL.
+
+Something like this:
+LISP> (in-package :clfswm)
+CLFSWM> (produce-doc-in-file \"my-keys.txt\")
+or
+CLFSWM> (produce-all-docs)~2%"))
@@ -135,7 +149,15 @@
(rec (menu-item-value item))))))))
(format stream "Here is the map of the CLFSWM menu:~%")
(format stream "(By default it is bound on second-mode + m)~%")
- (rec *menu*)))
+ (rec *menu*)
+ (format stream "~2%This documentation was produced with the CLFSWM auto-doc functions. To reproduce it, use the produce-menu-doc-in-file or
+the produce-all-docs function from the Lisp REPL.
+
+Something like this:
+LISP> (in-package :clfswm)
+CLFSWM> (produce-menu-doc-in-file \"my-menu.txt\")
+or
+CLFSWM> (produce-all-docs)~2%")))
@@ -180,7 +202,13 @@
(h1 ("a name=\"Top\"" "CLFSWM Menu"))
(p "Here is the map of the CLFSWM menu:"
"(By default it is bound on second-mode + m)")
- ,@(nreverse menu-list)))
+ ,@(nreverse menu-list)
+ (p (small "This documentation was produced with the CLFSWM auto-doc functions. To reproduce it, use the produce-menu-doc-html-in-file or
+the produce-all-docs function from the Lisp REPL."))
+ (p (small "Something like this:<br>
+LISP> (in-package :clfswm)<br>
+CLFSWM> (produce-menu-doc-html-in-file \"my-menu.html\")<br>
+or<br> CLFSWM> (produce-all-docs)"))))
0 stream))))
More information about the clfswm-cvs
mailing list