Table of contents for Fluid user manual

Anastasia Cheetham a.cheetham at utoronto.ca
Mon Jun 2 14:24:18 UTC 2008


On 30-May-08, at 3:00 PM, Paul Zablosky wrote:

> I have been giving some thought to Anastasia's points about "release  
> specific manual pages".   My current feeling is that they be  
> included in the ToC, along with the release-independent versions.   
> This gives the reader of the manual a comprehensive view of the  
> material, some of which is general, and some of which refers to a  
> particular release.  If the page naming scheme reflects the  
> distinction, a glance at the ToC will inform the user which is which.


I'm worried that including both versions of the API portion of the ToC  
might be too overwhelming. Also, what happens when we release verion  
0.4? and 0.6?

I suggest a separate release specific version of the API portion of  
the ToC, with a link to that in the live, 'trunk' version of the ToC.  
This seems more forward looking, so we could have something like this:

API Documents
   Released documents
     0.3 Documents
     0.4 Documents
     0.6 Documents
   Live Documents      (don't like this name - suggestions?
     Simple List Reorderer Api
     ...


-- 
Anastasia Cheetham                   a.cheetham at utoronto.ca
Software Designer, Fluid Project    http://fluidproject.org
Adaptive Technology Resource Centre / University of Toronto




More information about the fluid-work mailing list