[kupu-checkins] r38492 - in kupu/trunk/kupu/doc: . reference

[yuppie at codespeak.net]

Author: yuppie
Date: Sun Feb 11 18:38:03 2007
New Revision: 38492

Modified:
   kupu/trunk/kupu/doc/CUSTOMIZING.txt
   kupu/trunk/kupu/doc/EXTENDING.txt
   kupu/trunk/kupu/doc/reference/kupuconfig.txt
Log:
- improved kupuconfig reference

Modified: kupu/trunk/kupu/doc/CUSTOMIZING.txt
==============================================================================
--- kupu/trunk/kupu/doc/CUSTOMIZING.txt	(original)
+++ kupu/trunk/kupu/doc/CUSTOMIZING.txt	Sun Feb 11 18:38:03 2007
@@ -51,7 +51,6 @@
 ===================== ================================================
 Directive             Possible values
 ===================== ================================================
-src                   the source URL of the document
 dst                   the URL to PUT to (not used for POST setups)
 use_css               whether Kupu should try to (it will succeed in
                       Mozilla use CSS for bold, italic etc. rather

Modified: kupu/trunk/kupu/doc/EXTENDING.txt
==============================================================================
--- kupu/trunk/kupu/doc/EXTENDING.txt	(original)
+++ kupu/trunk/kupu/doc/EXTENDING.txt	Sun Feb 11 18:38:03 2007
@@ -277,7 +277,7 @@
 `width` attribute for the `th` and `td` tags only. ::
 
         <htmlfilter>
-                <t>center></t><t>font</t>
+                <t>center</t><t>font</t>
                 <a>cellspacing</a>
                 <c><t>th</t><t>td</t><a>width</a></c>
         </htmlfilter>

Modified: kupu/trunk/kupu/doc/reference/kupuconfig.txt
==============================================================================
--- kupu/trunk/kupu/doc/reference/kupuconfig.txt	(original)
+++ kupu/trunk/kupu/doc/reference/kupuconfig.txt	Sun Feb 11 18:38:03 2007
@@ -3,62 +3,116 @@
 currently somewhat incomplete and could do with the attentions of an
 experienced Kupu developer ;)
 
-<src>http://www.example.com/mysource.html</src>
-
-  ??
-
 <dst>http://www.example.com/mysource.html</dst>
 
+  Value:    URI
+  Required: yes (for non-form mode), not used in form mode
+
   This is the URL to which the contents of the editing <iframe> will
   be sent by html POST when the save button is clicked in the editor.
 
 <use_css>1</use_css>
 
-  ??
+  Value:    boolean ('0' or '1')
+  Required: no, false by default
+
+  If true, 'style' attributes are used for text alignment and list styles.
 
 <reload_after_save>0</reload_after_save>
-  
-  ??
+
+  Value:    boolean ('0' or '1')
+  Required: no, false by default
+
+  If true, the document is reloaded after saving.
 
 <strict_output>1</strict_output>
- 
-  ??
+
+  Value:    boolean ('0' or '1')
+  Required: no, false by default, not used in form mode
+
+  If true, XHTML 1.0 Strict declarations are added before saving the document.
 
 <content_type>text/html</content_type>
 
-  ??
+  Value:    HTTP content type
+  Required: no, none by default, not used in form mode
+
+  Content type used for saving the document.
 
 <compatible_singletons>1</compatible_singletons>
-  
-  ??
+
+  Value:    boolean ('0' or '1')
+  Required: no, false by default
+
+  If true, singletons are made XHTML compatible.
 
 <image_xsl_uri>http://www.example.com/kupu/kupudrawers/drawer.xsl</image_xsl_uri>
 
+  Value:    URI
+  Required: yes (for image drawer)
+
   ??
-              
+
 <link_xsl_uri>http://www.example.com/kupu/kupudrawers/drawer.xsl</link_xsl_uri>
 
+  Value:    URI
+  Required: yes (for link drawer)
+
   ??
-              
+
 <image_libraries_uri>http://www.example.com/kupu/kupudrawers/imagelibrary.xml</image_libraries_uri>
 
+  Value:    URI
+  Required: yes (for image drawer)
+
   ??
-              
+
 <link_libraries_uri>http://www.example.com/kupu/kupudrawers/linklibrary.xml</link_libraries_uri>
 
+  Value:    URI
+  Required: yes (for link drawer)
+
   ??
-              
-<search_images_uri> </search_images_uri>
+
+<search_images_uri>...</search_images_uri>
+
+  Value:    URI
+  Required: yes (for search field of image drawer)
 
   ??
-              
-<search_links_uri> </search_links_uri>
+
+<search_links_uri>...</search_links_uri>
+
+  Value:    URI
+  Required: yes (for search field of link drawer)
 
   ??
-              
+
 <cleanup_expressions>...</cleanup_expressions>
 
+  Value:    various sub-elements
+  Required: yes (for cleanup tool)
+
   This contains the expressions used by the cleanup tool. Their format
   should be documented in kupucleanupexpressions.js.
 
-?? - there may be more ;-)
\ No newline at end of file
+<table_classes>...</table_classes>
+
+  Value:   <class> sub-elements
+  Required: yes (for table tool)
+
+  Sets list of selectable table classes.
+
+<filtersourceedit>1</filtersourceedit>
+
+  Value:    boolean ('0' or '1')
+  Required: no, false by default
+
+  If true, content filters are applied before switching to source mode.
+
+<htmlfilter>...</htmlfilter>
+
+  Value:    various sub-elements
+  Required: no, uncustomized by default
+
+  Customizes XHTML cleanup and validation.