Getting started

In this chapter you will learn how to setup an Xeditor instance.

You can choose between using your own schema or basing it on one of our pre-configured schemas (like JATS or DITA).

We recommend that you start by installing the Xeditor demo package. This package comes with a simple schema preinstalled, so you will be able to get a feel for the architecture and play around in a test environment.

For more information about the technical requirements please read here first.

Logging in to Xeditor NPM

Xeditor itself, along with all other modules and plugins provided by Xeditor, are shipped via a private NPM repository. In order to download the Xeditor packages, you have to sign in to NPM using the credentials provided by our Sales team.

  1. Set our private NPM as the basis for all packages using the Xeditor namespace. This can be done using the following command
npm set @xeditor:registry https://npm.xeditor.com

By doing so, you can use NPM as usual, and all modules provided by Xeditor will automatically be downloaded from our NPM, instead of the public one.

  1. Log into our NPM. This can be done by using the following command:
npm adduser --registry https://npm.xeditor.com

This will prompt you to enter your user credentials.

After the login was performed, you can start downloading the Xeditor packages.

Middleware Server (Blackbox)

The Blackbox is our middleware and it is optional for your end configuration. However, it is required to run Xeditor pre-built packages and highly recommended to use since it handles a lot of functionalities.

For more information about the Blackbox please read here.

  1. Install Java RE supporting Java 6 or higher.

    Note:

    Manually installing xsltproc is only necessary for Linux systems. Windows and Mac will already have this installed.

  2. Install xsltproc with sudo get-apt install xsltproc.

Install and run demo

  1. Switch into the directory where you want to install Xeditor:
    cd myNewXeditor
  2. Get Xeditor package:
    npm pack @xeditor/xeditor-demo
  3. Decompress downloaded folder, e.g. with
    tar -xzf xeditor-xeditor-demo-2.4.0.tgz
  4. Switch into new package folder.
    cd package
  5. Install the packages dependencies using npm.
    npm install
  6. Start the demo application.
    npm run start:develop

The demo package is now up and running. Enjoy!