QD Hyperhelp

Anything QL Software or Programming Related.
Derek_Stewart
Font of All Knowledge
Posts: 3976
Joined: Mon Dec 20, 2010 11:40 am
Location: Sunny Runcorn, Cheshire, UK

Re: QD Hyperhelp

Post by Derek_Stewart »

Hi,

I have been converting the SBASIC / SuperBASIC Reference Manual Online manual, to single files for use in QD Hyper Help.

I thought that this was a good idea, but after separating the SBASIC / SuperBASIC Keywords into separate files suitable for QD Hyper Help system.

I have removed all the control codes from the 2000 plus, files, with Linux Bash scrpting, and corrected some errors in the Manual data.

I am about half way through keywords starting with 'C' ...

Testing the completed keywords starting with A or B works well, allowing keyword definition to be displayed by pressing F1 while the cursor is on the keyword.

A nice personal project, will give me some interest in S*BASIC programming.


Regards,

Derek
User avatar
RalfR
Aurora
Posts: 872
Joined: Fri Jun 15, 2018 8:58 pm

Re: QD Hyperhelp

Post by RalfR »

Good Idea, I am looking forward to it.


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

Re: QD Hyperhelp

Post by NormanDunbar »

derek_stewart wrote:I have been converting the SBASIC / SuperBASIC Reference Manual Online manual, to single files for use in QD Hyper Help.
Hey Derek,

how are you going about doing this? If you are copying and pasting from the online content, it's going to take you a while. The source files for the individual commands are available on github at https://github.com/NormanDunbar/SuperBASIC-Manual. If you download the zip file of the repository, you'll find all the individual source files in the subdirectory, sphinx/source.

Unfortunately, those files are written in a markup called ReStructuredText (that capitalisation is mandatory!) but if you install Sphinx and then, in the repo that you downloaded, "cd sphinx" and "make help", it will tell you the formats it can generate. PDF needs LaTeX though, that's a huge install.

If you don't want to install Sphinx, then give me a shout. I can generate the following from the sources:

Code: Select all

Please use `make <target>' where <target> is one of
  html       to make standalone HTML files
  dirhtml    to make HTML files named index.html in directories
  singlehtml to make a single large HTML file
  pickle     to make pickle files
  json       to make JSON files
  htmlhelp   to make HTML files and a HTML help project
  qthelp     to make HTML files and a qthelp project
  applehelp  to make an Apple Help Book
  devhelp    to make HTML files and a Devhelp project
  epub       to make an epub
  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
  latexpdf   to make LaTeX files and run them through pdflatex
  latexpdfja to make LaTeX files and run them through platex/dvipdfmx
  text       to make text files
  man        to make manual pages
  texinfo    to make Texinfo files
  info       to make Texinfo files and run them through makeinfo
  gettext    to make PO message catalogs
  changes    to make an overview of all changed/added/deprecated items
  xml        to make Docutils-native XML files
  pseudoxml  to make pseudoxml-XML files for display purposes
  linkcheck  to check all external links for integrity
  doctest    to run all doctests embedded in the documentation (if enabled)
  coverage   to run coverage check of the documentation (if enabled)
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: 3976
Joined: Mon Dec 20, 2010 11:40 am
Location: Sunny Runcorn, Cheshire, UK

Re: QD Hyperhelp

Post by Derek_Stewart »

Hi Norm,

Copying and Pasting would be the normal as I did with QPTR, DBAS, but, I downloaded the source code for the online manual and removed all the control codes using a simple Bash script.

There were a few errors in the data of the manual , but since this is a personal project I just corrected the errors and dod not record the error..


Regards,

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

Re: QD Hyperhelp

Post by NormanDunbar »

Ok Derek, no worries, if you are happy with that. Give me a shout if you need anything else that I might be able to supply.

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