summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Leupold <lemma@leunet.de>2009-08-01 17:12:50 +0200
committerStef Walter <stefw@collabora.co.uk>2010-12-04 16:11:42 +0000
commit7fd31353669e5068e1712348f3a239c8140b7236 (patch)
treed285a0ee4d0446b22a2e0da1b80f5eadb0f0f0c6
parent71b33da854c43d89147075fb5d06673b52d0bd1c (diff)
downloadxdg-specs-7fd31353669e5068e1712348f3a239c8140b7236.tar.xz
Add a README so others can figure out how to generate the docs as well.
-rw-r--r--secret-service/README20
1 files changed, 20 insertions, 0 deletions
diff --git a/secret-service/README b/secret-service/README
new file mode 100644
index 0000000..3f9eadd
--- /dev/null
+++ b/secret-service/README
@@ -0,0 +1,20 @@
+Generating the specification consists of separate steps:
+
+1. Use an xslt processor to create a DocBook XML document from the Telepathy
+ Introspection document using the provided stylesheet:
+
+$ xsltproc tools/spec-to-docbook.xsl \
+ org.freedesktop.Secrets.xml >reference.xml
+
+2. Convert specification.xml and reference.xml to a suitable output format
+ (specification.xml includes reference.xml), eg html:
+
+$ xmlto --skip-validation -o html -p params-html.xsl xhtml specification.xml
+
+If you choose a different directory for html generation, be sure to copy
+html/style.css to that location.
+
+Then open the resulting html/index.html in your favourite browser.
+
+
+Michael Leupold <lemma@confuego.org> \ No newline at end of file