Menu
▾
▴
[axdocs] CVS: axkit-docs config-quickref.dkb,1.2,1.3
|
From: Robin B. <da...@us...> - 2002-02-05 19:25:31
|
Update of /cvsroot/axkit-docs/axkit-docs
In directory usw-pr-cvs1:/tmp/cvs-serv13038
Modified Files:
config-quickref.dkb
Log Message:
filled in most of the holes. There are prolly mistakes and there are still a few omissions though
Index: config-quickref.dkb
===================================================================
RCS file: /cvsroot/axkit-docs/axkit-docs/config-quickref.dkb,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- config-quickref.dkb 2002/02/05 17:48:16 1.2
+++ config-quickref.dkb 2002/02/05 19:25:04 1.3
@@ -153,81 +153,191 @@
<section label='AxAddRootProcessor'>
<title>AxAddRootProcessor</title>
- <para>TAKE3</para>
<para>
- a mime type, a stylesheet, and a root element
+ <emphasis>Syntax:</emphasis>
+ AxAddRootProcessor
+ <literal>mime/type</literal>
+ <filename>processor-stylesheet</filename>
+ <literal>root-element</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 root element
+ that matches the given <literal>root-element</literal>.
+ </para>
+
+ <para>
+ Note that <literal>root-element</literal> is expressed in JClark notation,
+ that is if your element has a namespace it is written {ns}lname.
+ </para>
</section>
<section label='AxAddURIProcessor'>
<title>AxAddURIProcessor</title>
- <para>TAKE3</para>
<para>
- a mime type, a stylesheet, and a Perl regexp to match the URI
+ <emphasis>Syntax:</emphasis>
+ AxAddURIProcessor
+ <literal>mime/type</literal>
+ <filename>processor-stylesheet</filename>
+ <literal>regexp</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 URI
+ that matches the given <literal>regexp</literal>.
</para>
</section>
<section label='AxResetProcessors'>
<title>AxResetProcessors</title>
- <para>NO_ARGS</para>
<para>
- reset the list of processors
+ <emphasis>Syntax:</emphasis>
+ AxResetProcessors
</para>
+
+ <para>
+ <emphasis>Version:</emphasis>
+ ???
+ </para>
+
+ <para>
+ Removes all previously configured processors in the pipeline.
+ </para>
</section>
</section>
+
+
+
+
+
+
+
<section label='plugins'>
<title>Plugin Directives</title>
<section label='AxAddPlugin'>
<title>AxAddPlugin</title>
- <para>TAKE_ONE</para>
<para>
- Add a plugin
+ <emphasis>Syntax:</emphasis>
+ AxAddPlugin <literal>Perl::Package</literal>
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis> 1.5
+ </para>
+
+ <para>
+ Will add a Plugin to the list of plugins that will be run before the
+ processing beings. A plugin may modify all sorts of request parametres and
+ notes in order to influence the behaviour of the processor.
+ </para>
+
+ <para>
+ The <literal>handler()</literal> in the given <literal>Perl::Package</literal>
+ will be called with $r, as if it were a normal modperl handler (except that it
+ is not expected to do anything fancy there, or to return something).
</para>
</section>
<section label='AxResetPlugins'>
<title>AxResetPlugins</title>
- <para>TAKE1</para>
<para>
- remove all plugins
+ <emphasis>Syntax:</emphasis>
+ AxResetPlugins
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis> 1.5
+ </para>
+
+ <para>
+ Removes all previously configured plugins.
</para>
</section>
</section>
+
+
+
+
+
+
+
<section label='media'>
<title>Media Directives</title>
<section label='AxMediaType'>
<title><AxMediaType></title>
- <para>RAW_ARGS</para>
<para>
- Media type block
+ <emphasis>Syntax:</emphasis>
+ ???
</para>
+
+ <para>
+ <emphasis>Version:</emphasis>
+ ???
+ </para>
+
+ <para>
+ ???
+ </para>
</section>
<section label='AxMedia'>
<title>AxMedia</title>
- <para>TAKE1</para>
<para>
- a default media to use other than screen
+ <emphasis>Syntax:</emphasis>
+ ???
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis>
+ ???
</para>
+
+ <para>
+ ???
+ </para>
</section>
</section>
+
+
+
+
+
+
<section label='style'>
<title>Style Directives</title>
@@ -235,87 +345,183 @@
<section label='AxStyleName'>
<title><AxStyleName></title>
- <para>RAW_ARGS</para>
<para>
- Style name block
+ <emphasis>Syntax:</emphasis>
+ ???
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis>
+ ???
+ </para>
+
+ <para>
+ ???
</para>
</section>
<section label='AxAddStyleMap'>
<title>AxAddStyleMap</title>
- <para>TAKE2</para>
<para>
- a mime type and a module name to use
+ <emphasis>Syntax:</emphasis>
+ AxAddStyleMap <literal>mime/type</literal> <literal>Perl::Module</literal>
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis>
+ ???
+ </para>
+
+ <para>
+ Adds a type to the StyleMap, to be used by Processors so that they
+ know which module you use. The benefit of this is that you only define
+ that mapping once. For instance, if you were processing XSLT with
+ Apache::AxKit::Language::FooXSLT and you suddenly want to change to using
+ Apache::AxKit::Language::BarXSLT, all you'll have to do to switch is to
+ change the AxAddStyleMap mapping for text/xsl from the former to the
+ latter, and all Processors using text/xsl will switch automatically.
</para>
</section>
<section label='AxResetStyleMap'>
<title>AxResetStyleMap</title>
- <para>NO_ARGS</para>
<para>
- reset the styles
+ <emphasis>Syntax:</emphasis>
+ AxResetStyleMap
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis> ???
</para>
+
+ <para>
+ Removes all previously configured StyleMaps.
+ </para>
</section>
<section label='AxStyleProvider'>
<title>AxStyleProvider</title>
- <para>TAKE1</para>
<para>
- alternative module to use for reading the stylesheet
+ <emphasis>Syntax:</emphasis>
+ AxStyleProvider <literal>Perl::Module</literal>
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis> ???
</para>
+
+ <para>
+ ??? (alternative module to use for reading the stylesheet)
+ [I thought Matt said this was given up on]
+ </para>
</section>
<section label='AxStyle'>
<title>AxStyle</title>
- <para>TAKE1</para>
<para>
- a default stylesheet (title) to use
+ <emphasis>Syntax:</emphasis>
+ ???
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis>
+ ???
</para>
+
+ <para>
+ ???
+ </para>
</section>
</section>
+
+
+
+
+
+
+
<section label='cache'>
<title>Cache Directives</title>
<section label='AxCacheDir'>
<title>AxCacheDir</title>
- <para>TAKE1</para>
<para>
- directory to store cache files
+ <emphasis>Syntax:</emphasis>
+ AxCacheDir <filename>cache-dir</filename>
</para>
+
+ <para>
+ <emphasis>Version:</emphasis> ???
+ </para>
+
+ <para>
+ Specifies the directory in which the cache is maintained, as
+ opposed to using .axcache in the current directory. It is recommended
+ that this be set to a non web-accessible directory.
+ </para>
</section>
<section label='AxCacheModule'>
<title>AxCacheModule</title>
- <para>TAKE1</para>
<para>
- alternative cache module
+ <emphasis>Syntax:</emphasis>
+ AxCacheModule <literal>Perl::Module</literal>
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis> ???
+ </para>
+
+ <para>
+ Specifies an alternative module to use in order to implement caching.
+ That module must implement the same API as is found in
+ <literal>Apache::AxKit::Cache</literal>, and probably ought to subclass
+ it to avoid future breakage should that API evolve.
</para>
</section>
<section label='AxNoCache'>
<title>AxNoCache</title>
- <para>FLAG</para>
<para>
- On or Off [default] to not cache results
+ <emphasis>Syntax:</emphasis>
+ AxNoCache <literal>On | Off</literal>
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis> ???
+ </para>
+
+ <para>
+ Whether results should be cached (default) or not.
</para>
</section>
<section label='AxDependencyChecks'>
<title>AxDependencyChecks</title>
- <para>FLAG</para>
<para>
- On [default] or Off to disable dependency checking
+ <emphasis>Syntax:</emphasis>
+ AxDependencyChecks <literal>On | Off</literal>
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis> 1.5
+ </para>
+
+ <para>
+ Whether dependencies (eg external entities) should be
+ checked (default) or not. Turning this off can be a major
+ performance boost if you know what you're doing.
</para>
</section>
</section>
@@ -329,120 +535,251 @@
<section label='AxAddOutputTransformer'>
<title>AxAddOutputTransformer</title>
- <para>TAKE1</para>
<para>
- An output transformer function, qualified with package name.
+ <emphasis>Syntax:</emphasis>
+ AxAddOutputTransformer <literal>Perl::sub</literal>
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis> ???
+ </para>
+
+ <para>
+ Adds an OutputTransformer subroutine. That subroutine will receive
+ the content to modify in @_ and must modify it in place. It is run
+ right after cache which makes it the ideal place to perform small
+ per request modifications while still benefitting from the caching
+ of the other operations.
</para>
</section>
<section label='AxResetOutputTransformers'>
<title>AxResetOutputTransformers</title>
- <para>NO_ARGS</para>
<para>
- Reset list of output transformers.
+ <emphasis>Syntax:</emphasis>
+ AxResetOutputTransformers
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis> ???
+ </para>
+
+ <para>
+ Removes all previously configured OutputTransformers.
</para>
</section>
<section label='AxOutputCharset'>
<title>AxOutputCharset</title>
- <para>TAKE1</para>
<para>
- character set used by iconv
+ <emphasis>Syntax:</emphasis>
+ AxOutputCharset <literal>charset</literal>
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis> ???
+ </para>
+
+ <para>
+ Requests that the output be translated to the given
+ <literal>charset</literal> before it is sent.
</para>
</section>
<section label='AxGzipOutput'>
<title>AxGzipOutput</title>
- <para>FLAG</para>
<para>
- On or Off [default] to gzip the output
+ <emphasis>Syntax:</emphasis>
+ AxGzipOutput <literal>On | Off</literal>
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis> ???
+ </para>
+
+ <para>
+ Whether the output should be gzipped or not (default).
</para>
</section>
<section label='AxTranslateOutput'>
<title>AxTranslateOutput</title>
- <para>FLAG</para>
<para>
- On or Off [default] to automatically change character set on output
+ <emphasis>Syntax:</emphasis>
+ AxTranslateOutput <literal>On | Off</literal>
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis> ???
</para>
+
+ <para>
+ Whether the output should have automatic charset conversion on
+ or not (default). [and that kicks in when???]
+ </para>
</section>
</section>
+
+
+
+
+
+
+
+
<section label='logging'>
<title>Logging Directives</title>
<section label='AxDebugLevel'>
<title>AxDebugLevel</title>
- <para>TAKE1</para>
<para>
- debug level (0 == none, higher numbers == more debugging)
+ <emphasis>Syntax:</emphasis>
+ AxDebugLevel <literal>level</literal>
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis> ???
</para>
+
+ <para>
+ Sets the debugging level. 0 is no debugging and higher numbers mean
+ more of it. The max should normally be 10.
+ </para>
</section>
<section label='AxLogDeclines'>
<title>AxLogDeclines</title>
- <para>FLAG</para>
<para>
- On or Off [default] to log why AxKit declined to process the resource
+ <emphasis>Syntax:</emphasis>
+ AxLogDeclines <literal>On | Off</literal>
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis> ???
</para>
+
+ <para>
+ Whether the requests that AxKit declines to handle should be
+ logged or not or not (default).
+ </para>
</section>
<section label='AxStackTrace'>
<title>AxStackTrace</title>
- <para>FLAG</para>
<para>
- On or Off [default] to maintain a stack trace with exceptions
+ <emphasis>Syntax:</emphasis>
+ AxStackTrace <literal>On | Off</literal>
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis> ???
+ </para>
+
+ <para>
+ Whether the a stack trace of AxKit exceptions should be maintained
+ or not (default).
</para>
</section>
</section>
+
+
+
+
+
+
+
<section label='misc'>
<title>Miscellaneous Directives</title>
<section label='AxConfigReader'>
<title>AxConfigReader</title>
- <para>TAKE1</para>
<para>
- alternative module to use for reading configuration
+ <emphasis>Syntax:</emphasis>
+ AxConfigReader <literal>Perl::Module</literal>
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis> ???
+ </para>
+
+ <para>
+ Specifies an alternative module to use in order to implement configuration.
+ That module must implement the same API as is found in
+ <literal>Apache::AxKit::ConfigReader</literal>, and probably ought to subclass
+ it to avoid future breakage should that API evolve.
</para>
</section>
<section label='AxProvider'>
<title>AxProvider</title>
- <para>TAKE1</para>
<para>
- alternative module to use for reading the xml
+ <emphasis>Syntax:</emphasis>
+ AxProvider <literal>Perl::Module</literal>
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis> ???
+ </para>
+
+ <para>
+ Specifies an alternative module to use in order to implement providing of
+ files to AxKit.
+ That module must implement the same API as is found in
+ <literal>Apache::AxKit::Provider</literal>, and probably ought to subclass
+ it to avoid future breakage should that API evolve.
</para>
</section>
<section label='AxErrorStylesheet'>
<title>AxErrorStylesheet</title>
- <para>TAKE2</para>
<para>
- mime type and Error Stylesheet to use for displaying errors
+ <emphasis>Syntax:</emphasis>
+ AxErrorStylesheet <literal>mime/type</literal> <filename>stylesheet</filename>
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis> ???
+ </para>
+
+ <para>
+ Defines the stylesheet to use for error documents when errors occur. It's
+ syntax is comparable to that of <xref linkend='AxAddProcessor'>AxAddProcessor</xref>.
+ [and supposedly the document it gets to transform is described somewhere???]
</para>
</section>
<section label='AxAddXSPTaglib'>
<title>AxAddXSPTaglib</title>
- <para>TAKE1</para>
<para>
- module that provides a taglib functionality
+ <emphasis>Syntax:</emphasis>
+ AxAddXSPTaglib <literal>Perl::Module</literal>
+ </para>
+
+ <para>
+ <emphasis>Version:</emphasis> ???
+ </para>
+
+ <para>
+ Adds an XSP handling module. This is required in order to use taglibs as
+ it gives them a chance to register their namespaces with the XSP dispatcher.
+ Without this, taglib code in XSP will not function properly.
</para>
</section>
</section>
|
