Vex User Guide

Overview

What is Vex?

Vex is a V' isual '''E'ditor for 'X'ML 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, DITA and XHTML. To edit other XML formats only a DTD (or XML schema) and a CSS are needed.

Who Uses Vex?

Installation

After installing one of the Eclipse Indigo or later packages, the easiest way to install Vex is via the Eclipse Marketplace by performing the following steps:

The Vex installer adds the following items to your Eclipse installation.

The Vex installer also makes the Visual XML editor the default editor for xml files.  If you would like to change this preference see the General - Editors - File Associations section of the Eclipse Preferences tool.

Document Creation

After installation, you are ready to create and edit an XML document using the Vex tools.  You are not required to use the Vex tools to create the initial XML document but the Vex tools may help you get started.  After creating a project to contain your XML document, perform the following step:

Vex supports the following Document Types out of the box.

After creating the document you are ready to add elements and content.

Document Navigation

You navigate between and within document elements using the mouse and the arrow keys on your keyboard.  As you navigate the document, the Eclipse status bar displays your current location within the document and the cursor orientation gives you clue as to what you can do at the current location.

A vertical cursor indicates that you can type content into the element while a horizontal cursor indicates that Vex is expecting you to insert new element.

Navigation Tip: Sometimes it is difficult or impossible to select the correct location to insert a new element using the mouse.  However, you should be able to get close with the mouse and then use the arrow keys to find the desired location.

Document Editing

Vex provides several commands to edit a XML document.

Editing Tip: Currently, Vex only displays the rendered view of the XML document, so you may want to also open the document using the Eclipse XML Editor. Having the document open in both editors allows you to move between the rendered XML in Vex and the source XML in the XML Editor.

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:

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.

Add Comment

Vex allows to insert and edit XML comments: simply choose Document | Add | Comment (or hit Ctrl+7 ) to insert a new comment at the current cursor position. Vex renders <!-- and ''-->'' as start and end marker for the comment. Everything between those markers is the comment text.

The formatting of comments can also be defined in the CSS (see Pseudo Elements).

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:

&lt;emph&gt;The element's content&lt;emph/&gt;

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.

The Remove Tag command can also be used to remove comment tags from a comment to "uncomment" text.

Find/Replace

The option Scope is inoperable.

Visual XML Plug-in Project: Configure your own XML format

A Visual XML Plug-in Project contains information about a custom document type accompanied with (at least one) style definition. This is one way to make a custom document type usable in the Visual Editor for XML (Vex).

The Visual XML Plug-in Project consist of a file named vex-plugin.xml, which contains the configuration, plus all files needed for the document type definition (DTD) or XML Schema (XSD) and style (CSS).

The following steps describe how to create such a Visual XML Plug-in Project:

  1. Choose File | New | Project...
  2. Choose XML Authoring | Visual XML Plug-in Project
  3. Add the DTD/XSD and CSS file into the project
    1. Open the properties dialog for the main *.dtd file: Right-click on the *.dtd file and choose 'Properties''
    2. Choose Visual XML Document Type
    3. Enter all information about the document type and select the allowed root elements
    1. Open the vex-plugin.xml file with a text editor: Right-click on the vex-plugin.xml file and choose Open With... | Text Editor
    2. In the root element <plugin> add following XML snippet:<source lang="xml"><extension id="UNIQUE_ID" point="org.eclipse.vex.ui.doctypes" name="MY_LABEL"><doctype publicId=" http://my.public.id" systemId="path/to/sample.xsd"><rootElement name="my-root-element"/></doctype></extension></source>
    3. Edit UNIQUE_ID, MY_LABEL, http://my.public.id , path/to/sample.xsd and my-root-element
  4. Open the properties dialog for each *.css file: Right-click on the *.css file and choose 'Properties''
  5. Choose Visual XML Style
  6. Give the style a name and select all document types for which this style should be available

Now, a new document of your format could be created by choosing File | New | Others... | XML Authoring | Document , clicking Next > and choosing the name of your Document Type.

Deploy a Visual XML Plug-in Project as Eclipse Plug-in

  1. Create a new Plug-in project: Choose File | New | Project... and Plug-in Project and enter the required information
  2. Copy all Files from the Visual XML Plug-in project into the new Plug-in project
  3. Add the extension org.eclipse.core.contenttype.contentTypes: Open plugin.xml and in the Extension tab click the Add... button; choose org.eclipse.core.contenttype.contentTypes
  4. Copy the content of the root element vex-plugin.xml into the plug-in.xml file
  5. Delete vex-plugin.xml
  6. Add all files to '''Binary Build ': Open ''plugin.xml and in the Build tab in Binary Build section select all required files
  7. Export as Eclipse plug-in: Open plugin.xml and in the Overview tab in the Exporting section click Export Wizard link

CSS

Rules

Pattern Meaning See W3C
* Matches any element Universal selector
E Matches any E element (i.e., an element of type E) Type selectors
E F Matches any F element that is a descendant of an E element Descendant selectors
E > F Matches any F element that is a child of an element E Child selectors
E + F Matches any F element immediately preceded by a sibling element E (this rule is applied when saving instead of when editing the document) Adjacent selectors
E foo Matches any E element with the "foo" attribute set (whatever the value) Attribute selectors
E foo="warning" Matches any E element whose "foo" attribute value is exactly equal to "warning" Attribute selectors
E foo~="warning" Matches any E element whose "foo" attribute value is a list of space-separated values, one of which is exactly equal to "warning" Attribute selectors

Not (yet) supported: E:first-child (see The&nbsp;:first-child pseudo-class), E ="en" (see Attribute selectors), E#myid (see ID selectors), and CSS3 rules (e.g. E foo^=bar or E ~ F)

Layout



Font


VEX specific properties


Pseudo Elements