[interchange-docs] [SCM] Interchange XML documentation branch, master, updated. 59c5be688dc8afdcbff6883b2726ea965b41a10f

[Stefan Hornburg]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "Interchange XML documentation".

The branch, master has been updated
       via  59c5be688dc8afdcbff6883b2726ea965b41a10f (commit)
       via  2f3e84051cb0c8af74591a0bd53878572d177d67 (commit)
       via  76457f2cba496b2e332e17004540c3b26fe893e7 (commit)
      from  e2ac75ca544894c7a41c2b42974298a1f84fe71c (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 59c5be688dc8afdcbff6883b2726ea965b41a10f
Author: Stefan Hornburg (Racke) <racke at linuxia.de>
Date:   Sun Mar 28 13:30:30 2010 +0200

    added subsection on special form widgets

commit 2f3e84051cb0c8af74591a0bd53878572d177d67
Author: Stefan Hornburg (Racke) <racke at linuxia.de>
Date:   Thu Mar 11 18:53:41 2010 +0100

    sample for form_series added

commit 76457f2cba496b2e332e17004540c3b26fe893e7
Author: Stefan Hornburg (Racke) <racke at linuxia.de>
Date:   Thu Mar 11 18:53:01 2010 +0100

    taxonomy section added with description of categories table

-----------------------------------------------------------------------

Summary of changes and diff:
 guides/wellwell.xml |  104 +++++++++++++++++++++++++++++++++++++++++++++++++--
 1 files changed, 100 insertions(+), 4 deletions(-)

diff --git a/guides/wellwell.xml b/guides/wellwell.xml
index 523067b..92f916f 100644
--- a/guides/wellwell.xml
+++ b/guides/wellwell.xml
@@ -296,6 +296,62 @@ names of the components to skip, or "1" to skip all default components.
 </section>
 
 <section>
+	<title>Taxonomy</title>
+	<para>
+The taxonomy system in WellWell allows products to be
+categorized in various ways, e.g. by genre, producer
+and star for videos. 
+	</para>
+	<para>
+	Categories are kept in the
+	<database>categories</database> table:
+	</para>
+	<informaltable>
+<tgroup cols="2">
+<thead>
+<row>
+<entry>Field</entry>
+<entry>Description</entry>
+<entry>Remarks</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry>code</entry>
+<entry>category identifier</entry>
+<entry>numeric, assigned automatically</entry>
+</row>
+<row>
+<entry>name</entry>
+<entry>category name</entry>
+<entry>used as title in category navigation</entry>
+</row>
+<row>
+<entry>type</entry>
+<entry>category type</entry>
+<entry>e.g. genre, star, tag</entry>
+</row>
+<row>
+<entry>parent</entry>
+<entry>identifier of parent category</entry>
+<entry>0 for top level categories</entry>
+</row>
+<row>
+<entry>priority</entry>
+<entry>category priority for sorting</entry>
+<entry>numeric, highest number comes first</entry>
+</row>
+<row>
+<entry>uri</entry>
+<entry>page to view the category</entry>
+<entry></entry>
+</row>
+</tbody>
+</tgroup>
+	  </informaltable>
+</section>
+
+<section>
 	<title>Users, Roles and Permissions</title>
 	<para>
 	<emphasis role='bold'>Users</emphasis> are stored in the 
@@ -431,6 +487,29 @@ check because they are evaluated earlier, during autoload routine.
 			<database class='field'>position</database>: Position of part (1,2,3,...)
 			</para></listitem>
 		</itemizedlist>
+	    <para>As example we are looking at the checkout form, with the
+			following parts:
+		</para>
+		<itemizedlist>
+			<listitem>Shipping</listitem>
+			<listitem>Payment</listitem>
+			<listitem>Confirmation</listitem>
+			<listitem>Receipt</listitem>
+		</itemizedlist>
+		<para>
+			These are the corresponding entries in <database class='table'>form_series</database>:
+		</para>
+		<screen>
+mysql> select name,part,label,profile,position from form_series where name = 'checkout' order by position;
++----------+--------------+--------------+----------+----------+
+| name     | part         | label        | profile  | position |
++----------+--------------+--------------+----------+----------+
+| checkout | shipping     | Shipping     | shipping |        1 | 
+| checkout | payment      | Payment      |          |        2 | 
+| checkout | confirmation | Confirmation |          |        3 | 
+| checkout | receipt      | Receipt      |          |        4 | 
++----------+--------------+--------------+----------+----------+
+		</screen>
 	</section>
 
 
@@ -507,11 +586,28 @@ The elements of a form (part) are stored in the
 			<database class='field'>widget</database>: Widget to display
 			</para></listitem>
 		</itemizedlist>
+
 		<para>
-The widget is passed by the form_element_field theme function to the
-&tag-display; tag.  One exception to that is the widget named
-"<literal>legend</literal>" just displays the label of the form_element.
-	</para>
+			The widget is passed by the form_element_field theme function to the
+			&tag-display; tag. Exceptions to that are explained below.
+		</para>
+
+		<sect3>
+			<title>Special Form Widgets</title>
+				<para>
+					A form element with the widget named
+					"<literal>legend</literal>" just displays the label of the
+					form_element.
+					This is useful if you want to separate your form into separate
+					visual parts.
+				</para>
+				<para>
+					Form elements with the widget named "<literal>button</literal>"
+					are used to produce submit buttons.
+					This is useful if you want to have multiple buttons in your 
+					form without changing your form template, like Preview or Delete.
+				</para>
+		</sect3>
 	</section>
 
 	<section>


hooks/post-receive
-- 
Interchange XML documentation