[docs] xmldocs - docelic modified 4 files

docs at icdevgroup.org docs at icdevgroup.org
Fri May 20 11:01:03 EDT 2005


User:      docelic
Date:      2005-05-20 15:01:03 GMT
Modified:  refs     TemplateDir
Added:     glossary feature
Added:     refs     Feature FeatureDir
Log:
Maybe I have trouble catching up on old stuff, but nothing's preventing me
from staying alert to current development.
(In other words, documentation from the recently-added "Feature" facility
has been properly integrated to xmldocs).

Revision  Changes    Path
1.1                  xmldocs/glossary/feature


rev 1.1, prev_rev 1.0
Index: feature
===================================================================

With ⁣ 5.3.0, ⁣ supports so-called "features". 
The whole purpose of the new "Feature" facility is to allow easy
installation of new capabilities to ⁣.
</para><para>
&IC; already has the convention of "extensions" which allow you to put together
features to add to Interchange. But the installation is manual, and requires
good docs to make it easily installable for end-users. Also, many features
require access to the global configuration.
There's also another problem at sight, namely that of feature creep, since 
everything was just being added to the "&std-catalog;" catalog.
</para><para>
The basic mechanism is simple:
Inside "feature" modules, there are two special kinds of files, called by
extensions <literal>.global</literal> and <literal>.init</literal>.
(In the included <literal>quickpoll</literal> feature, these are named
<filename>quickpoll.global</filename> and <filename>quickpoll.init</filename>).
</para><para>
If a file has the extension <literal>.global</literal>, it is added to the global
configuration. The included <literal>quickpoll</literal> feature, for example,
adds the <am>quickpoll</am> &glos-ActionMap;, and two usertags:
&tag-poll-answer; and &tag-ascii-graph;.
</para><para>

If a file has the extension <literal>.init</literal>, it is run once &mdash;
the first time
the target catalog is accessed. Again, in the <literal>quickpoll</literal> example, it is used to add
<database>mv_metadata</database> entries and a couple of sample polls.
</para><para>

All other files in the directory are catalog configuration
(<filename>quickpoll.catalog.cfg</filename> for a concrete example).
It could have also been
broken up into say, files <filename>quickpoll.sql</filename> and
<filename>quickpoll_answer.sql</filename>.
</para><para>
All subdirectories contain files which are copied to the
catalog directory with the same relative path. In this
case,
<filename>&ICROOT;/features/quickpoll/templates/components/quickpoll</filename>
would go to 
<filename>&CATROOT;/templates/components/quickpoll</filename>.
</para><para>
The <literal>.init</literal> file, when run, sends its output to
<filename>&conf-ConfDir;/init/<replaceable>FEATURE</replaceable>/<replaceable>FEATURE</replaceable>.init</filename>
(and that would be <filename>etc/init/quickpoll/quickpoll.init</filename> for
the concrete example.)
Once it is run, the existence of the file prevents it being run again.
<!-- TODO: Doesnt it always check for existence of the file on (re)start?
When the server is restarted, the file test is no longer needed, as the 
init procedure has already been done.
 -->
</para><para>
Currently, the uninstallation procedure is missing.



1.2       +1 -1      xmldocs/refs/TemplateDir


rev 1.2, prev_rev 1.1
Index: TemplateDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/TemplateDir,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TemplateDir	21 Feb 2005 01:16:51 -0000	1.1
+++ TemplateDir	20 May 2005 15:01:03 -0000	1.2
@@ -5,7 +5,7 @@
 
 __NAME__ synopsis
 <group choice='req'>
-	<arg choice='plain' rep='repeat'>directory</arg>
+	<arg choice='plain' rep='repeat'><replaceable>directory</replaceable></arg>
 </group>
 __END__
 



1.1                  xmldocs/refs/Feature


rev 1.1, prev_rev 1.0
Index: Feature
===================================================================
__NAME__ purpose
specify Interchange "feature" for activation in the catalog
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain'><replaceable>feature_name</replaceable></arg>
</group>
__END__


__NAME__ description
Specify &IC; "feature" for inclusion in the current &glos-catalog;.
</para><para>
For an introduction to &IC; "features", please see the 
&glos-feature; glossary entry.
__END__

__NAME__ example: Setting FeatureDir
<programlisting>
Feature quickpoll
</programlisting>
__END__

__NAME__ see also
FeatureDir
__END__

__NAME__ author
&mheins;
__END__



1.1                  xmldocs/refs/FeatureDir


rev 1.1, prev_rev 1.0
Index: FeatureDir
===================================================================
__NAME__ purpose
specify "feature" directory
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain'><replaceable>directory</replaceable></arg>
</group>
__END__


__NAME__ description
Specify directory containing &IC; "feature" modules.
</para><para>
For an introduction to &IC; "features", please see the 
&glos-feature; glossary entry.
__END__

__NAME__ example: Setting FeatureDir
<programlisting>
FeatureDir /usr/local/interchange/features
</programlisting>
__END__

__NAME__ author
&mheins;
__END__








More information about the docs mailing list