|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | 03-May-2022 | - |
| images/ | H | 03-Jun-2016 | - | | |
| make.d/ | H | 20-Jun-2019 | - | 435 | 303 |
| po/ | H | 21-Jun-2019 | - | 2,317,253 | 1,986,729 |
| quickreference/ | H | 21-Jun-2019 | - | 16,016 | 12,531 |
| src/ | H | 21-Jun-2019 | - | 106,976 | 98,513 |
| stylesheets/ | H | 21-Jun-2019 | - | 3,804 | 3,344 |
| tools/ | H | 03-May-2022 | - | 1,264 | 927 |
| AUTHORS | H A D | 19-Nov-2017 | 2.9 KiB | 126 | 118 |
| COPYING | H A D | 03-Jun-2016 | 19.9 KiB | 398 | 328 |
| ChangeLog | H A D | 21-Jun-2019 | 1.9 MiB | 41,733 | 34,238 |
| HACKING | H A D | 20-Jun-2019 | 3.7 KiB | 151 | 133 |
| INSTALL | H A D | 18-Dec-2012 | 15.2 KiB | 366 | 284 |
| MAINTAINERS | H A D | 20-Jun-2019 | 377 | 22 | 16 |
| Makefile.am | H A D | 13-Sep-2018 | 37.5 KiB | 1,069 | 456 |
| Makefile.in | H A D | 20-Jun-2019 | 54.8 KiB | 1,669 | 1,209 |
| NEWS | H A D | 03-Jun-2016 | 12 KiB | 342 | 245 |
| README | H A D | 20-Jun-2019 | 6 KiB | 210 | 133 |
| TERMINOLOGY | H A D | 03-Jun-2016 | 1.8 KiB | 57 | 50 |
| aclocal.m4 | H A D | 20-Jun-2019 | 29.9 KiB | 851 | 755 |
| autogen.sh | H A D | 29-Mar-2018 | 3.1 KiB | 129 | 101 |
| config.guess | H A D | 18-Dec-2012 | 43.9 KiB | 1,502 | 1,291 |
| config.sub | H A D | 18-Dec-2012 | 33.6 KiB | 1,706 | 1,558 |
| configure | H A D | 03-May-2022 | 143.6 KiB | 5,061 | 4,086 |
| configure.ac | H A D | 20-Jun-2019 | 9.5 KiB | 343 | 248 |
| gimp-help.doap | H A D | 13-Sep-2018 | 3.5 KiB | 88 | 82 |
| install-sh | H A D | 18-Dec-2012 | 13.3 KiB | 521 | 344 |
| missing | H A D | 18-Dec-2012 | 11.2 KiB | 377 | 281 |
README
1===========
2 GIMP-Help
3===========
4
5GIMP-Help is a help system designed for use with the internal GIMP help
6browser, external web browser and HTML renderers, and human eyeballs.
7Docbook is used to create a highly customizable system for all needs.
8
9The current manual documents features for GIMP 2.10.
10
11
12Project page and news
13=====================
14
15Recent changes and updates about the modules are available at:
16
17 https://www.gimp.org/docs/
18
19
20Tips for contribution
21=====================
22
23Write a mail to one of the authors (check the WIKI).
24They should know what tasks need to be done and can find something to
25do for you. You should subscribe to the gimp mailing lists to get up
26to date information of the current GIMP development.
27
28 What you should know
29 --------------------
30
31 You should know a bit about Docbook and XML, or be smart enough to learn
32 the syntax yourself. You can get more information about Docbook and XML
33 by using your preferred search engine.
34
35 Editors, Programs and Setups
36 ----------------------------
37
38 Use any editor you want, but you should handle it well. Please keep in
39 mind, that the tab width in XML Mode should be 2 spaces. It is
40 recommended to attach patches to a bug report. Creating patches with
41 git is probably better described at https://wiki.gnome.org, but in
42 short:
43
44 git format-patch HEAD^
45
46 to create a patch with your last local commits.
47
48 Provided you have xmllint installed, you can validate the XML
49 and check the well-formedness of the XML files by running
50
51 make validate
52
53 When you edit an XML file and want to quickly check your changes,
54 you can create a single quick-and-dirty HMTL draft file with
55
56 make src/of/the/xml-file.draft
57
58 where the target is the path name with extension ".draft" instead
59 of ".xml", or with
60
61 make preview-src/of/the/xml-file.xml
62
63 where the path name is preceded with "preview-".
64
65 The name of the HMTL draft file depends on its id (not on the name
66 of the XML source file!) and is displayed when the file is created.
67
68
69 Hints for making good screenshots
70 ---------------------------------
71
72 * please make screenshots only with the system default theme, which
73 is of course just the plain gtk+ default look
74 * use default fonts like Bitstream Vera Sans
75 * crop the window manager borders
76 * before saving an image as PNG, check if you can convert it to indexed
77 mode without loss of quality (saves space and bandwidth)
78 * provide your source images (eg. for making new screenshots in other
79 languages)
80
81Creating a Release
82==================
83
84Before you create a release you'll need:
85
86 * be a maintainer
87 * have ssh access to pentagon.gimp.org
88 * have access to http://www.gimp.org/admin/
89
90Steps
91-----
92
93* Make sure that all XML is valid. Run:
94
95 make validate-all
96
97* Prepare the NEWS file, by adding an additional release, bugs fixed and
98 contributors. You can use a little shortcut for compiling the
99 contributors using git shortlog (<release tag> is the tag of the last
100 release):
101
102 git shortlog -sn <release tag>..HEAD
103
104
105* Check if the authors.xml have to be adjusted for this release. (Not
106 needed for every minor release).
107
108* Bump the version number (help_(major, minor, micro)_version) in
109 configure.ac, commit, push. Rule of thumb: It should be documented the
110 current GIMP stable release. The minor version aligns therefore with
111 the current stable release.
112
113 vi configure.ac
114
115* Create a distribution package:
116
117 make dist
118
119* Tag the release:
120
121 git tag -s
122
123 Rule of thumb: Use capital case, whitespace delimited by underscores.
124
125* Copy the *.bz2 on to pentagon.gimp.org:/srv/ftp/pub/gimp/help/:
126
127 scp gimp-help-*.tar.* pentagon.gimp.org:/srv/ftp/pub/gimp/help/
128
129 Verify the tarball appears on:
130
131 http://download.gimp.org/pub/gimp/help/
132
133* Announce the release on http://www.gimp.org/admin/. Click on `Pending
134 News` → `New News`, fill in the form (subject, announce), choose a
135 reading wilber and press `Save`. Depending if it needs review (ask one
136 of the developers), approve it to publish it.
137
138* Announce the release on our mailing lists:
139
140 GIMP Developer
141 https://mail.gnome.org/mailman/listinfo/gimp-developer-list
142
143 GIMP User
144 https://mail.gnome.org/mailman/listinfo/gimp-user-list
145
146 GIMP Docs
147 https://mail.gnome.org/mailman/listinfo/gimp-docs-list
148
149 Template:
150
151 GIMP Manual <version> released
152
153 We've released a new version of the user manual with:
154
155 * <Changelog here>
156
157 Download the packages from our download software.
158
159 For easy installation we suggest that you wait until an installer for this
160 release has been packaged for your platform. Find more releases and information
161 about our goals and how you can help at https://docs.gimp.org.
162
163
164TODO
165====
166
167see Bugzilla:
168
169 https://gitlab.gnome.org/GNOME/gimp-help/issues
170
171
172
173ODF Files
174=========
175
176You need docbook2odf installed to create ODF files. Although the
177transformation process is very slow (because every picture is copied to
178a temp directory), you can start the transformation by typing:
179
180 make odf
181
182Hint: Set the ALL_LINGUAS environment variable to create ODF files only
183for a particular language.
184Docbook2ODF can be obtained from the following website:
185
186 http://open.comsultia.com/docbook2odf/
187
188HINT: If you get an error opening the created ODT files, open
189docbook2odf (probably installed in /usr/bin/) in a text editor.
190Uncomment the line:
191
192 #use encoding 'utf-8';
193
194and rerun 'make odf'.
195
196
197History of the gimp-help-2 module
198=================================
199
200The development on the original gimp-help modules came pretty much to a
201stop after the first few stable versions of GIMP 1.2 were released. This is
202due to several reasons, one of them being that all of the original
203documentation had been converted from HTML to DocBook/SGML and apart from a
204bit new content, lots of markup and proofreading not too much happened to
205the organization of the complete mess.
206
207Daniel Egger and Mel Boyce were not too happy about the quirks with
208this help system. So they started completely from scratch creating a new
209manual based on Docbook/XML.
210