[gtksourceview] docs: add an intro with the pkg-config name
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtksourceview] docs: add an intro with the pkg-config name
- Date: Thu, 3 Nov 2016 15:44:30 +0000 (UTC)
commit e95a042243092ec04c9315de7715344d8bc879d1
Author: Sébastien Wilmet <swilmet gnome org>
Date: Thu Nov 3 16:29:53 2016 +0100
docs: add an intro with the pkg-config name
configure.ac | 1 +
docs/reference/Makefile.am | 3 ++
docs/reference/gtksourceview-docs.xml.in | 2 +
docs/reference/intro.xml.in | 38 ++++++++++++++++++++++++++++++
4 files changed, 44 insertions(+), 0 deletions(-)
---
diff --git a/configure.ac b/configure.ac
index e4e91d9..32ffbba 100644
--- a/configure.ac
+++ b/configure.ac
@@ -246,6 +246,7 @@ data/styles/Makefile
docs/Makefile
docs/reference/Makefile
docs/reference/gtksourceview-docs.xml
+docs/reference/intro.xml
docs/reference/lang-reference.xml
docs/reference/style-reference.xml
gtksourceview/Makefile
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 607434e..26fad1f 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -69,6 +69,7 @@ HTML_IMAGES =
# Extra XML files that are included by $(DOC_MAIN_SGML_FILE)
content_files = \
+ intro.xml \
lang-tutorial.xml \
lang-reference.xml \
style-reference.xml
@@ -93,11 +94,13 @@ include $(top_srcdir)/gtk-doc.make
EXTRA_DIST += \
gtksourceview-docs.xml.in \
+ intro.xml.in \
lang-reference.xml.in \
style-reference.xml.in
DISTCLEANFILES = \
gtksourceview-docs.xml \
+ intro.xml \
lang-reference.xml \
style-reference.xml
diff --git a/docs/reference/gtksourceview-docs.xml.in b/docs/reference/gtksourceview-docs.xml.in
index a01eaf3..61ce9c4 100644
--- a/docs/reference/gtksourceview-docs.xml.in
+++ b/docs/reference/gtksourceview-docs.xml.in
@@ -12,6 +12,8 @@
<releaseinfo>for GtkSourceView &package_version;</releaseinfo>
</bookinfo>
+ <xi:include href="intro.xml"/>
+
<part>
<title>API reference</title>
diff --git a/docs/reference/intro.xml.in b/docs/reference/intro.xml.in
new file mode 100644
index 0000000..e515e7c
--- /dev/null
+++ b/docs/reference/intro.xml.in
@@ -0,0 +1,38 @@
+<?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>
+ GtkSourceView is a portable C library that extends the standard GTK+
+ framework for multiline text editing with support for configurable syntax
+ highlighting, unlimited undo/redo, search and replace, a completion
+ framework, printing and other features typical of a source code editor.
+ </para>
+
+ <para>
+ See the <ulink url="https://wiki.gnome.org/Projects/GtkSourceView">GtkSourceView website</ulink>.
+ </para>
+
+ <refsect1>
+ <title>pkg-config name</title>
+ <para>
+ For GtkSourceView @GSV_MAJOR_API_VERSION@, the pkg-config name is:
+ <code>gtksourceview-@GSV_API_VERSION@</code>
+ </para>
+ <para>
+ To compile a program that uses GtkSourceView @GSV_MAJOR_API_VERSION@, you
+ can for example use the following command:
+ </para>
+ <para>
+ <code>$ gcc hello.c `pkg-config --cflags --libs gtksourceview-@GSV_API_VERSION@` -o hello</code>
+ </para>
+ </refsect1>
+</part>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]