Documentation!

[GameMonetize]

Thanks to great folks at Sokrate, we now have a first version of a documentation:

 

http://www.sokrate.fr/documentation/babylonjs/index.html

 

 

Big thanks to Temechon and his team

[Temechon]

My pleasure !

 

I would like to ask, if any of you guys have some update to do on a specific function or a class, don't hesitate to send me a PM, I will update the documentation quickly !

[dav74]

Thank you very much Temechon

[Dad72]

Super cool. A big thank you to Temechon and his team.

[Ariel Yust]

Hallelujah ! great stuff thanks 

[isigui]

Thank you !!

[Temechon]

Hi all, 

 

The documentation has been updated to version 1.8.0 of babylon (with the awesome physics engine). You can find it here : http://www.sokrate.fr/documentation/babylonjs/index.html

 

Doncha think that aquamarine green on white background... sort of sucks? ;/

 

Sadly for Wingnut, the template has not been updated If it's a big ask from the community, we can obvisouly change it.

 

Cheers !

[brainlab]

Great.

Just what I was looking for.

[Dad72]

Error in documentation:
 
Class: PickingInfo
pickedPoint return BABYLON.Vector3 (no Vector2)

Class: Scene
Pick add the camera a signature: pick(x, y, predicate, fastCheck, camera);

 

Thanks

[Temechon]

Hi all, 

 

The documentation has been updated to version 1.9.0 of babylon. Still the same link : http://www.sokrate.fr/documentation/babylonjs/index.html

The babylon.js version has been added in the documentation title.

 

The old version (1.8.0) can be found here : http://www.sokrate.fr/documentation/babylonjs/1.8.0/index.html

 

I tried to take into account all your remarks/PM. If I forgot something, please send me a message.

 

Cheers !

[Dad72]

Thank you, however pick() has disappeared from the mesh class (1.8.0 and 1.9.0)

[Temechon]

I cannot find any method called 'pick' in the class Mesh in babylon.js => Not in babylon.js, not in the documentation !

[Dad72]

Ah yes, I was wrong, pick is in the Scene class.

Sorry

[Dad72]

Is it is possible to have classes in a margin (left for example) rather than a select menu.

 

This select menu is not practical when one seeks a class then another.

[Temechon]

I use an automatic template with jsdoc to generate the website : let me check if there is any other template that could fit this need.

 

In the mean time, check this : http://www.sokrate.fr/documentation/babylonjs/classes.list.html

[Dad72]

Should the margin is always present left when one is in a class.

 

I hope that you will find a template.

 

Thanks Temechon

[Wingnut]

Dad72...  there are currently 86 classes and surely more to come.  That means the left-margin list-of-classes would need to scroll.  A scrolling left-margin list of classes... would conflict with the scrolling of the rest of the page.  Its still possible, using focus changing... but... what would you gain?  You would still (sometimes) have to scroll down through a list of classes like you do now.

 

You can only get about 35 items in a left margin list (without scrolling) and still have the font be readable-sized. If you could get the left margin list of classes to scroll independently, it would still be over 3 screens of scrolling (at the current Sokrate font size).  You gain very little class selectability, and you will lose about 25% of screen width area.

 

http://webpages.charter.net/wingthing/html/propIndex.htm  *shrug*

[Dad72]

I find it well as on your link with the left margin.

[Wingnut]

But only 35 items in my left margin, and with small fonts.  We have 86 classes in BJS, so the Sokrate left margin would need to scroll vertically... lots.  We might be at 150 classes in two years.

 

My guess... 25 CLASS items per screen using Sokrate current font size.  So you would have to scroll that left margin area...  6 screens... to get from top to bottom.  Do you understand what I am saying? 

 

The current pull-down CLASS menu makes you scroll up and down a little, but a left-margin method of CLASS selection, would also make you scroll up and down a little.  Would you gain CLASS-selecting speed with the left margin method?  Not much, I think.  Just my opinion.

 

Some expert html template writer could sure try your method.  It's certainly possible.  It would be interesting to see it and test drive it.  A person would have to study JsDoc quite a bit, probably.  *shrug*

[Dad72]

No, if the body of page is in an iframe, then the scroll of the margin will remain a position when we click on a class.

 

for my part, I find it more convenient to have a margin to find a class... The navigation  menus selection <select> is less obvious.

[Wingnut]

Nod.  I found a few... but not sure if Temechon would want to try them out.  And, they might be non-standard.

 

https://groups.google.com/forum/#!topic/jsdoc-users/lVz20dcVHo4  A couple links there to a 'classes sidebar' version.

 

Here is another...

 

http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/

 

There is a picture of one here...

 

http://css.dzone.com/articles/introduction-jsdoc

 

None of these examples show a long classes list, so it's difficult to see how well that would work.

 

*shrug*  I'm easy.  Temechon might not be. 

[Dad72]

The 2 and 3 link looks interesting.

[Dad72]

The documentation is not updated? There should be a official documentation for babylon, rather than community documentation. In the case of abandonment, the documentation is not updated as it might be the case here.

There should be a documentation also explains what functions and examples of basic usage would make a really perfect documentation.

 

I have the right to dream. 

 

A perfect documentation attracts many users. If you look at the documentation of Unity3D (for exemple), there are many users because their documentation is great, perfect .

[Temechon]

Hello all ! Long time no see

 

The documentation has been updated to the version 1.11 of our favorite 3D engine : BabylonJS !

 

http://www.sokrate.fr/documentation/babylonjs/index.html

 

As usual, if you see any mistake, send me a PM (with a beer please )

[Dad72]

Cool, Temechon. Thank you. We believed that you do more will update this documentation.