docs/pwg/: Remove never-written filter-factory chapter; I'll add the various base classes to part 4 ("other element t...

Original commit message from CVS:
* docs/pwg/building-filterfactory.xml:
* docs/pwg/pwg.xml:
Remove never-written filter-factory chapter; I'll add the various
base classes to part 4 ("other element types") later on.
This commit is contained in:
Ronald S. Bultje 2005-07-06 12:24:50 +00:00
parent a13be0a71e
commit 80251ed8ed
3 changed files with 7 additions and 26 deletions

View file

@ -1,3 +1,10 @@
2005-07-06 Ronald S. Bultje <rbultje@ronald.bitfreak.net>
* docs/pwg/building-filterfactory.xml:
* docs/pwg/pwg.xml:
Remove never-written filter-factory chapter; I'll add the various
base classes to part 4 ("other element types") later on.
2005-07-06 Ronald S. Bultje <rbultje@ronald.bitfreak.net>
* docs/pwg/advanced-negotiation.xml:

View file

@ -1,24 +0,0 @@
<chapter id="chapter-building-filterfactory">
<title>Creating a Filter with a Filter Factory</title>
<para>
A plan for the future is to create a FilterFactory, to make the process of making a new filter a simple process of specifying a few details, and
writing a small amount of code to perform the actual data processing.
Ideally, a FilterFactory would perform the tasks of boilerplate creation,
code functionality implementation, and filter registration.
</para>
<para>
Unfortunately, this has not yet been implemented. Even when someone
eventually does write a FilterFactory, this element will not be able to
cover all the possibilities available for filter writing. Thus, some
plugins will always need to be manually coded and registered.
</para>
<para>
Here is a rough outline of what is planned: You run the FilterFactory and
give the factory a list of appropriate function pointers and data
structures to define a filter. With a reasonable measure of preprocessor
magic, you just need to provide a name for the filter and definitions of
the functions and data structures desired. Then you call a macro from
within plugin_init() that registers the new filter. All the fluff that
goes into the definition of a filter is thus be hidden from view.
</para>
</chapter>

View file

@ -19,7 +19,6 @@
<!ENTITY BUILDING_PROPS SYSTEM "building-props.xml">
<!ENTITY BUILDING_SIGNALS SYSTEM "building-signals.xml">
<!ENTITY BUILDING_TESTAPP SYSTEM "building-testapp.xml">
<!ENTITY BUILDING_FILTERFACT SYSTEM "building-filterfactory.xml">
<!ENTITY ADVANCED_NEGOTIATION SYSTEM "advanced-negotiation.xml">
<!ENTITY ADVANCED_SCHEDULING SYSTEM "advanced-scheduling.xml">
@ -119,7 +118,6 @@
&BUILDING_PROPS;
&BUILDING_SIGNALS;
&BUILDING_TESTAPP;
&BUILDING_FILTERFACT;
</part>
<!-- ############ part ############# -->