[Pipet Devel] important changes to docs

[Gary Van Domselaar]

"J.W. Bizzaro" wrote:
> 
> Locians,
> 
> ***ALL DOCUMENTATION (INCLUDING THE DOCUMENTATION WEB PAGES THAT GARY
> MADE) FOR LOCI WILL BE KEPT IN THE LOCI-DOC MODULE AND MODIFIED VIA THE
> CVS SYSTEM.  AND THE CONTENTS OF LOCI-DOC WILL BE IN THE DOCUMENTATION
> DIRECTORY ON THE WEB: THEY ARE TO BE THE SAME.
> 
> This way, Gary, David, myself and others can all work on parts of the
> documentation from one source, and keep it in one place.

Absotively fantabulous idea!


> 
> Major changes:
> 
> (1) What was in the root directory of the module
> 
>       loci-doc
> 
>     is now in
> 
>       loci-doc/manual/
> 
> (2) What was in the Web directory
> 
>       loci/documentation/
> 
>     is now in the root directory of the module
> 
>       loci-doc
> 
>     ***That Web directory is therefore the check(ed)out loci-doc from CVS.
> 
> (3) What was in the Web directory
> 
>       loci/documentation/official/
> 
>     which was simply the contents of loci-doc, is now
> 
>       loci/documentation/manual/
> 
>     and as mentioned above in (1) is in the module directory
> 
>       loci-doc/manual/

got it.

> 
> (4) The name 'Loci Documentation Project' previously described the
> contents of the loci-doc module.  Since the contents are now in
> loci-doc/manual, the name is 'Loci Users Manual'.  (This needs to be
> changed still in the TOC, Gary.)

done.

> 
> (5) The screenshots directory is used mostly by the documentation, so the
> Web directory
> 
>       loci/screenshots/
> 
>     is now
> 
>       loci/documentation/screenshots/

Updated the ToC here, too.

> 
>     and is therefore in the module directory
> 
>       loci-doc/screenshots/

  

> 
> ***I REPEAT: ALL DOCUMENTATION FOR LOCI WILL BE KEPT IN THE LOCI-DOC
> MODULE AND MODIFIED VIA THE CVS SYSTEM.  AND THE CONTENTS OF LOCI-DOC WILL
> BE IN THE DOCUMENTATION DIRECTORY ON THE WEB: THEY ARE THE SAME.
> 

I just made a small change to the loci-doc module as a test. It seems to
work nicely, but how about publishing the updated web documentation?  
Transplanting the cvs docs to the actual web docs is an administrative
issue, so perhaps we should discuss the protocol on admin list?  BTW,
I'll mark-up your posting and add it to the Loci Development pages.

On a related, nit-picking, semantics note, we currently describe the
Loci Manual as a technical description of the various loci components. 
Do we plan to use that document as described (currently it is just a
skeleton of the 'various loci components')?  I suggest we make that
document a users guide, and have an extra link on the documentation page
(white pages) where we publish our technical essays on Loci.




-- gary
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Gary Van Domselaar		gvd at redpoll.pharmacy.ualberta.ca
Faculty of Pharmacy 		Phone: (780) 492-4493
University of Alberta		FAX:   (780) 492-5305
Edmonton, Alberta, Canada       http://redpoll.pharmacy.ualberta.ca/~gvd