> iriel.org XML Markup

Overview

One of the aims of this project is to create a very simple set of XML markup tags to enable rapid and easy creation of usable content, oriented towards jotting down notes and code snippets on various topics. In order to remember what has been implemented so far, as well as to provide documentation for future potential users of the markup, this section will attempt to describe all valid elements and their usage.

Content structure

Content for the site is placed into a directory tree called the content tree. The page navigation flow on the site will mirror this content tree almost directly, so just place your documents in a logical arrangement within it. Documents themselves are XML files that define pages, using an XML schema defined by this project. Each of the files begins as follows:

Start of content file

The first two lines indicate that the file is an XML file (its filename must also end in .xml otherwise the publisher will ignore it), and that it contains a Page element defined by the http://www.iriel.org/Site/content namespace. The third line provides the name of the page which is displayed at the top of the page, as well as in the site navigation.

You can give your files any names you want, but there are two special names to be aware of; In the topmost content directory, the file root.xml is used as the main page for the site (This is so that index.html can be provided in a more static manner, though that might be changed in the future). In all other directories the file index.xml is used as the index page for the directory, and is the default page to display when navigating to the directory that contains it. It's important, and useful, to note that subdirectories which do not contain an index.xml file will not be listed in their parent's navigation box, and can only be reached by explicit links.

See the entries under the Concepts navigation header for details of the specific markup elements within each file.