SBASIC / SuperBASIC Reference Manual Online

[pjw]

Well, Rich, Theres no denying that you have done commendable work with the keywords you have included! Its going to be a hard act to follow to do the same for the remainder. Perhaps the first step would be to just add the keywords and the most basic information pertaining to them (description and syntax), in the hope that the detail will follow over the course of the next 20 to 30 years..

Provided it is not too hard to update/edit entries, there may be some hope. I believe Norman is doing what he can on that score.

I could extract the keyword info from EasyPTR, provided permission is given from MK & AH (I'll ax) I presume it is sufficient to provide this as (a) text file(s)? Is there a template somewhere, Norm?

[NormanDunbar]

No - there is the Tiny Toolkit and a separate Qview TinyToolkit.

Bugger, bugger, bugger!

Ok, my mistake. I shall fix the toolkits page into "Qview Tiny Toolkit" and "Tiny Toolkit" - it's my mess, so I clean up! It shouldn't take long, I just "grep" out the TinyToolkit locations, then grep out the ones with "qview" and that's about it.


Cheers,
Norm.

[NormanDunbar]

I could extract the keyword info from EasyPTR, provided permission is given from MK & AH (I'll ax) I presume it is sufficient to provide this as (a) text file(s)? Is there a template somewhere, Norm?

There's a whole manual on updating the SuperBASIC Manual, but there's a pretty workable template at https://updating-superbasic-manual.read ... the-source whihc is almost up to date. But I can fix any problems.

I've just put a whole pile of updates for SMSQ/E, SMSQ/e 3.00, SMSQ/E 3.01 and SMSQ/E 3.12 as supplied by Tobias (ToFro) into both the Working and Master branch. This means, tada, that the docs are now converted to the new format.

A quick word about ReStructuredText can be found at https://updating-superbasic-manual.read ... Part3.html.

Give me a shout if there are any problems.


Differences between the current format and that documented:

• Each keyword has it's own source file now;
• Keywords live in a folder defined by the upper case first letter (or underscore) of their name;
• Adding a keyword to the system means adding it's filename to the index.rst file within the keyword's folder.
• It's also required to update the file "Frontmatter/Toolkits.rst" for any new additions and/or new toolkits.

Regarding Turbo Toolkit - I think it's pretty incomplete, as Rich suspected, there are only a few commands. We might be able to extract the details from the DP Collection files on floppy though....... any volunteers?


Cheers,
Norm.

[Andrew]

D page is currently missing from the online manual https://superbasic-manual.readthedocs.i ... clean.html

[pjw]

There's a whole manual on updating the SuperBASIC Manual, but there's a pretty workable template at https://updating-superbasic-manual.read ... the-source whihc is almost up to date. But I can fix any problems.

Yeah, thats just what I was worried about. First theres getting into GIT, which I didnt like even before M$ got their mitts into it, then theres a manual to read just to do a voluntary chore, that already is, well, a chore. My limited QL time mainly goes into programming, which Id rather be doing than any sort of Linuxy/MSDoxy stuff. If I can provide the keywords, syntax and descriptions in suitable text files, one for each, for example, then Im happy to do that (I can do most of that inside a QL environment). Otherwise, I must just be grateful to those who do that sort of work, and go back to my programming.

[NormanDunbar]

D page is currently missing from the online manual https://superbasic-manual.readthedocs.i ... clean.html

Hi Andrew. If you had bookmarked any pages, then you'll need to update them I'm afraid. If the word 'clean' occurs, they are old urls and no longer work.

https://superbasic-manual.readthedocs.i ... index.html is the new format. No more do all the 'd' keywords live in the sane page, they have a page each. It makes for easier updating.

https://superbasic-manual.readthedocs.i ... index.html is the top level entry point.


HTH

Cheers,
Norm.

[NormanDunbar]

Per,

If you leave it a wee while, I'm working on something to make submitting changes easier. It's going to be QL based, no Windows, Linux or Macs required.

Watch this space.


Cheers,
Norm.

[pjw]

Per,

If you leave it a wee while, I'm working on something to make submitting changes easier. It's going to be QL based, no Windows, Linux or Macs required.

Watch this space.


Cheers,
Norm.

[NormanDunbar]

In case anyone is interested, the new stuff submitted by ToFro for the online manual are as follows:

I've added the new commands to the toolkits named below. However, for SMSQ/E I have not updated any of the SMSQ/E for XXX (Atari, Amiga, ST etc) as I have no idea if those versions included these commands.

Code: Select all

SMSQ/E
------

DAY%
FET
FEW
FEX
FEX_M
HOT_GETSTUFF$
JOBID
MONTH%
WEEKDAY%
YEAR%

Code: Select all

SMSQ/E - v3.00 Onwards
----------------------
WM_BLOCK
WM_BORDER
WM_INK
WM_PAPER
WM_STRIP

Code: Select all

+SMSQ/E - v3.01 Onwards
-----------------------
WM_MOVEMODE

Code: Select all

SMSQ/E - v3.12 Onwards
----------------------
PE_BGOFF
PE_BGON

Cheers,
Norm.

[NormanDunbar]

I have yet another update and build in progress - it should be online soon at the usual URL on ReadTheDocs.

Thanks to PER (PJW) for pointing out a few possible foibles in some of the updates I made recently in FEX_M, HOT_GETSTUFF$ and FEW. See if you can spot what they were!

The build is currently running and should be finished about 5 minutes after this gets posted.


Cheers,
Norm.