Author Topic: OxygenBasic formal documentation  (Read 9974 times)

0 Members and 1 Guest are viewing this topic.

Peter

  • Full Member
  • ***
  • Posts: 161
Re: OxygenBasic formal documentation
« Reply #15 on: July 24, 2013, 03:57:38 AM »
Hi Kent,

Be happy that we have so many things.
I hate limited programming languages, which make it impossible to write your ideas.

Kent, just take what you want, if you want to use brackets, use brackets.  :D  
« Last Edit: July 24, 2013, 06:29:22 AM by peter »

Charles Pegge

  • Admin Support Member
  • *****
  • Posts: 3745
    • Oxygen Basic
Re: OxygenBasic formal documentation
« Reply #16 on: July 24, 2013, 06:53:40 AM »
One advantage of flexible syntax, I find,  is porting code. A quick partial translation to get the thing working, then gradually trim off all the noisy bits and reconfigure into a structure you are comfortable with.

Aurel

  • Guest
Re: OxygenBasic formal documentation
« Reply #17 on: July 24, 2013, 06:59:43 AM »
Quote
2. Have O2 automatically include a file named user.inc, this would be where I would put all my code which would make all my libraries.
3. Have O2 automatically compile with the RTL and make the .exe file and auto name the .exe with the programs name.

Kent
This can be done if you create small builder program, something like i do in AurelBasic....
But of course little bit exetended with include file options.
And also this program must be capable to add few first lines into main code file.


Charles Pegge

  • Admin Support Member
  • *****
  • Posts: 3745
    • Oxygen Basic
Re: OxygenBasic formal documentation
« Reply #19 on: July 25, 2013, 01:31:37 AM »

It would be quite easy to make a virtual keyboard control for IDEs. Might need a few more keys than the old Spectrum, but it would be good for beginners anyway.

John

  • Hero Member
  • *****
  • Posts: 3249
Re: OxygenBasic formal documentation
« Reply #20 on: September 07, 2013, 08:09:09 PM »
I feel we can no longer wait with an attempt at formal documentation. Charles has brought OxygenBasic to the point of a mature/flexible foundation for a BASIC compiler. Charles has demonstrated at one point or another examples that you would expect a BASIC compiler to support, and more. (64 bit, JIT, ...)

I have installed for the project when it first began Mediawki (what Wikipedia uses) to support the documentation effort. Emil took a shot at getting the ball rolling but it may have been to early in the development cycle to cast anything in stone. I feel the syntax of the language is stable/functional and a documentation effort could be started. I don't want to put any effort into a method doomed for failure so before I start working on frameworks and formats, I'm looking for feedback from the O2 team as what tool you think we should use.


Charles Pegge

  • Admin Support Member
  • *****
  • Posts: 3745
    • Oxygen Basic
Re: OxygenBasic formal documentation
« Reply #21 on: September 08, 2013, 12:39:13 AM »
I favour Bulletin Board Format, since we already use it abundantly :).

It is also easy to auto-translate into HTML for web pages.

John

  • Hero Member
  • *****
  • Posts: 3249
Re: OxygenBasic formal documentation
« Reply #22 on: September 08, 2013, 08:58:42 AM »
Excellent point, nothing new to learn. I will try to find a few BB based documentation tools for us to select from.

There is a BBCode extension that could be added to the current O2 wiki. This would allow using either standard markup (BB or mediawiki codes) with the option to move to something else if this documentation project takes off.
« Last Edit: September 08, 2013, 12:26:00 PM by JRS »

John

  • Hero Member
  • *****
  • Posts: 3249
Re: OxygenBasic formal documentation
« Reply #23 on: September 08, 2013, 01:45:44 PM »
I think the fastest/easiest way to make a dent in this is for me to write a SB script to take what documentation Charles has already created and generate the pages for the keywords. The pages will be pre-formatted  with the style/theme agreed on. I will leave linking the pages together into groups for the next pass.

Here is a Mediawiki extension to add syntax coloring to the wiki pages. The best part is it's the same syntax highlighter used on this forum so the template file for O2 should be reusable.
« Last Edit: September 08, 2013, 08:32:06 PM by JRS »

John

  • Hero Member
  • *****
  • Posts: 3249
Re: OxygenBasic formal documentation
« Reply #24 on: September 12, 2013, 05:40:31 PM »
If there isn't any interest by others to create formal documentation for O2, I'll take shot at on my own and see how it turns out. If you don't like the end result, don't start whining as I'm giving everyone a chance to define the path we should take with this.


Aurel

  • Guest
Re: OxygenBasic formal documentation
« Reply #25 on: September 12, 2013, 09:26:04 PM »
Quote
If there isn't any interest by others to create formal documentation for O2, I'll take shot at on my own and see how it turns out. If you don't like the end result, don't start whining as I'm giving everyone a chance to define the path we should take with this.

Do you know how to create .chm file ?
Do you know how to explain to people how to create windows GUI app ?
Do you know....
Do you...

OK ...if you whish to do this just go ... ;)

PS.Do i must repeat myself again...?
I work on my chm files for GUI functions which i have created in awinh, and please stop
inputing what you whish that someone else do,ok ... :)

John

  • Hero Member
  • *****
  • Posts: 3249
Re: OxygenBasic formal documentation
« Reply #26 on: September 12, 2013, 09:46:20 PM »
Quote
PS.Do i must repeat myself again...?
I work on my chm files for GUI functions which i have created in awinh, and please stop
inputing what you whish that someone else do,ok ...

Refresh time.

  • This is the OxygenBasic open source project not the RubinDev forum. We are happy to help you with your personal projects but the focus of this forum is moving O2 along.
  • Open source projects are successful if people contribute.
  • I'm a facilitator and involved in multiple BASIC language projects and I don't have time to explain to you what I have been doing in this industry for over 35 years. I highly recommend you first learn English before a BASIC language if you plan on further conversations with me.
  • I don't take on projects I know nothing about.
  • There is time for fun and time to get serious. We are lacking on serious from most of the project members here.

« Last Edit: September 12, 2013, 10:14:53 PM by JRS »

Aurel

  • Guest
Re: OxygenBasic formal documentation
« Reply #27 on: September 13, 2013, 02:11:21 AM »
And for what is awinh.inc than for Oxygen Basic  ???
Awinh.inc don't have nothing with my hobby interpreter at all...
do you understand this ?

Ok forget... ;)
« Last Edit: September 13, 2013, 02:43:30 AM by Aurel »

John

  • Hero Member
  • *****
  • Posts: 3249
Re: OxygenBasic formal documentation
« Reply #28 on: September 13, 2013, 08:16:47 AM »
Aurel,

It's great that you decided to use O2 for your projects creating custom includes and tools to make your development easier. If you're saying that this is your contribution to the O2 project then you need to follow normal open source protocol to have them approved to become part of the standard distribution. Not everything posted is considered an extension to O2. Please check with Charles as to his requirements for having code contributions submitted to the project.

Thanks!

John

Peter

  • Full Member
  • ***
  • Posts: 161
Re: OxygenBasic formal documentation
« Reply #29 on: September 13, 2013, 08:45:28 AM »
If I understand correct, you are the commander of this forum.
Aurel can do what he wants!

All is bit unfriendly here. Stay a little bit in the background with your commands.
We are all old enough.