Documentation for the BAD Engine

XML Files

For each before and after page there is an XML file which is constructed in the following way:

<annotations>
	<annotation id="01">
		<title><![CDATA[
			Text
		]]></title>
		<desc><![CDATA[
			Text
		]]></desc>
		<linkplace>prev_sib|parent_node</linkplace>
		<style><![CDATA[
			CSS
		]]></style>
		<guideline id="ID">
			<title><![CDATA[
				Text
			]]></title>
			<desc><![CDATA[
				Text
			]]></desc>
			<link>URL</link>
		</guideline>
	</annotation>
</annotations>

Elements:

• annotations — Root element
  • annotation – Individual annotations (multiple times)
    • @id – Number of the annotation, later used in the marker
    • title – Annotation’s title
    • desc – Annotation’s description
    • linkplace – Describes which element to highlight on mouse over – Possible values: pev_sib, parent_node
    • style – Custom style for the annotation – Probably we move that into the marker in the markup
    • guideline – The guidelines/techniques which are displayed on the bottom of the page (multiple times)
      • @id – Number of the guideline/technique
      • title – Title
      • desc – Description
      • link — Link to the guideline

PHP marker

There are two markers which can be attached directly to the HTML code. Example:

<div id="header"<?php GAp(true);?>>
	<img src="…" alt="Citylights: your access to the city."><?php GA('01'); ?>
	<img src="…" alt="Sunny Spells">

• GAp() – notes the parent element of an annotation
  If you provide true as an parameter a whole class="annot_link_parent", if there is already a class attribute just put it like that and it will attach the class in annotation mode:

  <div id="header" class="example<?php GAp();?>">

• GA($ID) – Get Annotation. Puts out the annotations.