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 and client-side markdown where the optional TYPE:
view | help
specifies the rendering mode.
npm install @totemstan/skin # Install
npm run start [ ? | $ | ...] # Unit test
npm run verminor # Roll minor version
npm run vermajor # Roll major version
npm run redoc # Regen documentation
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.
Open/Close
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
Kind: static constant of SKIN
Kind: static constant of SKIN
Blogging context.
Kind: static constant of SKIN
Kind: static constant of SKIN
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 |
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) |
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) |
Kind: inner constant of SKIN
Client error messages
Kind: inner constant of SKIN
Requested skin not found - check spelling
Kind: static property of _Errors
Requested skin contains invalid jade markdown
Kind: static property of _Errors
Requested engine not found - check spelling
Kind: static property of _Errors
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 |
Feel free to
- submit and status TOTEM issues
- contribute to TOTEM notebooks
- revise TOTEM requirements
- browse TOTEM holdings
- or follow TOTEM milestones
© 2012 ACMESDS