Static Site Builder Util (SBU) 1.0 Documentation

Index Introduction File Filters File Handlers Default Source Parser Data Providers Extending SBU

Data Providers

There are three build-in data providers available for the FTL file handler: navigation, udata and util

Navigation

This data provider realizes a navigation structure. On the top level a set of root nodes will be specified. Each node can have a list of child nodes. A node is linked to a source file path (relative to the source folder, e.g. '/index.html') and has a name. Optional parameters can be specified. If a node matches the current source file, this information is available with the template. Alternatively a JAVA regular expression maybe defined for matching (e.g. to have multiple language versions). Example:

		<navigation>
			<root-node name="Start" target="/index.htm"/>
			<root-node name="Documentation" target="/doc.htm"/>
				 <node name="Introduction" target="/doc/introduction.htm"/>
				 <node name="File Filters" target="/file-filters.htm"/>
			</root-node>
		</navigation>
		

UData

A dynamic text-based data structure. It provides a set of attributes. Additionally a list and/or a map of child instances ma be defined. Example:

		<udata>
		    <attribute name="key1" value="value1"/>
		    <attribute name="key2" value="value2"/>
		    <child-list>
		        <udata>
		            <attribute name="key" value="value"/>
		        </udata>
		        <udata/>
		    </child-list>
		    <child-map>
		        <child name="key">
		            <udata>
		            	<attribute name="key" value="value"/>
		            	<child-list>
		            		<udata/>
		            	</child-list>
		            </udata>
		        </child>
		    </child-map>
		</udata>
		

Util

This data provider has no further attributes: '<util/>'. It provides various useful operations that can be used during processing the template. Read the JavaDoc for more information.

previous page next page