[gspell: 2/2] docs: add an intro section
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gspell: 2/2] docs: add an intro section
- Date: Mon, 8 Aug 2016 13:13:33 +0000 (UTC)
commit 769b3d23c5d9dce6e3661d35f28caaa9a71bdd14
Author: Sébastien Wilmet <swilmet gnome org>
Date: Mon Aug 8 15:01:27 2016 +0200
docs: add an intro section
docs/reference/Makefile.am | 2 +-
docs/reference/gspell-docs.xml.in | 2 ++
docs/reference/intro.xml | 26 ++++++++++++++++++++++++++
3 files changed, 29 insertions(+), 1 deletions(-)
---
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index ea9dd58..e62e6a2 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -44,7 +44,7 @@ MKDB_OPTIONS = --xml-mode --output-format=xml
HTML_IMAGES =
# Extra XML files that are included by $(DOC_MAIN_SGML_FILE)
-content_files =
+content_files = intro.xml
# Extra options to supply to gtkdoc-fixref
FIXXREF_OPTIONS =
diff --git a/docs/reference/gspell-docs.xml.in b/docs/reference/gspell-docs.xml.in
index f04744e..3f17a04 100644
--- a/docs/reference/gspell-docs.xml.in
+++ b/docs/reference/gspell-docs.xml.in
@@ -12,6 +12,8 @@
<releaseinfo>for gspell &package_version;</releaseinfo>
</bookinfo>
+ <xi:include href="intro.xml"/>
+
<part>
<title>API reference</title>
diff --git a/docs/reference/intro.xml b/docs/reference/intro.xml
new file mode 100644
index 0000000..15ae36a
--- /dev/null
+++ b/docs/reference/intro.xml
@@ -0,0 +1,26 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry 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;
+]>
+
+<part>
+ <title>Introduction</title>
+
+ <para>
+ gspell provides a flexible API to add spell checking to a GTK+ application.
+ See the <ulink url="https://wiki.gnome.org/Projects/gspell">gspell website</ulink>.
+ </para>
+
+ <refsect1>
+ <title>How to enable inline spell checking in a GtkTextView</title>
+ <para>
+ See the <link
linkend="gspell-text-view-basic-setup"><function>gspell_text_view_basic_setup()</function></link>
+ convenience function to quickly enable inline spell checking in a
+ <link linkend="GtkTextView"><type>GtkTextView</type></link> widget.
+ </para>
+ </refsect1>
+</part>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]