[devhelp] help: start to write user documentation in Mallard

[Sébastien Wilmet <swilmet src gnome org>]

commit 2236b9744c065b9f269627519d4911d73308fed3
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Sun Jan 21 08:32:53 2018 +0100

    help: start to write user documentation in Mallard
    
    For the search functionality in the side panel.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=782257

 Makefile.am        |    2 +-
 configure.ac       |    4 +++
 help/C/index.page  |    5 ++++
 help/C/search.page |   56 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 help/Makefile.am   |   12 +++++++++++
 5 files changed, 78 insertions(+), 1 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index 6310c75..5e2f380 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,4 +1,4 @@
-SUBDIRS = data plugins po src unit-tests docs
+SUBDIRS = data plugins po help src unit-tests docs
 
 AM_DISTCHECK_CONFIGURE_FLAGS = \
        --enable-gtk-doc        \
diff --git a/configure.ac b/configure.ac
index 087e0f8..adadab9 100644
--- a/configure.ac
+++ b/configure.ac
@@ -49,6 +49,9 @@ GLIB_GSETTINGS
 AX_REQUIRE_DEFINED([GOBJECT_INTROSPECTION_CHECK])
 GOBJECT_INTROSPECTION_CHECK([1.30.0])
 
+AX_REQUIRE_DEFINED([YELP_HELP_INIT])
+YELP_HELP_INIT
+
 # Compile warnings. There can be deprecation warnings at any time, so disable
 # -Werror by default with the [yes] argument.
 AX_REQUIRE_DEFINED([AX_COMPILER_FLAGS])
@@ -96,6 +99,7 @@ AC_CONFIG_FILES([
        data/icons/Makefile
        docs/Makefile
        docs/reference/Makefile
+       help/Makefile
        plugins/Makefile
        plugins/gedit-plugin/Makefile
        po/Makefile.in
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100644
index 0000000..db1646b
--- /dev/null
+++ b/help/C/index.page
@@ -0,0 +1,5 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="index">
+<title>Devhelp User Documentation</title>
+</page>
diff --git a/help/C/search.page b/help/C/search.page
new file mode 100644
index 0000000..188199d
--- /dev/null
+++ b/help/C/search.page
@@ -0,0 +1,56 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="topic"
+      id="search">
+
+<info>
+  <link type="guide" xref="index" />
+</info>
+
+<title>Search in the side panel</title>
+
+<synopsis>
+  <p>How the search in the side panel works.</p>
+</synopsis>
+
+<section id="case-sensitivity">
+  <title>Case sensitivity</title>
+  <p>
+    The search is case sensitive when there is an uppercase letter. If the
+    search terms are all in lowercase, the search is case insensitive. It's
+    like the “smartcase” feature present in some text editors.
+  </p>
+</section>
+
+<section id="globs">
+  <title>Glob-style pattern matching</title>
+  <p>
+    A search term can be a pattern containing ‘*’ and ‘?’ wildcards. ‘*’
+    matches an arbitrary, possibly empty, string; and ‘?’ matches an arbitrary
+    character.
+  </p>
+</section>
+
+<section id="several-search-terms">
+  <title>Several search terms</title>
+  <p>
+    You can search with several search terms (separated by spaces). A symbol
+    will match only if <em>all</em> the search terms individually match (not
+    necessarily in the same order of appearance).
+  </p>
+  <p>
+    Note that it is different than searching with the ‘*’ wildcard: with the
+    ‘*’ wildcard it forces the keywords to be in the same order.
+  </p>
+  <p>
+    For example when searching “<input>gtk window application</input>”, it
+    matches both “<code>gtk_window_get_application()</code>” and
+    “<code>GtkApplicationWindow</code>” (among other symbols).
+  </p>
+  <p>
+    On the other hand, searching “<input>gtk*window*application</input>” will
+    match “<code>gtk_window_get_application()</code>” but not
+    “<code>GtkApplicationWindow</code>”.
+  </p>
+</section>
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
new file mode 100644
index 0000000..fe1ecb5
--- /dev/null
+++ b/help/Makefile.am
@@ -0,0 +1,12 @@
+@YELP_HELP_RULES@
+
+HELP_ID = devhelp
+
+HELP_FILES =           \
+       index.page      \
+       search.page     \
+       $(NULL)
+
+HELP_LINGUAS =
+
+-include $(top_srcdir)/git.mk