Eric wrote: > WRT documentation standards, I ran a few small scripts on the source > directory tree for the display, general, raster, and vector commands to see > how much variation there is in the use of different headings and sections > within the description.html pages. > > I've attached the listing for the raster commands; as you can see, there's a > fair bit of variation in the wording of sections in the html pages. If the > goal is to use a uniform documentation style, we should probably figure out > which headings are going to be accepted. I know it's not the most pressing > issue, but a common style could save a lot of work in re-writes in the > future. > > OTOH, it may be deemed more important to allow flexibility in the use of > headings for each module's html page. > > Ideas?
Auto-generated (usually) ======================== <H2>NAME</H2> <H2>KEYWORDS</H2> <H2>SYNOPSIS</H2> * = Required ! = Suggested . = Optional In recommended order -------------------- * <H2>DESCRIPTION</H2> ! <H2>NOTE</H2>, <H2>NOTES</H2> ! <H2>EXAMPLE</H2>, <H2>EXAMPLES</H2> . <H2>TODO</H2> . <H2>BUGS</H2> . <H2>REFERENCE</H2>, <H2>REFERENCES</H2> * <H2>SEE ALSO</H2> * <H2>AUTHOR</H2>, <H2>AUTHORS</H2> more in this added to the wiki page: http://grass.gdf-hannover.de/wiki/Updating_GRASS_Documentation Hamish __________________________________________________ Do You Yahoo!? Tired of spam? Yahoo! Mail has the best spam protection around http://mail.yahoo.com _______________________________________________ grass-dev mailing list [email protected] http://grass.itc.it/mailman/listinfo/grass-dev
