Inaguration of G'MIC-GIMP Help

Software G'MIC
1

The first Help file is in place. I’ve created an overall structure for a help system which visually looks like this:

Help Home Page
|

  • Help Index by script internal name
    |
  • Help Index by script Menu name
    |
  • Help index by Author Name
       |
       + Help Index for author name XXXX (Eventually one page of this type per author)

Links to the initial pages are:
Help Home Page
Author Index
Internal Name Index
Menu Name Index
garagecoders Script Help Index
the first help page, garagecoders Wiremap

A simple help page template (copy-paste-replace text variety) exists on this page.

Due to limitations of the Wiki, links must be manually maintained, so if there are any proposed changes to naming syntax, let’s get them over with now. It is currently only 6 pages involved, and if they are to be reorganized, I would rather do it now, then after I have 50+ created. :wink:

Any and all comments/criticisms appreciated!

2 Likes
2

Ancillary to the help system is a Glossary page.

Not every user of G’MIC or GIMP is as knowledgeable as the authors of these scripts are. When it is unavoidable that unusual words be used in the help pages, I am documenting them here. When I write a help page I make the following assumptions:

1 This is the first time the reader has ever used The GIMP.
2 This is the first time the reader has ever used G’MIC.
3 This reader is not a graphic artist, programmer, or artist.
4 This reader is not a native English speaker.

Thus a glossary is almost required.

2 Likes
3

@jazzon, in the glossary, you say that greyscale images use 1 byte per pixel, but that’s true only in GIMP 2.8. In upcoming GIMP 2.9, values can be 16bits, 32bits or even 64bits floats per pixel, so speaking the number of bytes used to encode images is a bit risky. Same for color images, RGB may use 48bits or 96bits per pixel.

4

@David_Tschumperle Thanks for the heads up. I will change that information to be more generic.