README 6.01 KB
Newer Older
1 2 3
===========
 GIMP-Help
===========
4 5

GIMP-Help is a help system designed for use with the internal GIMP help
Roman Joost's avatar
Roman Joost committed
6 7 8
browser, external web browser and HTML renderers, and human eyeballs. 
Docbook is used to create a highly customizable system for all needs. 

9
The current manual documents features for GIMP 2.10.
10

Sven Neumann's avatar
Sven Neumann committed
11

12
Project page and news
13
=====================
14

Sven Neumann's avatar
Sven Neumann committed
15
Recent changes and updates about the modules are available at:
16

17
  https://www.gimp.org/docs/
18

Sven Neumann's avatar
Sven Neumann committed
19

20
Tips for contribution
21
=====================
22

23
Write a mail to one of the authors (check the WIKI).
Sven Neumann's avatar
Sven Neumann committed
24 25 26
They should know what tasks need to be done and can find something to
do for you. You should subscribe to the gimp mailing lists to get up
to date information of the current GIMP development.
27 28 29 30 31

  What you should know
  --------------------

  You should know a bit about Docbook and XML, or be smart enough to learn
Sven Neumann's avatar
Sven Neumann committed
32
  the syntax yourself. You can get more information about Docbook and XML
33
  by using your preferred search engine.
34 35 36 37 38

  Editors, Programs and Setups
  ----------------------------

  Use any editor you want, but you should handle it well. Please keep in
Roman Joost's avatar
Roman Joost committed
39 40
  mind, that the tab width in XML Mode should be 2 spaces. It is
  recommended to attach patches to a bug report. Creating patches with
Piotr Drąg's avatar
Piotr Drąg committed
41
  git is probably better described at https://wiki.gnome.org, but in
Roman Joost's avatar
Roman Joost committed
42
  short: 
43

Roman Joost's avatar
Roman Joost committed
44
    git format-patch HEAD^
45

Roman Joost's avatar
Roman Joost committed
46
  to create a patch with your last local commits.
47

48 49
  Provided you have xmllint installed, you can validate the XML
  and check the well-formedness of the XML files by running
50

51
    make validate
52

53 54
  When you edit an XML file and want to quickly check your changes,
  you can create a single quick-and-dirty HMTL draft file with
55

56 57 58
    make src/of/the/xml-file.draft

  where the target is the path name with extension ".draft" instead
59 60 61 62 63 64 65 66
  of ".xml", or with

    make preview-src/of/the/xml-file.xml

  where the path name is preceded with "preview-".

  The name of the HMTL draft file depends on its id (not on the name
  of the XML source file!) and is displayed when the file is created.
67 68 69 70 71


  Hints for making good screenshots
  ---------------------------------

Sven Neumann's avatar
Sven Neumann committed
72 73
  * please make screenshots only with the system default theme, which
    is of course just the plain gtk+ default look
74
  * use default fonts like Bitstream Vera Sans
Sven Neumann's avatar
Sven Neumann committed
75
  * crop the window manager borders
76 77
  * before saving an image as PNG, check if you can convert it to indexed
    mode without loss of quality (saves space and bandwidth)
78
  * provide your source images (eg. for making new screenshots in other
79 80 81 82 83 84 85 86
    languages)

Creating a Release
==================

Before you create a release you'll need:

    * be a maintainer
87
    * have ssh access to pentagon.gimp.org
88 89 90 91 92 93 94 95 96 97
    * have access to http://www.gimp.org/admin/

Steps
-----

* Make sure that all XML is valid. Run:

    make validate-all

* Prepare the NEWS file, by adding an additional release, bugs fixed and
98 99 100 101 102 103
  contributors. You can use a little shortcut for compiling the
  contributors using git shortlog (<release tag> is the tag of the last
  release):

    git shortlog -sn <release tag>..HEAD

104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124

* Check if the authors.xml have to be adjusted for this release. (Not
  needed for every minor release).

* Bump the version number (help_(major, minor, micro)_version) in
  configure.ac, commit, push. Rule of thumb: It should be documented the
  current GIMP stable release. The minor version aligns therefore with
  the current stable release.

    vi configure.ac

* Create a distribution package:

    make dist

* Tag the release:

    git tag -s

  Rule of thumb: Use capital case, whitespace delimited by underscores.

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 130

  Verify the tarball appears on:

131
    http://download.gimp.org/pub/gimp/help/
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147

* Announce the release on http://www.gimp.org/admin/. Click on `Pending
  News` → `New News`, fill in the form (subject, announce), choose a
  reading wilber and press `Save`. Depending if it needs review (ask one
  of the developers), approve it to publish it.

* Announce the release on our mailing lists:

    GIMP Developer
    https://mail.gnome.org/mailman/listinfo/gimp-developer-list

    GIMP User
    https://mail.gnome.org/mailman/listinfo/gimp-user-list

    GIMP Docs
    https://mail.gnome.org/mailman/listinfo/gimp-docs-list
148

149 150 151 152 153 154 155 156 157 158 159 160
  Template:

      GIMP Manual <version> released

      We've released a new version of the user manual with:

        * <Changelog here>

      Download the packages from our download software.

    For easy installation we suggest that you wait until an installer for this
    release has been packaged for your platform. Find more releases and information
Piotr Drąg's avatar
Piotr Drąg committed
161
    about our goals and how you can help at https://docs.gimp.org.
162

163

164 165 166 167 168
TODO
====

see Bugzilla:

Piotr Drąg's avatar
Piotr Drąg committed
169
  https://gitlab.gnome.org/GNOME/gimp-help/issues
170

171

172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187

ODF Files
=========

You need docbook2odf installed to create ODF files. Although the
transformation process is very slow (because every picture is copied to
a temp directory), you can start the transformation by typing:

    make odf

Hint: Set the ALL_LINGUAS environment variable to create ODF files only
for a particular language. 
Docbook2ODF can be obtained from the following website:

    http://open.comsultia.com/docbook2odf/

188 189 190 191 192 193 194 195
HINT: If you get an error opening the created ODT files, open
docbook2odf (probably installed in /usr/bin/) in a text editor.
Uncomment the line:

    #use encoding 'utf-8';

and rerun 'make odf'.

196

197 198 199 200 201 202 203 204
History of the gimp-help-2 module
=================================

The development on the original gimp-help modules came pretty much to a
stop after the first few stable versions of GIMP 1.2 were released. This is
due to several reasons, one of them being that all of the original
documentation had been converted from HTML to DocBook/SGML and apart from a
bit new content, lots of markup and proofreading not too much happened to
205
the organization of the complete mess.
206

207 208 209
Daniel Egger and Mel Boyce were not too happy about the quirks with 
this help system. So they started completely from scratch creating a new
manual based on Docbook/XML.