Documenting Add-ons

Note

The Add-on documentation is part of the packaged Add-on.

Terminology

Item	Description	Origin
Title	Add-on title	‘Title’ field in the Add-on properties/ "title" in metainfo.json
One-Liner	Add-on short description, a single line	‘Description’ field in the Add-on properties/ "description" in metainfo.json
Short description	Add-on short description	doc/README.md, first paragraph, see below
Long description	Add-on long description	doc/README.md, starting from second paragraph, see below
Documentation	Documentation as PDF (optional) (in download area, not shown above)	doc/Documentation.md/.pdf
Releasenotes	Releasenotes as PDF	doc/Releasenotes.md
Add-on category	Add-on category (optional)	"technical-category" in metainfo.json
Versions	Main software / Add-on version	"software-version" and "version" in metainfo.json
Compatible software	Compatible main software product(s)	"compatible-software" in metainfo.json

Rendering in the ZEISS Quality Software Store

ZEISS Quality Software Store – Product overview

ZEISS Quality Software Store – Product details

Add-on documentation structure

Caution

Add-on short / long descriptions can only be rendered as plain text without formatting in the ZEISS Quality Software Store.

Note

An Add-on (.addon file) is technically a ZIP file. See Add-on file format for details.

• Mandatory contents:

  • doc/README.md — Add-on short / long description

  • doc/Releasenotes.md/.pdf — The Markdown file allows viewing in the Add-on Editor while the PDF file is used in the ZEISS Quality Software Store.

• Optional contents:

  • doc/Documentation.md/.pdf — Extended Add-on documentation / user manual

  • doc/... — any number of additional files

Example

Source: doc/README.md

# Airfoil Inspection

Contains relevant functions to inspect airfoils. The app also supports the acquisition and preparation of optical and tactile measurement data. The industry-specific
Airfoil Inspection workspace is optimized for analyzing airfoils, such as blades, vanes or blisks.

The Airfoil Inspection App provides functions to prepare your measured data, no matter if tactile or optical, and to analyze airfoils, such as blades, vanes or blisks.
In addition, the App also provides the Smart Teach functionality for profile edge points, to measure airfoils in a dedicated way. 

Further functionality provided by Airfoil Inspection: 
 - specific Airfoil workspaces 
 - import and processing of tactile measured curves (incl. stylus sphere radius correction) 
 - interface to CALYPSO for data acquisition 
 - advanced Airfoil functionalities for profile inspection 
 - industry specific Apps  
     - Efficient Blisk Measurement and Inspection 
     - Airfoil Bow and Sweep Inspection 
     - Virtual Balancing 
     - Throat Area - together with Local Minimal Surface 

Want to know more? Check the related articles in the ZEISS Quality Tech Guide.

Short description

Contains relevant functions to inspect airfoils. The app also supports the acquisition and preparation of optical and tactile measurement data. The industry-specific Airfoil Inspection workspace is optimized for analyzing airfoils, such as blades, vanes or blisks.

Long description

The Airfoil Inspection App provides functions to prepare your measured data, no matter if tactile or optical, and to analyze airfoils, such as blades, vanes or blisks. In addition, the App also provides the Smart Teach functionality for profile edge points, to measure airfoils in a dedicated way.

Further functionality provided by Airfoil Inspection:

• specific Airfoil workspaces

• import and processing of tactile measured curves (incl. stylus sphere radius correction)

• interface to CALYPSO for data acquisition

• advanced Airfoil functionalities for profile inspection

• industry specific Apps

  • Efficient Blisk Measurement and Inspection

  • Airfoil Bow and Sweep Inspection

  • Virtual Balancing

  • Throat Area - together with Local Minimal Surface

Want to know more? Check the related articles in the ZEISS Quality Tech Guide.

Markdown

Caution

Add-on short / long descriptions can only be rendered as plain text without formatting in the ZEISS Quality Software Store.

Note

See markdown guide for a brief description of the markdown format.

See ZEISS Quality Software Store — FileSelectionAndFiltering for example.

A markdown editor/viewer is integrated in the ZEISS INSPECT Add-on editor.

See Releasenotes template.

Converting Markdown files to Portable Document Format (PDF)

The Visual Studio Code extension Markdown PDF allows to convert Markdown files to PDF. The ZEISS App Development Environment converts Releasenotes from Markdown to PDF automatically.