[gnome-sound-recorder/wip/add-help-docus: 1/2] help: Add initial structure for help pages

[Felipe Borges <felipeborges src gnome org>]

commit c183867a7d210e8f21cd3960f57765a21000050c
Author: Felipe Borges <felipeborges gnome org>
Date:   Wed Jul 7 13:11:26 2021 +0200

    help: Add initial structure for help pages
    
    These are the base files necessary for Sound Recorder to have user
    documentation.

 help/C/figures/org.gnome.SoundRecorder.svg |  1 +
 help/C/index.page                          | 34 ++++++++++++++++++++++++++++++
 help/C/legal.xml                           |  6 ++++++
 help/LINGUAS                               |  1 +
 help/meson.build                           | 15 +++++++++++++
 meson.build                                |  1 +
 6 files changed, 58 insertions(+)
---
diff --git a/help/C/figures/org.gnome.SoundRecorder.svg b/help/C/figures/org.gnome.SoundRecorder.svg
new file mode 100644
index 0000000..8d9ae6f
--- /dev/null
+++ b/help/C/figures/org.gnome.SoundRecorder.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg"; xmlns:xlink="http://www.w3.org/1999/xlink"; width="128" height="128" 
version="1.0"><defs><linearGradient id="e"><stop offset="0" stop-color="#26a269"/><stop offset="1" 
stop-color="#26a269" stop-opacity="0"/></linearGradient><linearGradient id="d"><stop offset="0" 
stop-color="#e54b57"/><stop offset="1" stop-color="#a51d2d"/></linearGradient><linearGradient id="b"><stop 
offset="0" stop-color="#deddda"/><stop offset="1" stop-color="#9a9996"/></linearGradient><linearGradient 
id="a"><stop offset="0" stop-color="#57e389"/><stop offset="1" stop-color="#57e389" 
stop-opacity=".204"/></linearGradient><linearGradient id="c"><stop offset="0" stop-color="#d5d3cf"/><stop 
offset=".036" stop-color="#e4e1de"/><stop offset=".071" stop-color="#d5d3cf"/><stop offset=".929" 
stop-color="#d5d3cf"/><stop offset=".964" stop-color="#e4e1de"/><stop offset="1" 
stop-color="#d5d3cf"/></linearGradient><linearGradient xlink:href="#c" id="f" gradientUnits="userSpaceOnUse" 
grad
 ientTransform="matrix(.25 0 0 .25 -22.212 121.009)" x1="120" y1="619.964" x2="568" 
y2="619.964"/><linearGradient xlink:href="#d" id="i" x1="23.712" y1="268.75" x2="27.212" y2="268.75" 
gradientUnits="userSpaceOnUse" gradientTransform="translate(-6.712 -4)"/><linearGradient xlink:href="#c" 
id="h" gradientUnits="userSpaceOnUse" gradientTransform="matrix(.25 0 0 .25 -15.5 297.009)" x1="513.5" 
y1="-88.536" x2="277.5" y2="-88.536"/><linearGradient xlink:href="#e" id="g" x1="106.712" y1="227" 
x2="58.712" y2="227" gradientUnits="userSpaceOnUse" gradientTransform="translate(-6.712 -4)"/></defs><g 
transform="translate(0 -172)"><rect style="marker:none" width="112" height="86" x="7.788" y="200" rx="8" 
ry="8" fill="#f6f5f4"/><path style="marker:none" d="M7.788 276v4c0 4.432 3.568 8 8 8h96c4.432 0 8-3.568 
8-8v-4c0 4.432-3.568 8-8 8h-96c-4.432 0-8-3.568-8-8z" fill="url(#f)"/><rect ry="1.945" rx="1.945" y="207" 
x="16" height="24" width="96" style="marker:none" fill="#241f31"/><rect ry="0" rx="0" y
 ="207" x="29" height="24" width="72" style="marker:none" fill="url(#g)"/><path opacity=".623" fill="#26a269" 
d="M16 218h96v2H16z"/><path d="M100.916 218.998H17" fill="none" stroke="#57e389" stroke-width="2" 
stroke-linecap="round"/><path d="M41 216.01v6.414M49 216.867v4.7M57 216.475v5.483M65 214.908v8.617M73 
212.558v13.317M81 215.691v7.05M89 214.516v9.4" fill="none" stroke="#33d17a" stroke-width="4" 
stroke-linecap="round"/><path d="M41 218.693v1.047M49 218.433V220M57 218.831v1.478M65 217.65v3.133M73 
216v6M81 217.65v3.133M89 218.042v2.35" fill="none" stroke="#f9f06b" stroke-width="4" 
stroke-linecap="round"/><path d="M64 236v40h44.994a3 3 0 0 0 3.006-3.006v-33.988a3 3 0 0 0-3.006-3.006z" 
style="marker:none" fill="url(#h)"/><path d="M64 231v40h44.994a3 3 0 0 0 3.006-3.006v-33.988a3 3 0 0 
0-3.006-3.006z" style="marker:none" fill="#f6f6f6"/><path style="marker:none" d="M64 236v40H19.006A3 3 0 0 1 
16 272.994v-33.988A3 3 0 0 1 19.006 236z" fill="url(#i)"/><path style="marker:none" d="M64 23
 4v40H19.006A3 3 0 0 1 16 270.994v-33.988A3 3 0 0 1 19.006 234z" fill="#e01b24"/><circle r="8" cy="255" 
cx="40" style="marker:none" fill="#fff"/><path d="M72 243v16l16-8zM88 243h5v16h-5zM96 243h5v16h-5z" 
style="marker:none" fill="#241f31"/><path style="marker:none" fill="#8ff0a4" d="M100 207h2v24h-2z"/><path 
d="M17.945 207a1.942 1.942 0 0 0-1.946 1.945v2c0-1.077.868-1.945 1.946-1.945h92.11c1.077 0 1.945.868 1.945 
1.945v-2a1.942 1.942 0 0 0-1.945-1.945z" style="marker:none" fill="#241f31" fill-opacity=".374"/></g></svg>
\ No newline at end of file
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100644
index 0000000..b047148
--- /dev/null
+++ b/help/C/index.page
@@ -0,0 +1,34 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="guide"
+      id="index">
+
+  <info>
+    <title type="link" role="trail">Sound Recorder</title>
+    <title type="link">Sound Recorder</title>
+    <title type="text">Sound Recorder</title>
+    <revision pkgversion="40" date="2021-07-07" status="candidate"/>
+
+    <credit type="author copyright">
+      <name>Felipe Borges</name>
+      <email its:translate="no">felipeborges gnome org</email>
+      <years>2021</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <desc>Learn how to use Sound Recorder.</desc> 
+  </info>
+
+  <title>
+    <media type="image" its:translate="no" width="48px" height="48px"
+      src="figures/org.gnome.SoundRecorder.svg" /> Sound Recorder
+  </title>
+
+  <p><app>Sound Recorder</app> is a simple sound recording app for the GNOME desktop environment.</p> 
+
+  <section id="start" style="2column">
+    <title>Getting started</title>
+  </section>
+
+</page>
diff --git a/help/C/legal.xml b/help/C/legal.xml
new file mode 100644
index 0000000..f36c14d
--- /dev/null
+++ b/help/C/legal.xml
@@ -0,0 +1,6 @@
+<license xmlns="http://projectmallard.org/1.0/";
+         href="http://creativecommons.org/licenses/by-sa/3.0/";>
+  <p>This work is licensed under a
+  <link href="http://creativecommons.org/licenses/by-sa/3.0/";>Creative
+  Commons Attribution-Share Alike 3.0 Unported License</link>.</p>
+</license>
diff --git a/help/LINGUAS b/help/LINGUAS
new file mode 100644
index 0000000..af407ee
--- /dev/null
+++ b/help/LINGUAS
@@ -0,0 +1 @@
+# Keep this list sorted alphabetically
diff --git a/help/meson.build b/help/meson.build
new file mode 100644
index 0000000..a2b4a1d
--- /dev/null
+++ b/help/meson.build
@@ -0,0 +1,15 @@
+# Please keep this list in alphabetical order
+help_files = [
+  'index.page',
+  'legal.xml',
+]
+
+help_media = [
+  'figures/org.gnome.SoundRecorder.svg'
+]
+
+gnome.yelp(meson.project_name(),
+           sources: help_files,
+           media: help_media,
+           symlink_media: true
+)
diff --git a/meson.build b/meson.build
index f26876a..9f03350 100644
--- a/meson.build
+++ b/meson.build
@@ -48,6 +48,7 @@ i18n = import('i18n')
 po_dir = meson.source_root() / 'po'
 
 subdir('data')
+subdir('help')
 subdir('src')
 subdir('po')