@totemorg/skin

SKIN

The SKIN TOTEM plugin provides:

/DATASET.TYPE ? QUERY
/AREA/FILE ? QUERY
/AREA/STORE ? QUERY
/AREA/GRAPH ? QUERY
/AREA/ ? QUERY

endpoints to render datasets, folders, graphs per client API requireents where the optional TYPE:

view | help

specifies the rendering mode.

Install

npm install @totemstan/skin		# Install
npm update

Manage

npm run start [ ? | $ | ...]	# Unit test
npm run verminor				# Roll minor version
npm run vermajor				# Roll major version
npm run redoc					# Regen documentation
npm run pubminor				# republish as minor version
npm run pubmajor				# republish as major version

Usage

Acquire and optionally configure SKIN:

const SKIN = require("skin").config({
	key: value, 						// set key
	"key.key": value, 					// indexed set
	"key.key.": value					// indexed append
});

where configuration keys follow ENUMS deep copy conventions.

Program Reference

Open/Close

SKIN

Provides endpoint agents to render DEBE notebooks, datasets, and engines using the (possibly dynamically generated) jade associated with the requested notebook/table/engine. Converts TOTEM markdown to html. This module documented IAW jsdoc.

Requires: module:enums, module:fs, module:cluster, module:jade@1.9.0
Author: ACMESDS

• SKIN
  • static
    • .agents
    • .lookups
    • .blogCtx
    • .skinCtx
    • .renderSkin(req, res)
    • .skinContext(req, cb)
    • .renderJade(jade, ctx, cb)
  • inner
    • ~_SQLs
    • ~_Errors
      • .noSkin
      • .badSkin
      • .noEngine
    • ~blog(ctx, src, rec, cb)

SKIN.agents

Kind: static constant of SKIN

SKIN.lookups

Kind: static constant of SKIN

SKIN.blogCtx

Blogging context.

Kind: static constant of SKIN

SKIN.skinCtx

Kind: static constant of SKIN

SKIN.renderSkin(req, res)

Endpoint to render req.table using associated jade engine.

Kind: static method of SKIN

Param	Type	Description
req	Object	Totem request
res	function	Totem response

SKIN.skinContext(req, cb)

Callback cb with skinning context ctx for requested table.

Kind: static method of SKIN

Param	Type	Description
req	Object	Totem request
cb	function	callback(ctx)

SKIN.renderJade(jade, ctx, cb)

Render jade string to callback cb( err || html ) in a new context created for this request.

Kind: static method of SKIN

Param	Type	Description
jade	String	contents to render
ctx	Object	skinning context
cb	function	callback(ctx)

SKIN~_SQLs

Kind: inner constant of SKIN

SKIN~_Errors

Client error messages

Kind: inner constant of SKIN

• ~_Errors
  • .noSkin
  • .badSkin
  • .noEngine

_Errors.noSkin

Requested skin not found - check spelling

Kind: static property of _Errors

_Errors.badSkin

Requested skin contains invalid jade markdown

Kind: static property of _Errors

_Errors.noEngine

Requested engine not found - check spelling

Kind: static property of _Errors

SKIN~blog(ctx, src, rec, cb)

Render markdown to html:

$ tabs || accordion || drop { JX }
$ KEY || $ { JS }
[ LINK ] ( URL )
$$ inline TeX $$ || n$$ break TeX $$ || a$$ AsciiMath $$ || m$$ MathML $$
TeX [:;|]= TeX || # KEY || # { JS }
| GRID | ... | ... 
#... SECTION
ESCAPE || figure || earth || map || brief || ...:
	CODE BLOCK

Kind: inner method of SKIN

Param	Type	Description
ctx	Object	initial blogging context
src	String	default source path
rec	Object	source record
cb	function	callback accepting the resulting html

Contacting, Contributing, Following

Feel free to

• submit and status TOTEM issues
• contribute to TOTEM notebooks
• revise TOTEM requirements
• browse TOTEM holdings
• or follow TOTEM milestones

License

MIT

---

© 2012 ACMESDS