Is the documentation of the pipeline processor missed?

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

Is the documentation of the pipeline processor missed?

Peter.Heintz
The only part of the documentation  (at least I found)  saying something about the  oxf:pipeline  processor was in the XPL 1.0 W3C Submission.  Is this processor in the documentation missed?

-Peter






--
You receive this message as a subscriber of the [hidden email] mailing list.
To unsubscribe: mailto:[hidden email]
For general help: mailto:[hidden email]?subject=help
ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
Reply | Threaded
Open this post in threaded view
|

RE: Is the documentation of the pipeline processor missed?

Stephen Bayliss
I think it is missing.  Find below some notes I made about it:
Note that I could only get it working using two inputs to the called pipeline: config and data; haven't investigated if that was something I was doing wrong or is actually the case.

The oxf:pipeline processor
--------------------------

This processor is mentioned, but not documented, on the Orbeon web site. It is included in the W3C XPL submission.

It allows xpl pipelines to call pipelines defined in other xpl documents; for example to encapsulate a standard piece of functionallity or a utility pipeline.

The caller xpl pipeline
-----------------------

The "calling" document uses the oxf:pipeline processor to execute the called xpl, using the following syntax

<p:processor name="oxf:pipeline">
        <p:input name="config" href="/my-library/example.xpl" /> *1
        <p:input name="some-data"> *2
                <example-data>
                        <item>Søren Kierkegaard</item>
                </example-data>
        </p:input>
        <p:input name="some-more-data" href="#op1"/> *3
        <p:output name="results" id="the-output"/> *4
</p:processor>

*1: the config input specifies the xpl document where the pipeline is defined
*2: example input with inline xml containing data. Input name must match the <p:param ... /> name used in the pipeline being called.
*3: example supplying input from another processor in this document
*4: consuming the output of the pipeline; called pipeline must match "results", local name is "the-output"

Examples using more than one data input haven't so far worked, so it's assumed that the called pipeline can only have a config and a single data input.

Example callee xpl pipeline
---------------------------

Based on the calling xpl pipeline document above, the outline of the callee document (without any processes defined) would be as follows:

<p:config xmlns:p="http://www.orbeon.com/oxf/pipeline"
          xmlns:oxf="http://www.orbeon.com/oxf/processors">

<p:param name="some-data" type="input"/> <p:param name="some-more-data" type="input"/> <p:param name="results" type="output"/> ... <!-- define processors here --> ... </p:config>

Note that pipelines used as page models and views use certain input and output names such as instance and data; so if it is intended to plug the callee pipeline directly into the PFC, in page-flow.xml, then these names must be used.

-----Original Message-----
From: [hidden email] [mailto:[hidden email]]
Sent: 20 September 2005 15:15
To: [hidden email]
Subject: [ops-users] Is the documentation of the pipeline processor missed?

The only part of the documentation  (at least I found)  saying something about the  oxf:pipeline  processor was in the XPL 1.0 W3C Submission.  Is this processor in the documentation missed?

-Peter








--
You receive this message as a subscriber of the [hidden email] mailing list.
To unsubscribe: mailto:[hidden email]
For general help: mailto:[hidden email]?subject=help
ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
Reply | Threaded
Open this post in threaded view
|

Re: Is the documentation of the pipeline processor missed?

Erik Bruchez
Administrator
In reply to this post by Peter.Heintz
[hidden email] wrote:

 > The only part of the documentation (at least I found) saying
 > something about the oxf:pipeline processor was in the XPL 1.0 W3C
 > Submission.  Is this processor in the documentation missed?

Yes, it was missing. This is now fixed: I added a new documentation
page on this topic. Now in CVS.

Thanks to you and Steve for the heads up.

-Erik




--
You receive this message as a subscriber of the [hidden email] mailing list.
To unsubscribe: mailto:[hidden email]
For general help: mailto:[hidden email]?subject=help
ObjectWeb mailing lists service home page: http://www.objectweb.org/wws