Boost Quickbook Support Extension
From the Boost.Quickbook website:
QuickBook is a WikiWiki style documentation tool geared towards C++ documentation using simple rules and markup for simple formatting tasks.
This Visual Studio Code extension provide some simple language support to ease the task of authoring Boost.Quickbook(source) files.
It is not endorsed, published, approved or peer-reviewed by the Boost community,
or anybody represented by the community. I have simply written it for myself to use - and put it out in the ether in case somebody else may find it useful too.
It is called "Boost Quickbook Support" because Quickbook is a Boost-published language/tool,
and when I google "Quickbook" on its own, the search engine assumes I mean accounting software.
For the preview feature to work, you need a
quickbook executable - either accessible within your
or explicitly specified in the
The executable command options (see
quickbook --help) are represented by equivalent settings.
Consult the documentation for appropriate usage.
In addition, all filesystem paths can be specified relative to the workspace directory;
These settings are processed as follows:
- The specified path is quoted and tested as is - if it exists, it is used.
- Otherwise the specified path is prepended in turn by each of the workspace directories - if it exists, it is used.
- Otherwise the specified path is used as specified.
This extension is not bullet proof. It is only intended as the next step up from a pure text editor - not as a complete documentation writing tool.
Currently it suffers from the following caveats.
See the GitHub Issues Page for more.
Bracket & Quote matching does not recognise escaped characters:
[myTemplate includes a \] character]
does not match correctly on the last
is simply specified inside the
I don't know how to do specify the concept of an escaped character in there - if possible at all.
The preview panel does not correctly display graphics/images etc.
The preview is simply generated with the
quickbook --output-format onehtml ... option.
As Visual Studio Code is rightly security conscious, the
that I use to display the preview does not have access to local resources outside of the
Personally I'm fine with that - a quick preview of the document-structure and presentation is all I wanted.
It may be possible to post-process the generated HTML in order to change the schema, but in my opinion it kind of defies the purpose of the extension.
See WebView API documentation for more on this subject.
- Minor documentation & naming issues fixed.