The installation takes quite a lot of place because of all graphics needs to document DocBook and XML Schema.
 |
| ||||||
|---|---|---|---|---|---|---|---|
|
| ||||||
|---|---|---|---|---|---|---|---|
At the present stage of the SchemaDoc project development, the environment relies on some XML Spy outputs (see requirements). Therefore, running SchemaDoc on Linux systems is not recommended as long as this dependency is not resolved.
The core code component (generator) will run on any Java machine with at least a SUN Java VM 1.5.0_01. Useful scripts are solely provided for Microsoft Windows and Linux and the SchemaDoc graphic interface will not be fully functional on other operating systems.
Minimum disk space: 60 MB.
The installation takes quite a lot of place because of all graphics needs to document DocBook and XML Schema.
Minimum memory used : 256M but may need to be increased because of the memory used by FOP as soon as there is a lot of schema images.
As an option, SchemaDoc generates a documentation that contains high-valued graphical representations of the model it is documenting. These representations are built from structured objects produced by Altova XML Spy. Though the SchemaDoc environment does not technically require XML Spy to be installed on the system it's running on, most users will want to take advantage of all SchemaDoc features.
Software components needed to install the SchemaDoc environment on your system are available on the SchemaDoc web site. Though the environment can run on any system homing a compliant Java virtual machine, it's packaging is system-dependant :
Microsoft Windows users will get a single executable
file, hereafter called the installer
Linux users will get a zip archive
The SchemaDoc installer can be stored and run from any directory since the installing process will ask for an installation target directory. Running the program initiates a 4 steps installation process.
License agreement
Select the installer target directory
What needs to be installed will be choose from this panel. At least, programs are needed.
Done !
Clicking the Show details button displays
the installation log, hiding the installer window content.
The end of the installation launches the documentation, if required in (3).
Though the installed environment can be moved to another base directory, testing the installation before proceeding is deeply recommended.
Over Linux platform, a sole zipped file is provided. The user
will extract the content of this archive to the directory that will
home the SchemaDoc environment. Keep in mind that SchemaDoc Java components
expect the JAVA_HOME environment variable is set
to a proper value.
The SchemaDoc generator is the core software
component of the SchemaDoc environment. Running this component gives
a fairly good estimation of the achievement of the installation process.
You don't need to master SchemaDoc concepts to proceed this test.
You can just do it and check if you get the expected results.
The base directory where the SchemaDoc was installed (hereinafter
named ~SchemaDoc) looks like this :
The bin directory contains the scripts
that will launch the generator : sdOutput.bat for Windows users and sdOutput.sh for Linux
users.
When run, the generator opens a new window on the users's desktop :
view
The installed environment provides a SchemaDoc documentation sample that can be used to test the generator. All the
files needed to perform the test were installed, including the XML
Spy graphical outputs. Therefore, the test can be driven on any Linux
or Windows system that fulfills the basic requirements. To process the sample, just click the Go button that displays on the generator interface.
Logged messages should display in the Log field and should not contain any error nor warning message. The
end of the process is signaled by the "Completed !" message.
 |  |  |
| 1. Introduction | 3. The environment |
