INTRODUCTION
------------

This repository contains the source files for the UIG use cases.  Final
production files are produced from the sources here.

CONTRIBUTIONS
-------------

Members of the UIG can request write access to this repository by sending 
an email to the address: support@lal.in2p3.fr with "Write access to EGEE/UIG
subversion repository" in the subject line. 

Contributions from authors outside of the UIG should be put into the 
repository by a UIG member.  That member should ensure that the contribution
passes the content and style requirements of the UIG.

CHECKING OUT REPOSITORY
-----------------------

The sources can be checked out with any subversion client.  Clients, both
graphical and commandline, exist for all major platforms.  The URL to 
check out the 'HEAD' revision is:

https://svn.lal.in2p3.fr/EGEE/UIG/trunk

For the command line, the check out would be:

svn checkout https://svn.lal.in2p3.fr/EGEE/UIG/trunk UIG

For graphical clients give the URL above to the checkout dialog for your 
client.

VERIFYING SOURCE AND GENERATED FILES
------------------------------------

People adding or modifying content within the repository should ensure 
that the source files and the generated files conform to the XHTML 
specification.  In addition, the source files should also conform to the
style defined by the UIG.

The validation of the files requires that you have java installed; you 
should install Java5 or later.  The validation is run through ant ('make'
for java) and relies on XSLT transforms to validate the files.

To run the source validation on unix from the root of your workspace:

./external/ant/bin/ant validate.src

This will validate that the file conforms to the XHTML standard and, if
successful, will also check the UIG style guidelines.  The process will
fail with an error if problems are found. 

To generate the 'final' production files and validate them, do the 
following:

./external/ant/bin/ant validate.generated

The generated files will appear in the subdirectory build/xhtml and can
be viewed with your browser.

To do everything (the default), the ant command without any options 
will work:

./external/ant/bin/ant

NOTE: Ant startup scripts for other operating systems are also in the 
./external/ant/bin subdirectory.  Replace the above command with the
one appropriate for your operating system.

ORGANIZATION
------------

The 'external' subdirectory contains a copy of ant and of saxon.  These
should never need to be modified manually.  New versions when released
can be obtained via the normal subversion 'update' command.

The 'src' subdirectory contains all of the sources for the pages.  Details 
follow.

'src/css': contains master style sheet for UIG pages; modify only if you
  know what your doing

'src/dtd': contains cached copies of DTDs to speed XHTML validation; do
  not modify any of the files here

'src/html-todo': uncompleted pages; this should eventually go away

'src/images': images used on final pages

'src/java': code for the custom ant tasks; modify only if you know
  what your doing
  
'src/xhtml': individual use cases

'src/xsl': XSL stylesheets for validation and transformation of raw use
  case files; uig-style.xsl is used to transform to the final production
  pages; uig-validation.xsl checks various UIG style guidelines