RELAX NG Schema for Paloose Sitemaps

This is the RELAX NG schema for the Paloose sitemaps. They are very similar to Cocoon sitemaps, but with enough differences to make it worth formalising separately. Any bug reports, help, suggestions, new task schemas etc to me, Hugh Field-Richards (hsfr@hsfr.org.uk).

The documentation is designed to be processed by the rng2xhtml.xsl pretty-printing processor available from the author.

Pipeline Definitions

map.pipelines — Warning! not used within this schema file.

define : map.pipelines

element : map:pipelines

interleave

optional

ref → pipelines.component-configurations

oneOrMore

ref → pipelines.pipeline

<define name="map.pipelines">
   <element name="map:pipelines">
      <interleave>
         <optional>
            <ref name="pipelines.component-configurations"/>
         </optional>
         <oneOrMore>
            <ref name="pipelines.pipeline"/>
         </oneOrMore>
      </interleave>
   </element>
</define>

pipelines.pipeline

define : pipelines.pipeline

element : map:pipeline

optional

attribute : internal-only

ref → common.trueFalseEnum

interleave

oneOrMore

ref → matcher.instance

optional

ref → pipelines.handle-errors

<define name="pipelines.pipeline">
   <element name="map:pipeline">
      <optional>
         <attribute name="internal-only">
            <ref name="common.trueFalseEnum"/>
         </attribute>
      </optional>
      <interleave>
         <oneOrMore>
            <ref name="matcher.instance"/>
         </oneOrMore>
         <optional>
            <ref name="pipelines.handle-errors"/>
         </optional>
      </interleave>
   </element>
</define>

pipelines.component-configurations

define : pipelines.component-configurations

element : map:component-configurations

interleave

optional

ref → pipelines.authentication-manager

optional

ref → pipelines.global-variables

<define name="pipelines.component-configurations">
   <element name="map:component-configurations">
      <interleave>
         <optional>
            <ref name="pipelines.authentication-manager"/>
         </optional>
         <optional>
            <ref name="pipelines.global-variables"/>
         </optional>
      </interleave>
   </element>
</define>

pipelines.authentication-manager

define : pipelines.authentication-manager

element : map:authentication-manager

interleave

zeroOrMore

ref → pipelines.handlers

<define name="pipelines.authentication-manager">
   <element name="map:authentication-manager">
      <interleave>
         <zeroOrMore>
            <ref name="pipelines.handlers"/>
         </zeroOrMore>
      </interleave>
   </element>
</define>

pipelines.global-variables

define : pipelines.global-variables

element : map:global-variables

zeroOrMore

ref → pipelines.variable

<define name="pipelines.global-variables">
   <element name="map:global-variables">
      <zeroOrMore>
         <ref name="pipelines.variable"/>
      </zeroOrMore>
   </element>
</define>

pipelines.variable

define : pipelines.variable

element : map:variable

attribute : name

attribute : value

<define name="pipelines.variable">
   <element name="map:variable">
      <attribute name="name"/>
      <attribute name="value"/>
   </element>
</define>

pipelines.handlers

define : pipelines.handlers

element : map:handlers

interleave

oneOrMore

ref → pipelines.handler

<define name="pipelines.handlers">
   <element name="map:handlers">
      <interleave>
         <oneOrMore>
            <ref name="pipelines.handler"/>
         </oneOrMore>
      </interleave>
   </element>
</define>

pipelines.handler

define : pipelines.handler

element : map:handler

attribute : name

ref → resource.redirect-to

element : map:authentication

attribute : uri

<define name="pipelines.handler">
   <element name="map:handler">
      <attribute name="name"/>
      <ref name="resource.redirect-to"/>
      <element name="map:authentication">
         <attribute name="uri"/>
      </element>
   </element>
</define>

pipelines.handle-errors

define : pipelines.handle-errors

element : map:handle-errors

interleave

oneOrMore

ref → pipeline.matcher

<define name="pipelines.handle-errors">
   <element name="map:handle-errors">
      <interleave>
         <oneOrMore>
            <ref name="pipeline.matcher"/>
         </oneOrMore>
      </interleave>
   </element>
</define>

Pipelines used in matchers

There is no sensible way of providing restictions on the pipeline ordering in RELAX-NG. I have had to resort to Schematron rules to do this. Oh for DSD-2, which can do this with no problem at all.

pipeline.matcher

define : pipeline.matcher

Schematron

Check position of pipeline elements

Context : “map:generate”

If condition “count( preceding-sibling::* ) > 0 and not ( preceding-sibling::map:parameter )”

then output: Generate element must be first in the pipeline

Context : “map:aggregate”

If condition “count( preceding-sibling::* ) > 0 and not( preceding-sibling::map:act ) and not ( preceding-sibling::map:parameter )”

then output: Aggregate element must be first in the pipeline

Context : “map:call”

If condition “count( following-sibling::* ) > 0”

then output: call element must be last in the pipeline

Context : “map:redirect-to”

If condition “count( following-sibling::* ) > 0 and not( parent::map:handler )”

then output: redirect-to element must be last in the pipeline

Context : “map:read”

If condition “count( preceding-sibling::* ) > 0 and count( following-sibling::* ) > 0”

then output: Read element must be only element in the pipeline

Context : “map:mount”

If condition “count( preceding-sibling::* ) > 0 and count( following-sibling::* ) > 0”

then output: Mount element must be only element in the pipeline

choice

ref → resource.mount

ref → reader.instance

ref → selector.instance

ref → action.instance

ref → resource.redirect-to

choice

ref → generator.instance

ref → aggregate.instance

ref → action.instance

ref → selector.instance

zeroOrMore

ref → transformer.instance

choice

ref → resource.call

ref → resource.redirect-to

ref → serializer.instance

<define name="pipeline.matcher">
   <sch:pattern name="Check position of pipeline elements">
      <sch:rule context="map:generate">
         <sch:report test="count( preceding-sibling::* ) > 0                and not ( preceding-sibling::map:parameter )">
            Generate element must be first in the pipeline
         </sch:report>
      </sch:rule>
      <sch:rule context="map:aggregate">
         <sch:report test="count( preceding-sibling::* ) > 0                and not( preceding-sibling::map:act )                and not ( preceding-sibling::map:parameter )">
            Aggregate element must be first in the pipeline
         </sch:report>
      </sch:rule>
      <sch:rule context="map:call">
         <sch:report test="count( following-sibling::* ) > 0">
            call element must be last in the pipeline
         </sch:report>
      </sch:rule>
      <sch:rule context="map:redirect-to">
         <sch:report test="count( following-sibling::* ) > 0                and not( parent::map:handler )">
            redirect-to element must be last in the pipeline
         </sch:report>
      </sch:rule>
      <sch:rule context="map:read">
         <sch:report test="count( preceding-sibling::* ) > 0 and count( following-sibling::* ) > 0">
            Read element must be only element in the pipeline
         </sch:report>
      </sch:rule>
      <sch:rule context="map:mount">
         <sch:report test="count( preceding-sibling::* ) > 0 and count( following-sibling::* ) > 0">
            Mount element must be only element in the pipeline
         </sch:report>
      </sch:rule>
   </sch:pattern>
   <choice>
      <group>
         <ref name="resource.mount"/>
      </group>
      <group>
         <ref name="reader.instance"/>
      </group>
      <group>
         <ref name="selector.instance"/>
      </group>
      <group>
         <ref name="action.instance"/>
      </group>
      <group>
         <ref name="resource.redirect-to"/>
      </group>
      <group>
         <choice>
            <ref name="generator.instance"/>
            <ref name="aggregate.instance"/>
            <ref name="action.instance"/>
            <ref name="selector.instance"/>
         </choice>
         <zeroOrMore>
            <ref name="transformer.instance"/>
         </zeroOrMore>
         <choice>
            <ref name="resource.call"/>
            <ref name="resource.redirect-to"/>
            <ref name="serializer.instance"/>
         </choice>
      </group>
   </choice>
</define>

pipeline.select — Warning! not used within this schema file.

define : pipeline.select

choice

ref → resource.mount

ref → reader.instance

optional

choice

ref → generator.instance

ref → aggregate.instance

interleave

optional

ref → selector.instance

zeroOrMore

optional

ref → transformer.instance

optional

choice

ref → resource.call

ref → resource.redirect-to

ref → serializer.instance

<define name="pipeline.select">
   <choice>
      <group>
         <ref name="resource.mount"/>
      </group>
      <group>
         <ref name="reader.instance"/>
      </group>
      <group>
         <optional>
            <choice>
               <ref name="generator.instance"/>
               <ref name="aggregate.instance"/>
            </choice>
         </optional>
         <interleave>
            <optional>
               <ref name="selector.instance"/>
            </optional>
            <zeroOrMore>
               <optional>
                  <ref name="transformer.instance"/>
               </optional>
            </zeroOrMore>
            <optional>
               <choice>
                  <ref name="resource.call"/>
                  <ref name="resource.redirect-to"/>
                  <ref name="serializer.instance"/>
               </choice>
            </optional>
         </interleave>
      </group>
   </choice>
</define>

pipeline.views — Warning! not used within this schema file.

define : pipeline.views

zeroOrMore

ref → transformer.instance

choice

ref → resource.call

ref → serializer.instance

<define name="pipeline.views">
   <zeroOrMore>
      <ref name="transformer.instance"/>
   </zeroOrMore>
   <choice>
      <group>
         <ref name="resource.call"/>
      </group>
      <group>
         <ref name="serializer.instance"/>
      </group>
   </choice>
</define>

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

For a copy of the GNU General Public License write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Pipeline Definitions

Pipelines used in matchers

Copyright