cvs: peardoc /en/package/html html-quickform-advmultiselect.xml

farell		Fri Jan 23 12:44:31 2009 UTC

  Modified files:              
    /peardoc/en/package/html	html-quickform-advmultiselect.xml 
  Log:
  add introduction to reference guide
  
http://cvs.php.net/viewvc.cgi/peardoc/en/package/html/html-quickform-advmultiselect.xml?r1=1.10&r2=1.11&diff_format=u
Index: peardoc/en/package/html/html-quickform-advmultiselect.xml
diff -u peardoc/en/package/html/html-quickform-advmultiselect.xml:1.10 peardoc/en/package/html/html-quickform-advmultiselect.xml:1.11
--- peardoc/en/package/html/html-quickform-advmultiselect.xml:1.10	Thu Jan 22 16:32:38 2009
+++ peardoc/en/package/html/html-quickform-advmultiselect.xml	Fri Jan 23 12:44:31 2009
@@ -105,8 +105,80 @@
  </chapter>
 
  <chapter xml:id="package.html.html-quickform-advmultiselect.ref">
-  <info><title>Reference guide</title></info>
-
+  <info>
+   <title>Reference guide</title>
+   <abstract>
+    <simpara>
+     This reference describes every method in the HTML_QuickForm_advmultiselect class.
+    </simpara>
+    <para>
+     In a two multi-select boxes default shape, there are :
+     <itemizedlist>
+      <listitem>
+       <para>
+        a list with all unselected values (on left side)
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        a list with all selected values (on right side)
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        two buttons (add, remove) to swap items from one list to the other (on middle side)
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        optional headers for each list
+       </para>
+      </listitem>
+     </itemizedlist>
+    </para>
+    <para>
+     In a single multi-select box default shape, there are :
+     <itemizedlist>
+      <listitem>
+       <para>
+        a list with all values (selected: checkbox on, unselected: checkbox off)
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        none buttons
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        optional header for the list
+       </para>
+      </listitem>
+     </itemizedlist>
+     <note>
+      <para>
+       Buttons (up, down) to sort item are unavailable in a single multi-select box shape.
+      </para>
+     </note>
+    </para>
+    <para>
+     In a two multi-select boxes custom shape, you may also have :
+     <itemizedlist>
+      <listitem>
+       <para>
+        two buttons to sort selected item (by user-end)
+       </para>
+      </listitem>
+     </itemizedlist>
+     <important>
+      <para>
+       There are no order between setting button (up, down) attributes and setting placeholders
+       <emphasis role="bold">{moveup}, {movedown}</emphasis> into the template.
+      </para>
+     </important>
+    </para>
+   </abstract>
+  </info>
   &package.html.html-quickform-advmultiselect.html-quickform-advmultiselect.html-quickform-advmultiselect;
   &package.html.html-quickform-advmultiselect.html-quickform-advmultiselect.getelementcss;
   &package.html.html-quickform-advmultiselect.html-quickform-advmultiselect.getelementjs;