[Qgis-community-team] manual images

Tara Athan tara_athan at alt2is.com
Sat Jun 7 21:41:27 EDT 2008


There are some issues regarding images in the manual, and I would like 
to ask for opinions on the best way to get these resolved.
1. The GUI is being revised, with the icon images for tool buttons and 
options having different names, as well as new tools and options being 
added.
Alternatives I can think of are:
  A. Maintain parallel folders- keep the old image folders and add new 
image folders, called something like images_new. Add  commands to the 
Makefile to process both the new images as well as the old ones. Allow 
all manual editors to migrate to the new images at their convenience 
(but before the Version 1.0 release). Eventually all references to old 
images are removed, these image folders are deleted and the "new" suffix 
is dropped from the remaining image folders.
  B. One-Shot Switch. After the GUI freeze ( June 15) remove the old 
images, put in the new images, and ask everyone to help update the latex 
source. Missing images will give error messages when compiling that can 
be bypassed with Enter or quiet mode. The error messages could be 
helpful in finding all occurrences of old image names, but would also be 
annoying to anyone modifying the manual in other ways.


2. Up until now, images used in the GRASS toolbox have not been  used in 
the manual. These images have names like nviz.1.eps. This naming 
convention, or something like it, is required because some modules 
require a set of images to represent them, indicating for example, the 
starting format and the ending format of a conversion module. When 
referring to these images in the latex source, it is necessary to 
include the .eps extension, otherwise the \includegraphics macro looks 
for nviz.1 and can't find it.
Alternatives:
  A. Try to remember to use the .eps extension in the latex source when 
referring to these images, add a note to the wiki about it (prone to 
errors?)
  B. Change the naming convention in the source to not include an extra 
"." (perhaps a lot of trouble?)
  C. batch rename all the images when copying from the source to the manual
  D. rewrite the \includegraphics macro to accommodate this case

Please let me know what you think,

Tara


More information about the Qgis-community-team mailing list