SBASIC / SuperBASIC Reference Manual Online

A collection of QL services and websites.
Derek_Stewart
Font of All Knowledge
Posts: 3901
Joined: Mon Dec 20, 2010 11:40 am
Location: Sunny Runcorn, Cheshire, UK

Re: SBASIC / SuperBASIC Reference Manual Online

Post by Derek_Stewart »

Hi Rich,

I have resent the email to you and Norman.

I have used the sales email for you.


Regards,

Derek
RWAP
RWAP Master
Posts: 2833
Joined: Sun Nov 28, 2010 4:51 pm
Location: Stone, United Kingdom
Contact:

Re: SBASIC / SuperBASIC Reference Manual Online

Post by RWAP »

Derek_Stewart wrote:Hi Rich,

I have resent the email to you and Norman.

I have used the sales email for you.
Many thanks - no sign of the original email last year - oh well...

The beauty of the approach used by Norman is that if anyone edits the document on github, it will get built into HTML, PDF and ePub formats automatically - you can access these from the one webpage - http://superbasic-manual.readthedocs.io/en/latest/

Click on read the docs at the bottom of the left hand menu to access the various formats.


User avatar
NormanDunbar
Forum Moderator
Posts: 2249
Joined: Tue Dec 14, 2010 9:04 am
Location: Leeds, West Yorkshire, UK
Contact:

Re: SBASIC / SuperBASIC Reference Manual Online

Post by NormanDunbar »

Hi Derek,

Thanks for the epub. I could have saved months of lunchtimes at work if I'd known! :-)

My version has taken the original html created by a Text printer driver, cleaned it up, converted it to RestructuredText and then built html from that.

Rst as it is known, and Pandoc or better, Sphinx doc, can convert from Rst to just about anything.

My GitHub repository is configured so that any time anyone pushes to it, to force a build at Read the Docs. That will create online and downloadable html, pdf and epub with the latest amendments.

Feel free to fork me! (That wasn't a euphemism by the way ;-) )

There are still a few todos to sort out but the vast majority of the conversion has been done over the past few months.

Cheers,
Norm.


Why do they put lightning conductors on churches?
Author of Arduino Software Internals
Author of Arduino Interrupts

No longer on Twitter, find me on https://mastodon.scot/@NormanDunbar.
User avatar
NormanDunbar
Forum Moderator
Posts: 2249
Joined: Tue Dec 14, 2010 9:04 am
Location: Leeds, West Yorkshire, UK
Contact:

Re: SBASIC / SuperBASIC Reference Manual Online

Post by NormanDunbar »

Text 87, obviously.
Damned auto correct!


Why do they put lightning conductors on churches?
Author of Arduino Software Internals
Author of Arduino Interrupts

No longer on Twitter, find me on https://mastodon.scot/@NormanDunbar.
Derek_Stewart
Font of All Knowledge
Posts: 3901
Joined: Mon Dec 20, 2010 11:40 am
Location: Sunny Runcorn, Cheshire, UK

Re: SBASIC / SuperBASIC Reference Manual Online

Post by Derek_Stewart »

Hi Norman,

I just dumped the Web site and converted the html files in Sigil. There was a few CSS style errors, but it was anot easy conversion.

I updated the SMQ/E Ref Manual in Libreville Office / PDF, which Wolfgang had on his Web site. I really wanted the manual in Epub format. But the ODT file format to Epub is not good conversion. Nedd a lot of manual conversion.


Regards,

Derek
User avatar
NormanDunbar
Forum Moderator
Posts: 2249
Joined: Tue Dec 14, 2010 9:04 am
Location: Leeds, West Yorkshire, UK
Contact:

Re: SBASIC / SuperBASIC Reference Manual Online

Post by NormanDunbar »

Hi Derek,

Having run html tidy against the original html files, there were a lot more than a few CSS errors!

Program code had <>& etc which needed to be escaped as the lines were just italic paragraphs, not in pre tags. The ampersands also caused Basic strings to be considered as html entities too. Illegal ones.

Headings with line feeds in.

Br tags with a url attached which should have been a tags, etc, etc.

The tables were all over the place. Have a look at the table of printer types in your epub sdp_key section, for example.

Hopefully, now, most things are good. Knowing the internal format of Text87 files would have been a better way to extract the text and formatting, but it was not to be, so we have to work with what we had. The output from a printer driver.

Cheers,
Norm.


Why do they put lightning conductors on churches?
Author of Arduino Software Internals
Author of Arduino Interrupts

No longer on Twitter, find me on https://mastodon.scot/@NormanDunbar.
Derek_Stewart
Font of All Knowledge
Posts: 3901
Joined: Mon Dec 20, 2010 11:40 am
Location: Sunny Runcorn, Cheshire, UK

Re: SBASIC / SuperBASIC Reference Manual Online

Post by Derek_Stewart »

Hi Norman,

I optimised the epub file to be viewed on a Kindle. Since it looked OK, I did not delve too much into the it.


Regards,

Derek
Derek_Stewart
Font of All Knowledge
Posts: 3901
Joined: Mon Dec 20, 2010 11:40 am
Location: Sunny Runcorn, Cheshire, UK

Re: SBASIC / SuperBASIC Reference Manual Online

Post by Derek_Stewart »

HI Norman,

I checked the converted epub file to azw3 on the Kindle, it seemed to read okay, maybe I did not alter the HTML files much. Checking the epub file in Sigil, gave no errors on the HTML structure. Since this was really for my benefit, I am happy with the result.

My ebook is a snapshot of manual at that time and does not take in account any updates, which your system does.


Regards,

Derek
User avatar
NormanDunbar
Forum Moderator
Posts: 2249
Joined: Tue Dec 14, 2010 9:04 am
Location: Leeds, West Yorkshire, UK
Contact:

Re: SBASIC / SuperBASIC Reference Manual Online

Post by NormanDunbar »

Evening all,

I've done some more work on the SuperBasic Online Manual. Some of the introductory chapters and appendices had formatting errors in that lines of code were rendering as plain text. These have been fixed.

I also took the liberty of adding DJToolkit version 1.16, the latest version, to the manual. Well, if I can't blow my own trumpet .....

As usual, the build is automatic and there is html, pdf and epub files to download if you want your own local copy.

Enjoy.


Cheers,
Norm.


Why do they put lightning conductors on churches?
Author of Arduino Software Internals
Author of Arduino Interrupts

No longer on Twitter, find me on https://mastodon.scot/@NormanDunbar.
User avatar
NormanDunbar
Forum Moderator
Posts: 2249
Joined: Tue Dec 14, 2010 9:04 am
Location: Leeds, West Yorkshire, UK
Contact:

Re: SBASIC / SuperBASIC Reference Manual Online

Post by NormanDunbar »

QPC commands gave been added to the SuperBasic Online Manual.

Cheers,
Norm.


Why do they put lightning conductors on churches?
Author of Arduino Software Internals
Author of Arduino Interrupts

No longer on Twitter, find me on https://mastodon.scot/@NormanDunbar.
Post Reply