summary refs log tree commit diff
path: root/docs/api/settings-spec.xsl
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api/settings-spec.xsl')
-rw-r--r--docs/api/settings-spec.xsl49
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/api/settings-spec.xsl b/docs/api/settings-spec.xsl
new file mode 100644
index 00000000..04feb398
--- /dev/null
+++ b/docs/api/settings-spec.xsl
@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xsl:stylesheet version="1.0"
+                xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+
+  <xsl:output
+      method="xml"
+      doctype-public="-//OASIS//DTD DocBook XML V4.3//EN"
+      doctype-system="http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+      />
+
+  <xsl:template match="nm-setting-docs">
+    <section>
+      <title>Configuration Settings</title>
+      <xsl:apply-templates/>
+    </section>
+  </xsl:template>
+
+  <xsl:template match="setting">
+    <para>
+      <table>
+	<title><xsl:value-of select="@name"/> setting</title>
+	<tgroup cols="4">
+	  <thead>
+	    <row>
+              <entry>Key Name</entry>
+              <entry>Value Type</entry>
+              <entry>Default Value</entry>
+              <entry>Value Description</entry>
+	    </row>
+	  </thead>
+	  <tbody>
+	    <xsl:apply-templates/>
+	  </tbody>
+	</tgroup>
+      </table>
+    </para>
+  </xsl:template>
+
+  <xsl:template match="property">
+    <xsl:variable name="setting_name" select="../@name"/>
+    <row>
+      <entry><screen><xsl:value-of select="@name"/></screen></entry>
+      <entry><screen><xsl:value-of select="@type"/></screen></entry>
+      <entry><screen><xsl:value-of select="@default"/></screen></entry>
+      <entry><xsl:value-of select="@description"/><xsl:if test="@type = 'NMSettingSecretFlags'"> (see <xref linkend="secrets-flags"/> for flag values)</xsl:if></entry>
+    </row>
+  </xsl:template>
+
+</xsl:stylesheet>