src/doc/sphinx/index.rst (1911B) - raw
1 rdftemplate
2 ===========
3
4 Rdftemplate is a library for generating XML documents from RDF data using
5 templates.
6
7 The library supports evaluation of “\ :doc:`selector expressions <selector>`\ ”, which use an
8 XPath-inspired syntax for selecting an ordered set of nodes from an arbitrary
9 starting context node.
10
11 The library also supports rendering XML from :doc:`templates <xml-template>`. The template
12 interpolator recognises a number of Genshi-inspired template directives, which
13 are used to insert the result of a selector expression into the generated
14 XML.
15
16 The library uses the Jena RDF model API.
17 It also includes optional support for :doc:`integrating with Spring
18 <spring>`, allowing templates to be used as Spring Web MVC views.
19
20 Rdftemplate was developed for the `Miskin Hill`_ web site, where it is used to
21 generate output in various XML-based formats. You can view the `templates used
22 for Miskin Hill <http://code.miskinhill.com.au/hg/miskinhill-master/file/tip/web/src/main/resources/au/com/miskinhill/rdf/template/>`_
23 to see some examples of how rdftemplate works.
24
25 .. _Miskin Hill: http://miskinhill.com.au/
26
27 Development
28 -----------
29
30 * `Javadoc <http://code.djc.id.au/rdftemplate/javadoc/latest/>`_
31 * `Git repository <https://github.com/danc86/rdftemplate>`_
32 * Send bugs and suggestions to `Dan C <mailto:djc@djc.id.au>`_
33
34 Quick start with Maven
35 ----------------------
36
37 Add the following to your pom.xml:
38
39 .. code-block:: xml
40
41 <repositories>
42 <repository>
43 <id>code.djc.id.au</id>
44 <url>http://code.djc.id.au/maven2/</url>
45 </repository>
46 </repositories>
47
48 <dependencies>
49 <dependency>
50 <groupId>au.id.djc</groupId>
51 <artifactId>rdftemplate</artifactId>
52 <version>1.2</version>
53 </dependency>
54 </dependencies>
55
56 .. todo:: more examples, like calling TemplateInterpolator or using Spring views