first consult the file ../README for a vague idea on the meaning of subdirectories. in doc do: for z in images/*.* images/*/*.*; do fgrep -q $z *.html || echo "$z"; done
 

GridFlow 0.4.1 - reference index

       

Note

Responsibilities

Release

Documentation

...



Note

 

Responsibilities

Frameworkmatjumain.c,dim.c,bitpacking.c,grid.[ch],operator.c
Grid Processorsmatjugrid_basic.c,grid_extra.c
Input/Outputmatjuio.c,format*.c
Build Processmatjuconfigure,Makefile
Test Suitematjutest1.c
Samplesmatjusamples/*
Documentationmatjudoc/*
Help Files and Documentation Picturesalxhelp/*,doc/images/*
Java/Swing Extensionsmatjujava/*
C Portmatjunofts.[ch]
Max Port?nil
Ruby Port?nil
Extrasmatjuextra/*
 

Release

Compatibility:
  • 1 : "support" for jMax 2.4 will stop when jMax 3.0 comes out, but it's not like we're actually testing our releases against jMax 2.4...
Release steps:
  • 1 : cvs tag gridflow_0_4 .
  • 2 : mkdir gridflow
  • 3 : cd gridflow
  • 4 : cvs -d hostname.2y.net:/home/cvs/gridflow export -r gridflow_0_4 .
  • 5 : rm -rf CVS CVSROOT
  • 6 : cd ..
  • 7 : tar cfz gridflow-0.4.tar.gz gridflow
  • 8 : rm -rf gridflow # caution!!!
 

Documentation

  • 1 : Pictures formerly identified as "samples" should be screenshots of the help files. The tag will be replaced by a tag.
  • 2 : Pictures identified as help must be real help. The source code of a template doesn't count as help.
  • 3 : A Help file is a visual summary of what an object does. It should be interactive and allow the user to understand what the object does. Sample inputs are provided and sample results can be seen.
  • 4 : All modifications to the documentation must be done in the XML. The HTML must be kept up-to-date by rerunning "make" in the "doc/" directory.
  • 5 : Help-wise, Formats are considered objects. Operators are to be documented as part of [@] and [@!].
  • 6 : Images grabbed directly from a jMax window should be encoded in PNG. This includes "icons" (object boxes, message boxes, etc). If they are in JPEG, only change to PNG when the image has to change anyway. Distinguish "icons" from "thumbnails", the latter of which are scaled-down grabs, which should be encoded in JPEG.
  • 7 : There are not help-thumbnails anymore in the reference manual because they were not helpful.
  • 8 : Large images should be kept out of the release. The release itself must be small enough not to discourage us from doing releases and keeping them all. It also should be downloadable on a bad modem. =) Let's keep it under 500k please.
 

...

CVS Quick Reference: environment variables CVSEDITOR=pico CVS_RSH=ssh2
 

GridFlow 0.4.1 Documentation
by Mathieu Bouchard matju@sympatico.ca and
Alexandre Castonguay acastonguay@artengine.ca