Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 1.79 KB

FAQ.md

File metadata and controls

36 lines (24 loc) · 1.79 KB

FAQ

  1. How does the "Preview" work?

    It simply runs a quickbook [options...] --output-format onehtml --output-file "CONTEXT.EXTENSIONPATH/jbouwer.boost-quickbook-support-X.Y.Z/out/preview.html" "input_file" command and display the resulting output the file in a vscode.WebviewPanel.

  2. How can I see what command line is used to generate the preview?

    The View/Output panel will have a "Quickbook Preview Generation" channel (drop down) that displays the preview generation command line, and output from stdout & stderr.

  3. How come the preview does not update in real time - like the Markdown preview does?

    The quickbook functionality is not really designed to support that, and hence the preview does not implement it.

  4. I've changed a setting XYZ, but it does not show up in the command line or in the preview.

    Some settings will require a simple "Refresh Preview" to take effect. Others - those that persist with the VSCode WebView, will require a Developer: Reload Window command in order to take effect.

  5. Why does the "Preview" not look like the finished document?

    Remember that quickbook output is intended as an input to the BoostBook processor - and not to deliver a finished product.
    This extension only intends to augment the quickbook output in order to prepare a "quick & dirty" preview.

  6. Why does the "Preview" functionality need so many settings - in addition to those used by the quickbook executable?

    See also #5 above.
    In order to prepare the preview as close as possible to the finished product, the extension do some post-processing on the quickbook preview output - hence the many settings.