start project's internal notes documentation

Added a 'notes/' project folder. Described the new folder both in a readme.txt
file contained in that folder and in the project's central HACKING.rst
documentation. The folder and its *.rst/*.txt content is included in the
project's source distribution, but is not included in project builds &
installations.

Updated project release notes.
Updated todo list.

HACKING.rst

@@ -158,6 +158,9 @@ External documentation:
   * Part 1: Structures - http://www.w3.org/TR/xmlschema-1
   * Part 2: Datatypes - http://www.w3.org/TR/xmlschema-2
 
+For additional design, research & development project notes see the project's
+``notes/`` folder.
+
 
 TOP-LEVEL FILES & FOLDERS
 =================================================
@@ -174,6 +177,10 @@ TOP-LEVEL FILES & FOLDERS
 
 * Folders created during project setup procedure (build/install).
 
+| notes/
+
+* Internal project design, research & development notes.
+
 | suds/
 
 * Basic project source code.

MANIFEST.in

@@ -5,6 +5,8 @@
 # tried out did not work correctly with Python 3.
 
 # Top level project files.
+include notes/*.rst
+include notes/*.txt
 include ez_setup.py
 include HACKING.rst
 include LICENSE.txt

README.rst

@@ -156,6 +156,9 @@ version 0.6 (development)
 
   * ``HACKING.txt`` updated, converted to .rst format & renamed to
     ``HACKING.rst``.
+  * Started internal project design, research & development notes documentation.
+    Stored in a new ``notes/`` subfolder, included in the project's source
+    distribution, but not its builds or installations.
 
 * Internal test suite improvements.
 

TODO.txt

@@ -755,10 +755,19 @@ PRIORETIZED:
 (+)     * Commit.
 (+)     * Push changes to BitBucket.
 
-(22.01.2014.)
+(23.01.2014.)
 
-    * (Jurko) Process research & todo notes collected while working on reporting
-      extra parameter errors.
+(+) * (Jurko) Prepare internal documentation notes folder.
+(+)     * Add folder & add a descriptive readme.txt file to it.
+(+)     * Include in the source distribution folder.
+(+)     * Do not include it in the installation.
+(+)     * Note the new documentation notes folder in the project's HACKING.rst
+(+)       documentation.
+
+    * (Jurko) Process Jurko's research & todo notes collected while working on
+      reporting extra parameter errors.
+
+(24.01.2014.)
 
     * (Jurko) Process decimal type support patch sent in by pendletongp on
       BitBucket.
@@ -871,10 +880,13 @@ NON PRIORETIZED:
         * Research.
             * HTML.
             * PDF.
-        * Decide how to generate & distribute this documentation.
+        * Decide how to maintain, generate & distribute this documentation.
         * Update project HACKING notes to note the external software required
           for generating the documentation.
         * Update release procedure to include releasing the documentation.
+        * Once the official project documentation has been integrated into this
+          fork, go through existing internal project notes in our fork and see
+          how to integrate them into the official project documentation.
 
     * Research.
         * Test how optional elements under a choice work.

notes/readme.txt

@@ -0,0 +1,9 @@
+This documentation has been started because we needed some place to put our
+design, research & development related notes collected collected while hacking
+on this project. The official suds project documentation has not been included
+in this fork, as it was not stored in the same repository as the original
+project's code base.
+
+Once official suds project documentation has been integrated into this fork,
+parts of this documentation that start getting some well rounded form, should be
+integrated into the official project documentation.