fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2026-02-04 11:50:29 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs/api: make the connection settings look better

Browse source 
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.
This commit is contained in:
Lubomir Rintel 2017-03-10 18:40:03 +01:00
parent 265269855b
commit c673c52101
2 changed files with 44 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/api/Makefile.am
View file

@ -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 \

63
docs/api/settings-spec.xsl
View file

@ -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>