EditiX Manual

EditiX XML Editor 2019 is now available

• 1. General Interface
  • a. Global view
  • b. Document type
  • c. Menu content
  • d. ToolBar content
  • e. Status bar
  • f. File browser
• 2. File management
  • a. Standard file access
  • b. Remote file access
  • c. Project
• 3. Editing
  • a. Tree
  • b. Editor
  • c. Content assistant
  • d. Namespace Manager
• 4. Templates
  • a. Creating a template
  • b. Updating a template
  • c. Using parameters
• 5. XML Differencing
  • a. Comparing the current document to another one
  • b. Diff content
• 6. XML Schema
  • a. DTD
  • b. W3C XML Schema
  • c. XML RelaxNG
• 7. XSLT document
  • a. Basic Transforming
  • b. Assign an XSLT document
  • c. XSLT Debug
• 8. DocBook document
  • a. Basic Transforming
  • b. Repeating the last transformation
• 9. XSL-FO  document
  • a. Basic Transforming
  • b. Repeating the last transformation
• 10. Document preview
  • a. HTML Preview
  • b. SVG Preview
• 11. User preferences
  • a. List of user preferences
  • b. Installing a new XML Parser
  • c. Installing a new XSLT Transformer
• 12. EditiX Components

1. General Interface

a. Global view

1. A set of menus which are active depending on the current document type
2. A toolbar varying with the current  document type
   
3. A tab list of opened documents with an icon and a file name depending on the current document type and the current document path
   
4. A status bar with data about the current editing state
5. A panel on the left side containing various windows like a file browser, a project manager, an xpath evaluator...
   

b. Document type

Each document has a document type that has to be choosen when opening a file according to the selected filter from the file dialog box.
When opening a document from the "Open recent" menu item or by opening a project from the "Open project" menu item, the document type is always restored. User may also change the default file encoding. User cannot define a new document type but it is always possible to assign another document type for a template document from the "Template" menu and the "Edit templates" item.

Here a list of available document types :

Document Type	Role	Icon
XML	Standard XML document
DTD	Document Type declaration
TEXT	Simple text document without XML content
XSLT	XSL Transformations document
XHTML	XHTML document
FO	XSL-FO document
RNG	XML RelaxNG document
XSD	W3C XML Schema document
SVG	Scalable Vector Graphics document
DOCBOOK	DocBook document
ANT	Ant project document

c. Menu content

d. ToolBar content

Icon

Role

New document

Open a document

Save the current document

Save the current document to another path.

Undo

Redo

Cut

Copy

Paste

Find

Search/Replace

Check or validate the current document

Format the current document

Split vertically

Split horizontally

Shortkey*

ctrl N

ctrl O

ctrl S

ctrl Z

ctrl Y

ctrl X

ctrl C

ctrl P

ctrl F

ctrl K

Icon
Role	Enabled/Disable the content assistant	Start degugging	Run until the next breakpoint	Run step by step	Stop debugging	Apply a transformation
Shortkey			ctrl  shift  B	ctrl shift E

Icon
Role	Analysis the DTD
Shortkey

e. Status bar

• An XSL Transformation
• A DocBook Transformation
• An XSL-FO Transformation
  

f. File browser

2. File management

a. Standard file access

b. Remote file access

• FTP (File Transfer Protocol) access : Menu File, Item "Open by FTP..."
  
• WebDAV access : Menu File, Item "Open by WebDAV..."
  
• ZIP or JAR file format : Menu File, Item "Open by ZIP..."
  

c. Project

For displaying the project panel, use the File/Project/Project Manager menu item or the View/Windows/Project Manager menu item. This panel contains your favorite files with the respective parameters like transformation (XSLT, FO), maximized state... Note that when a file is not found it is colored in red.

Note : If you leave EditiX having this panel opened, it will be restored automatically at the next EditiX call.

A project is stored in a file with the ".pre" extension. You may save/load your project or use the default one.

Toolbar actions :

Put the current opened document into the selected project node
Add a new group
Edit the group name
Delete the selected node (group or file)
Lock enabled : The current project file will be loaded automatically when editix's loading

Menu File / Project :

- ProjectManager : Show or hide the project panel. Note that it will save the project panel visibility for the next editix usage

- Open project... : Open a project file (*.pre)

- Save project : Save the current project file (*.pre)

- Save project as... : Save the current project file (*.pre)

- Export project as a ZIP document... : Export the project content in a zip. Note that it will create relative paths even for XSLT transformation... So your ZIP file can be reused on another machine and can work directly.

- Action / Open the selected file : Open the selected file from the project

- Action / Add the current document : Add the currenct opened document to selected project node.

- Action / Add a folder : Add a folder to the selected project node.

- Action / Rename a folder : Rename the selected project folder.

- Action / Delete a file reference or a folder : Delete the selected project node. Note that, it will not delete physically your file.

- Check project files : Check all files from the project. When a file is not found it is shown in red.

- Lock the project state for the next editix usage : A way to store the project panel state for the next usage.

Drag'n and drop is both available for project nodes (group or file) or from the file system. For opening your document just double-click on the file node, if the document is already opened it will be selected. When leaving the project, the visible files are saved and will be restored the next time the project will be visible.

3. Editing

a. Tree

Action	Role
	Comment the select node. If a comment is located inside the node, this action is rejected so in this case commenting the node will need to remove all inner comments.
	Copy the selected node and its content.
	Cut the selected node and its content.
	Past the last copied or cut node.
	Switch to another tree view. We detail it after.

• Default : The local node name is displayed with the first attribute value if available. If the node has more than one attribute a "..." content is added
• Prefix : The namespace prefix is displayed followed by the local node name. If there's no namespace prefix a "?" text is shown.
  
• Namespace : This is the namespace value followed by the local node name. If there's no namespace a "?" text is shown.
  
• Qualified name : This is the prefix and the local name.
  

b. Editor

c. Content assistant

• DTD
• W3C XML Schema
• XML RelaxNG
  

d. Namespace Manager

• A namespace prefix : This is a prefix definition or a bound namespace for the current node (meaning the definition is inside an ancestor node)
• A namespace URL : This is the namespace URL bound to the prefix. When a node is "qualified" it is inside this namespace URL.
• A current flag. This flag is for deciding what is the current namespace. There's only one activated flag because a node can't be assigned to several namespaces.
  

4. Templates

a. Creating a template

b. Updating a template

• Edit : The template (default one or not) will be editable inside EditiX.
  
• Remove : Remove the selected template. This action is disabled for the default templates.
  

c. Using parameters

• ${date}: Insert the current date/time
• ${cursor} : The caret/cursor will be at this location
• ${default-encoding} : This is the default document encoding like UTF8 available from the File menu.
• ${lastname}, ${firstname}, ${address}, ${phone}, ${email}, ${company} : User information
  

<?xml version="1.0" encoding="${default-encoding}"?>

<!-- New document created at ${date} -->

${cursor}

5. XML Differencing

• The left tree which is the current document (or a new selected one)
• The right tree which is another XML document choosen by the user
• A summary table for each selected node from one of the previous trees.
  

	Element added
	Element moved
	Element equal
	At least, one different descendant
	Element removed

a. Comparing the current document to another one

b. Diff content

• The "Change" column with a name for classifying the difference : "attribute removed, attribute added, attribute changed, element different,
  element added, element removed, element moved"
• The "Content" column which contains the detail about the change. For the case of an attribute this is the name or the value of the attribute. For the case of an element this is the name of the tag.
  

6. XML Schema

• A DTD (Document Type definition) which is a very common and simple way to check a document
• A W3C XML Schema which is a pure XML schema that is more precise and complex than a DTD
• A XML RelaxNG Schema which is may be between the DTD and the W3C XML Schema
  

a. DTD

<!ELEMENT root ( child1, child2 )>
<!ELEMENT child1 #PCDATA>
<!ELEMENT child2 #PCDATA>

b. W3C XML Schema

<?xml version="1.0" encoding="UTF-8"?>

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="root">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="child1" minOccurs="1" maxOccurs="1"/>
        <xs:element ref="child2" minOccurs="1" maxOccurs="1"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="child1" type="xs:string"/>
  <xs:element name="child2" type="xs:string"/>
</xs:schema>

<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="file:///home/japisoft/test.xsd">
</application>

<application att1="value1" att2="value2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="test.xsd">
</application>

<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mysite.com/test.xsd">
</application>

c. XML RelaxNG

?xml version="1.0"?>
<grammar xmlns="http://relaxng.org/ns/structure/1.0">
  <start>
    <ref name="root"/>
  </start>

  <define name="root">
    <element>
      <name ns="">root</name>
      <group>
        <ref name="child1"/>
        <ref name="child2"/>
      </group>
    </element>
  </define>

  <define name="child1">
    <element>
      <name ns="">child1</name>
      <empty/>
    </element>
  </define>

  <define name="child2">
    <element>
      <name ns="">child2</name>
      <empty/>
    </element>
  </define>
</grammar>

7. XSLT document

• A multi-view XSLT Editor
• An XSLT Debugger
  

1. An XSLT Editor in the center which is a standard XML editor with an adapted content assistant
2. A DATA Source view which is not editable but where the user can evaluate XPath expressions
3. A Result view which contains the transformation result document. This view has two modes : The Source mode which is a text result view and  an HTML 3.2 preview.
   

User can drag'n drop a node from the Data source to the XSLT editor for building template, for-each or value-of instructions.

The XSLT Debugger has five main parts :

1. An XSLT Editor in the center which is a standard XML editor with an adapted content assistant
2. A set of breakpoints located beside the XSLT Editor
   
3. A DATA Source view which is not editable but where user can evaluate XPath expressions
4. A Result view which contains the transformation result document. This view has two modes : The Source mode which is a text result view and  an HTML 3.2 preview.
   
5. A Debugging data view at the same location than the result view.
   

a. Basic Transforming

• XSLT file (required) : This is the current document path. This field must be specified only when transforming from an XML document.
  
• Data file (required) : This is the data document used by the XSLT document for producing a final document
• Result file (required) : This is the result document from the transforming of the Data file by the XSLT file
• Check box for opening the result file (optional) : When this element is pressed and the transformation is terminated, the result document is automatically opened as a new editix document. Most of the time it should be non-pressed.
• Set of parameters (optional) : This is a set of XSLT parameters we describe below
  

<xsl:param name="test1"></xsl:param>
...

<xsl:value-of select="$test1"/>

b. Assign an XSLT document

<?xml-stylesheet type="text/xsl" href="file:///home/test/test.xsl"?>

c. XSLT Debug

	Start the XSLT Debugging. It will run until the first breakpoint
	Run until the next breakpoint
	Run step by step
	Conclude the XSLT Debugging

• "Call stack" : This is the previous XSLT elements processed. The user can click on a line for displaying the similar line inside the XSLT editor. Two icons and are respectively for output elements and XSLT elements (with an XSLT prefix).
• "XPath NodeSet" : This is the current XPath expression evaluated with the found nodes. By clicking one a line, EditiX will display the similar line inside the data source view. Two icons and are respectivly for available nodes and for the current node.
  
• "Variables" : This is a set of accessible variables with their name, type and value. By clicking on a line, EditiX will show you the bound line inside your XSLT document.
  

8. DocBook document

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN"  "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd">

<book>
    <bookinfo>
        <title>Your title</title>
        <author>
            <firstname>Your first name</firstname>
            <surname>Your surname</surname>
            <affiliation>
                <address>
                    <email>Your e-mail address</email>
                </address>
            </affiliation>
        </author>
        <copyright>
            <year>2004</year>
            <holder role="mailto:your e-mail address">Your name</holder>
        </copyright>
        <abstract>
            <para>Include an abstract of the book&apos;s contents</para>
        </abstract>
    </bookinfo>
    <part>
        <title>Part1</title>
        <chapter>
            <title>Part 1, Chapter 1</title>
            <sect1>
                <title>Part1, Chapter 1, Section1</title>
                <para>    Your Text </para>
            </sect1>
        </chapter>
    </part>
</book>

a. Basic Transforming

• HTML
• HTML Help
• XHTML
• Java Help
• FO
• PDF
• XML
• PRINT
• PCL
• PS
• TXT
• SVG
  

b. Repeating the last transformation

9. XSL-FO  document

<?xml version="1.0"?>

<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format">
  <fo:layout-master-set>
    <fo:simple-page-master master-name="my-page">
      <fo:region-body margin="1in"/>
    </fo:simple-page-master>
  </fo:layout-master-set>

  <fo:page-sequence master-reference="my-page">
    <fo:flow flow-name="xsl-region-body">
      <fo:block>My text</fo:block>
    </fo:flow>
  </fo:page-sequence>
</fo:root>

a. Basic Transforming

• PDF
• GUI Windows : It will open a dialog box with the transformation result
• MIF
• XML
• PRINT
• PCL
• PS
• TXT
• SVG

b. Repeating the last transformation

10. Document preview

a. HTML Preview

b. SVG Preview

11. User preferences

• A list of groups
• A list of preferences for the selected group

a. List of user preferences

b. Installing a new XML Parser

1. Copy inside the EDITIX_INSTALL_DIRECTORY/ext/parser directory your jar file(s)
   
2. Modify the xmlconfig / parser preference with your JAXP SAXParser factory class
   
3. Restart EditiX

c. Installing a new XSLT Transformer

1. Copy inside the EDITIX_INSTALL_DIRECTORY/ext/xslt directory your jar file(s)
2. Modify the xmlconfig / xslt preference with your JAXP Tranformer factory class
3. Restart EditiX

1. Download SAXON (http://saxon.sourceforge.net)
2. Copy saxon.jar to the EDITIX_INSTALL_DIRECTORY/ext/xslt directory
   
3. Modify inside the EditiX the preference xmlconfig / transformer with the value com.icl.saxon.TransformerFactoryImpl
4. Restart EditiX

12. EditiX Components

• The Saxon XSLT and XQuery Processor from Saxonica Limited
• JXMLPad a swing component for editing XML from JAPISoft
• JDock a swing docking environment from JAPISoft.
• JResourceBrowser a swing component for browsing FTP,WebDAV,ZIP content from JAPISoft.