extmpl

extmpl - server side templates based on go/templates

Example Setup in a server

In the global config

type GlobalConfigData struct {
	...
	extmpl.ExTmplConfig
	...
}

then the setup for configuration files:

	// ==============================================================================================================================================
	// setup of multi/table master detail = 1:N, M:N, checkbox list tables.
	// if err = extmpl.SetupExTmplModels("./tmpl1/group.json", "./tmpl1/model.json"); err != nil {
	// ==============================================================================================================================================
	extmpl.SetupNoDoc(true)
	if err = extmpl.SetupExTmplModels(gCfg.ExTmplGroup, gCfg.ExTmplModel); err != nil {
		fmt.Fprintf(os.Stderr, "Fatal Error:%s\n", err)
		os.Exit(1)
	}
	// ==============================================================================================================================================
	// setups stuff in ./tmpl1/setup[.json like /index.html and "/" and "" all going to index.html handler.
	// ==============================================================================================================================================
	extmpl.SetupMux(mux, logFilePtr, &(gCfg.ExTmplConfig), DB, &dbOn, &dbOnLock, gCfg.AppName)

3 configuration files are at the top level, ./tmpl1/setup.json determines the simple paths, ./tmp1/group.json determines the master-detail and M:N paths along with ./tmpl1/model.json that holds a copy of the relational database model.

./tmpl1/setup.json

An example. The /index.html is defined in ./tmpl1/index.json. /login.html is defined in ./tmpl1/login.json. Paths are searched in order for each of the templates defined.

{ "api": {
	 "/index.html": { 
		  "page_name": "index.json"
		, "path": "./tmpl1;./tmpl1/index"
		}
...
	,"/login.html": { 
		  "page_name": "login.json"
		, "path": "./tmpl1"
		}
...
} }

./tmp1/login.json

This specifies for the 'partial' == 'page' that the set of template files will be page.html with replacement templates from login.html.

For "partial" == "partial" the set will be partial-page.html with replacements from lgoin.html.

You can specify as many different named sets of templates as you want. The default set is 'page'.

No selects are performed to fetch data from the database.

{
	"TemplateSet": {
		  "page": {
			  "Template": [ "page.html", "login.html" ]
		}
		, "partial": {
			  "Template": [ "partial-page.html", "login.html" ]
		}
	},
	"SelectData": [ ]
}

Example Call

	mdata["data"] = make ( map[string]interface{} )

	// ------------------------------------------------------------------------------------------------------------------------
	// Load template files
	// ------------------------------------------------------------------------------------------------------------------------
	TemplateCtl, err := extmpl.NewTemplate(tmpl_name, templateList...)

	// ------------------------------------------------------------------------------------------------------------------------
	// Render Template
	// ------------------------------------------------------------------------------------------------------------------------
	tmpl_rendered, err = extmpl.TemplateCtl.ByName("render", mdata)

Client Side partial rendering

A function to take the partial that is returned and paint this into a page at the #body id tag.

// ---------------------------------------------------------------------------------------------------------------------
// Rendering of partials into page.
//
// PushParams takes parameters and pushes them into data that is will be passed as a part of the "GET" request.
// ---------------------------------------------------------------------------------------------------------------------

function PushParams() {
	g_data.params = {};
	for ( var i = 0; i < arguments.length; i += 2 ) {
		var n = arguments[i];
		var v = ( (i+1) < arguments.length ) ? arguments[i+1] : "";
		g_data.params[n] = v;
	}
}

function getGData() {
	var ss = "";
	for ( var key in g_data.params ) {
		ss = ss + '&' + key + '=' + encodeURIComponent( g_data.params[key] );
	}
	return ss;
}

function renderPartial(name) {
	var addHtml = ( name.match(/\.html$/ ) ) ? "" : ".html";		// add .html to end if it is not there.
	if ( ! g_data.params ) {
		g_data.params = {};
	}
	for ( var i = 1; i < arguments.length; i += 2 ) {
		var n = arguments[i];
		var v = ( (i+1) < arguments.length ) ? arguments[i+1] : "";
		g_data.params[n] = v;
	}
	// console.log ( "g_daa.params = ", g_data.params, "getGData()=", getGData() );
	var url = "/"+name+addHtml+"?page_type=partial"+getGData();
	// console.log ( "url=", url );
	$.get( url, function( data ) {
		$("#body").html( data );
		g_data.prev_params = $.extend ( {}, g_data.params );	// Save for debuging purposes.
		g_data.params = {};
	});
}