Copyright © 2005 Robert Bienert
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled GNU Free Documentation License.
This section describes all XML namespaces and the elements they contain. These tags are used for LayManSys in the RDF files.
Table of Contents
The elements in this namespace are used to include meta data about the web document as well as the entire website. Most of this elements are required for generating the HTML header.
All elements listed here have no attributes, they only contain character data between the opening and closing tag, except
Subject which contains an
rdf:li items. Some elements may be specfied in the global
etc/laymansys.rdf file so that they are valid for every document. They still can be overwritten on a per-document base using the (local) documents RDF file.
All elements are required to be either in the global or in the documents RDF file, except the ones noted specially.
This is the date when the document has been last modified. It has to be in a common Date and Time Format.
The description is a very important part of each documents RDF file because it describes briefly the document contents. It should be only a few sentences, so you do not need to give the complete abstract here.
This is the documents MIME type, which will be sent as HTTP
Content-Type header. In most cases you will use something like
This element contains all publishers of the document, so in most cases your name will be here, too.
This is the copyright statement for document. Although it is not used in the HTML header, the default implementation of
writeFooter uses it.
This element was introduced in release 0.5 and is used for access control. LayManSys recognizes the following values:
means public access, no restriction. This value is translated into a HTML
meta tag allowing full robots inclusion.
This value restricts robots access in a way, that robots do not index the document.
This value restricts robots access in a way, that robots do not follow any links.
This value is used for restricting access to the document in a user-defined way; for checking the access rights you have to provide a function
.htaccess you can leave this value or provide a stub function. It gets
$meta as parameter, but it is useful to accept it by reference. The formal definition of
The values (using
$accessRights as placeholder) used for restricting robots access to the document produce the following pseudo XHTML in the output:
<meta name="robots" content="$accessRights" />
See DCMI Government Working Group – Proposal: Access Rights qualifier for Rights element for more information about the semantics of
The elements in this namespace are used to include CSS files into your HTML content.
Use this element to reference style files that are included using XHTMLs
There are the following attributes:
This is the files path, either relative or absolute to the webservers document root.
Style files may be given a descriptive title. (Some webbrowsers let the user choose a style by selecting it by this name.)
This is the CSS output media the style file is designed for.
The syntax and meaning of this elements is very similar to the ones used for CSS elements. The only difference is, that not all attributes are supported.
This namespace contains elements for including layout information in LayManSys RDF files.
This is a stand-alone (empty) tag for including a so-called layout.cfg file. Use this attributes:
Specifies the config files path. It can either be relative or absolute to the constant value
DIR . '../'; the constant
DIR points to the document root, so it is absolute to the web projects directory.
LayManSys uses MIME types to determine how to handle the configuration files:
This tells LayManSys that the layout configuration is in the popular INI format as it can be read using the PHP function
parse_ini_file. See the ??? File Format Specification for details about this kind of files.
With LayManSys 0.3.0 you can also use XML bases configuration files. This files contain the same XML tags as described below for RDF files.
This tag is the root element for a XML-based layout configuration. It enclosures all other layout tags in the RDF files. The formal XML Schema Definition file can be found in the Appendix ???.
<!-- somewhere in the RDF file: --> <layout xmlns="http://laymansys.sf.net/rdf/layout"> <!-- put here the layout tags --> </layout>
There is only one attribute:
an optional name for the layout
The following elements can be used as stand-alone tags, referencing the files using
src attributes. But the file paths can also be the tags node value.
This tags purpose is including a so-called "favicon" that most browsers display in the address bar. It has the following attributes:
This is the URI path to the icon file.
This is icons MIME type. Common icon types are
This element references (and not includes) a Style Sheet file of any type and for any utput media, unlike the elements for css content. The tag accepts this attributes:
This is the style files URI path.
The style sheets MIME type, e.g.
A certain output medium the style sheet is designed for, e.g.
This is the files optional title. Some browsers use it for letting the user choose a certain one.
Your style sheets may be in a different character set than your web documents. Use this attribute to specify an explicit charset like
LayManSys supports the inclusion of a navigation module using this tag. It requires the following attributes:
This is the modules path, either relative or absolute to the constant
DIR . '../'.
The modules MIME type can be one of these:
This tells LayManSys that the navigation module is a "plain" HTML that can be passed through (using
This type specifies a PHP module that is included (using
include). The module has to define a function named
getNavigation, accepting two, optional three arguments:
The URI path (a string) of the section the current document – this term stands for the web document calling LayManSys – belongs to (as specified by the first
The documents encoding as string value.
A (optional) reference to the
$meta objects array with the documents related links.
This function may either write the navigation directly, but than has to return a printable value (this can also be
''), or return the navigations whole HTML code.
Using this (new) attribute you can tell LayManSys where to place the documents navigation. This setting deprecates the
.NavFirst. entry in the
laymansys/config.php file. There are the following positions available:
LayManSys places the navigation directly on top of the documents
The navigation will be put directly after the documents heading,
<h1 id="top">. To be backwards compatible, this is the default value for
With this setting, the navigation will appear directly in front of the documents footer (in the HTML code, you can position it anywhere else using CSS).
Using this argument, the navigation will be the last element inside the documents
Use this value, if you want the navigation to appear at another place inside the HTML code. LayManSys does not put out any code for navigation, it is your task.
There is not a certain set of tags you are only allowed to use. Instead, LayManSys' RDF-Parser accepts every element in this namespace. The following list shows some commonly used link types:
points to the Table of Contents
links the sections TOC
presents a link to the copyright information and/or your imprint
If you have a LayManSys RDF-File entry like this,
link:section entry in a RDF file
<link:section link:title="LayManSys Documentation">/doc/</link:section>
LayManSys transforms that into this XHTML code:
link:section transformed into XHTML
<link rel="section" title="LayManSys Documentation" href="/doc/" />