• Including the files ModeliXe, Mxconf and ErrorManager in your script.
• The configuration file.
• Instantiation of the class.
• Instantiation methods.
• Possible declaration of " plug-ins ".
• Parsing of the templates (call of the method SetModeliXe ()).
• Declaration of ModeliXe elements.
• Call the of the class exit method.

		web/project/project1/monfichier.php
		web/project/lib/ModeliXe.php
		web/project/lib/ErrorManager.php
		web/config/project1/Mxconf.php		

		define('MX_GENERAL_PATH', '../../config/project1');
		define('MX_ERROR_PATH', '../lib/');
		include('../lib/ModeliXe.php');		

• MX_FLAGS_TYPE, takes the value " xml ", " classical " or " pear ". It specifies the type of tag syntax used. At the moment " classical " and " pear " are equivalent. If this constant isn't assigned, the tag syntax used by default is " xml ".
• MX_OUTPUT_TYPE, takes the value "xhtml", "xml" or "html". It specifies the type of tag generated on exit by ModeliXe. If this constant isn't assigned, the tag syntax used by default is " xhtml ".
• MX_TEMPLATE_PATH, defines the directory in which the templates will be situated. It's possible to specify a path in the template declaration, but if this constant is assigned, the template declaration path will be relative to the MX_TEMPLATE_PATH directory.
• MX_DEFAULT_PARAMETER, definition of the path to the default configuration file, common for the whole site. If you specify a special parameter setting file during the instantiation of the class, it will override this default.
• MX_CACHE_PATH, specifies a directory to store cached pages.
• MX_CACHE_DELAY, sets a maximum time to live for pages in cache.
• MX_SIGNATURE, activates ("on") or deactivates ("off") ModeliXe signature writing within the generated HTML file. This allows an easier debugging when you are integrating foreign blocks or managing the cache. I suggest you set it to " off " when you move into production, it will save a little time on the server.
• MX_COMPRESS, activates the compression of pages if the browser supports it (on or off).
• MX_REWRITE_URL, uses mode_rewrite to create urls (on or off).
• MX_PERFORMANCE_TRACER, activates performance timing (on or off).
• ERROR_MANAGER_SYSTEM, if set to "on", errors are raised, errors are ignored if set to "off".
• ERROR_MANAGER_LEVEL, defines the tolerated error level, the lower it's set, the less errors are tolerated.
• ERROR_MANAGER_ESCAPE, allows you to specify a substitute local url to use in case of errors.
• ERROR_MANAGER_LOG, allows you to define a log file.
• ERROR_MANAGER_ALARME, specifies a comma separated series of email addresses to which alerts will be will be sent.

• $page -> SetMxCompress(boolean); activates (on) or deactives (off) compression in the outgoing HTML stream.
• $page -> SetMxModRewrite(boolean); activates (on) or deactivates (off) rewriting of urls by mod_rewrite.
• $page -> SetMxSignature(boolean); activates (on) or deactivates (off) the ModeliXe signature in the generated HTML file, useful for debugging blocks.
• $page -> SetMxSession(string); specifies session parameters which will not be parsed during the use of the cache.
• $page -> SetMxFileParameter(filePath); specifies a (pre-parsing) parameter file for the current page.

• $page -> SetMxTemplatePath(directoryPath); specification of the template directory for the current page.
• $page -> SetMxFlagsType(string); Specification of the template tag syntax to be used (xml or classic/PEAR).
• $page -> SetMxOutputType(string); specification of the tag type generated by ModeliXe (xhtml or html).
• $page -> SetMxCachePath(directoryPath); Specification of the cache directory for the current page.
• $page -> SetMxCacheDelay(integer); Specifies the time in cache value for the current page.

			#flag
			title = Welcome to my site
			sub-title = J'adore les smileys =o)
			image = <img src="ma_photo.gif">
			text = """This is a text that spans many lines.
			        Its encompassed at the beginning and end by three quotes.
			        You can declare fields of big values in this way.
			        This option exists since release beta 4.0.0 """
			#attribut
			backgroundColor = bgcolor="#FFFFFF"
			my style sheet = href="monStyle.css"
			email = chezmoi@ici.com	

• Dynamic element tags.
• Dynamic block tags.
• Dynamic attribute tags.
• Tags for parameter settings.
• The attributes of parameter settings

• mx, defines the namespace of the ModeliXe tags.
• tagtype, contains the name of the tag, it can have six values, image, text, hidden, select, formField or checker.
• ref, the reference of the tag. This attribute is optional and serves only to facilitating reading of the template, it can contain any character except double quotes.
• id, is the unique reference of the tag, this attribute is compulsory, and can contain any character except dot and double quotes, we advise you to make ids short so as not to create too complex an address scheme.(cf. the following paragraph).
• New!
  attributHTML, contains all the static attributes of the HTML tag which will be generated from this ModeliXe tag. This feature exists since beta 6.1. Note that for the PEAR syntax tags, the tagging of these attributes is included in the declaration of htmlAtt[]

• The attribute "ref" of the bloc tag has the a different semantic to that of the defined tags. It allows a block to reference the contents of an external template.
• Id, is the attribute containing the unique reference for the tag, this attribute is compulsory, and can contain any character except dot and double quotes. We suggest you make the value short. Note, the opening and closing tags must have the same value for the id attribute.

• The type of the attribute can be any standard HTML or XML tag attribute. But one of those values, the URL, will be the object of special treatment by ModeliXe's methods.
  
• Id of the attribute plays the same role as other ModeliXe tags. It allows a unique reference to attribute within the template. Note the id of an attribute cannot contain commas, nor spaces, dots characters, double quotes, or simple quotes.

• mx, the namespace of the ModeliXe tags.
• id, is the unique reference of the tag. This attribute is compulsory and can contain any character except dot and double quotes. The tag won't be added to the address scheme during the parsing of the template because it is only present during the pre-formatting step of template generation.

• id, is the unique reference of the tag, this attribute is compulsory, and can contain any character except dot and double quotes. The tag won't be added to the address scheme during parsing of the template because it is only present during the pre-formatting step of template generation.

• The addressing of ModeliXe elements within the template.
• The addressing of ModeliXe elements within the php script.

• The path parameter specifies the block address of a text-type ModeliXe tag within the template, it contains the relative or absolute path (relative by default) up to the enclosing block, then id of the tag.
• The value parameter contains the text to be displayed.

• The path parameter specifies the block address of the ModeliXe image-type tag within the template, it contains the relative or absolute path (relative by default) to the containing block, then id of the tag.
• The image parameter contains the path from the php script, to the image file.
• The title parameter contains the title of the image, otherwise a default title will be created from the name of the image.
• The imageAttribute parameter contains all attributes of the image tag, not managed by ModeliXe, they'll be copied out verbatim when the tag is created. Note that size attributes aren't necessary because they are directly generated by ModeliXe.
• GetSize is an optional parameter, if its assigned ModeliXe won't generate default image size attributes allowing you to manage them your own way via imageAttribut.

• The path parameter specifies the block address of the hidden-type ModeliXe tag within the template, it contains the relative or absolute road (relative by default) to the enclosing block, then id of the tag.
• The value parameter contains the key-value pairs to be contained in the generated hidden tags. They must be declared like a "query-string", following this pattern: key1=value1&key2=value2&key3=value3 etc....
  If session parameters were declared during the instantiation of the class ModeliXe, they'll automatically be added.

			$parametreSession["sid"] = $sid;
			$parametreSession["lang"] = $lang;

			$queryString = $page -> GetQueryString($parametreSession);
			

• The path specifies the block address of the tag ModeliXe of type select within the template, it contains the relative or absolute path (relative by default) to the enclosing block, then id of the tag.
• The name parameter will be the name given to the select and the name of the variable with which will return the selected value. If it's a multiple select you will get back an array, the method will take care of this.
• SelectedValue, contains the default selected value or values. It can therefore involve an array or a simple string.
• Value, contains the array of the key value pairs which comprise the select.
• defaultValue, contains the null value of the select (for example a string asking the user to select a value), if it is selected it will return #.
• multipleSize, allows the declaration of a multi-value select and to provide the number of items returned.
• javaScriptAttribut, makes it possible to add scripts or HTML attributes to the select, they'll be added directly to the tag.

• The path specifies the block path of the ModeliXe attribute tag within the template, it contains the relative or absolute path (relative by default) to the enclosing block, then id of the tag.
• The url is the complete url without querystring, to which the link points.
• querystring is an optional argument, which allows the addition of query elements to the url. The session parameters declared during the instantiation of the class will automatically be integrated into the url.
• NoSid, is an optional boolean argument which defaults to " false ". If it is set to true, the session parameter is NOT added to the querystring.

• The path parameter specifies the path to the ModeliXe tag within the template, it contains the relative or absolute path (relative by default) to the enclosing block, then id of the tag.
• The type parameter specifies if a textarea, or a tag of type text, etc should be generated. It can take the values " textarea ", " password ", " text ", "image", " submit ", "row" and " button ".
• The value parameter assigns a value to the attribute of the relevant tag.
• Name assigns a value to the attribute "name" of the relevant tag.
• The attribute parameter is optional, it allows the specification of further attributes of the tag.

• The path parameter specifies the path to the ModeliXe checker tag within the template, it contains the relative or absolute path (relative by default) to the enclosing block, then id of the tag.
• The type parameter specifies the type of the checker, it's permitted values are "radio" or " checkbox ".
• The name parameter provides a name for the CheckBox input tag.
• The value parameter allows assignment of a value to the input tags "value" attribute.
• The Checked parameter is optional, if its assigned, the corresponding input tag will be checked.
• The Attribute parameter is optional. It allows you to specify further attributes of the tag.

• The path allows the specification of the location of the ModeliXe attribute tag within the template, it contains the relative or absolute path (relative by default) up to the enclosing block, then the id of the tag.
• The value will be assigned to the target attribute of the HTML tag.

• A block is an entity made of a part of the ModeliXe template, and is delimited by a start and an end tag sharing the same id.
• A block creates a hierarchy into the ModeliXe addressing space, and each ModeliXe element inside a block is independent of the elements contained in the child blocks (Translator's note: I don't quite understand the meaning of the French sentence).
• A block and its content may be deleted, replaced or multiplied as many times as you like.

• The $path specifies the tag location inside the template, it contains the absolute or relative (relative is the default) path toward the block containing this block, followed by this block id.
  
  Warning ! Notice the addressing differences when using WithMxPath in absolute or relative mode. By default, addressing is relative and the main document is the root. So, the address of the block "bloc2" contained inside "bloc1", itself inside the main document, is "bloc1.bloc2". Look into WithMxPath documentation for further explanations.
  
  
• $operator is used to specify the kind of operation used on the block. It can take six different values on which we'll discuss later.
• $option is a complementary parameter used when some specific value of $operator is used.

• Replacement ("remplace" operator). Allows to replace the block content with the third argument of the ModeliXe method. This one may be a template. It's a temporary alteration.
• Concatenation ("append" operator). Allows to append to the block content the value of the third argument of the ModeliXe method. This one may be a template.
• Modification ("modify" operator). Allows to replace the block content with the third argument of the ModeliXe method. This one may be a template. It's a permanent alteration.
• Deletion ("delete" operator). Allows to delete a block and its children. It's a temporary alteration.
• Destruction ("reset" operator). Allows to delete a block, its children and it's draft. If this draft has already been used for instantiating, it's not destroyed. It's a permanent alteration.
• Looping ("looping" operator). Allows to concatenate different instances of a block, in a loop for instance. It's a temporary alteration. Only an instance is appended, with no impact on the skeleton.

				<?PHP
				include("ModeliXe.php");
				$test = new ModeliXe( "test" );
				$test -> SetModeliXe();

        for ($i = 0; $i < $eleves; $i ++){
						$test -> MxText( "bloc.numero", $i);
            $test -> MxText( "bloc.identite", $eleves[ $i ]);

            $test -> Mxbloc( "bloc", "loop" );
        }

        $test -> MxWrite();
        ?>

            <?PHP
            include("ModeliXe.php");

            $test = new ModeliXe( "test" );
            $test -> SetModeliXe();

            for ( $i =  0; $i < $eleves; $i ++){

                $test -> MxText( "bloc.numero", $i);
                $test -> MxText( "bloc.identite", $eleves [ $i ]);

                for ($j = 0; $j < count ( $notes [ $eleves [ $i ]]);$j ++){
                    $test -> MxText( "bloc.blocnote.note", $notes [ $eleves [ $i ]][ $j ]);

                    $test -> MxBloc( "bloc.blocnote", "loop" );
                    }
                $test -> MxBloc( "bloc", "loop" );
                }

            $test -> MxWrite();
            ?>

			function maFonction($argumentsArray){
				$num1 = $argumentsArray["num1"];
				$num2 = $argumentsArray["num2"];

				return ($num1 + $num2)
				}

			//-----------------------------------------------------------------

			$page -> ModeliXe("template.mxt");

			$page -> AddMxPlugIn("MyPlugIn", "flag", "myFunction");

			$page -> SetModeliXe();

			$page -> SetMxPlugIn("MyPlugin", "template.texte1", array("num1" => 1, "num2" => 3));
			$page -> SetMxPlugIn("MyPlugin", "template.bloc1.texte2", array("num1" => 5, "num2" => 6));

			$page -> MxWrite();

• GetMxPath() - deprecated.
• GetQueryString() - Query string generation.
• WithMxPath() - Relative addressing management.
• MxErrorManager() - Error management.
• MxRefresh() - Dynamic caching.
• GetMxBloc() - Get a block content.
• AboutModeliXe() - ModeliXe license.
• GetExecutionTime() - All is in the name.

            $parametereSession["sid"] = $sid;
            $parametereSession["lang"] = $lang;

            //Génération de la querystring
            $queryString = $page -> GetQueryString($parametereSession);

Relative addressing
You can call WithMxPath with a relative (default) or an absolute path. The latter must be used with "absolute" as second parameter of course.
The relative addressing is incremental, thus it takes in account all the previous WithMxPath calls. There are two ways to go back in the hierarchy:

• Give an empty path: this will reset the addressing from the document root.
• Use ../ to go up one level: $page -> WithMxPath("../siblingPath");
  

            $page = new ModeliXe("test.mxt");

            //Relative addressing by default, so we are
            //at the document root
            $page -> MxText("texte1", "Bonjour");

            //New addressing, absolute mode
            $page -> WithMxPath("test.bloc", "absolute");

            //Now we are in the "test.bloc" block
            $page -> MxText("texteDuBloc", "je suis dans un bloc");

            //New addressing, relative against "test.bloc"
            $page -> WithMxPath("bloc2", "relative");

            //We are now in "test.bloc.bloc2"
            $page -> MxText("texteDuBloc2", "je suis dans un sous bloc");

            //Moving back
            $page -> WithMxPath("../bloc");

            //Now in  "test.bloc"
            $page -> MxText("texte2DuBloc", "je suis de nouveau dans ce bloc");

            //We're still in relative mode, going again in "bloc2"
            $page -> WithMxPath("bloc2");

            //Back to the root
            $page -> WithMxPath();

• ERROR_MANAGER_SYSTEM, errors are reported if set to "on", ignored if "off".
• ERROR_MANAGER_LEVEL, level of ModeliXe tolerance regarding errors. One of the 5 error levels: Low Warning, Warning, Notification, Error, Emergency break.
• ERROR_MANAGER_ESCAPE, replacement URL when an error occurs.
• ERROR_MANAGER_LOG, log filename.
• ERROR_MANAGER_ALARME, a coma separated email addresses list, where to send error messages.