The OBS Framework is delivered as one single web site that contains all the framework
documentation and gives access to all its code including source code, meta-component
code, and command files. The OBS Framework should normally be expanded in a dedicated
directory called ObsFramework. This page discusses some issues related to
the installation and usage of the OBS Framework web site.
Web Site Structure
The HTML pages that make up the OBS Framework web site are automatically generated by XSL
programs that process a set of XML documents. The appearance of the web site can be
customized by modifying the XSL programs. Customization of these programs would also
allow generation of the OBS Framework documentation in a format other than HTML (e.g.
PDF). The xsl programs that generate the web site can be found in the project directory
doc/xsl.
All the figures used by the web site are stored in the project directory figures.
The hyperlinks to the figures are automatically generated by the XSL transformations.
The generation of the OBS Framework web site can be done automatically by calling the default target
in the Ant command file
build.xml
. The interpretation of the XML files is done by the Saxon XSLT processor.
Command Files
A number of command files are provided in the /scripts directory of the OBS
Framework. Command files are implemented as Apache Ant build files. The Ant command
processor is not included in the OBS Framework delivery but can be downloaded at no cost
from the Apache Ant web site. The meta-components
require version 1.1 of the XSLT processor. During the development of the OBS Framework,
the Saxon XSLT processor was used. This processor may not be included in the default
Apache Ant delivery. The corresponding saxon.jar file can be downloaded from
the Saxon web site and must then be placed
in the lib directory of the Ant command processor.
The master command file is build.xml. Its default target processes the framework feature models, generates the HTML pages
that make up the web site, generates the doxygen
documentation of the source code, and runs all the generator meta-components associated to the framework.
The command directory also contains the makefile that is used to build the regression test of the OBS Framework under a Linux environment.
The code documentation is automatically generated using the (open and free software) facility doxygen. The Ant command file requires doxygen to be available on the host platform. Depending on where the doxygen executable is located, the "doxygen"property in the Ant build file may have to be modified.
Project Files
For the convenience of some users, the OBS Framework includes four project subdirectories
(in directory projects). Two projects are oxygen projects that cover the definition of the
framework models and of the web site, respectively. The third and fourth project
subdirectories contain Microsoft Visual Studio (version 7.1) projects of which the first
cover the regression test whereas the
second one covers the sample application test that is used in the memory occupation tests. Note
that the VS environment hardcodes the full path of the files it manipulates. The VS
projects files included in the OBS Framework delivery assume that the framework web site
is placed in directory: D:/Projects/ObsFramework.