asciidoc toolkit for LabVIEW

This version mainly fixes and improves the feature added in v1.5.0.

It improves error reporting during the asciidoctor installation document generation.

It also fixes rendering issues.

Release note

Changes:

• LabVIEW error generated on Asciidoctor rendering failure –> #44
• Improve error reporting on toolchain installation –> #48

Fixes:

• UTF8 support not handle when generating a section –> #43
• Issue in image integration –> #46
• Error on Asciidoctor toolchain destination directory clean up –> #47
• Rendering large diagram fails –> #51

This version introduces the capability to render your adoc file into PDF or HTLM5 files directly in your LabVIEW applications.

With this capability, it’s never been easier to get rid of MS Office and other complex solutions to generate beautiful documents and reports in LabVIEW.

Asciidoctor toolchain install during VIP installation

During the package installation, the Ascidoctor toolchain is installed locally with a minimum footprint. Rendering feature supported by the installation:

• Rendering adoc files to HTML5 and PDF
• Diagram generation (web connection required)
• STEM expressions rendered (HTML5 output only)

3 new functions available in the palette

• Render Adoc File: Takes an adoc file as input and generates HTML5 or PDF output next to the adoc file
• Check Asciidoctor Toolchain Installation: Verify if the toolchain is correctly installed
• Installing Asciidoctor Toolchain: Process to the toolchain installation. This function is useful when you want to ingrate rendering to your application.

Contributor

Big thanks to Matthias Baudot for his help with the installation process.

This version introduces advanced table formating and fixes some minor bugs:

Advanced table formating

You can now build modern table including images <1>, admonitions <2> and nested tables <3> in cells. On top of that, you can also span cells over rows or columns <3>.

Building this table is made easy by this new version and you don’t need to know anything about asciidoc syntax.

Contributor

Big thanks to Paul Morris for his contributions to improving the table creation and for the VIs description review.

This version introduces new formating features:

• Table:
  • Width, style and alignment for each column of a table
  • Width, border and stripes of the table
• Document
  • Select where you want the TOC (Table Of Content) to be displayed in HTML files
  • Add revison information

This version introduces some changes and bug fix you can see below. It brings you UTF-8 support to allow extended characters support.

Release note

Changes:

• Ouptut string encoding set to UTF-8 –> #27

• If needed for recording the output in a file, folder arborescence is created –> #28

Bug Fix :

• Rendering issue when paragraph is empty –> #14

This version introduces some new features, changes and bug fix you can see below.

Release note

New features:

• Add Diagram bloc –> #22
• Add function to add custom attributes not directly handle by the toolkit –> #26
• Handle Doctype property –> #25

Changes:

• Email information added to Author –> #23 ⚠️ This change breaks public toolkit interface. You will have to modify existing code after update

• Wovalab_lib_AsciiDoctor library is no more installed in Sources folder

Bug Fix :

• Document header was ill formed when Autors array was empty –> #24

Asciidoc syntax is quite readable as a plain text file, but not as easy as the same file rendered as HTML or PDF.

If you want to quickly test the final render of your file the following tools can be useful.

#1 - Asciidoctor.js Live Preview

Asciidoctor.js Live Preview is a Google Chrome extension that will display any asciidoc file as html directly inside your browser.

This is one of the easiest ways to display asciidoc files.

Download extension here

This version introduces some new features, changes and bug fix you can see below.

I want to thank people who contribute to this new version with code and ideas:

• Samuel Taggart who did add unit test to the project
• Joerg Hampel who did fix bug and had lots of great ideas on the toolkit
• All LabVIEW User Group members from french Alps who did a code review of the v1.0 version during our last 2019 session

but it’s also easier to install thanks to the new VIPM Community repository.

We are happy to release the first public version of the tookit.

Download

Asciidoc toolkit for LabVIEW v1.0.0