Xeddy FAQ

HOWTO SECTION
...with an overview of common tips and tricks is available here for XML files or here for DTD files.

Xeddy is an XML editor written in Java and this is its FAQ page. If you are using our editor, you can find some useful information regarding installation and running the application here.

General

What is Xeddy
Xeddy is an XML editor developed as a plugin into JBuilder or a standalone Java Application.

What is the difference between Xeddy Standa and Xeddy JB
Xeddy 1.5 Standa is a standalone application that can run above any 1.2.X Java Virtual Machine (TM). Xeddy 1.0 JB is a JBuilder plugin working within JBuilder 3.5 and higher. Both versions have identical functionality.

Why should I use Xeddy
Xeddy is extremely easy to install and use. After you download the installation package, it is a matter of seconds to start working on your XML files. It supports XML parser plugging, is close to DTD, allows direct editing of code, does not force you to use its formatting and many more. See more about features.

What is SDEX
SDEX (Simply DTD editor for Xeddy) is simply a DTD editor developed as a part of Xeddy Standa 1.5 application or as a plugin into JBuilder.

What is DTD?
Every XML document can have rules on what elements and attributes it may contain. The rules are stored in a DTD file. If you want to edit this type of files, try SDEX
note: Click here for more details about DTD files ;-)

What is the difference between Xeddy and SDEX
Xeddy is an XML editor. You can use it only for editing a XML code. If you want to edit a DTD file you should use SDEX.

Downloading

How to download Xeddy
Click here to download the package

Installation (Xeddy 1.5 JB)

How to install Xeddy
Unzip the downloaded package into jbuilder's ~/lib/ext directory. Restart JBuilder; if it is running.

How to check the installation
Open any XML document. A typical Xeddy screen should appear. If not, see JBuilder's console for errors. Check the XML parser installation (should be present in the same folder), make sure you are using JBuilder 3.5 or have updated 3.0's startup file (in Windows, sometimes not all .jar files from <JBUILDER>/lib/ext are properly loaded). Also do not hesitate to contact our support at xeddysupport@amaio.com; please enclose your system configuration, the operating system you are running, and the text from the console.

Installation (Xeddy 1.0 Standa)

How to install Xeddy
The installation processes are different on different operating systems. Please select the operating system you use.

How to uninstall Xeddy in MS Windows operating system
Uninstallation process in Xeddy is identical to common Windows applications. Press buttonStart and select the menu item Settings... | Control panel. Select Add/Remove programs. SelectXeddy 1.5 and press the Remove selected. The Xeddy application will be removed.

How to uninstall Xeddy in Linux or Unix operating systems
For uninstalling Xeddy in Linux or Unix operating systems you should delete the Xeddy directory. (The directory which you are using for starting the Xeddy application).

How to check whether the Java Virtual Machine(TM) is present on your computer
Invoke a command line and type the java command. If your computer does not know this command it has no Java Virtual Machine(TM).
Note: The complete installation of Xeddy provides a Java Virtual Machine(TM) for its use.

How to start Xeddy 1.5 Standa
If you used Windows 9X/ME/NT operating system, press button Start and select menu item Programs | Amaio Technologies | Xeddy 1.5 Standa.
If you used Linux or Unix operating systems, locate the <XEDDY_HOME> directory and launch the xeddy.sh script.

Working with XML files

How to open an XML file
Choose "Open file..." from the File|Open menu. Click here for more details.
How to create an XML file
Choose "New file..." from the File menu and let the wizard guide you. Click here for more details.

How to create an element or attribute
Typically, there are several ways you can do this. The easiest way is to locate the correct piece of XML code and type the required element. The editor will parse the information and update the structure. A better way is to select a parent node of your new node (node colortable in our example), right click and choose 'Add Subnode...". If you are using a DTD file, the easiest way to insert an element is to use the Add submenu. The integrated DTD parser will keep this menu in sync with current state of the document. Click here for more details.

How to edit an element or attribute
Editing the elements and attributes is extremely simple, just select the element in the structure view and change its value or the value of its attribute in the inspector. Click here for more details.

How to work with templates
You can save any element (except the root) as a template. Once you have done so, the system will add the saved item into the Add menu for the relevant nodes; therefore you can add a saved template to an element just by selecting its name from the Add submenu. Click here for more details.

Is it possible to use any XML parser
You can use any SAX/2 parser that supports the Location feature. Unfortunately, this is only the Apache Xerces now.

More information
Check the community pages for Xeddy documents regarding Xeddy's development. It describes why we have chosen JBuilder and its API as a main development target for Xeddy, involves some tips of how_to start writing modules for JBuilder, and explains a bit from Xeddy's architecture.

Working with DTD files

How to open a DTD file
Choose "Open file..." from the File|Open menu. Click here for more details.

How to create DTD file
Choose "New file..." from the File menu and let the wizard guide you. Click here for more details.

How to create a new element declaration
Typically, right click in the Declaration List and select <ELEMENT menu item.
Click here for more details.

How to crate new attribute declaration
Right click in the Declaration List and select <ATTLIST menu item.
Click here for more details.

How to build the content model in element declaration
The SDEX editor allows operations with content model. You can add, remove, copy and paste the content model or its parts.

If you want to add a new element declaration, invoke the popup menu in Declaration Structure and select the Add Custom Element menu item.
Click here for more details.

If you want to group declarations in the declaration group, select the element which you want to have in the group, invoke the popup menu in Declaration Structure and select the Enclose (Elm,...) menu item.
Click here for more details.