[axdocs] CVS: axkit-docs config-quickref.dkb,1.1,1.2

[Robin B. <da...@us...>]

Update of /cvsroot/axkit-docs/axkit-docs
In directory usw-pr-cvs1:/tmp/cvs-serv18542

Modified Files:
	config-quickref.dkb 
Log Message:
in the process of filling it out

Index: config-quickref.dkb
===================================================================
RCS file: /cvsroot/axkit-docs/axkit-docs/config-quickref.dkb,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- config-quickref.dkb	2001/11/09 20:41:37	1.1
+++ config-quickref.dkb	2002/02/05 17:48:16	1.2
@@ -48,42 +48,105 @@
       </abstract>
     </articleinfo>
 
+
     <section label='processor'>
       <title>Processor Directives</title>
 
       <section label='AxAddProcessor'>
         <title>AxAddProcessor</title>
 
-        <para>TAKE2</para>
         <para>
-          a mime type and a stylesheet to use
+         <emphasis>Syntax:</emphasis>
+         AxAddProcessor <literal>mime/type</literal> <filename>processor-stylesheet</filename>
+        </para>
+
+        <para>
+         <emphasis>Version:</emphasis>
+         ???
+        </para>
+
+        <para>
+          Adds a step to the processing pipeline which will feed the
+          <filename>processor-stylesheet</filename> file to the processor
+          mapped to handle that <literal>mime/type</literal> by an
+          <xref linkend='AxAddStyleMap'>AddStyleMap</xref> directive and use
+          that to process the requested file.
         </para>
       </section>
 
+
       <section label='AxAddDocTypeProcessor'>
         <title>AxAddDocTypeProcessor</title>
 
-        <para>TAKE3</para>
         <para>
-          a mime type, a stylesheet, and an XML public identifier
+         <emphasis>Syntax:</emphasis>
+         AxAddDocTypeProcessor
+            <literal>mime/type</literal>
+            <filename>processor-stylesheet</filename>
+            <literal>PUBLIC_ID</literal>
         </para>
+
+        <para>
+         <emphasis>Version:</emphasis>
+         ???
+        </para>
+
+        <para>
+          Adds a step to the processing pipeline which will feed the
+          <filename>processor-stylesheet</filename> file to the processor
+          mapped to handle that <literal>mime/type</literal> by an
+          <xref linkend='AxAddStyleMap'>AddStyleMap</xref> directive and use
+          that to process the requested file if it happens to have a DOCTYPE
+          pointing to the specified <literal>PUBLIC_ID</literal>.
+        </para>
       </section>
 
       <section label='AxAddDTDProcessor'>
         <title>AxAddDTDProcessor</title>
 
-        <para>TAKE3</para>
         <para>
-          a mime type, a stylesheet, and a dtd filename
+         <emphasis>Syntax:</emphasis>
+         AxAddDTDProcessor
+            <literal>mime/type</literal>
+            <filename>processor-stylesheet</filename>
+            <literal>SYSTEM_ID</literal>
+        </para>
+
+        <para>
+         <emphasis>Version:</emphasis>
+         ???
         </para>
+
+        <para>
+          Adds a step to the processing pipeline which will feed the
+          <filename>processor-stylesheet</filename> file to the processor
+          mapped to handle that <literal>mime/type</literal> by an
+          <xref linkend='AxAddStyleMap'>AddStyleMap</xref> directive and use
+          that to process the requested file if it happens to have a DOCTYPE
+          pointing to the specified <literal>SYSTEM_ID</literal>.
+        </para>
       </section>
 
       <section label='AxAddDynamicProcessor'>
         <title>AxAddDynamicProcessor</title>
 
-        <para>TAKE1</para>
         <para>
-          a package name
+         <emphasis>Syntax:</emphasis>
+         AxAddDynamicProcessor <literal>Perl::Package</literal>
+        </para>
+
+        <para>
+         <emphasis>Version:</emphasis> 1.5
+        </para>
+
+        <para>
+          Will call the <literal>handler()</literal> in the given <literal>Perl::Package</literal>
+          before processing takes place. The <literal>handler()</literal> must set up the list of
+          processors to be used, manipulating them with the <literal>AxKit::reset_stylesheets()</literal>
+          (which empties the processor list), <literal>AxKit::insert_next_stylesheet($type,$path)</literal>
+          which adds a stylesheet to the front of the list, and
+          <literal>AxKit::insert_next_stylesheet($type,$path)</literal> which adds a stylesheet to
+          the end of the list.
         </para>
       </section>
 
@@ -106,7 +169,7 @@
       </section>
 
       <section label='AxResetProcessors'>
-        <title>AxAddProcessor</title>
+        <title>AxResetProcessors</title>
 
         <para>NO_ARGS</para>
         <para>
@@ -114,6 +177,29 @@
         </para>
       </section>
 
+    </section>
+
+
+    <section label='plugins'>
+      <title>Plugin Directives</title>
+
+      <section label='AxAddPlugin'>
+        <title>AxAddPlugin</title>
+
+        <para>TAKE_ONE</para>
+        <para>
+          Add a plugin
+        </para>
+      </section>
+
+      <section label='AxResetPlugins'>
+        <title>AxResetPlugins</title>
+
+        <para>TAKE1</para>
+        <para>
+          remove all plugins
+        </para>
+      </section>
     </section>