RE: [Phpgroupware-docteam] phpdocs for phpgw api - actual status

[Brian Johnson]

Man, you're late to the party.

1. available docs
a) wiki
b) installed with apps
c) axisgroupware (some do not apply since they are specifically for axis
interface)
d) anything else that is discovered/found

2. required docs
a) online (wiki at docs.phpgroupware.org is good for this but needs
reorganization).  This could be reorganized to allow cron jobs to pull out
info for the other needs
b) installed with apps.  This could be a mirror of the wiki docs made with
scheduled cvs updates from the wiki docs.  Could the phpgw manual app be
resurrected to display this info for the end user?

3. tools to make required docs
IMO wiki is best.  No client setup, easy for newbies, useful for
quick/immediate changes.  Can be used to develop new docs .. can even be used
to create/test reorganization of official docs site.
Coordinator need only copy/paste sections to update official docs at
docs.phpgroupware.org
I prefer a wiki that can require login in order to easier track who made doc
changes.  However, the account registration should be automated so that users
can auto-create their own accounts.  I have used Twiki before for this.
This docdev wiki should have a clause at the initial screen highlighting that
all submitted content will be considered LGPL and copyright is assigned to GNU
(suitable wording can be developed)






Kai Hofmann (address@hidden) wrote:
>
> Hi all,
>
> > These are intended for developers correct?  They pull info
> > from the inline docs and create pages from them?
>
> correct.
>
> > What about user docs?
>
> Thats the next topic.
> At first it would be good to have two lists:
>
> 1. Already available documentation
> 2. Required documentation (independent of point 1!)
>
> To my best knowledge there are the following sources:
>
> 1. docs within the phpgw installation - some in docs subdirectories - some
> otherwhere
>    can someone please create a list for these?
>
> 2. things in the wiki (which might be offline at the moment do to a server
> change - see daves mail).
>
> 3. some docs (developer and user) at the axis project
>
> 4. I thought there where also docs at ceb's page at "funkwerk"
>
>
> Others ?
>
>
> Greetings
>
>    Kai
>
>
> --
> *****    Open Source und Linux im professionellen Einsatz    *****
> **  komplexe Mailserver, Groupware, Office: sprechen Sie uns an **
> Dipl.-Inform. Kai Hofmann                    Team Softwarelösungen
> pro|business AG, EXPO Plaza 1 (Deutscher Pavillon), 30539 Hannover
> E-Mail: address@hidden,   Tel.: 0511/60066-332, Fax: -355
> WWW: http://www.probusiness.de/
>
>
> _______________________________________________
> Phpgroupware-docteam mailing list
> address@hidden
> http://mail.gnu.org/mailman/listinfo/phpgroupware-docteam
>