[gtk-doc] help: document how to use the new entities feature
- From: Stefan Kost <stefkost src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk-doc] help: document how to use the new entities feature
- Date: Wed, 15 Jul 2015 08:31:10 +0000 (UTC)
commit ca106ece4dacff17dab105dd65f5c1046a03e391
Author: Stefan Sauer <ensonic users sf net>
Date: Wed Jul 15 10:28:43 2015 +0200
help: document how to use the new entities feature
help/manual/C/index.docbook | 35 +++++++++++++++++++++++++++++++++++
1 files changed, 35 insertions(+), 0 deletions(-)
---
diff --git a/help/manual/C/index.docbook b/help/manual/C/index.docbook
index a7c24fd..0e63644 100644
--- a/help/manual/C/index.docbook
+++ b/help/manual/C/index.docbook
@@ -1872,6 +1872,41 @@ endif
has all the details.
</para>
</sect1>
+
+ <sect1 id="modernizing-gtk-doc-1-25">
+ <title>GTK-Doc 1.25</title>
+
+ <para>
+ The makefiles shipped with this version generate an entity file at
<filename>xml/gtkdocentities.ent</filename>,
+ containing entities for e.g. package_name and package_version. You can
+ use this e.g. in the main xml file to avoid hardcoding the version
+ number. Below is any example that shows how the entity file is included
+ and how the entities are used. The entities can also be used in all
+ generated files, GTK-Doc will use the same xml header in generated xml
+ files.
+ <example><title>Use pre-generated entities</title>
+ <programlisting><![CDATA[
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+ <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
+ %gtkdocentities;
+]>
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+ <bookinfo>
+ <title>&package_name; Reference Manual</title>
+ <releaseinfo>
+ for &package_string;.
+ The latest version of this documentation can be found on-line at
+ <ulink role="online-location"
url="http://[SERVER]/&package_name;/index.html">http://[SERVER]/&package_name;/</ulink>.
+ </releaseinfo>
+ </bookinfo>
+]]></programlisting>
+ </example>
+ </para>
+ </sect1>
</chapter>
<chapter id="documenting-others">
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]