aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rwxr-xr-xmake_docu.sh2
-rw-r--r--ratatoeskr/libs/.gitignore2
-rw-r--r--ratatoeskr/libs/INFO15
-rw-r--r--ratatoeskr/licenses/php_markdown36
-rw-r--r--ratatoeskr/licenses/ratatoeskr18
-rw-r--r--ratatoeskr/licenses/smarty165
-rw-r--r--ratatoeskr/sys/load_smarty.php28
-rw-r--r--ratatoeskr/tmp/smarty/.gitignore2
-rw-r--r--ratatoeskr/tmp/smarty/INFO6
9 files changed, 273 insertions, 1 deletions
diff --git a/make_docu.sh b/make_docu.sh
index 37c0210..8d64d10 100755
--- a/make_docu.sh
+++ b/make_docu.sh
@@ -1,4 +1,4 @@
#!/usr/bin/env bash
if ! [ -d docu ]; then mkdir docu; fi
if ! [ -d naturaldocs_dir ]; then mkdir naturaldocs_dir; fi
-NaturalDocs -i . -o HTML docu -p naturaldocs_dir/
+NaturalDocs -i . -xi ./ratatoeskr/libs/ -o HTML docu -p naturaldocs_dir/
diff --git a/ratatoeskr/libs/.gitignore b/ratatoeskr/libs/.gitignore
new file mode 100644
index 0000000..1af7787
--- /dev/null
+++ b/ratatoeskr/libs/.gitignore
@@ -0,0 +1,2 @@
+smarty
+markdown.php
diff --git a/ratatoeskr/libs/INFO b/ratatoeskr/libs/INFO
new file mode 100644
index 0000000..5298ab2
--- /dev/null
+++ b/ratatoeskr/libs/INFO
@@ -0,0 +1,15 @@
+This directory will hold some libraries Ratatöskr needs.
+
+1. Smarty Template engine
+
+ Create a directory called "smarty" and place the content of the "libs"
+ directory there.
+
+ Smarty can be found here: <http://www.smarty.net/download>
+
+2. PHP Markdown
+
+ Place "markdown.php" from the archive directly into this directory.
+
+ PHP Markdown can be found here: <http://michelf.com/projects/php-markdown/>
+
diff --git a/ratatoeskr/licenses/php_markdown b/ratatoeskr/licenses/php_markdown
new file mode 100644
index 0000000..ea90c49
--- /dev/null
+++ b/ratatoeskr/licenses/php_markdown
@@ -0,0 +1,36 @@
+PHP Markdown
+Copyright (c) 2004-2009 Michel Fortin
+<http://michelf.com/>
+All rights reserved.
+
+Based on Markdown
+Copyright (c) 2003-2006 John Gruber
+<http://daringfireball.net/>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+* Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+* Neither the name "Markdown" nor the names of its contributors may
+ be used to endorse or promote products derived from this software
+ without specific prior written permission.
+
+This software is provided by the copyright holders and contributors "as
+is" and any express or implied warranties, including, but not limited
+to, the implied warranties of merchantability and fitness for a
+particular purpose are disclaimed. In no event shall the copyright owner
+or contributors be liable for any direct, indirect, incidental, special,
+exemplary, or consequential damages (including, but not limited to,
+procurement of substitute goods or services; loss of use, data, or
+profits; or business interruption) however caused and on any theory of
+liability, whether in contract, strict liability, or tort (including
+negligence or otherwise) arising in any way out of the use of this
+software, even if advised of the possibility of such damage.
diff --git a/ratatoeskr/licenses/ratatoeskr b/ratatoeskr/licenses/ratatoeskr
new file mode 100644
index 0000000..c0dc1c0
--- /dev/null
+++ b/ratatoeskr/licenses/ratatoeskr
@@ -0,0 +1,18 @@
+Copyright (c) 2011 Kevin Chabowski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/ratatoeskr/licenses/smarty b/ratatoeskr/licenses/smarty
new file mode 100644
index 0000000..02bbb60
--- /dev/null
+++ b/ratatoeskr/licenses/smarty
@@ -0,0 +1,165 @@
+ GNU LESSER GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+ This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+ 0. Additional Definitions.
+
+ As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+ "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+ An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+ A "Combined Work" is a work produced by combining or linking an
+Application with the Library. The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+ The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+ The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+ 1. Exception to Section 3 of the GNU GPL.
+
+ You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+ 2. Conveying Modified Versions.
+
+ If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+ a) under this License, provided that you make a good faith effort to
+ ensure that, in the event an Application does not supply the
+ function or data, the facility still operates, and performs
+ whatever part of its purpose remains meaningful, or
+
+ b) under the GNU GPL, with none of the additional permissions of
+ this License applicable to that copy.
+
+ 3. Object Code Incorporating Material from Library Header Files.
+
+ The object code form of an Application may incorporate material from
+a header file that is part of the Library. You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+ a) Give prominent notice with each copy of the object code that the
+ Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the object code with a copy of the GNU GPL and this license
+ document.
+
+ 4. Combined Works.
+
+ You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+ a) Give prominent notice with each copy of the Combined Work that
+ the Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the Combined Work with a copy of the GNU GPL and this license
+ document.
+
+ c) For a Combined Work that displays copyright notices during
+ execution, include the copyright notice for the Library among
+ these notices, as well as a reference directing the user to the
+ copies of the GNU GPL and this license document.
+
+ d) Do one of the following:
+
+ 0) Convey the Minimal Corresponding Source under the terms of this
+ License, and the Corresponding Application Code in a form
+ suitable for, and under terms that permit, the user to
+ recombine or relink the Application with a modified version of
+ the Linked Version to produce a modified Combined Work, in the
+ manner specified by section 6 of the GNU GPL for conveying
+ Corresponding Source.
+
+ 1) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (a) uses at run time
+ a copy of the Library already present on the user's computer
+ system, and (b) will operate properly with a modified version
+ of the Library that is interface-compatible with the Linked
+ Version.
+
+ e) Provide Installation Information, but only if you would otherwise
+ be required to provide such information under section 6 of the
+ GNU GPL, and only to the extent that such information is
+ necessary to install and execute a modified version of the
+ Combined Work produced by recombining or relinking the
+ Application with a modified version of the Linked Version. (If
+ you use option 4d0, the Installation Information must accompany
+ the Minimal Corresponding Source and Corresponding Application
+ Code. If you use option 4d1, you must provide the Installation
+ Information in the manner specified by section 6 of the GNU GPL
+ for conveying Corresponding Source.)
+
+ 5. Combined Libraries.
+
+ You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+ a) Accompany the combined library with a copy of the same work based
+ on the Library, uncombined with any other library facilities,
+ conveyed under the terms of this License.
+
+ b) Give prominent notice with the combined library that part of it
+ is a work based on the Library, and explaining where to find the
+ accompanying uncombined form of the same work.
+
+ 6. Revised Versions of the GNU Lesser General Public License.
+
+ The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+ If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library. \ No newline at end of file
diff --git a/ratatoeskr/sys/load_smarty.php b/ratatoeskr/sys/load_smarty.php
new file mode 100644
index 0000000..574f3c9
--- /dev/null
+++ b/ratatoeskr/sys/load_smarty.php
@@ -0,0 +1,28 @@
+<?php
+/*
+ * File: ratatoeskr/sys/load_smarty.php
+ *
+ * Create the global Smarty instance.
+ *
+ * License:
+ * This file is part of Ratatöskr.
+ * Ratatöskr is licensed unter the MIT / X11 License.
+ * See "ratatoeskr/licenses/ratatoeskr" for more information.
+ */
+
+require_once(dirname(__FILE__) . "/../libs/smarty/Smarty.class.php");
+
+if(!isset($smarty))
+{
+ /*
+ * Variable: $smarty
+ * Global smarty instance.
+ */
+ $smarty = new Smarty();
+ $smarty->setTemplateDir(dirname(__FILE__) . "/../templates/");
+ $smarty->setCompileDir(dirname(__FILE__) . "/../tmp/smartytemplates_c");
+ $smarty->setCacheDir(dirname(__FILE__) . "/../tmp/smarty/cache");
+ $smarty->setConfigDir(dirname(__FILE__) . "/../smarty_confdir");
+}
+
+?>
diff --git a/ratatoeskr/tmp/smarty/.gitignore b/ratatoeskr/tmp/smarty/.gitignore
new file mode 100644
index 0000000..ee31da6
--- /dev/null
+++ b/ratatoeskr/tmp/smarty/.gitignore
@@ -0,0 +1,2 @@
+cache
+templates_c
diff --git a/ratatoeskr/tmp/smarty/INFO b/ratatoeskr/tmp/smarty/INFO
new file mode 100644
index 0000000..fe980f1
--- /dev/null
+++ b/ratatoeskr/tmp/smarty/INFO
@@ -0,0 +1,6 @@
+Temp / Cache dir for smarty
+needs two subdirectories: "templates_c" and "cache". The server needs full file
+access (rwx) to both of them. Usually you can do this by set the group to
+"apache" or "nobody" and then `chmod 775`, or if you do not have the rights to
+set the group: `chmod 777`, but this usually not a good idea (because everyone
+can now see this files), so only do this if you can not set the group.