ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Exalt

by eerohele ST3

A Sublime Text 3 plugin for validating and formatting XML and (X)HTML

Details

Installs

  • Total 5K
  • Win 3K
  • OS X 2K
  • Linux 660
Jun 25 Jun 24 Jun 23 Jun 22 Jun 21 Jun 20 Jun 19 Jun 18 Jun 17 Jun 16 Jun 15 Jun 14 Jun 13 Jun 12 Jun 11 Jun 10 Jun 9 Jun 8 Jun 7 Jun 6 Jun 5 Jun 4 Jun 3 Jun 2 Jun 1 May 31 May 30 May 29 May 28 May 27 May 26 May 25 May 24 May 23 May 22 May 21 May 20 May 19 May 18 May 17 May 16 May 15 May 14 May 13 May 12 May 11
Windows 0 2 1 3 6 6 12 10 0 2 7 14 4 5 8 0 0 3 1 17 9 11 1 0 4 4 3 4 6 1 0 5 11 6 4 4 3 0 8 4 7 10 17 1 2 5
OS X 0 1 1 3 4 4 2 3 1 0 1 4 3 4 3 1 1 2 2 4 3 3 1 0 4 1 3 4 2 2 2 2 2 2 8 1 0 1 5 1 8 4 3 2 3 1
Linux 0 1 0 2 1 2 3 2 1 0 0 1 1 2 3 1 2 5 1 0 2 1 1 1 2 2 2 1 4 0 0 1 3 1 1 0 0 0 1 2 3 1 0 0 0 1

Readme

Source
raw.​githubusercontent.​com

Exalt

If you have the misfortune of having to work with XML, this is the Sublime Text 3 plugin for you.

The theme in the screenshot is Boxy.

Features

Validate files on the fly

Validate XML, XHTML, HTML, and XSLT files on the fly with lxml against a Document Type Definition (DTD), an XML schema (XSD), a RelaxNG schema (RNG), or a Schematron schema.

Exalt supports XML catalogs via lxml so that you don't need to put unnecessary load on W3C's servers.

XSLT validation

If the syntax of your current file is set to XSLT, Exalt automatically validates the file against Norman Walsh's Relax NG grammars for XSLT stylesheets.

XSD validation

Exalt uses the xsi:schemaLocation or the xsi:noNamespaceSchemaLocation attribute of the root element to validate against the schema defined in that attribute.

This means Exalt can validate Maven POM files that look like this:

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
                             http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>foobar</groupId>

    . . .
</project>

You'll probably want to set up an XML catalog to avoid having to fetch schemas from the internet. See Installing for more information.

xml-model validation

Exalt also supports the xml-model processing instruction. That means that you can have a processing instruction like this before the root element of your DITA XML 1.2 document (but after the XML declaration, of course):

<?xml-model href="urn:dita-ng:dita:rng:topic.rng"
            schematypens="http://relaxng.org/ns/structure/1.0"?>

Exalt will then validate against the schema in the href pseudo-attribute. It uses the XML catalog you've set up to resolve the path in the href pseudo-attribute and the schematypens pseudo-attribute to determine the the type of the schema.

You can naturally use absolute or relative paths, too:

<?xml-model href="file:///etc/xml/common/schemas/docbook/docbook-5.0/docbook.rng"
            schematypens="http://relaxng.org/ns/structure/1.0"?>


<?xml-model href="../docbook-5.0/xsd/docbook.xsd"
            schematypens="http://www.w3.org/2001/XMLSchema"?>


<?xml-model href="file:///etc/xml/common/schemas/dita/schematron/dita-1.2-for-xslt1.sch"
            schematypens="http://purl.oclc.org/dsdl/schematron"?>

If your file doesn't validate, you can press ⌘ + Ctrl + E to jump to the validation error if it's not already in view.

Format XML & HTML files

Press ⌘ + Ctrl + X to reformat (pretty-print) an XML or HTML file. If you have nothing selected, Exalt will format the entire document. If you have one or more selections, Exalt will format those.

NOTE: When formatting a selection, Exalt assumes the selection is a well-formed XML fragment. It will try to recover, but if your selection isn't well-formed, chances are the result is not what you want.

Exalt tries to format non-well-formed XML files via the libxml2 recover flag.

Schema caching

Exalt caches the schemas it uses for performance. This is useful if you're working on XML documents that use large schemas or when the schema is stored elsewhere than your computer.

However, this means that if you're developing a schema, the changes in the schema will not take effect until you clear the Exalt schema cache.

To clear the schema cache, run the Exalt: Clear Parser Cache command via the Sublime Text command palette. If you need to do it often, you might want to add a keyboard shortcut for that command in the Sublime Text settings.

Installing

  1. Install Exalt via Package Control.
  2. Restart Sublime Text.
  3. (Optional, but recommended.) In User/Exalt.sublime-settings, set the path to your XML catalog files.

    For example:

    {
      "xml_catalog_files": ["/etc/xml/catalog", "~/.schemas/catalog.xml"]
    }
    

    By default, the plugin uses the catalog files defined in Exalt/Exalt.sublime-settings. Those catalog files might or might not exist on your system.

    If you want, you can use my catalogs repository to install a set of commonly used XML catalogs and schemas. Just set the xml_catalog_files setting of this plugin to point to the catalog.xml file in where you cloned the repo.

    Alternatively, you can clonecatalogs into /etc/xml and create /etc/xml/catalog.xml with this content:

    <catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
      <nextCatalog catalog="catalogs/catalog.xml"/>
    </catalog>
    

    If you do that, you shouldn't need to set the xml_catalog_files setting.

    NOTE: If you change XML catalogs in any way, you need to restart Sublime Text 3 for the changes to take effect.

Known issues

  • Due to libxml2 issues #573483, #753970, and 753997, none of the available validation methods work for DITA 1.3 files. That's a bit of a bummer.
  • ISO Schematron validation doesn't always report the error position correctly.

Other caveats

  • There's probably many encoding things I didn't take into account. UTF-8 content should work OK.
  • I don't really know Python.

TODO

  • DTD validation support is incomplete.
  • More unit tests are needed.

Acknowledgements