prev-arrow Projekte
Team Peter Heilbronn
Thema Readme of MXKS xml Project ( original )
Home www.mxks.de
1. Overview
2. Structure
2.1. Global structure
2.2. Logical structure of a level
2.3. Build structure, level and collection build
3. MXKS
3.1. First level files
3.2. Second level files
4. Main Build.xml file
4.1. Overview
4.2. Targets
4.3. Paths
4.4. Index files
4.4.1. Original file, origbuildmode
4.4.2. Compiling
5. Todo

1. Overview

The goal:
We use
Jakarta apache.org
ant apache.org
Xalan apache.org
In fact we have discovered a new technologie, the XSL with Xalan, we try to use this simpler processing for our case.
In each of the directories should be exist a separate specialized Readme.xml file.

2. Structure

2.1. Global structure

The dtd's described the html files to create over a xml representation. The build.xml file is the ant 'Makefile' to start the creation process. With this mechanism we can write the excerpts into an format independent way over xml. With certain jsp programs we can create distinct representation of the content like html or pdf, ...

2.2. Logical structure of a level

We have two files which describe the structure of a level of the site.
The navbar file
describe the whole level with it's pages, like n index pages or others. This represents the described order.
The index file
describe the grouped or non grouped pages of the lower level as IndexGroups' and IdexItems. Here we find source and destination paths of the files and the stylesheet to use and other things. This represents the vertically order.
Build files
There exist a main build file and so called subproject build files which represents rules of lower levels or other views as the main view. Automatically created buildfiles have an underscore '_' as trailing letter in name respective a '_build' as suffix in case of an sublevel build file .

2.3. Build structure, level and collection build

firstlevel - ... -(level)-> index file -> original files -> xml files -> original files -> xml files
Navbar file: IndexGroup -> IndexItem -> IndexItem -> IndexGroup -> IndexItem ->IndexItem
The begin of each build is the main build file. From here we call all sub build processes. We have a lot of targets (see below).
In generally there exist a multi step target for each level (level build):
1. creation of the level build file over the navbar file of this level with navbar2build.xsl
2. with this build file creation of the level main pages, thats the pages linked over the navigation bar, _build.XXX.xml
2.1 and creation of the compact index files, which includes all external informations inside
3. creation of sublevel build files for each index file,XXX.xml_build, to create the subfiles of this index file
4. with this build file creation of the subfiles and several copy and link actions

3. MXKS

The first processing we use for the MXKS pages.
The project files related to the xml processing are in the apronsknie/xml directory. Here we find the related dtd, xsl and doc directories.
The automaticly created html files and the other archive or original files are sited in the apronsknie-mxks tree.
The first level pages are processed with the main build file apronsknie⁄xml⁄build.xml.

3.1. First level files

apronsknie⁄xml⁄mxks top level MXKS files
apronsknie⁄xml⁄misc other files
The apronsknie⁄xml⁄mxks⁄apolit.peter.index.xml is the main excerpt index file.
  1. It described the whole of the structure of the excerpt overview and will be processed into a html page
  2. It will be used to construct the excerpts them self because the file contains informations about the original files
  3. Within the index will be used to construct the excerpt build.xml files.

3.2. Second level files

Here we use automaticly generated build.xml files

apronsknie⁄xml⁄mxks⁄excerpt excerpt xml files
apronsknie⁄xml⁄mxks⁄kapital excerpt xml files related to the Kapital

4. Main Build.xml file

4.1. Overview

This file includes the process rules to create the MXKS web site. Here we use the jakarta 'ant' tool. There exists targets with a deeper process level. It creates subproject build.xml within a xsl and process these subprojects.

4.2. Targets

The actual targets are builded direct automatically from the main build file.
"Actual target descriptions"

4.3. Paths

We have 2 paths. First is the path of the xml tree, the source path. The base directory is the root if it in which we start the 'ant' tool with the main targets.
The second Path is the result document tree, called the target path, the html tree of the MXKS web site related documents. The root is given with the '$dest.home' property of the main build.xml file.

4.4. Index files

The index file include decodeions of all related link targets as IndexItems. Each of it has an nested Abstract item which descripe the target documents content like author or title. The IndexItem itself include informations about the optional source document, target link location and an optional file to copy into the target path.

4.4.1. Original file, origbuildmode

The original source file can be a raw file or an well known xml file. In the first case the rules just create a copy tag to copy the file without changes into the target location. If we have an well known xml file, that is the origbuildmode=build, it will be a compiling target tag to process this file as the output file format into the target location.

4.4.2. Compiling

The processing of the index file is a multi step way. First a new index file will be created which include all extern informations as internal structure, because we may wish to sort. The second step is to process this new index file to create its html representation. In the third step we create a new ant build file which includes building rules about all of the nessecary index items to build. And now its time to process this build file to create all subordered target files.

5. Todo

^ top

last update : Tue Apr 06 00:39:54 CEST 2004 Peter Heilbronn
automatically created by Linux/X86; vendor=Apache Software Foundation; version=1; http://xml.apache.org/xalan-j