dynapi-help

RE: [Dynapi-Help] Agree with Jack

[Jannon F. <ja...@CS...>]

New Guy here,

So I'm a long time user of the original DynAPI and am all too familiar with
the frustrations involved in using that one and having to tweak it for your
specific purposes.  I mean I was glad to have it, but I'm really stoked
about DynAPI 2. Anyway, decent API documentation is something I am missing.
To that end, last week I started to create a documentation system.  I've got
a real rough mysql schema  with tables for packages, classes, methods,
properties, parameters, etc.  I was just going to set up some servlets and
have my own little system, but I think others would benefit.  There are two
issues:
	1. I don't have an mysql account somewhere static (I can't serve off my
machine)
	2. Documentation bores the hell out of me

But I'm more than willing to offer my beginnings as a starting point.  It
could definitely use some more thinking through and discussion.  I
orignially started working with Java API documentation in mind.  I'm also
willing to help develop and host the interface (preferrably using JSP).
So, I guess I'll put the sql files up somewhere and we can let the
discussion begin.

-jannon

-- "Sometimes the majority only means that all the fools
	 are on  the same side."
	- ??

> -----Original Message-----
> From: dyn...@li...
> [mailto:dyn...@li...]On Behalf Of Tarun
> Sent: Thursday, October 26, 2000 8:08 AM
> To: 'dyn...@li...'
> Subject: [Dynapi-Help] Agree with Jack
>
>
> I believe that what Jack says is quite correct. Newbies like us
> would love to
> contribute something what the experts dont have time to do ,like
> maintaining
> API  documentation (which currently is very little), maybe a
> searchable help
> system...
>  If we know where to start we could get working pronto :-)
> _______________________________________________
> Dynapi-Help mailing list
> Dyn...@li...
> http://lists.sourceforge.net/mailman/listinfo/dynapi-help

Re: [Dynapi-Help] Agree with Jack

[Scott A. L. <sc...@sc...>]

I think that's a great idea.  Especially if it's able to be searchable. 
It would be a great supplement to detailed docs.

I'd like to get something up similar to what they have at www.php.net,
where almost every object/method/property is available through searching
or directory.

Sorry, I don't know where to host it.  Is there a place that offers free
mysql accounts?

scottandrew

Jannon Frank wrote:
> 
> New Guy here,
> 
> So I'm a long time user of the original DynAPI and am all too familiar with
> the frustrations involved in using that one and having to tweak it for your
> specific purposes.  I mean I was glad to have it, but I'm really stoked
> about DynAPI 2. Anyway, decent API documentation is something I am missing.
> To that end, last week I started to create a documentation system.  I've got
> a real rough mysql schema  with tables for packages, classes, methods,
> properties, parameters, etc.  I was just going to set up some servlets and
> have my own little system, but I think others would benefit.  There are two
> issues:
>         1. I don't have an mysql account somewhere static (I can't serve off my
> machine)
>         2. Documentation bores the hell out of me
> 
> But I'm more than willing to offer my beginnings as a starting point.  It
> could definitely use some more thinking through and discussion.  I
> orignially started working with Java API documentation in mind.  I'm also
> willing to help develop and host the interface (preferrably using JSP).
> So, I guess I'll put the sql files up somewhere and we can let the
> discussion begin.
> 
> -jannon
> 
> -- "Sometimes the majority only means that all the fools
>          are on  the same side."
>         - ??
> 
> > -----Original Message-----
> > From: dyn...@li...
> > [mailto:dyn...@li...]On Behalf Of Tarun
> > Sent: Thursday, October 26, 2000 8:08 AM
> > To: 'dyn...@li...'
> > Subject: [Dynapi-Help] Agree with Jack
> >
> >
> > I believe that what Jack says is quite correct. Newbies like us
> > would love to
> > contribute something what the experts dont have time to do ,like
> > maintaining
> > API  documentation (which currently is very little), maybe a
> > searchable help
> > system...
> >  If we know where to start we could get working pronto :-)
> > _______________________________________________
> > Dynapi-Help mailing list
> > Dyn...@li...
> > http://lists.sourceforge.net/mailman/listinfo/dynapi-help
> 
> _______________________________________________
> Dynapi-Help mailing list
> Dyn...@li...
> http://lists.sourceforge.net/mailman/listinfo/dynapi-help

Re: [Dynapi-Help] Agree with Jack

[Richard :o\) <ma...@ri...>]

hi,
http://www.freesqlhost.com/register.asp
should be free but I haven't tried it,
http://www.brinkster.com/ offers asp (jsp also I presume) support with
access database but no global.asa and no ftp and a little slow sometimes.

cheers,
Richard

----- Original Message -----
From: "Scott Andrew LePera" <sc...@sc...>
To: <dyn...@li...>
Sent: Friday, October 27, 2000 1:18 AM
Subject: Re: [Dynapi-Help] Agree with Jack


> I think that's a great idea.  Especially if it's able to be searchable.
> It would be a great supplement to detailed docs.
>
> I'd like to get something up similar to what they have at www.php.net,
> where almost every object/method/property is available through searching
> or directory.
>
> Sorry, I don't know where to host it.  Is there a place that offers free
> mysql accounts?
>
> scottandrew
>
> Jannon Frank wrote:
> >
> > New Guy here,
> >
> > So I'm a long time user of the original DynAPI and am all too familiar
with
> > the frustrations involved in using that one and having to tweak it for
your
> > specific purposes.  I mean I was glad to have it, but I'm really stoked
> > about DynAPI 2. Anyway, decent API documentation is something I am
missing.
> > To that end, last week I started to create a documentation system.  I've
got
> > a real rough mysql schema  with tables for packages, classes, methods,
> > properties, parameters, etc.  I was just going to set up some servlets
and
> > have my own little system, but I think others would benefit.  There are
two
> > issues:
> >         1. I don't have an mysql account somewhere static (I can't serve
off my
> > machine)
> >         2. Documentation bores the hell out of me
> >
> > But I'm more than willing to offer my beginnings as a starting point.
It
> > could definitely use some more thinking through and discussion.  I
> > orignially started working with Java API documentation in mind.  I'm
also
> > willing to help develop and host the interface (preferrably using JSP).
> > So, I guess I'll put the sql files up somewhere and we can let the
> > discussion begin.
> >
> > -jannon
> >
> > -- "Sometimes the majority only means that all the fools
> >          are on  the same side."
> >         - ??
> >
> > > -----Original Message-----
> > > From: dyn...@li...
> > > [mailto:dyn...@li...]On Behalf Of Tarun
> > > Sent: Thursday, October 26, 2000 8:08 AM
> > > To: 'dyn...@li...'
> > > Subject: [Dynapi-Help] Agree with Jack
> > >
> > >
> > > I believe that what Jack says is quite correct. Newbies like us
> > > would love to
> > > contribute something what the experts dont have time to do ,like
> > > maintaining
> > > API  documentation (which currently is very little), maybe a
> > > searchable help
> > > system...
> > >  If we know where to start we could get working pronto :-)
> > > _______________________________________________
> > > Dynapi-Help mailing list
> > > Dyn...@li...
> > > http://lists.sourceforge.net/mailman/listinfo/dynapi-help
> >
> > _______________________________________________
> > Dynapi-Help mailing list
> > Dyn...@li...
> > http://lists.sourceforge.net/mailman/listinfo/dynapi-help
> _______________________________________________
> Dynapi-Help mailing list
> Dyn...@li...
> http://lists.sourceforge.net/mailman/listinfo/dynapi-help
> ____________________________________________________________
> Get your FREE personal .com domain name and
> NAMEzero Personal Portal at: http://www.namezero.com.
> For customer service, mailto:cus...@na....
>
>

Re[2]: [Dynapi-Help] Agree with Jack

[Robert R. <rai...@us...>]

Since the project is hosted at sourceforge, we have a free web server
with PHP and MySQL support.  I would suggest we take advantage of
that, especially since its free.  PHP is not very hard to learn
especially for what we would need it for.


Later,
Robert <rai...@us...>

> hi,
> http://www.freesqlhost.com/register.asp
> should be free but I haven't tried it,
> http://www.brinkster.com/ offers asp (jsp also I presume) support with
> access database but no global.asa and no ftp and a little slow sometimes.
> 
> cheers,
> Richard

Re[3]: [Dynapi-Help] Agree with Jack

[Robert R. <rai...@us...>]

Also, I would also be interested in creating a sort of DynAPI portal at
dynapi.sourceforge.net that could have the latest news/info on the
dynapi.  Plus have a section for peoples personal contributions
(widgets, etc).  And of course have the documentation there as well.
As it is now, there is not a central place for this type of information.

Later,
Robert <rai...@us...>

[Dynapi-Help] About DynAPI portal and documentation project

[Tarun R E. <ta...@we...>]

There seems to be a lot of mail flying back and forth about the
documentation project with seemingly no consensus, about which server should
be the base and about what version of the API we should document.

I personally dont see the point of documenting version 1 because
Dansteinmans site does that fairly well already. DynAPI2 should be the main
focus here, I believe.

It would be a fairly good idea to put DynAPI docs at sourceforge itself,
since it makes more sense to have everything at one place.

I wasnt  aware that sourceforge offers MySQL support. The only disadvantage
is that sourceforge offers just PHP support, not Serlvet,JSP or Perl
support.

 But I guess Rainwater is correct in saying that the advantage(s) in having
everything at one place, exceeds the advantage(s) of having the freedom of
development platform..

That also means that some of us will have to learn PHP  :-)

( I apologize for submitting this message to the help list as it technically
should go into open discussion, however it seems that no-one is on the
open-discussion mailing list)


----- Original Message -----
From: "Robert Rainwater" <rai...@us...>
To: "Robert Rainwater" <dyn...@li...>
Sent: Friday, October 27, 2000 5:46 PM
Subject: Re[3]: [Dynapi-Help] Agree with Jack


>
> Also, I would also be interested in creating a sort of DynAPI portal at
> dynapi.sourceforge.net that could have the latest news/info on the
> dynapi.  Plus have a section for peoples personal contributions
> (widgets, etc).  And of course have the documentation there as well.
> As it is now, there is not a central place for this type of information.
>
> Later,
> Robert <rai...@us...>
>
>
> _______________________________________________
> Dynapi-Help mailing list
> Dyn...@li...
> http://lists.sourceforge.net/mailman/listinfo/dynapi-help
>

Re: [Dynapi-Help] About DynAPI portal and documentation project

[Scott A. L. <sc...@sc...>]

I think what Jordan meant was that he's building empty page templates
based on Dan's original Dynamic Duo tutorial, to be used for DynAPI2
documentation.  It's not a bad idea.

I'd like to see a central location for everything too, preferably at
SourceForge.  A 'portal' where the public can get the latest news and
grab documentation and widget sets.

I agree with Tarun, and would like to add that if we are getting serious
about documenting the DynAPI2, we should probably choose a *standard*
format and divide the work up among us.  There's no point in everyone
running off to do their own documentation of the API, and wind up with
four different versions. Maybe we should divide into teams to get the
docs finished.

Once we have the DB up and format decided, I would be happy to see even
only two or three classes and their methods/properties documented each
day. It doesn't have to be done all in one day and it certainly
shouldn't be done in a hurry, IMO.

As an aside, I used to be a copywriter and proofreader, and would be
happy to edit and proof anyone's articles or documentation.

scottandrew

Tarun R Elankath wrote:
> 
> There seems to be a lot of mail flying back and forth about the
> documentation project with seemingly no consensus, about which server should
> be the base and about what version of the API we should document.
> 
> I personally dont see the point of documenting version 1 because
> Dansteinmans site does that fairly well already. DynAPI2 should be the main
> focus here, I believe.
> 
> It would be a fairly good idea to put DynAPI docs at sourceforge itself,
> since it makes more sense to have everything at one place.
> 
> I wasnt  aware that sourceforge offers MySQL support. The only disadvantage
> is that sourceforge offers just PHP support, not Serlvet,JSP or Perl
> support.
> 
>  But I guess Rainwater is correct in saying that the advantage(s) in having
> everything at one place, exceeds the advantage(s) of having the freedom of
> development platform..
> 
> That also means that some of us will have to learn PHP  :-)
> 
> ( I apologize for submitting this message to the help list as it technically
> should go into open discussion, however it seems that no-one is on the
> open-discussion mailing list)
> 
> ----- Original Message -----
> From: "Robert Rainwater" <rai...@us...>
> To: "Robert Rainwater" <dyn...@li...>
> Sent: Friday, October 27, 2000 5:46 PM
> Subject: Re[3]: [Dynapi-Help] Agree with Jack
> 
> >
> > Also, I would also be interested in creating a sort of DynAPI portal at
> > dynapi.sourceforge.net that could have the latest news/info on the
> > dynapi.  Plus have a section for peoples personal contributions
> > (widgets, etc).  And of course have the documentation there as well.
> > As it is now, there is not a central place for this type of information.
> >
> > Later,
> > Robert <rai...@us...>
> >
> >
> > _______________________________________________
> > Dynapi-Help mailing list
> > Dyn...@li...
> > http://lists.sourceforge.net/mailman/listinfo/dynapi-help
> >
> 
> _______________________________________________
> Dynapi-Help mailing list
> Dyn...@li...
> http://lists.sourceforge.net/mailman/listinfo/dynapi-help

RE: [Dynapi-Help] About DynAPI portal and documentation project

[Jordan L. <jo...@ex...>]

i believe no one even mentiond documenting version 1.
i said that i'm using the document layout and style from version 1 to
provide templates for the documentation to version 2. i'm not into writing
the documents yet, just the templates.

after that, anyone that wants to provide documentation to the widgets he
built
can write them into the template, thus all the documentation will have a
similar format. = easy for a newbie to navigate!

as a recall, documentation came also with DynAPI 1 distribution, and i thing
it can come
in the site as well as in the distribution of API2


Cheers
Jordan.


-----Original Message-----
From: dyn...@li...
[mailto:dyn...@li...]On Behalf Of Tarun R
Elankath
Sent: Friday, October 27, 2000 4:49 PM
To: dyn...@li...
Subject: [Dynapi-Help] About DynAPI portal and documentation project


There seems to be a lot of mail flying back and forth about the
documentation project with seemingly no consensus, about which server should
be the base and about what version of the API we should document.

I personally dont see the point of documenting version 1 because
Dansteinmans site does that fairly well already. DynAPI2 should be the main
focus here, I believe.

It would be a fairly good idea to put DynAPI docs at sourceforge itself,
since it makes more sense to have everything at one place.

I wasnt  aware that sourceforge offers MySQL support. The only disadvantage
is that sourceforge offers just PHP support, not Serlvet,JSP or Perl
support.

 But I guess Rainwater is correct in saying that the advantage(s) in having
everything at one place, exceeds the advantage(s) of having the freedom of
development platform..

That also means that some of us will have to learn PHP  :-)

( I apologize for submitting this message to the help list as it technically
should go into open discussion, however it seems that no-one is on the
open-discussion mailing list)


----- Original Message -----
From: "Robert Rainwater" <rai...@us...>
To: "Robert Rainwater" <dyn...@li...>
Sent: Friday, October 27, 2000 5:46 PM
Subject: Re[3]: [Dynapi-Help] Agree with Jack


>
> Also, I would also be interested in creating a sort of DynAPI portal at
> dynapi.sourceforge.net that could have the latest news/info on the
> dynapi.  Plus have a section for peoples personal contributions
> (widgets, etc).  And of course have the documentation there as well.
> As it is now, there is not a central place for this type of information.
>
> Later,
> Robert <rai...@us...>
>
>
> _______________________________________________
> Dynapi-Help mailing list
> Dyn...@li...
> http://lists.sourceforge.net/mailman/listinfo/dynapi-help
>


_______________________________________________
Dynapi-Help mailing list
Dyn...@li...
http://lists.sourceforge.net/mailman/listinfo/dynapi-help