Compiled Help using HelpNDoc

[kryton9]

I am using HelpNDoc to write a users help file. Please let me know of any corrections that need to be made or suggestions.

help version 004

[Peter]

Great work , Kryton9

By the way, if you cannot read the source code of Peter, take a pair of eyeglasses.
Try to get more light, if you read!   

[jcfuller]

Good stuff Kent.
Now all I need is to find out what /\ means in a class?
I probably knew it once but my remembering is even worse than yours

James

[kryton9]

Thanks guys.

@Peter I have a hard time reading yours and Charles code as you guys come from assembly and you are used to a style that makes perfect sense for assembly. When Charles and I were working on the glwindow class, he would change to his format when he did his updates and I would change to my style when I did mine... just a matter of what you are used to

@James I don't use the /\ in classes. I will work on finishing my classes so far and documenting them next. Hopefully that will help.

[Charles Pegge]

Thanks Kent, I'll look at it now.

The '/\' is used in class definitions. If you define all your properties and methods inside the class block then this symbol is not used.

If however you require the methods to be defined outside the class block then the '/\' marker separates the method prototypes and the static properties from the other properties in the object body. Methods cannot be defined inside the class block when this marker is present; only method prototypes can be declared.

The only time you really need it is when working with oxygen class library DLLs
Examples/OOP/ClassLibrary/

Charles

[Peter]

Kent,

Don't forget C! Is a pitty that this old days are gone.

Think on it, it's all Bits and Bytes, not more!

[kryton9]

I added some pages to test out a structure for the help. I created a winh.inc page that can be filled in by Aurel when he is ready.
I sort of figured out how to organize the pages now, so I can group and adjust as users add content.

[JRS]

Please correct me John, but are you the owner / creator of the cross platform ScriptBasic?

I picked up the project manager job when Peter Verhas (author) moved on to other projects in 2005. Armando I. Rivera (AIR) has been a valuable asset and frontiersman with creating 32/64 bit ScriptBasic distributions for Windows, Linux and the Mac.



[attachment deleted by admin]

[Aurel]

Kent ...helpNdoc is ok but i prefer to use HelpMaker ...
Did you try HelpMaker?

[kryton9]

Please correct me John, but are you the owner / creator of the cross platform ScriptBasic?

I picked up the project manager job when Peter Verhas (author) moved on to other projects in 2005. Armando I. Rivera (AIR) has been a valuable asset and frontiersman with creating 32/64 bit ScriptBasic distributions for Windows, Linux and the Mac.

I will update the help with the correct information John, thanks.

[kryton9]

Kent ...helpNdoc is ok but i prefer to use HelpMaker ...
Did you try HelpMaker?

The website was down and only the sourceforge page was there with not much info. You can use helpmaker and I can just link to your help file when it is finished.

[kryton9]

Made the corrections mentioned, thanks for the info guys. Help is now at version 004.

Besides the corrections, I have been concentrating on fleshing out the Console Class help. It is a pretty good sized class, so a good test case to work on to see how well the help flows.

[Charles Pegge]

Hi Kent

Just to let you know that about 1-2 years from now (hard to predict), SCITE and the CHM help file will be decoupled from the main Oxygen package when we will have a fully integrated  IDE using Opengl for the visual interface. Those will become  legacy items on a separate download.

The Opengl IDE will open all kinds of possibilities - combining text and graphics and will be much easier to port.

But we will be able to port much of the material you are developing now, except for any specifics on Scite controls.

Since all the source script for the IDE will be included,  I hope spawning new tools and applications will be much easier than building from scratch.

Charles

[kryton9]

Thanks for the heads up Charles. I will put effort into making more classes we can use and flesh out in the coming year then. It looks like Aurel and Peter are working on the procedural programming libraries while you work on the core.

[kryton9]

I was thinking about one of the lectures I watched while learning c++ and opengl. They mentioned using the GL specified variables to maintain true cross platform ability. Since that is the direction Oxygen is going to go via Opengl, perhaps the oxygen variable types should be defines of opengl variable types to avoid any problems?