Revision as of 20:02, 22 August 2010

Vex User Guide

Overview

What is Vex?

Vex is a Visual Editor for XML that hides the raw XML tags from the user, providing instead a word processor like interface. Vex uses standard DTD files to define document types and CSS stylesheets to define document layout. Vex contains definitions for DocBook and DITA. To edit other XML formats only a DTD and a CSS are needed.

Who Uses Vex?

• Pacx
• TextGrid

Create a new Document

• DITA
• DocBook
• Other XML Formats

Editing

Vex provides several commands to edit a XML document.

Copy and Paste

Undo/Redo

Add Element

To insert a new element at the current cursor position or - in the case if something is selected - to surround the selected text or fragment with a new element:

1. Choose Document | Add | Element... (or hit Ctrl+Space)
2. In the content assist which pops up choose the element to add by one of the following possibilities:
   • Use Up and Down keys to select element and hit Return
   • Click on the element to add
   • To filter the list of elements type the name or a part of the name and hit Return to add the topmost element

Tip: To place the cursor at the proper position (e.g. a new chapter between two existing chapters in DocBook) see the path which is shown in the status bar.

Duplicate Selection

This command duplicates the currently selected elements and inserts them at the beginning of the current selection. If there is nothing selected, 'Duplicate Selection' duplicates the element that surrounds the current cursor position.

The document's root element can, of course, not be duplicated.

Convert Element

This command allows you to change the surrounding element of the current selection. A popup dialog shows a list of all elements that could replace the element. An element A can be replaced by another element B, if B can contain all the content of A and B is allowed at A's position in the document structure. If you select one of the list items, the popup dialog is closed and the element, which surrounds the current selection is replaced by the selected element.

Remove Tag

This command removes the element that surrounds the current selection:

<emph>The element's content<emph/>

will result in

The element's content

The main purpose of this command is to remove inline elements from text. If you use 'Remove Tag' to remove structural elements (e.g. <para> or <section>), the content of the element might also be removed. The current implementation does not handle this case properly. This might change in the future.

Find/Replace

The option Scope is inoperable.

Vex Plug-in Project: Configure your own XML format

1. Choose File | New | Project...
2. Choose XML Authoring | Vex Plug-in Project
3. Add the DTD and CSS file into the project
4. Edit file vex-plugin.xml:

<plugin>
    <extension id="MyXml"
               name="My XML"
               point="org.eclipse.wst.xml.vex.ui.doctypes">
        <doctype dtd="folder/myXml.dtd"
                 publicId="-//MY//XML//EN"
                 systemId="myXml.dtd"/>
    </extension>
    <extension id="MyXmlStyleA"
               name="My XML - Style A"
               point="org.eclipse.wst.xml.vex.ui.styles">
        <style css="folder/myXml.css">
            <doctypeRef publicId="-//MY//XML//EN"/>
        </style>
   </extension>
</plugin>

Vex Plug-in: Deploy your XML Format Configuration