Geometry Boost List: [ggl] Re: Started quickbook doc

Subject: [ggl] Re: Started quickbook doc
From: Barend Gehrels (Barend.Gehrels)
Date: 2010-01-10 13:21:02

Hi,

About the quickbook documentation / table of contents, discussed in 
december, sorry for the delay.

The ToC created with Quickbook is now:

Introduction
Quick Start
Design
    Introduction
    Using templates
    Using type traits
    dimension
    Coordinate type
    Geometry type
    Coordinate system
    Concepts
Modules
    Concepts
    Geometry
    Algorithms
Performance
Extensions

I compared it with the current documentation and with the documentation 
(ToC) several other Boost libraries.  And also with the current wiki.

With help of that I get the following proposal:

Introduction
Tutorial
    Quick start
    Examples
Library overview
    Design rationale
    Strategy rationale
    Spatial set-theoretic operations
    Robustness
Reference
    Geometries
        Concepts
        Provided geometries
        Adaption and registration
    Coordinate Systems
    Algorithms
        area
           formal description
           parameters
           complexity
           example
           notes
        etc.
    Strategies and policies
        for area
        ...
    Iterators
    Utilities
Extensions
    GIS
    GIS/projections
    Spatial Index
    SVG
    ...
Miscellaneous notes (or ordered differently)
    Relations
        Relation with Boost libraries
        Relation with Std library
        Relation with OGC (a.o. the matrix from the wiki)
    Release Notes (the current "status and preview" page)
    Compilation
        Supported compilers
        Hints
        Issues
    Performance
    Who uses Boost.Geometry
    Future work
    Acknowlegdements

Does this cover all subjects?

Furthermore I would like to see how the examples and code pieces (now 
within many algorithms) would look like...

Regards, Barend

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.osgeo.org/pipermail/ggl/attachments/20100110/7b929f60/attachment.html