Project Aon

Warning: Parts of this page are sorely in need of revision

Obtaining the XML

Project Aon uses XML source files to create the end product that is consumed by visitors to the website. These source files are located in several places:

SVN

The current working copies are stored in a subversion repository (SVN for shorts). If you need to work on the XML files themselves, you need to use SVN.

You can access a anonmyous http view of the repository and you can also anonymously access the repository using a SVN client

To gain write access, you must

  1. set up a subversion client for your operating system. The subversion site lists how to do this. For MS Windows users, we highly recommend TortoiseSVN.
  2. post a request for access to the repository on the volunteer mailing list

Using the SVN command line

For users that have the command line svn client available for the operating system. You can do the following to checkout all the XML files:

  • Request access to the repository:
    • Anonymous access: svn co http://www.projectaon.org/data/ projectaonsvn
    • Write access: svn co --username YOURUSER http://www.projectaon.org/data/ projectaonsvn (you will be prompted for your password)
  • Download your local copy svn update

The "projectaonsvn" is optional. It specifies the folder the files should be written to.

If you make changes, make sure you send them back using svn commit.

For an in-depth view of SVN read the Subversion book.

Published XML

The XML files which are deemed ready for publication are located on the web at:

http://www.projectaon.org/en/xml/ http://www.projectaon.org/es/xml/

That's the theory in any case. It's probably safer to select a particular revision in SVN based on the log.

Checking for Errors

When you have altered an XML source file, it is critical that you validate your revision.

XML Validation

Your XML must validate. RXP is a good XML validator, you can also use

gblint.pl

For some of the common problems found in our XML files, we have created gblint.pl which is available in SVN in the "scripts" module.

Publishing from XML

Those who need to publish the XML will need access to upload XML source files to the website. Request this access on the volunteer mailing list.

If everything is set up correctly and the planets are aligned, simply uploading to the previously mentioned directories will cause an XHTML version of the book to be generated from the XML source file.

Prerequisites for Automatic Publication

There are quite a few things that must be set up before automatic publication will work correctly.

  1. Each XML file must validate
  2. Publication of an entirely new language requires that the site administrator revise the cron-gbtoxhtml.pl script to include the new language and create published and working draft directories for the language including the xml/ and .publisher/ directories [Although this needs fixing, there is currently only one .publisher/ directory for each language located in the working draft area.]
  3. Each book must have an entry in the language's standard rules file (.publisher/rules/standard)
  4. Each book linked to within an XML file must also have an entry in the htmllink.mod file
  5. All graphics for the book must be in the correct locations

Graphics Locations

The location for graphics files is a bit byzantine. Since there is only one .publisher/ directory, both published and working draft sections pull their graphics files from the same location on the web server. For example, here is the directory structure for one English Lone Wolf book:

http://www.projectaon.org/en/gif/lw/01fftd/ http://www.projectaon.org/en/gif/lw/01fftd/ill/ http://www.projectaon.org/en/gif/lw/01fftd/ill/alvarez-blake/ http://www.projectaon.org/en/gif/lw/01fftd/ill/blake/ http://www.projectaon.org/en/gif/lw/01fftd/ill/chalk/ http://www.projectaon.org/en/gif/lw/01fftd/skins/ http://www.projectaon.org/en/gif/lw/01fftd/skins/standard/ http://www.projectaon.org/en/jpeg/lw/01fftd/ill/chalk/

Examining the contents of each directory should give some insight into what needs to go where. The ill/ directory stores all proper illustrations. The skins/ directory stores all graphics which are part of the presentation of the book.

Other languages may not have complete archives. Only those graphics which require translation may be included in the non-English directories. The graphics which don't require translation are pulled from the English (en) directories.