mirrors/clog
1
Fork 0
mirror of https://github.com/rabbibotton/clog.git synced 2025-12-09 20:30:26 -08:00
Code Issues Projects Releases Wiki Activity

doc update

Browse source
This commit is contained in:
David Botton 2021-01-29 01:31:41 -05:00
parent 04b2fd316f
commit e433cf1e4c
5 changed files with 75 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -73,10 +73,16 @@ CL-USER> (clog:clog-install-dir)
You can the load the demos with: You can the load the demos with:
``` ```
CL-USER> (load "path to clog/demos/01-snake.lisp) CL-USER> (load "path to clog/demos/01-snake.lisp")
CL-USER> (clog-user:start-demo) CL-USER> (clog-user:start-demo)
``` ```
To open a browser with the CLOG manual:
```
CL-USER> (clog:open-manual)
```
Work your way through the tutorials. You will see how quick and easy it is Work your way through the tutorials. You will see how quick and easy it is
to be a CLOGer. to be a CLOGer.

35
clog-docs.lisp
View file

@ -19,8 +19,6 @@ David Botton <david@botton.com>
License BSD 3-Clause License License BSD 3-Clause License
- Introduction
The Common Lisp Omnificent GUI, CLOG for short, uses web technology to The Common Lisp Omnificent GUI, CLOG for short, uses web technology to
produce graphical user interfaces for applications locally or remotely. produce graphical user interfaces for applications locally or remotely.
CLOG can take the place, or work alongside, most cross-platform GUI CLOG can take the place, or work alongside, most cross-platform GUI
@ -28,10 +26,10 @@ frameworks and website frameworks. The CLOG package starts up the
connectivity to the browser or other websocket client (often a browser connectivity to the browser or other websocket client (often a browser
embedded in a native template application.) embedded in a native template application.)
STATUS: CLOG is complete enough for most uses. See the README.md for STATUS: CLOG is complete enough for most uses. See below for some
some enhacements bing worked on, CLOG is actually based on GNOGA, a enhacements bing worked on, CLOG is actually based on GNOGA, a
framework I wrote for Ada in 2013 and used in commercial production framework I wrote for Ada in 2013 and used in commercial production
code for the last 6 years, i.e. the techiniques CLOG uses are solid code for the last 8 years, i.e. the techiniques CLOG uses are solid
and proven. and proven.
Some potential applications for CLOG: Some potential applications for CLOG:
@ -68,14 +66,31 @@ git clone https://github.com/rabbibotton/clog.git
To load this package and work through tutorials (assuming you To load this package and work through tutorials (assuming you
have Quicklisp configured): have Quicklisp configured):
1. cd to the CLOG dir (the dir should be one used by Quicklisp ex. ~/common-lisp/) 1. Start emacs then M-x slime
2. Start emacs/slime or your common lisp \"repl\" in _that_ directory. 2. In the REPL, run:
3. In the REPL, run:
``` ```
CL-USER> (ql:quickload :clog) CL-USER> (ql:quickload :clog)
CL-USER> (load \"~/common-lisp/clog/tutorial/01-tutorial.lisp\") CL-USER> (clog-user:run-tutorial 1)
CL-USER> (clog-user:start-tutorial) ```
To see where the source files are:
```
CL-USER> (clog:clog-install-dir)
```
You can the load the demos with:
```
CL-USER> (load \"path to clog/demos/01-snake.lisp\")
CL-USER> (clog-user:start-demo)
```
To open a browser with the CLOG manual:
```
CL-USER> (clog:open-manual)
``` ```
Work your way through the tutorials. You will see how quick and easy it is Work your way through the tutorials. You will see how quick and easy it is

10
clog-helpers.lisp
View file

@ -25,6 +25,16 @@
"Return the directory CLOG was installed in." "Return the directory CLOG was installed in."
(asdf:system-source-directory :clog)) (asdf:system-source-directory :clog))
;;;;;;;;;;;;;;;;;
;; open-manual ;;
;;;;;;;;;;;;;;;;;
(defun open-manual ()
"Launches a browser with CLOG manual."
(open-browser :url (format nil "~A"
(merge-pathnames "./doc/clog-manual.html"
(asdf:system-source-directory :clog)))))
;;;;;;;;;;;;;;;;;; ;;;;;;;;;;;;;;;;;;
;; run-tutorial ;; ;; run-tutorial ;;
;;;;;;;;;;;;;;;;;; ;;;;;;;;;;;;;;;;;;

1
clog.lisp
View file

@ -735,6 +735,7 @@ embedded in a native template application.)"
(defsection @clog-helpers (:title "CLOG Helper Functions") (defsection @clog-helpers (:title "CLOG Helper Functions")
"Tutorial and demo helpers" "Tutorial and demo helpers"
(clog-install-dir function) (clog-install-dir function)
(open-manual function)
(run-tutorial function) (run-tutorial function)
"Functions for Compilation and Documentation" "Functions for Compilation and Documentation"

45
doc/clog-manual.html
View file

@ -75,10 +75,6 @@ embedded in a native template application.)</p>
<p>License BSD 3-Clause License</p> <p>License BSD 3-Clause License</p>
<ul>
<li>Introduction</li>
</ul>
<p>The Common Lisp Omnificent GUI, <code>CLOG</code> for short, uses web technology to <p>The Common Lisp Omnificent GUI, <code>CLOG</code> for short, uses web technology to
produce graphical user interfaces for applications locally or remotely. produce graphical user interfaces for applications locally or remotely.
<code>CLOG</code> can take the place, or work alongside, most cross-platform GUI <code>CLOG</code> can take the place, or work alongside, most cross-platform GUI
@ -86,10 +82,10 @@ frameworks and website frameworks. The <code>CLOG</code> package starts up the
connectivity to the browser or other websocket client (often a browser connectivity to the browser or other websocket client (often a browser
embedded in a native template application.)</p> embedded in a native template application.)</p>
<p>STATUS: <code>CLOG</code> is complete enough for most uses. See the README.md for <p>STATUS: <code>CLOG</code> is complete enough for most uses. See below for some
some enhacements bing worked on, <code>CLOG</code> is actually based on GNOGA, a enhacements bing worked on, <code>CLOG</code> is actually based on GNOGA, a
framework I wrote for Ada in 2013 and used in commercial production framework I wrote for Ada in 2013 and used in commercial production
code for the last 6 years, i.e. the techiniques <code>CLOG</code> uses are solid code for the last 8 years, i.e. the techiniques <code>CLOG</code> uses are solid
and proven.</p> and proven.</p>
<p>Some potential applications for <code>CLOG</code>:</p> <p>Some potential applications for <code>CLOG</code>:</p>
@ -127,14 +123,25 @@ git clone https://github.com/rabbibotton/clog.git</span></code></pre>
have Quicklisp configured):</p> have Quicklisp configured):</p>
<ol> <ol>
<li><p>cd to the <code>CLOG</code> dir (the dir should be one used by Quicklisp ex. ~/common-lisp/)</p></li> <li><p>Start emacs then M-x slime</p></li>
<li><p>Start emacs/slime or your common lisp &quot;repl&quot; in <em>that</em> directory.</p></li>
<li><p>In the REPL, run:</p></li> <li><p>In the REPL, run:</p></li>
</ol> </ol>
<pre><code><span class="code">CL-USER&gt; <span class="paren1">(<span class="code">ql:quickload <span class="keyword">:clog</span></span>)</span> <pre><code><span class="code">CL-USER&gt; <span class="paren1">(<span class="code">ql:quickload <span class="keyword">:clog</span></span>)</span>
CL-USER&gt; <span class="paren1">(<span class="code">load <span class="string">"~/common-lisp/clog/tutorial/01-tutorial.lisp"</span></span>)</span> CL-USER&gt; <span class="paren1">(<span class="code">clog-user:run-tutorial 1</span>)</span></span></code></pre>
CL-USER&gt; <span class="paren1">(<span class="code">clog-user:start-tutorial</span>)</span></span></code></pre>
<p>To see where the source files are:</p>
<pre><code><span class="code">CL-USER&gt; <span class="paren1">(<span class="code">clog:clog-install-dir</span>)</span></span></code></pre>
<p>You can the load the demos with:</p>
<pre><code><span class="code">CL-USER&gt; <span class="paren1">(<span class="code">load <span class="string">"path to clog/demos/01-snake.lisp"</span></span>)</span>
CL-USER&gt; <span class="paren1">(<span class="code">clog-user:start-demo</span>)</span></span></code></pre>
<p>To open a browser with the <code>CLOG</code> manual:</p>
<pre><code><span class="code">CL-USER&gt; <span class="paren1">(<span class="code">clog:open-manual</span>)</span></span></code></pre>
<p>Work your way through the tutorials. You will see how quick and easy it is <p>Work your way through the tutorials. You will see how quick and easy it is
to be a CLOGer. The next section also covers the basic programming concepts to be a CLOGer. The next section also covers the basic programming concepts
@ -4998,13 +5005,25 @@ on-storage event is fired for changes to :local storage keys.</p></li>
<p><a id='x-28CLOG-3ACLOG-INSTALL-DIR-20FUNCTION-29'></a></p> <p><a id='x-28CLOG-3ACLOG-INSTALL-DIR-20FUNCTION-29'></a></p>
<ul> <ul>
<li><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#x-28CLOG-3ACLOG-INSTALL-DIR-20FUNCTION-29" >CLOG-INSTALL-DIR</a></span></span> <span class="locative-args"></span></span></li> <li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#x-28CLOG-3ACLOG-INSTALL-DIR-20FUNCTION-29" >CLOG-INSTALL-DIR</a></span></span> <span class="locative-args"></span></span></p>
<p>Return the directory <code>CLOG</code> was installed in.</p></li>
</ul>
<p><a id='x-28CLOG-3AOPEN-MANUAL-20FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#x-28CLOG-3AOPEN-MANUAL-20FUNCTION-29" >OPEN-MANUAL</a></span></span> <span class="locative-args"></span></span></p>
<p>Launches a browser with <code>CLOG</code> manual.</p></li>
</ul> </ul>
<p><a id='x-28CLOG-3ARUN-TUTORIAL-20FUNCTION-29'></a></p> <p><a id='x-28CLOG-3ARUN-TUTORIAL-20FUNCTION-29'></a></p>
<ul> <ul>
<li><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#x-28CLOG-3ARUN-TUTORIAL-20FUNCTION-29" >RUN-TUTORIAL</a></span></span> <span class="locative-args">NUM</span></span></li> <li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#x-28CLOG-3ARUN-TUTORIAL-20FUNCTION-29" >RUN-TUTORIAL</a></span></span> <span class="locative-args">NUM</span></span></p>
<p>Run tutorial <code>NUM</code></p></li>
</ul> </ul>
<p>Functions for Compilation and Documentation</p> <p>Functions for Compilation and Documentation</p>