From 5ba53394fcda4ae9cfa9af52b37fb67517deeb5a Mon Sep 17 00:00:00 2001
From: Christian Weiske
Date: Wed, 25 May 2011 19:43:36 +0200
Subject: implement request #1989987: theme support. merge themes branch with
 --squash

---
 build.xml | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

(limited to 'build.xml')

diff --git a/build.xml b/build.xml
index 9773a63..7b3896b 100644
--- a/build.xml
+++ b/build.xml
@@ -121,18 +121,19 @@
 
      <replacement
       path="src/SemanticScuttle/header.php"
-      type="pear-config"
-      from="@data_dir@" to="data_dir"
+      type="pear-config" from="@data_dir@" to="data_dir"
+      />
+     <replacement
+      path="src/SemanticScuttle/header.php"
+      type="pear-config" from="@www_dir@" to="www_dir"
       />
      <replacement
       path="www/www-header.php"
-      type="pear-config"
-      from="@data_dir@" to="data_dir"
+      type="pear-config" from="@data_dir@" to="data_dir"
       />
      <replacement
       path="tests/prepare.php"
-      type="pear-config"
-      from="@data_dir@" to="data_dir"
+      type="pear-config" from="@data_dir@" to="data_dir"
       />
 
      <changelog version="0.97" date="2010-06-09" license="GPL">
-- 
cgit v1.2.3-54-g00ecf


From 7820014667f04d5d0a9c2f6913b3d3fb261f1b07 Mon Sep 17 00:00:00 2001
From: Christian Weiske
Date: Thu, 26 May 2011 18:03:46 +0200
Subject: task to generate docs from rst files. does not fully work yet

---
 build.xml | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

(limited to 'build.xml')

diff --git a/build.xml b/build.xml
index 7b3896b..cd80c06 100644
--- a/build.xml
+++ b/build.xml
@@ -41,7 +41,6 @@
 
       Test your zip with: unzip -l SemanticScuttle-0.95.0.zip
     -->
-    <mkdir dir="dist" />
     <echo msg="Creating distribution zip for SemanticScuttle ${version}"/>
     <delete file="${distfile}" failonerror="false"/>
     <zip destfile="${distfile}" prefix="${phing.project.name}-${version}/">
@@ -209,6 +208,23 @@
 
 
 
+  <target name="build-docs">
+   <foreach param="fname" absparam="abs-fname" target="build-doc-file">
+     <fileset dir=".">
+      <include name="doc/ChangeLog"/>
+      <include name="doc/**.txt"/>
+      <include name="doc/**.rst"/>
+     </fileset>
+   </foreach>
+  </target>
+
+  <target name="build-doc-file" depends="check">
+   <echo msg="${fname}"/>
+   <exec command="rst2html ${fname} > dist/${fname}.html" checkreturn="1"/>
+  </target>
+
+
+
   <target name="release" depends="check,zip,package,deploy-sf"
    description="Release the version on sourceforge"
    >
@@ -315,6 +331,9 @@
     <fail unless="sfuser" message="Sourceforge username not defined!" />
     <fail unless="sfproject" message="Sourceforge project name not defined!" />
     <fail unless="sffilepath" message="Sourceforge project file path not defined!" />
+
+    <mkdir dir="dist" />
+    <mkdir dir="dist/doc" />
   </target>
 
 </project>
-- 
cgit v1.2.3-54-g00ecf


From 189449c0d73a88ae87569cb9427fcd7dc6142c62 Mon Sep 17 00:00:00 2001
From: Christian Weiske
Date: Thu, 26 May 2011 18:17:26 +0200
Subject: doc building works now

---
 build.xml     | 10 +++++++++-
 doc/index.rst | 12 ++++++------
 2 files changed, 15 insertions(+), 7 deletions(-)

(limited to 'build.xml')

diff --git a/build.xml b/build.xml
index cd80c06..a51bdbb 100644
--- a/build.xml
+++ b/build.xml
@@ -214,13 +214,20 @@
       <include name="doc/ChangeLog"/>
       <include name="doc/**.txt"/>
       <include name="doc/**.rst"/>
+      <include name="doc/**/*.rst"/>
      </fileset>
    </foreach>
   </target>
 
   <target name="build-doc-file" depends="check">
    <echo msg="${fname}"/>
-   <exec command="rst2html ${fname} > dist/${fname}.html" checkreturn="1"/>
+   <php function="preg_replace" returnProperty="outfile">
+    <param value="/^(.+)(.rst|.txt)$/"/>
+    <param value="\1.html"/>
+    <param value="${fname}"/>
+   </php>
+   <!--<echo msg="${fname} - ${outfile}"/>-->
+   <exec command="rst2html ${fname} > dist/${outfile}" checkreturn="1"/>
   </target>
 
 
@@ -334,6 +341,7 @@
 
     <mkdir dir="dist" />
     <mkdir dir="dist/doc" />
+    <mkdir dir="dist/doc/developers" />
   </target>
 
 </project>
diff --git a/doc/index.rst b/doc/index.rst
index fc75aa6..a260642 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -34,10 +34,10 @@ Developer documentation
 - `Running unit testes`__
 - `How to translate SemanticScuttle`__
 
-__ rules.html
-__ api.html
-__ debugging.html
-__ release-new-version.html
-__ running-unit-tests.html
-__ translation.html
+__ developers/rules.html
+__ developers/api.html
+__ developers/debugging.html
+__ developers/release-new-version.html
+__ developers/running-unit-tests.html
+__ developers/translation.html
 
-- 
cgit v1.2.3-54-g00ecf


From b56d604e7eedc1c748e90da4f3a1948b052e20cb Mon Sep 17 00:00:00 2001
From: Christian Weiske
Date: Thu, 26 May 2011 18:19:35 +0200
Subject: let the doc build fail if rst2html finds errors

---
 build.xml | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'build.xml')

diff --git a/build.xml b/build.xml
index a51bdbb..0289c38 100644
--- a/build.xml
+++ b/build.xml
@@ -227,7 +227,10 @@
     <param value="${fname}"/>
    </php>
    <!--<echo msg="${fname} - ${outfile}"/>-->
-   <exec command="rst2html ${fname} > dist/${outfile}" checkreturn="1"/>
+   <exec
+    command="rst2html --exit-status=2 ${fname} > dist/${outfile}"
+    checkreturn="1"
+    />
   </target>
 
 
-- 
cgit v1.2.3-54-g00ecf


From a396759f22ff06689e25d92d4faaaf0835bf8bc8 Mon Sep 17 00:00:00 2001
From: Christian Weiske
Date: Thu, 26 May 2011 21:05:59 +0200
Subject: build doc files only if source files are newer than rendered files

---
 build.xml | 26 +++++++++++++++++++-------
 1 file changed, 19 insertions(+), 7 deletions(-)

(limited to 'build.xml')

diff --git a/build.xml b/build.xml
index 0289c38..f6731fe 100644
--- a/build.xml
+++ b/build.xml
@@ -219,18 +219,30 @@
    </foreach>
   </target>
 
-  <target name="build-doc-file" depends="check">
+
+  <target name="build-doc-file" depends="check"
+   description="Builds a single documentation file. Pass file path as $fname"
+  >
    <echo msg="${fname}"/>
    <php function="preg_replace" returnProperty="outfile">
     <param value="/^(.+)(.rst|.txt)$/"/>
-    <param value="\1.html"/>
+    <param value="dist/\1.html"/>
     <param value="${fname}"/>
    </php>
-   <!--<echo msg="${fname} - ${outfile}"/>-->
-   <exec
-    command="rst2html --exit-status=2 ${fname} > dist/${outfile}"
-    checkreturn="1"
-    />
+
+   <!-- only render file if the doc file is newer than the html file -->
+   <property name="isuptodate" value="false"/>
+   <uptodate property="isuptodate" srcfile="${fname}" targetfile="${outfile}" />
+   <if>
+    <not><istrue value="${isuptodate}"/></not>
+    <then>
+     <exec
+      command="rst2html --exit-status=2 ${fname} ${outfile}"
+      checkreturn="1"
+      />
+    </then>
+   </if>
+
   </target>
 
 
-- 
cgit v1.2.3-54-g00ecf


From bb4b6574bc63e38cb39dffab90985228f1506d90 Mon Sep 17 00:00:00 2001
From: Christian Weiske
Date: Thu, 26 May 2011 21:19:26 +0200
Subject: ignore license file when building docs

---
 build.xml | 1 +
 1 file changed, 1 insertion(+)

(limited to 'build.xml')

diff --git a/build.xml b/build.xml
index f6731fe..dbec0a6 100644
--- a/build.xml
+++ b/build.xml
@@ -215,6 +215,7 @@
       <include name="doc/**.txt"/>
       <include name="doc/**.rst"/>
       <include name="doc/**/*.rst"/>
+      <exclude name="doc/LICENSE.txt"/>
      </fileset>
    </foreach>
   </target>
-- 
cgit v1.2.3-54-g00ecf


From b55b3a6c670c5af99671c2d6c77cbf0d15954728 Mon Sep 17 00:00:00 2001
From: Christian Weiske
Date: Thu, 26 May 2011 21:39:06 +0200
Subject: hint about docutils

---
 build.xml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'build.xml')

diff --git a/build.xml b/build.xml
index dbec0a6..5a2a7fc 100644
--- a/build.xml
+++ b/build.xml
@@ -207,7 +207,8 @@
   </target>
 
 
-
+  <!-- you need to have the python docutils package installed, since
+       we use the rst2html tool -->
   <target name="build-docs">
    <foreach param="fname" absparam="abs-fname" target="build-doc-file">
      <fileset dir=".">
-- 
cgit v1.2.3-54-g00ecf


From 17dcda30e78c13f1ca91c1f031ecd4d6445ef6a7 Mon Sep 17 00:00:00 2001
From: Christian Weiske
Date: Thu, 26 May 2011 21:44:29 +0200
Subject: more documentation rST fixes

---
 build.xml                             |  1 +
 doc/developers/debugging.rst          | 30 +++++++++++++++++-------------
 doc/developers/running-unit-tests.rst | 25 +++++++++++++++----------
 3 files changed, 33 insertions(+), 23 deletions(-)

(limited to 'build.xml')

diff --git a/build.xml b/build.xml
index 5a2a7fc..d0637c7 100644
--- a/build.xml
+++ b/build.xml
@@ -217,6 +217,7 @@
       <include name="doc/**.rst"/>
       <include name="doc/**/*.rst"/>
       <exclude name="doc/LICENSE.txt"/>
+      <exclude name="doc/developers/TODO.rst"/>
      </fileset>
    </foreach>
   </target>
diff --git a/doc/developers/debugging.rst b/doc/developers/debugging.rst
index 7f84da6..6bee309 100644
--- a/doc/developers/debugging.rst
+++ b/doc/developers/debugging.rst
@@ -4,17 +4,21 @@ How to debug SemanticScuttle
 
 Database queries
 ----------------
-In config.php, enable debugMode.
-Further, add the following there:
--------
-register_shutdown_function(
-    create_function('', <<<FNC
-\$GLOBALS['db'] = SemanticScuttle_Service_Factory::getDb();
-\$GLOBALS['db']->sql_report('display');
-FNC
-    )
-);
-------
-To see database queries in SemanticScuttle, add
-> ?explain=1
+
+In ``data/config.php``, enable ``debugMode``.
+Further, add the following afterwards: ::
+
+  register_shutdown_function(
+      create_function('', <<<FNC
+  \$GLOBALS['db'] = SemanticScuttle_Service_Factory::getDb();
+  \$GLOBALS['db']->sql_report('display');
+  FNC
+      )
+  );
+
+
+To see database queries in SemanticScuttle, add ::
+
+  ?explain=1
+
 to your URL.
diff --git a/doc/developers/running-unit-tests.rst b/doc/developers/running-unit-tests.rst
index 556055f..8b0fa0d 100644
--- a/doc/developers/running-unit-tests.rst
+++ b/doc/developers/running-unit-tests.rst
@@ -1,21 +1,26 @@
 Running unit tests
 ==================
 
-Go to the SemanticScuttle main directory and run
- $ php tests/AllTests.php
-or
- $ phpunit tests/AllTests.php
-also remember the --verbose parameter to PHPUnit.
+Go to the SemanticScuttle ``tests`` directory and run ``phpunit``::
 
-If you want to run a specific test class only:
- $ phpunit tests/BookmarksTest.php
+  $ cd tests
+  $ phpunit .
 
-If you need to test one method only:
+also remember the ``--verbose`` parameter to PHPUnit.
+
+If you want to run a specific test class only: ::
+
+ $ cd tests
+ $ phpunit BookmarksTest.php
+
+If you need to test one method only: ::
+
+ $ cd tests
  $ phpunit --filter BookmarkTest::testUnificationOfBookmarks tests/BookmarkTest.php
 
 
 Caveats
 -------
-Having debugging enabled and database driver "mysql4" activated
-will lead to failing tests because of FOUND_ROWS() usage, which
+Having debugging enabled and database driver "``mysql4``" activated
+will lead to failing tests because of ``FOUND_ROWS()`` usage, which
 does not work nicely with database debugging.
-- 
cgit v1.2.3-54-g00ecf