From: konrad Date: Sat, 26 Feb 2011 21:29:29 +0000 (+0000) Subject: bring docu up to date X-Git-Url: http://git.silmor.de/gitweb/?a=commitdiff_plain;h=687b739507f270ec277b2d6d29ff5c28cf965358;p=konrad%2Fsmoke.git 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 --- 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 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 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 --- a/doc/index.html +++ b/doc/index.html @@ -62,6 +62,9 @@ External Components:
  • The PACK - Persistence And Communication Kit
  • The Twig template engine
  • Time Zone library source documentation
    • +
  • The ELAM arithmatic library
    • +
  • The DPtr cheshire cat files
    • +
  • The ZIP file access library

    • Source Documentation: diff --git a/doc/prog_arch.html b/doc/prog_arch.html index de4119a..1e50ea5 100644 --- a/doc/prog_arch.html +++ b/doc/prog_arch.html @@ -127,6 +127,8 @@ The client itself is stored in the src directory, with the following sub- mwin - tabs of the main window.

    +script - scripting classes

    + templates - rendering classes for ODF and ticket printing.

    tests - unit tests.

    @@ -135,7 +137,7 @@ The client itself is stored in the src directory, with the following sub- widgets - base utility widgets.

    -wob - generated Web Object code. Do not change anything in this directory.

    +wob - 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.

    Build Order

    @@ -144,7 +146,7 @@ Either build the entire system using the Makefile in th
    1. build the web object compiler in pack/woc
    2. go to the wob directory and call make (or call ../pack/woc/woc magicsmoke.wolf) -
    3. build the libraries in pack/qtbase, tzone, and zip +
    4. build the libraries in pack/qtbase, tzone, elam, and zip
    5. go to src and build MagicSmoke
    @@ -155,7 +157,9 @@ Each of the libraries and MagicSmoke itself are built by using qmake to diff --git a/doc/template.html b/doc/template.html index b81bfb5..d9f9358 100644 --- a/doc/template.html +++ b/doc/template.html @@ -19,18 +19,19 @@ Please see the Templates Chapter of the

    Template Caching

    -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.

    + +Allowing the web server write access to a directory opens a potential security hole. If you want to do caching more securely:

    1. create a storage directory in parallel to the template directory, eg. tcache, or if it already exists empty it
    2. make sure the directory is writable by the web server
    3. enter this directory into the Twig configuration:
      $twigoptions=array( 'cache' => './tcache' /*...*/ );
      4. -
    4. make it writable for the web server
    5. uncomment the "setAdminPassCode" line in config.php
    6. open index.php?mode=compile in a browser - it will ask you to enter the admin credentials
    7. the page will compile all templates it can find and store them in the configured cache directory
      8. -
    8. restrict the directory access rights so the web server cannot write to it any more, make sure it can also not overwrite the files
      9. -
    9. comment the "setAdminPassCode" line in config.php
      10. +
    10. 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
      11. +
    11. comment out the "setAdminPassCode" line in config.php
    diff --git a/doc/zip b/doc/zip new file mode 120000 index 0000000..223bbde --- /dev/null +++ b/doc/zip @@ -0,0 +1 @@ +../zip/html \ No newline at end of file