Setup with pre-configured schema

Xeditor does also offer a couple of pre-configured schemas which can be used directly without any additional configuration.

We provide the following standard schemas already pre-configured:

  • DITA (see here here for a guide)
  • JATS
  • (Lightweight DITA)
  • (Xdoc)

Those packages are delivered with

  • a complete schema configuration
  • basic styling
  • pre-configured toolbar and button templates
  • configured return handling
  • some custom code to improve usability and add required / schema specific features
  • configuration of middleware server

So, if you are either already using one of those schemas, or are interested in starting to use them, those packages are a good starting point, since they spare you a lot of configuration work.

In addition, those schemas are managed and updated by the Xeditor team. Therefore, you don't have to worry about performing updates yourself, since we update them to the latest Xeditor version and ship it out.

Downloading and installing a pre-configured schema module

For this, we will use the JATS package as an example. However, the process is identical for any other schema configurations we offer.

For a detailed description of the packages content, see our section about the folder structure.

In order to download and install the JATS schema configuration, proceed as follows:

  1. Download the package by executing npm pack @xeditor/xeditor-jats
  2. Extract it by running tar -xzf xeditor-xeditor-jats-{VERSIONNUMBER}.tgz (make sure to replace the version number with the version of the package you downloaded) This will create the folder package containing the whole Xeditor project.
  3. Navigate to the package
  4. Install the package and its dependencies by executing npm i

Now you are able to start up Xeditor by running

npm run start:develop

You can now access Xeditor by visiting http://localhost:7070/ with your browser.

Configuration / extension of pre-configured schema module

Since a pre-configured schema module has the same files and structures as a complete custom schema configuration, you can still go through our basic and advanced guides and extend it as required.

Updating pre-configured schema module

Updating a pre-configured schema than updating a "regular" Xeditor package using a custom schema. So you can follow the same update steps as for a regular package. Instructions on this can be found here.