1. module gulp-htmlincluder
   1. function gulp-htmlincluder (insertText)
   2. object gulp-htmlincluder.htmlincluder
2. module gulp-htmlincluder.htmlincluder
   1. function gulp-htmlincluder.htmlincluder.buildHtml (callback)
   2. function gulp-htmlincluder.htmlincluder.hashFile (file, insTxt)
   3. function gulp-htmlincluder.htmlincluder.initialize ()

module gulp-htmlincluder

function gulp-htmlincluder (insertText)

• description and source-code

  gulp-htmlincluder = function (insertText) {
  	"use strict";
  	var that;
  
  	includer.initialize();
  
  	function htmlincluder() {
  		includer.buildHtml(function(file) {
  			var f = file.file;
  			f.contents = new Buffer(file.content);
  
      		that.push(f);
  		});
  	}
  
  	function aggregateFiles(file, enc, callback) {
  
  		that = this; //defined in scope of module
  
  		// Do nothing if no contents
  		if (file.isNull()) {
  			this.push(file);
  			return callback();
  		}
  
  		if (file.isStream()) {
  			this.emit("error",
  				new gutil.PluginError("gulp-htmlincluder", "Stream content is not supported"));
  			return callback();
  		}
  
  		if (file.isBuffer()) {
  			includer.hashFile(file, insertText);
  		}
  
  		return callback();
  	}
  
  	return through.obj(aggregateFiles, htmlincluder);
  }

• example usage

  n/a

module gulp-htmlincluder.htmlincluder

function gulp-htmlincluder.htmlincluder.buildHtml (callback)

• description and source-code

  function buildHtml(callback) {
  		return pageFiles.map(function(file) {
  			processFile(file);
  
  			if(callback) {
  				callback(file);
  			}
  
  			return file;
  		});
  	}

• example usage

  ...
  module.exports = function (insertText) {
  	"use strict";
  	var that;
  
  	includer.initialize();
  
  	function htmlincluder() {
  		includer.buildHtml(function(file) {
  			var f = file.file;
  			f.contents = new Buffer(file.content);
  
      		that.push(f);
  		});
  	}
  ...

function gulp-htmlincluder.htmlincluder.hashFile (file, insTxt)

• description and source-code

  function hashFile(file, insTxt) {
  		var f = File(file);
  		
  		//set text value for insert tags, or default
  		insertText = (insTxt) ? '<!--#' + insTxt : '<!--#insert';
  
  		processClip(f);
  		
  		if(f.name[0] === '_')
  			wrapFiles[f.path] = f;
  		else if(f.name[0] === '-')
  			insertFiles[f.path] = f;
  		else
  			pageFiles.push(f);
  	}

• example usage

  ...
  		if (file.isStream()) {
  			this.emit("error",
  				new gutil.PluginError("gulp-htmlincluder", "Stream content is not supported"));
  			return callback();
  		}
  
  		if (file.isBuffer()) {
  			includer.hashFile(file, insertText);
  		}
  
  		return callback();
  	}
  
  	return through.obj(aggregateFiles, htmlincluder);
  };
  ...

function gulp-htmlincluder.htmlincluder.initialize ()

• description and source-code

  function initialize() {
  		//reset vars in case these had kept their value in closure
  	    wrapFiles = {};
  		insertFiles = {};
  		pageFiles = [];
  	}

• example usage

  ...
  // @insertText = (optional) the test looked for in order to insert files
  // 					(this is so ssi includes can be used instead)
  //
  module.exports = function (insertText) {
  	"use strict";
  	var that;
  
  	includer.initialize();
  
  	function htmlincluder() {
  		includer.buildHtml(function(file) {
  			var f = file.file;
  			f.contents = new Buffer(file.content);
  
  		that.push(f);
  ...