File: manual.xml

package info (click to toggle)
xiphos 4.1.0.1%2Bdfsg1-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 18,572 kB
  • sloc: ansic: 25,543; cpp: 13,223; python: 12,684; xml: 2,951; sh: 144; makefile: 42
file content (59 lines) | stat: -rw-r--r-- 2,182 bytes parent folder | download
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
<!-- ============= Manual  ============-->

<para>
  <itemizedlist>
    <listitem>
      The help files are in the help directory
      <para><command>cd help</command></para>
    </listitem>
    <listitem>
      There is a directory per YOUR-LANG. Create your own directory
      <para><command>mkdir YOUR-LANG</command></para>
    </listitem>
    <listitem>
      Edit Makefile.am and add YOUR-LANG to DOC_LINGUAS
      <para><command>vi Makefile.am</command></para>
    </listitem>
    <listitem>
      Go to YOUR-LANG directory
      <para><command>cd YOUR-LANG</command></para>
    </listitem>
    <listitem>
      Generate po files. For more information on xml2po, check the output
      of xml2po --help and man xml2po
      <para><command>xml2po -e -o YOUR-LANG.po ../C/*xml</command></para>
    </listitem>
    <listitem>
      Edit the file manually (emacs, vi, gedit) or with one of the available
      programs for this (gtranslator, poedit, emacs po mode...), creating
      the translation:
      <para><command>vi YOUR-LANG.po</command></para>
    </listitem>
    <listitem>
      You can add your localized screenshots. They go into the YOUR-LANG/figures
      directory. Once you have added them, copy the script 
      ../C/figures/index_all_pngs.py to YOUR-LANG/figures and run it. You will
      need to have the GIMP installed for this to work.
    </listitem>
    <listitem>
      When a new version of the help file is available, it's easy to update the
      po file:
      <para><command>xml2po -e -u YOUR-LANG.po ../C/*xml</command></para>
    </listitem>
    <listitem>
      You can test your new help file first of all by using xmllint:
      <para><command>xmllint xiphos.xml</command></para>
      <para>
	You can view the manual in gnome-help with this command:
      </para>
      <para><command>yelp `pwd`/xiphos.xml</command></para>
    </listitem>
  </itemizedlist>
</para>

<para>Don't forget to send YOUR-LANG.po files to xiphos-devel@crosswire.org.</para>

<para>"..and ye shall be witnesses unto me both in Jerusalem, and in all Judaea,
  and in Samaria, and unto the uttermost part of the earth." -- Acts 1:8</para>

<para> &xiphos; </para>