Newton API Documentation

[aqnuep]

Hi,

I know this is an all-time-upcoming topic, but I would really like to emphasize that there is a great need at least for some very rough documentation of Newton.
As I see most of the general discussion forum's topics are all about misunderstanding of functions because of lack of documentation.

I would be in to make the documentation if I would receive the required information.
What is your opinion guys?

[samisaham]

I think that would be quite helpful, even just putting more detail/description into the wiki's listed api function would help greatly.

[Stucuk]

IMO it would be better if you expanded the Wiki rather than made offline documentation.

[aqnuep]

I totally agree, the Wiki is the perfect place for this.

My problem is that I also don't know most of the Newton API's functionality, just those that I already used and it would be quite hard to get all the needed information.

I would encourage all you Newton experts to participate in making the Wiki better.

I can start making Wiki pages, let say two or three per week, but my main problem is that I lack some of the needed knowledge and I don't want to mislead people by putting invalid information on the Wiki.

[JernejL]

It shouldn't be a problem, i made "blank" wiki pages with just function definition for most newton functions, you can just add descriptions, parameter meaning, purpose.. i did a few functions already ( NewtonWorldConvexCast ), and i'm sure we can collaborate on forum with Julio and clear up any unknown stuff about functions for the wiki, the undocumented functions are categorized:

http://newtondynamics.com/wiki/index.ph ... escription

[aqnuep]

Btw is there an online documentation for the legacy API functions? I mean those which were already in Newton 1.53.
Also is there some documentation about the legacy API functions that changed since 1.53?
I'm asking this because I can find no resource even on those.
Maybe I'm stupid and there is something that I haven't observed.

[Stucuk]

1.53 had offline documentation.

[Julio Jerez]

Hi,

I know this is an all-time-upcoming topic, but I would really like to emphasize that there is a great need at least for some very rough documentation of Newton.
As I see most of the general discussion forum's topics are all about misunderstanding of functions because of lack of documentation.

I would be in to make the documentation if I would receive the required information.
What is your opinion guys?

Actually that's a good idea,
send me a PM

[JernejL]

Btw is there an online documentation for the legacy API functions? I mean those which were already in Newton 1.53.
Also is there some documentation about the legacy API functions that changed since 1.53?
I'm asking this because I can find no resource even on those.
Maybe I'm stupid and there is something that I haven't observed.

ALL the 1.53 offline documentation was imported into wiki, it is all there.

[aqnuep]

Sorry, I know that there was an offline documentation unfortunately I didn't find it nowadays, but okay, unfortunately I'm not totally competent about these stuff. Anyway I'm into making a good documentation and I'll help as much as possible.

[JernejL]

Sorry, I know that there was an offline documentation unfortunately I didn't find it nowadays, but okay, unfortunately I'm not totally competent about these stuff. Anyway I'm into making a good documentation and I'll help as much as possible.

There was only for newton 1.53, newton 2.x has everything that there is up to now on the wiki.

[Carli]

is there a chance to grab the wiki contents to a .chm?

[JernejL]

is there a chance to grab the wiki contents to a .chm?

i'm not sure about export, but it is great to have it online as you can use google search on it directly.