File: dev-help-build.page

package info (click to toggle)
gnome-devel-docs 40.3-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 79,188 kB
  • sloc: javascript: 2,514; xml: 2,407; ansic: 2,229; python: 1,854; makefile: 805; sh: 499; cpp: 131
file content (64 lines) | stat: -rw-r--r-- 1,674 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
<?xml version="1.0" encoding="utf-8"?>
<page xmlns="http://projectmallard.org/1.0/" xmlns:its="http://www.w3.org/2005/11/its" type="topic" style="task" id="dev-help-build" xml:lang="it">

  <info>
    <link type="next" xref="dev-help-appmenu"/>
    <revision version="0.1" date="2013-06-18" status="review"/>

    <credit type="author copyright">
      <name>Radina Matic</name>
      <email its:translate="no">radina.matic@gmail.com</email>
      <years>2013</years>
    </credit>
    <credit type="editor">
      <name>Ekaterina Gerasimova</name>
      <email its:translate="no">kittykat3756@gmail.com</email>
      <years/>
    </credit>

    <include xmlns="http://www.w3.org/2001/XInclude" href="cc-by-sa-3-0.xml"/>

  </info>

  <title>Set up your build system</title>

  <links type="series" style="floatend">
    <title>Set up help</title>
  </links>

  <p>Help is normally installed into the
  <file its:translate="no">/usr/share/help/<input>locale</input>/<input>HELP_ID</input></file> directory.</p>

  <p>Add the following lines in the file <file>configure.ac</file>:</p>

  <code>YELP_HELP_INIT</code>

  <code>AC_CONFIG_FILES([
help/Makefile
])</code>

  <p>Add the following line to the <file>Makefile.am</file>:</p>
  <code>SUBDIRS = help</code>

  <p>Add a <file>help/Makefile.am</file>, it should list the help files in your
  project that you want to install:</p>
<code>
@YELP_HELP_RULES@

HELP_ID = <input>applicationname</input>

# Media files
HELP_MEDIA = \
	figures/icon.png

# Help pages
HELP_FILES = \
	index.page \
	introduction.page \
	anotherpage.page

# Translated languages, blank if no translations exist
HELP_LINGUAS = en_GB
</code>

</page>