Author Topic: Documentation  (Read 25127 times)

0 Members and 1 Guest are viewing this topic.

John

  • Hero Member
  • *****
  • Posts: 3573
Documentation
« on: September 24, 2018, 04:26:36 PM »
If a new user of Oxygen Basic were to look at and compile the examples provide in the distribution, there should be no reason one couldn't be productive with the BASIC. Waiting for professional written docs to materialize anytime soon isn't  being realistic.

« Last Edit: September 26, 2018, 08:25:44 AM by John »

Aurel

  • Sr. Member
  • ****
  • Posts: 374
Re: Documentation
« Reply #1 on: September 25, 2018, 09:58:52 AM »
https://www.oxygenbasic.org/forum/index.php?topic=1721.msg18550#new

Hi
May i continue with my attempt on o2 help in chm form.
Of course it is not on proffesional level but can be useful ?

AlyssonR

  • Newbie
  • *
  • Posts: 7
Re: Documentation
« Reply #2 on: September 26, 2018, 12:56:42 AM »
Any reference material is always welcome - especially when we have senior moments and forget which dialect we're using.  :o :P

Charles Pegge

  • Admin Support Member
  • *****
  • Posts: 4033
    • Oxygen Basic
Re: Documentation
« Reply #3 on: September 26, 2018, 04:31:10 AM »
I think good search tools are the key, rather than static documentation. Assuming we will end up with thousands of examples, (currently 1200+), programmers should be able to locate any piece of code that approximates their needs. I find I'm writing far less original code now. It's mostly copy, paste, and adapt.

Oxygen_help.chm is currently more like a dictionary than a full manual. It's contents are sourced from inf\o2keyw.dat, a database of o2 keywords with various links to included examples.

John

  • Hero Member
  • *****
  • Posts: 3573
Re: Documentation
« Reply #4 on: September 26, 2018, 08:40:02 AM »
My vote is we expand on Charles's Github repository breaking apart the zips to source controlled pushes and use the Github markup tools for documentation.

I'm winding down my BASIC forum activity and plan to have Script BASIC on BitBucket or Gitlab and part of a major Linux distribution by 2020.

Aurel

  • Sr. Member
  • ****
  • Posts: 374
Re: Documentation
« Reply #5 on: September 26, 2018, 10:21:57 AM »
Quote
Any reference material is always welcome -
Ok..
then when i get some free time i will continue in hope that should be useful  :)

John

  • Hero Member
  • *****
  • Posts: 3573
Re: Documentation
« Reply #6 on: September 26, 2018, 11:02:20 AM »
Every contribution to the project by the community matures the BASIC. I think you should dedicate more time toward your English speaking skills which will make your programming topics easier to swallow.

Mike and Josť are great examples of 2nd language mastering.

Josť Roca

  • Sr. Member
  • ****
  • Posts: 263
Re: Documentation
« Reply #7 on: September 26, 2018, 12:52:07 PM »
Sorry, but without documentation you're going nowhere.

Examples are useful as a complement to the documentation, not a a substitute. Besides, there are many things whose explanation can't be found in the examples.

For example:

Code: [Select]
#include "$/inc/console.inc"
DIM n AS ULONG
n = -1
print n
waitkey

Why it prints -1 instead of 4294967295.

A bug? A feature?

If you assign -1 to a WORD variable it correctly converts it to 65535.

Aurel

  • Sr. Member
  • ****
  • Posts: 374
Re: Documentation
« Reply #8 on: September 26, 2018, 01:04:35 PM »
Quote
Why it prints -1 instead of 4294967295.

 ???

because is right,

n is defined as INT or UINT
so -1 is a INTEGER.... i don't see problem

John

  • Hero Member
  • *****
  • Posts: 3573
Re: Documentation
« Reply #9 on: September 26, 2018, 01:16:48 PM »
Asking questions is another excellent way to refine the understanding of O2.

John

  • Hero Member
  • *****
  • Posts: 3573
Re: Documentation
« Reply #10 on: September 26, 2018, 01:21:32 PM »
Josť,

Curious. Do you have a formal education or are you self taught?

Josť Roca

  • Sr. Member
  • ****
  • Posts: 263
Re: Documentation
« Reply #11 on: September 26, 2018, 01:43:30 PM »
In programming, self taught. Fortunately, the first PC that I used had a manual.

I learn by practice, but I first read the documentation to know if the lamguage has everything I need. And I hate to ask questions for simple things.

Josť Roca

  • Sr. Member
  • ****
  • Posts: 263
Re: Documentation
« Reply #12 on: September 26, 2018, 01:59:45 PM »
Another question: The compiler doesn't seem to work with unicode source code files. This means that I can't work with unicode string literals. Am I right?

Josť Roca

  • Sr. Member
  • ****
  • Posts: 263
Re: Documentation
« Reply #13 on: September 26, 2018, 02:33:18 PM »
How do you deference a pointer?

This does not compile:

Code: [Select]
$ FileName  "test.exe"
ASCIIZ s * 260
s = "Test string"
DIM p AS ASCIIZ PTR = @s
print *p

Do you really believe that this is a good way to learn a language?

The natural reaction will be to become angry quickly and send the compiler to hell.


Josť Roca

  • Sr. Member
  • ****
  • Posts: 263
Re: Documentation
« Reply #14 on: September 26, 2018, 03:53:40 PM »
I have collected information about O2 native data types.

See: https://github.com/JoseRoca/WinPBX/blob/master/docs/Oxygen/Data%20Types.md

For operators, I guess that I will have to search in the C++ documentation.
« Last Edit: September 26, 2018, 04:00:43 PM by Josť Roca »