[tepl] docs: write more intro documentation about Amtk
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [tepl] docs: write more intro documentation about Amtk
- Date: Thu, 27 Jul 2017 17:54:06 +0000 (UTC)
commit fb645b6752bc89625b4b37da1667bf46f971e153
Author: Sébastien Wilmet <swilmet gnome org>
Date: Thu Jul 27 19:33:08 2017 +0200
docs: write more intro documentation about Amtk
configure.ac | 3 +-
docs/reference/Makefile.am | 10 ++++--
.../{amtk-intro.xml => amtk-intro.xml.in} | 27 +++++++++++++++++
docs/reference/intro.xml.in | 31 +++++++++++++++++--
4 files changed, 62 insertions(+), 9 deletions(-)
---
diff --git a/configure.ac b/configure.ac
index c046edc..b49fb66 100644
--- a/configure.ac
+++ b/configure.ac
@@ -156,9 +156,10 @@ AC_CONFIG_FILES([
Makefile
amtk/Makefile
docs/Makefile
- docs/reference/tepl-docs.xml
+ docs/reference/amtk-intro.xml
docs/reference/intro.xml
docs/reference/Makefile
+ docs/reference/tepl-docs.xml
tepl/Makefile
po/Makefile.in
tests/Makefile
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index fa3e9a2..96ca0b7 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -67,11 +67,13 @@ MAINTAINERCLEANFILES = \
include $(top_srcdir)/gtk-doc.make
EXTRA_DIST += \
- tepl-docs.xml.in \
- intro.xml.in
+ amtk-intro.xml.in \
+ intro.xml.in \
+ tepl-docs.xml.in
DISTCLEANFILES = \
- tepl-docs.xml \
- intro.xml
+ amtk-intro.xml \
+ intro.xml \
+ tepl-docs.xml
-include $(top_srcdir)/git.mk
diff --git a/docs/reference/amtk-intro.xml b/docs/reference/amtk-intro.xml.in
similarity index 84%
rename from docs/reference/amtk-intro.xml
rename to docs/reference/amtk-intro.xml.in
index ede6e28..674b85f 100644
--- a/docs/reference/amtk-intro.xml
+++ b/docs/reference/amtk-intro.xml.in
@@ -33,6 +33,11 @@
</para>
<para>
+ Amtk is developed inside the Tepl repository, but is a separate shared library
+ so that applications can use it without depending on Tepl, GtkSourceView, etc.
+</para>
+
+<para>
With Amtk, menus and toolbars are created programmatically, but with
convenient APIs (the support for an XML format will maybe be added in the
future, contributions welcome). <link linkend="GMenu">GMenu</link> is not
@@ -92,4 +97,26 @@
</para>
</listitem>
</itemizedlist>
+
+<refsect1>
+ <title>GTK+ dependency</title>
+ <para>
+ Amtk @TEPL_API_VERSION@ depends on GTK+ 3.
+ </para>
+</refsect1>
+
+<refsect1>
+ <title>pkg-config name</title>
+ <para>
+ For Amtk @TEPL_API_VERSION@, the pkg-config name is:
+ <code>amtk-@TEPL_API_VERSION@</code>
+ </para>
+ <para>
+ To compile a program that uses Amtk @TEPL_API_VERSION@, you can for
+ example use the following command:
+ </para>
+ <para>
+ <code>$ gcc hello.c `pkg-config --cflags --libs amtk-@TEPL_API_VERSION@` -o hello</code>
+ </para>
+</refsect1>
</refentry>
diff --git a/docs/reference/intro.xml.in b/docs/reference/intro.xml.in
index f119649..c4bdd28 100644
--- a/docs/reference/intro.xml.in
+++ b/docs/reference/intro.xml.in
@@ -134,21 +134,44 @@
</refsect1>
<refsect1>
+ <title>Amtk - Actions, Menus and Toolbars Kit for GTK+</title>
+
+ <para>
+ As yak shaving, another shared library called Amtk has been developed.
+ Because with GTK+ alone, it is no longer possible to create a traditional
+ UI in a convenient way without using deprecated APIs (that have been
+ removed in GTK+ 4).
+ </para>
+
+ <para>
+ Amtk has been developed with libraries like Tepl in mind. This has the
+ nice benefit that action information is shared (see
+ <link
linkend="tepl-application-get-tepl-action-info-store">tepl_application_get_tepl_action_info_store()</link>).
+ </para>
+
+ <para>
+ Read the <link linkend="amtk-intro">Amtk introduction</link> for more
+ information.
+ </para>
+ </refsect1>
+
+ <refsect1>
<title>GTK+ and GtkSourceView dependencies</title>
<para>
- Tepl @TEPL_API_VERSION@ depends on GTK+ 3 and GtkSourceView 3.
+ Tepl @TEPL_API_VERSION@ depends on GTK+ 3 and
+ GtkSourceView 3.
</para>
</refsect1>
<refsect1>
<title>pkg-config name</title>
<para>
- For Tepl @TEPL_API_VERSION@, the pkg-config name is:
+ For Tepl @TEPL_API_VERSION@, the pkg-config name is:
<code>tepl-@TEPL_API_VERSION@</code>
</para>
<para>
- To compile a program that uses Tepl @TEPL_API_VERSION@, you
- can for example use the following command:
+ To compile a program that uses Tepl @TEPL_API_VERSION@, you can for
+ example use the following command:
</para>
<para>
<code>$ gcc hello.c `pkg-config --cflags --libs tepl-@TEPL_API_VERSION@` -o hello</code>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]