bring docu up to date

git-svn-id: https://silmor.de/svn/softmagic/smoke/trunk@735 6e3c4bff-ac9f-4ac1-96c5-d2ea494d3e33

diff --git a/Makefile b/Makefile
index cd8ce2b..60537b6 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -98,6 +98,8 @@ sdoc:
        cd pack/qtbase && $(DOXYGEN)
        cd tzone && $(DOXYGEN) Doxyfile
        cd elam/src && $(DOXYGEN) Doxyfile
+       cd dptr && $(DOXYGEN) Doxyfile
+       cd zip && $(DOXYGEN) Doxyfile
 
 lrelease:
        cd src && $(LREL) smoke.pro

diff --git a/doc/dptr b/doc/dptr
new file mode 120000 (symlink)
index 0000000..e869720
--- /dev/null
+++ b/doc/dptr
@@ -0,0 +1 @@
+../dptr/html
\ No newline at end of file

diff --git a/doc/elam b/doc/elam
new file mode 120000 (symlink)
index 0000000..2d8f95b
--- /dev/null
+++ b/doc/elam
@@ -0,0 +1 @@
+../elam/doc
\ No newline at end of file

diff --git a/doc/index.html b/doc/index.html
index 3eff8ee..1f737ea 100644 (file)
--- a/doc/index.html
+++ b/doc/index.html
@@ -62,6 +62,9 @@ External Components:
 <li>The <a href="pack/index.html">PACK - Persistence And Communication Kit</a></li>
 <li>The <a href="http://www.twig-project.org/documentation">Twig</a> template engine</li>
 <li>Time Zone library <a href="tzone/index.html">source documentation</a></li>
+<li>The <a href="elam/index.html">ELAM</a> arithmatic library</li>
+<li>The <a href="dptr/index.html">DPtr</a> cheshire cat files</li>
+<li>The <a href="zip/index.html">ZIP file</a> access library</li>
 </ul><p>
 
 Source Documentation:

diff --git a/doc/prog_arch.html b/doc/prog_arch.html
index de4119a..1e50ea5 100644 (file)
--- a/doc/prog_arch.html
+++ b/doc/prog_arch.html
@@ -127,6 +127,8 @@ The client itself is stored in the <b>src</b> directory, with the following sub-
 
 <b>mwin</b> - tabs of the main window.<p>
 
+<b>script</b> - scripting classes<p>
+
 <b>templates</b> - rendering classes for ODF and ticket printing.<p>
 
 <b>tests</b> - unit tests.<p>
@@ -135,7 +137,7 @@ The client itself is stored in the <b>src</b> directory, with the following sub-
 
 <b>widgets</b> - base utility widgets.<p>
 
-<b>wob</b> - generated Web Object code. Do not change anything in this directory.<p>
+<b>wob</b> - automatically generated Web Object code. Do not change anything in this directory. If there is a need to modify those objects: modify them in the *.wolf files, possibly marking them as abstract and overiding them in wext.<p>
 
 <h3>Build Order</h3>
 
@@ -144,7 +146,7 @@ Either <a href="build.html">build</a> the entire system using the Makefile in th
 <ol>
 <li>build the web object compiler in <b>pack/woc</b>
 <li>go to the <b>wob</b> directory and call <tt>make</tt> (or call <tt>../pack/woc/woc&nbsp;magicsmoke.wolf</tt>)
-<li>build the libraries in <b>pack/qtbase</b>, <b>tzone</b>, and <b>zip</b>
+<li>build the libraries in <b>pack/qtbase</b>, <b>tzone</b>, <b>elam</b>, and <b>zip</b>
 <li>go to <b>src</b> and build MagicSmoke
 </ol>
 
@@ -155,7 +157,9 @@ Each of the libraries and MagicSmoke itself are built by using <tt>qmake</tt> to
 <ul>
 <li><a href="pack/index.html">PACK</a> documentation
 <li>client <a href="source-cpp/index.html">source</a> documentation
+<li>server <a href="source-php/index.html">source</a> documentation
 <li><a href="tzone/index.html">Time Zone</a> library documentation
+<li><a href="elam/index.html">ELAM</a> expression library documentation
 <li>generated <a href="wob/index.html">Web Object</a> descriptions, language independent
 </ul>
 

diff --git a/doc/template.html b/doc/template.html
index b81bfb5..d9f9358 100644 (file)
--- a/doc/template.html
+++ b/doc/template.html
@@ -19,18 +19,19 @@ Please see the <a href="source-php/templates.html">Templates Chapter</a> of the
 
 <h2>Template Caching</h2>
 
-The Twig template engine compiles the templates into PHP code before actually displaying anything. You have to choice to discard those compiled templates or to store them for faster access next time the page is called. Allowing the web server write access to a directory opens a potential security hole. If you want to do caching securely:
+The Twig template engine compiles the templates into PHP code before actually displaying anything. You have the choice to discard those compiled templates or to store them for faster access next time the page is called.<p>
+
+Allowing the web server write access to a directory opens a potential security hole. If you want to do caching more securely:
 <ol>
 <li>create a storage directory in parallel to the <tt>template</tt> directory, eg. <tt>tcache</tt>, or if it already exists empty it</li>
 <li>make sure the directory is writable by the web server</li>
 <li>enter this directory into the Twig configuration:<br>
 <tt>$twigoptions=array( 'cache' => './tcache' /*...*/ );</tt></li>
-<li>make it writable for the web server</li>
 <li>uncomment the "setAdminPassCode" line in <tt>config.php</tt></li>
 <li>open <tt>index.php?mode=compile</tt> in a browser - it will ask you to enter the admin credentials</li>
 <li>the page will compile all templates it can find and store them in the configured cache directory</li>
-<li>restrict the directory access rights so the web server cannot write to it any more, make sure it can also not overwrite the files</li>
-<li>comment the "setAdminPassCode" line in <tt>config.php</tt></li>
+<li>restrict the directory access rights so the web server cannot write to it any more, make sure it can also not overwrite the files inside the directory</li>
+<li>comment out the "setAdminPassCode" line in <tt>config.php</tt></li>
 </ol>
 
 

diff --git a/doc/zip b/doc/zip
new file mode 120000 (symlink)
index 0000000..223bbde
--- /dev/null
+++ b/doc/zip
@@ -0,0 +1 @@
+../zip/html
\ No newline at end of file