From c673c5210143316234cb415ce0380aea9f63551e Mon Sep 17 00:00:00 2001
From: Lubomir Rintel <lkundrak@v3.sk>
Date: Fri, 10 Mar 2017 18:40:03 +0100
Subject: [PATCH] docs/api: make the connection settings look better

Turn the it into a chapter with refentries to better fit the structure
of the table of contects. Also, include the properties in the index.
---
 docs/api/Makefile.am       |  3 +-
 docs/api/settings-spec.xsl | 63 +++++++++++++++++++++++++-------------
 2 files changed, 44 insertions(+), 22 deletions(-)

diff --git a/docs/api/Makefile.am b/docs/api/Makefile.am
index 12a6d52f6a..f5def7b8b8 100644
--- a/docs/api/Makefile.am
+++ b/docs/api/Makefile.am
@@ -38,8 +38,9 @@ MKTMPL_OPTIONS=
 # Extra options to supply to gtkdoc-mkhtml
 MKHTML_OPTIONS=--path="$(abs_srcdir)"
 
-# Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE)
+# Files to be included in $(DOC_MAIN_SGML_FILE)
 content_files = \
+	$(GENERATED_FILES) \
 	dbus-org.freedesktop.NetworkManager.AccessPoint.xml \
 	dbus-org.freedesktop.NetworkManager.Connection.Active.xml \
 	dbus-org.freedesktop.NetworkManager.Device.Team.xml \
diff --git a/docs/api/settings-spec.xsl b/docs/api/settings-spec.xsl
index 04feb3987f..80f27309d5 100644
--- a/docs/api/settings-spec.xsl
+++ b/docs/api/settings-spec.xsl
@@ -9,37 +9,58 @@
       />
 
   <xsl:template match="nm-setting-docs">
-    <section>
+    <chapter>
       <title>Configuration Settings</title>
       <xsl:apply-templates/>
-    </section>
+    </chapter>
   </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>
+    <refentry>
+      <xsl:attribute name="id">settings-<xsl:value-of select="@name"/></xsl:attribute>
+      <refnamediv>
+        <refname><xsl:value-of select="@name"/></refname>
+        <refpurpose><xsl:value-of select="@description"/></refpurpose>
+      </refnamediv>
+      <refsect1 role="properties">
+        <title>
+            <xsl:attribute name="id">settings-<xsl:value-of select="@name"/>.properties</xsl:attribute>
+            Properties
+        </title>
+        <para>
+          <table>
+            <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>
+      </refsect1>
+    </refentry>
   </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="@name"/>
+        <indexterm>
+           <xsl:attribute name="zone">settings-<xsl:value-of select="../@name"/></xsl:attribute>
+           <primary>
+             <xsl:attribute name="sortas"><xsl:value-of select="@name"/></xsl:attribute>
+             <xsl:value-of select="@name"/>
+           </primary>
+        </indexterm>
+      </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>