Skip to content

Latest commit

 

History

History
109 lines (82 loc) · 3.65 KB

README.md

File metadata and controls

109 lines (82 loc) · 3.65 KB
Raw

XProc 3.0: An XML Pipeline Language

This is the home of the XProc 3.0 language specification developed by the XProc next community group. The specifications for the step libraries are maintained in the step repository.

Drafts are published automatically at spec.xproc.org.

GitHub

The XProc community is using GitHub to manage the development of this specification. Please pull the repository, make improvements, and propose changes in the form of pull requests.

Continuous integration

The XProc specification is built automatically with GitHub workflows.

To build and publish the spec on your gh-pages, create the gh-pages branch.

GitHub will then publish your changes everytime you do a commit to your master branch or any other branch.

How it works

The documents are built by a gradle task that runs XML Calabash and other tools. The individual specifications are in sub-projects. At the time of this writing, there are two specifications in this repository:

  • overview is the overview page that points to all the specs
  • xproc is XProc 3.0: A Pipeline Language

The default gradle target, allspecs, will build all of the specifications. The built specifications are in the build/dist/ directory or directories below it.

Within each subproject, the “source” for each specification is in src/main/xml/specification.xml. There may be other files as well. Use XInclude to break specs into pieces if you wish.

About the workflow

It’s all a bit complicated. These are some notes.

  • The published specs are the gh-pages branch of this repository.

  • Three repositories update the gh-pages branch: this repository publishes the language specification; the 3.0-steps repository publishes the steps; the 3.0-grammar repository publishes the grammar.

  • Publishing the grammar relies on the steps! So 3.0-grammar should be rebuilt whenever the steps change and this repos should be rebuilt whenever the core grammar changes!

  • All specifications have a glossary; if the glossary turns out to be empty, because there are no term definitions (firstterm elements) in a specification, it will be elided automatically.

<xi:include href="../../../build/glossary.xml">
  <xi:fallback>
    <glossary xml:id="glossary">
      <title>Glossary</title>
      <para>Glossary needs to be generated</para>
    </glossary>
  </xi:fallback>
</xi:include>
  • Similarly, for steps, there is a step errors appendix. It will be populated automatically and elided if there are no step errors.
<appendix xml:id="app.step-errors">
<title>Step Errors</title>
<para>The following <glossterm baseform="dynamic-error">dynamic errors</glossterm>
can be raised by the <code>p:validate-with-relax-ng</code> step:</para>
<?step-error-list?>
</appendix>
  • There is a single, master bibliography in src/main/xml/bibliography.xml. In each specification, use biblioref to refer to bibliography entries. Create a bibliolist with empty bibliomisc elements to pull in the relevant entries from the master bibliography:
<appendix xml:id="references">
<title>References</title>
<bibliolist>
<bibliomixed xml:id="xproc30"/>
<bibliomixed xml:id="xproc30-steps"/>
<bibliomixed xml:id="iso19757-2"/>
<bibliomixed xml:id="relaxng-compact-syntax"/>
<bibliomixed xml:id="relaxng-dtd-compat"/>
</bibliolist>
</appendix>
  • Examples and graphics are also a little complicated. I’ll describe them here if anyone asks. :-)

The build process is owned by norm; bug him if you have difficulties.