FontoXML Development Tools

Development license

Certain commands, like editor, connectors and content-quality, require a valid developer license file on your system and the permissions to run them. 

A license file fonto.lic can be stored in either of these locations:

  • In your user home directory ($HOME on linux/MacOS, or %homepath% on Windows). 
  • In an ancestor folder of where you are running the fdt command. 
  • Verify that your license file is installed correctly by running the fdt license validate command.

To obtain a license file, or to obtain additional permissions, please contact us at https://fontoxml.com/contact-us/ or reach out to your Fonto contact if you have one available. License files are personal and we disadvice to store them in any version control system you might have.

Fonto Development Tools

The development tools for Fonto are command-line tools which offer support for developers when configuring FontoXML Editor instances and their complementary apps, and facilitate running them locally for testing purposes. They act as a gateway to the Fonto SDK and can be used for creating and updating editor instances, and preparing XML schemas for use with Fonto.

Installation

The development tools require NPM on Node.jsĀ® version 8.11 or higher which are freely available. After installing Node.js you can install the FontoXML development tools using the following command: npm i -g @fontoxml/fontoxml-development-toolsYou can use Node Version Manager on Linux/MacOS or its Windows counterpart to install and use multiple versions of Node.js on a single system. This is useful if you develop different projects with different versions of Node.js.

Usage

Add --help to your command to see the available options.

Check the currently installed license and validate it online.

fdt license validate

Create a new instance of a Fonto Editor.

fdt editor init

Create a new Fonto Editor in the current directory with the specified name, schema, and addons, without prompting for input or confirmation.

fdt editor init --name my-fontoxml-editor --schema path/to/schema --addons fontoxml-dita fontoxml-structure-view --non-interactive

Start a development server for running a Fonto Editor.

fdt editor run

Start the development server for the current Fonto Editor repository on the non default port 8088.

fdt editor run -p 8088

Upgrade an instance of a Fonto Editor, and/or add or remove add ons.

fdt editor upgrade

Create a build version of a Fonto Editor for production usage.

fdt editor build

Compile an XSD schema to a schema format which can be used by a Fonto editor.

fdt editor schema compile path/to/schema

Output schema information about a specific element, including detailed content model info.

fdt element <element>

Output a table with information about all elements in a schema.

fdt elements

Output schema information about a specific attribute. An attribute may have different definitions in the same schema, this command summarizes them all.

fdt attribute <attribute>