XDocumentation - Revision history

Fabioz: Removing all content from page

2009-06-30T00:15:36Z

Removing all content from page

← Older revision		Revision as of 00:15, 30 June 2009
Line 1:		Line 1:
	~~[[Category:Xebra]]~~


	~~=Architecture Overview=~~
	~~#The Xebra HTTP plugin (Apache Module or IIS Handler) forwards a request from the HTTP server to the Xebra Server and waits for a response.~~
	~~#The Xebra Server forwards a request to the appropriate web application.~~

	~~(image)~~

	~~#The Xebra Server forwards requests to a REQUEST_HANDLER~~
	~~#The REQUEST_HANDLER sends a request to the appropriate SERVLET, which represents a xeb page.~~
	~~#The SERVLET renders an XHTML page. Depending on the xeb file it derives from, it will delegate calls to the controller (3).~~



	SERVLETs ans REQUEST_HANDLERs are generated from the xeb files, while the controller is implemented by the developer and has to inherit from XWA_CONTROLLER. The controller contains business logic for a servlet class (aka xeb file).
	~~(Detailed steps from a xeb file to a rendered html file:~~
	~~#Xeb files parsed and compiled to servlet_generators~~
	~~#servlet_generators generate servlets~~
	~~#servlets generate html)~~

	~~=Website creation work flow=~~



	The translation part works in two steps. First of all the .xeb-files are compiled to servlet generators and the classes for request handling and application launching. Servlet generators generate servlet classes for the final web app (second step).
	The double generation is needed because tags generate code which renders html and do not render html themselves. Since we can't load the classes at run time (since we only get the name of a tag class) we have to first generate servlet generators.

	~~=Xebra Libraries=~~
	~~===Page===~~
	~~The ''page'' libraries consists of the core tags needed for page configuration and composition. The Tags are:~~

	~~{\| class="wikitable"~~
	~~! Tag~~
	~~! Description~~
	\|-
	\|
	~~<xml>~~
	~~<page:controller class="..." />~~
	~~</xml>~~
	\|
	~~Defines the controller which should be used for the ''xeb'' page~~
	\|-
	\|
	~~<xml>~~
	~~<page:declare_region id="..." />~~
	~~</xml>~~
	\|
	~~Declares a region at the specific point in the xeb page~~
	\|-
	\|
	~~<xml>~~
	~~<page:define_region id="...">~~
	~~...~~
	~~</page:define_region>~~
	~~</xml>~~
	\|
	~~Defines a region from a template, can only be used inside a page-include tag~~
	\|-
	\|
	~~<xml>~~
	~~<page:include id="..." />~~
	~~</xml>~~
	\|
	~~Includes a template~~
	\|-
	\|
	~~<xml>~~
	~~</page:fragment>~~
	~~</xml>~~
	\|
	~~If used the page is not transformed to a servlet~~
	\|}


	~~====Example====~~

	~~This example shows the workings of the template framework. It consists of a master page which acts as a template and three different types of usage of this template.~~

	~~master.xeb~~
	~~<xml>~~
	~~<html>~~
	~~<page:controller class="DEFAULT_CONTROLLER"/>~~
	~~<body>~~
	~~<h1>~~
	~~<page:declare_region id="greeting" />~~
	~~</h1>~~
	~~<page:declare_region id="form" />~~
	~~</body>~~
	~~</html>~~
	~~</xml>~~

	~~The master page is "deferred", since there are page:declare_region tags. The translator detects the undefined regions and doesn't generate a servlet from this xeb file.~~

	~~slave1.xeb~~
	~~<xml>~~
	~~<page:include template="master">~~
	~~<page:define_region id="greeting">~~
	~~Hello, I'm Slave 1~~
	~~</page:define_region>~~
	~~<page:define_region id="form">~~
	~~Other region~~
	~~</page:define_region>~~
	~~</page:include>~~
	~~</xml>~~

	~~slave2.xeb~~

	~~<xml>~~
	~~<html>~~
	~~<page:controller class="SLAVE2_CONTROLLER" />~~
	~~<page:include template="master"~~
	~~<page:define_region id="form">~~
	~~Other region 2~~
	~~</page:define_region>~~
	~~</page:include>~~
	~~</html>~~
	~~</xml>~~

	~~slave3.xeb~~

	~~<xml>~~
	~~<page:include template="slave2.xeb">~~
	~~<page:controller class="SLAVE2_CONTROLLER" />~~
	~~<page:define_region id="greetings">~~
	~~</page:define_region>~~
	~~</page:include>~~
	~~</xml>~~

	~~With these techniques we would be able to minimize duplicated code and hence errors in the xeb files, which are difficult to debug.~~

	This code will generate exactly three servlets, SLAVE1_SERVLET.e , SLAVE2_SERVLET.e and SLAVE3_SERVLET.e. master.xeb and form.xeb are fragments. SLAVE1_SERVLET inherits the controller from the master page, while SLAVE2_SERVLET "overwrites" this definition and uses SLAVE2_CONTROLLER. All the pages which are deferred (like master.xeb) are not compiled to servlets. Neither are pages which are denoted with the tag page:fragment.
	Template pages could be used to differentiate views based on roles. For instance one could think of roles like 'guest', 'user' and 'admin'. 'guest' and 'user' would then have pages which inherit from a 'master_page', implementing their own menus. 'admin' in contrast would inherit from 'user', since it is a user with additional rights. So it would have to extend the menu and contents. Sub pages which have been added through page:include could act as master pages as well, further encouraging code reuse.

	~~===Xeb===~~
	~~===Form===~~

Sandrod: /* Page */

2009-06-29T23:55:57Z

Page

← Older revision		Revision as of 23:55, 29 June 2009
Line 74:		Line 74:


	~~With these techniques we would be able to minimize duplicated code and hence errors in the xeb files, which are difficult to debug.~~		====Example====

	~~Example:~~		This example shows the workings of the template framework. It consists of a master page which acts as a template and three different types of usage of this template.

	master.xeb		master.xeb
			<xml>
	<html>		<html>
	<page:controller class="DEFAULT_CONTROLLER"/>		<page:controller class="DEFAULT_CONTROLLER"/>
Line 89:		Line 89:
	</body>		</body>
	</html>		</html>
			</xml>

			The master page is "deferred", since there are page:declare_region tags. The translator detects the undefined regions and doesn't generate a servlet from this xeb file.
	The master page is "deferred", since there are page:declare_region tags.

	slave1.xeb		slave1.xeb
			<xml>
	<page:include template="master">		<page:include template="master">
	<page:define_region id="greeting">		<page:define_region id="greeting">
Line 103:		Line 103:
	</page:define_region>		</page:define_region>
	</page:include>		</page:include>
			</xml>

	slave2.xeb		slave2.xeb

			<xml>
	<html>		<html>
	<page:controller class="SLAVE2_CONTROLLER" />		<page:controller class="SLAVE2_CONTROLLER" />
Line 115:		Line 116:
	</page:include>		</page:include>
	</html>		</html>
			</xml>

	slave3.xeb		slave3.xeb

			<xml>
	<page:include template="slave2.xeb">		<page:include template="slave2.xeb">
	<page:controller class="SLAVE2_CONTROLLER" />		<page:controller class="SLAVE2_CONTROLLER" />
Line 124:		Line 126:
	</page:define_region>		</page:define_region>
	</page:include>		</page:include>
			</xml>

			With these techniques we would be able to minimize duplicated code and hence errors in the xeb files, which are difficult to debug.

	This code will generate exactly three servlets, SLAVE1_SERVLET.e , SLAVE2_SERVLET.e and SLAVE3_SERVLET.e. master.xeb and form.xeb are fragments. SLAVE1_SERVLET inherits the controller from the master page, while SLAVE2_SERVLET "overwrites" this definition and uses SLAVE2_CONTROLLER. All the pages which are deferred (like master.xeb) are not compiled to servlets. Neither are pages which are denoted with the tag page:fragment.		This code will generate exactly three servlets, SLAVE1_SERVLET.e , SLAVE2_SERVLET.e and SLAVE3_SERVLET.e. master.xeb and form.xeb are fragments. SLAVE1_SERVLET inherits the controller from the master page, while SLAVE2_SERVLET "overwrites" this definition and uses SLAVE2_CONTROLLER. All the pages which are deferred (like master.xeb) are not compiled to servlets. Neither are pages which are denoted with the tag page:fragment.

Sandrod: /* Page */

2009-06-29T23:50:17Z

Page

← Older revision		Revision as of 23:50, 29 June 2009
Line 30:		Line 30:
	===Page===		===Page===
	The ''page'' libraries consists of the core tags needed for page configuration and composition. The Tags are:		The ''page'' libraries consists of the core tags needed for page configuration and composition. The Tags are:


	* page:fragment
	~~If used the page is not transformed to a servlet~~

	{\| class="wikitable"		{\| class="wikitable"
Line 68:		Line 64:
	\|		\|
	Includes a template		Includes a template
			\|-
			\|
			<xml>
			</page:fragment>
			</xml>
			\|
			If used the page is not transformed to a servlet
	\|}		\|}

Sandrod: /* Page */

2009-06-29T23:48:41Z

Page

← Older revision		Revision as of 23:48, 29 June 2009
Line 31:		Line 31:
	The ''page'' libraries consists of the core tags needed for page configuration and composition. The Tags are:		The ''page'' libraries consists of the core tags needed for page configuration and composition. The Tags are:

	* page:include [id]
	~~Includes a template~~
	* page:fragment		* page:fragment
	If used the page is not transformed to a servlet		If used the page is not transformed to a servlet
Line 62:		Line 61:
	\|		\|
	Defines a region from a template, can only be used inside a page-include tag		Defines a region from a template, can only be used inside a page-include tag
			\|-
			\|
			<xml>
			<page:include id="..." />
			</xml>
			\|
			Includes a template
	\|}		\|}

Sandrod: /* Page */

2009-06-29T23:47:29Z

Page

← Older revision		Revision as of 23:47, 29 June 2009
Line 54:		Line 54:
	Declares a region at the specific point in the xeb page		Declares a region at the specific point in the xeb page
	\|-		\|-
			\|
	<xml>		<xml>
	<page:define_region id="...">		<page:define_region id="...">
Line 60:		Line 61:
	</xml>		</xml>
	\|		\|
	Defines a region from a template, can only be used inside a page:include tag		Defines a region from a template, can only be used inside a page-include tag
	\|}		\|}

Sandrod: /* Page */

2009-06-29T23:44:21Z

Page

← Older revision		Revision as of 23:44, 29 June 2009
Line 45:		Line 45:
	</xml>		</xml>
	\|		\|
	Defines the controller which should be used for the xeb page		Defines the controller which should be used for the ''xeb'' page
	\|-		\|-
	\|		\|

Sandrod: /* Page */

2009-06-29T23:42:50Z

Page

← Older revision		Revision as of 23:42, 29 June 2009
Line 30:		Line 30:
	===Page===		===Page===
	The ''page'' libraries consists of the core tags needed for page configuration and composition. The Tags are:		The ''page'' libraries consists of the core tags needed for page configuration and composition. The Tags are:

	*

	*

	* page:include [id]		* page:include [id]
Line 54:		Line 50:
	<xml>		<xml>
	<page:declare_region id="..." />		<page:declare_region id="..." />
	</~~code~~>		</xml>
	\|		\|
	Declares a region at the specific point in the xeb page		Declares a region at the specific point in the xeb page

Sandrod: /* Page */

2009-06-29T23:41:05Z

Page

← Older revision		Revision as of 23:41, 29 June 2009
Line 58:		Line 58:
	Declares a region at the specific point in the xeb page		Declares a region at the specific point in the xeb page
	\|-		\|-
	\|
	<xml>		<xml>
	<page:define_region id="...">		<page:define_region id="...">
Line 66:		Line 65:
	\|		\|
	Defines a region from a template, can only be used inside a page:include tag		Defines a region from a template, can only be used inside a page:include tag
	\|-
	\|}		\|}

Sandrod: /* Page */

2009-06-29T23:36:00Z

Page

← Older revision		Revision as of 23:36, 29 June 2009
Line 33:		Line 33:
	*		*

	* ~~page:define_region [id]~~		*
	~~Defines a region from a template, can only be used inside a page:include tag~~
	* page:include [id]		* page:include [id]
	Includes a template		Includes a template
Line 45:		Line 45:
	\|-		\|-
	\|		\|
	<~~code~~>		<xml>
	<page:controller class="..." />		<page:controller class="..." />
	</~~code~~>		</xml>
	\|		\|
	Defines the controller which should be used for the xeb page		Defines the controller which should be used for the xeb page
	\|-		\|-
	\|		\|
	<~~code~~>		<xml>
	<page:declare_region id="..." />		<page:declare_region id="..." />
	</code>		</code>
	\|		\|
	Declares a region at the specific point in the xeb page		Declares a region at the specific point in the xeb page
			\|-
			\|
			<xml>
			<page:define_region id="...">
			...
			</page:define_region>
			</xml>
			\|
			Defines a region from a template, can only be used inside a page:include tag
	\|-		\|-
	\|}		\|}

Sandrod: /* Page */

2009-06-29T23:33:35Z

Page

← Older revision		Revision as of 23:33, 29 June 2009
Line 31:		Line 31:
	The ''page'' libraries consists of the core tags needed for page configuration and composition. The Tags are:		The ''page'' libraries consists of the core tags needed for page configuration and composition. The Tags are:

	* ~~page:declare_region [id]~~		*
	~~Declares a region at the specific point in the xeb page~~
	* page:define_region [id]		* page:define_region [id]
	Defines a region from a template, can only be used inside a page:include tag		Defines a region from a template, can only be used inside a page:include tag
Line 41:		Line 41:

	{\| class="wikitable"		{\| class="wikitable"
	! ~~What it looks like~~		! Tag
	! ~~What you type~~		! Description
	\|-		\|-
	\|		\|
	<code>		<code>
	page:controller [class]		<page:controller class="..." />
	</code>		</code>
	\|		\|
	Defines the controller which should be used for the xeb page		Defines the controller which should be used for the xeb page
			\|-
			\|
			<code>
			<page:declare_region id="..." />
			</code>
			\|
			Declares a region at the specific point in the xeb page
	\|-		\|-
	\|}		\|}