[Qgis-community-team] manual conventions

[Stephan Holl]

Hallo Tara,

Tara Athan <tara_athan at alt2is.com>, [20080601 - 01:12:59]

> I have added a subsection to the Forward (in the Manual) to define
> style conventions, and implemented the styles in the Getting Started
> section. The conventions are defined as macros, so that we can easily
> change a convention and have it be uniformly applied throughout the
> manual. Examples are Buttons, Menu Options, text input by users and
> so on. Also included are macros that apply to instructions that are 
> platform-specific- see the Starting QGIS section for a demonstration.
> 
> The actual styles are placeholders- we can modify them to provide
> better visual cues to the reader. For example, we can add icons for
> the platform-specific instructions. At present the \tab macro is just
> a copy of the \button macro, but someone (with more latex experience
> than I) might write a style that looks more like a tab.
> 
> *********************************************************************
> * For this to work, we need all sections of the manual to be updated
> to use these macros. 
> * Would anyone like to volunteer to update a section (4-13) or
> appendix (A-H)?

I volunteer to update section 4-7 to include the new macro-usage.

> ***********************************************************************
> * We may find a need for additional macros as we go through the rest
> of the sections- please let us know if you
> * find a situation that doesn't fit into any of the existing macros
> and we will add a new one to the list.
> *******************************************************************************
> * Would anyone like to improve the macros? When I compile, (on
> Windows) I have missing font problems so I can't really
> * tell what it looks like. Ideally, the manual item should look very 
> similar to the GUI item.
> ***************************************************************************************


Do you have posted a timeline for updating the manuel so far?

Best regards

	Stephan


-- 
Stephan Holl <stephan.holl at intevation.de>, http://intevation.de/~stephan
Tel: +49 (0)541-33 50 8 32 | Intevation GmbH | AG Osnabrück - HR B 18998
Geschäftsführer:  Frank Koormann, Bernhard Reiter, Dr. Jan-Oliver Wagner