V2.1.0 - March 7, 2017
Xatapult Content Engineering - http://www.xatapult.nl
Erik Siegel - erik@xatapult.nl - +31 6 53260792
xtpxlib is a library containing software, both libraries and ready-to-run stuff, for processing XML with languages like XSLT, XProc etc.
- Dump the files on some appropriate location on disk. That's basicly it for installation.
- If you want/need you can add the catalog
xmlcatalog/xtpxlib-catalog.xmlto your system or IDE. Then you can reference the files withurn:x-xtpxlib.nl://, e.g.urn:x-xtpxlib.nl://common/xslmod/common.mod.xsl. - Documentation is scattered around the library in Markdown
readme.mdfiles (like this one). I've also tried to document the code by adding enough comments. - Code documentation is done in such a way that you can extract some nice HTML page (a bit like Javadoc) from it. See the
readme.mdfile in the xmldoc subdirectory. - There is a basic oXygen project file for working with the library in
devenv/oxygen/xtpxlib.xpr
Most subdirectories contain a readme.md file that details its contents.
| Directory | Description |
|---|---|
common |
Sub-library with common code for processing strings, filenames, etc. |
container |
Sub-library for working with document containers. |
devenv |
Development environment related files, like templates. xtpxlib can be used in any XML processing environment but specifically supports oXygen as its main IDE. |
ms-office |
Sub-library for handling and working with some Microsoft Office formats (Office version > 2003) |
xmlcatalog |
Contains the XML catalog file(s) for easy access to the library from code. |
xmldoc |
Sub-library with code for generating documentation. A bit like Javadoc. |
| Directory | Description |
|---|---|
assets |
Binary static assets (images, etc.) |
bin |
Executable binaries and/or batch/shell files |
data |
Static datafiles |
etc |
Anything that does not fit in one of the other categories. |
doc |
Documentation |
xpl |
XProc scripts |
xplmod |
XProc modules/libraries |
xsl |
XSLT scripts |
xslmod |
XSLT modules/libraries |
- All file- and directory-names are in lower-case.
- Words/parts in names are separated with hyphens (e.g.
this-is-a-name). - Normal extensions are used (e.g.
.xsl,.xml, etc.) - For a file that contains a module or library, the extension is prefixed with
.mod.(e.g.xslt-library.mod.xsl) - Keep the filename simple, the location in the library will usually contain enough information
- All names (elements, attributes, prefixes, etc.) are in lower-case.
- Words/parts in names are separated with hyphens (e.g.
this-is-a-name). - Wherever possible (and appropriate), namespaces are used:
- xtpxlib namespace prefixes start with
xtl, short for xtpxlib. (e.g.xtlcforhttp:\\www.xtpxlib.nl\ns\common) - A sub-library of xtpxlib uses a single namespace for everything (unless technical reasons dictate otherwise).
- xtpxlib namespace prefixes start with
- Often a local namespace is needed for stuff like local functions, templates, etc. The prefix
localis used and the namespace is called#local.some-unique-id, e.g.xmlns:local="#local.ab-cd-ef"orxmlns:local="#local.filename". Templates use the oXygen${id}editor variable for this.