adoc-inline-json.xsl

This builder currently ships with CIMTool.

Builder Description

The adoc-inline-json.xsl builder generates documentation for a JSON schema profile in AsciiDoc format as content to be included within a larger AsciiDoc document. The output has no document header, title or table of contents. It starts with a section for the profile and otherwise matches the adoc-article-json.xsl builder: the profile’s class diagram and a section for each class, compound, enumeration and datatype, with tables of native and inherited members. Text entered on the “Documentation” tab in CIMTool is included alongside the UML and profile descriptions.

The diagram is included from the <profile>.json-l2r.puml file generated by the puml-json-l2r.xsl builder, so that builder should also be enabled for the profile. For a standalone document use the adoc-article-json.xsl builder. Equivalent builders are provided for RDFS (adoc-article-rdfs.xsl, adoc-inline-rdfs.xsl) and XSD (adoc-article-xsd.xsl, adoc-inline-xsd.xsl) profiles.

Below is an extract generated from a ComModuleConfig profile:

== ComModuleConfig Profile Specification

// Settings:
:doctype: inline
:reproducible:
:icons: font
:sectnums:
:sectnumlevels: 4
:xrefstyle: short

Profile namespace: http://iec.ch/TC57/2022/ComModuleConfig#

.ComModuleConfig Profile
plantuml::./Profiles/ComModuleConfig.json-l2r.puml[format=svg, align=center]
...
[[ComModuleConfig-ComModule]]
==== ComModule
...
*Native Members*

[%header,width="100%",cols="25%,^10%,20%a,45%a"]
|===
...
|ComFunctions (@ref)
|0..*
|<<ComModuleConfig-ComFunction,ComFunction>>
|
All functions this communication module performs.

...
|===

XSLT Version

This builder is XSLT 3.0 compliant.

Release History

CIMTool Release	Release Date	Changes
2.3.0	08-Jun-2026	Added to CIMTool (#24).

Author

Todd Viegut [@tviegut] on behalf of UCAIug.

Submission Date

01-Jan-2026

Builder NTE Configuration

Given this builder ships with CIMTool the below screenshot highlights the existing NTE (Name/Type/Extension) settings for the builder. We strongly recommend that you do not import customized versions of this shipped builder over the original in your local CIMTool installation. Doing so will force regeneration of any existing builder-generated artifacts for projects in your workspace that have this builder enabled.

The recommended best practice is to rename the builder file (from adoc-inline-json.xsl to custom-adoc-inline-json.xsl for example) before importing. On import this will be interpreted as a new builder and you will be allowed to enter values in the Type and Extension fields.

NOTE: </br>CIMTool requires that file extensions be unique and will prevent you from entering an extension already assigned to a builder. This is because an artifact’s name is derived by concatenating the base name of the CIMTool .owl profile with the file extension assigned to the builder. Therefore, a unique file extension must be assigned to each builder when imported. The file extension for a builder can be modified later from within the “Maintain XSLT Transform Builders” screen.

License

This builder is released under the Apache 2.0 license and was developed under sponsorship of the UCAIug.

This site is open source. Improve this page.