/*global env: true, publish: true */ (function() { var template = require('jsdoc/template'), fs = require('fs'), helper = require('jsdoc/util/templateHelper'), scopeToPunc = { 'static': '.', 'inner': '~', 'instance': '#' }, hasOwnProp = Object.prototype.hasOwnProperty; /** @global @param {TAFFY} data See <http://taffydb.com/>. @param {object} opts @param {Tutorial} tutorials */ // exports.publish = function(data, opts, tutorials) { publish = function(data, opts, tutorials) { var defaultTemplatePath = 'templates/default'; var templatePath = (opts.template) ? opts.template : defaultTemplatePath; var out = '', view = new template.Template(env.dirname + '/' + templatePath + '/tmpl'); // set up templating view.layout = 'layout.tmpl'; // set up tutorials for helper helper.setTutorials(tutorials); function find(spec) { return data.get( data.find(spec) ); } function htmlsafe(str) { return str.replace(/</g, '<'); } function addSignatureParams(f) { var pnames = []; if (f.params) { f.params.forEach(function(p) { if (p.name && p.name.indexOf('.') === -1) { if (p.optional) { pnames.push('<span class="optional">'+p.name+'</span>'); } else { pnames.push(p.name); } } }); } f.signature = (f.signature || '') + '('+pnames.join(', ')+')'; } function generateAncestry(thisdoc) { var ancestors = [], doc = thisdoc; while (doc = doc.memberof) { doc = find({longname: doc}); if (doc) { doc = doc[0]; } if (!doc) { break; } ancestors.unshift( linkto(doc.longname, (scopeToPunc[doc.scope] || '') + doc.name) ); } if (ancestors.length) { ancestors[ancestors.length-1] += (scopeToPunc[thisdoc.scope] || ''); } return ancestors; } function addSignatureReturns(f) { var returnTypes = []; if (f.returns) { f.returns.forEach(function(r) { if (r.type && r.type.names) { if (! returnTypes.length) { returnTypes = r.type.names; } } }); } if (returnTypes && returnTypes.length) { returnTypes = returnTypes.map(function(r) { return linkto(r); }); } f.signature = '<span class="signature">'+(f.signature || '') + '</span>' + '<span class="type-signature">'+(returnTypes.length? ' → {'+returnTypes.join('|')+'}' : '')+'</span>'; } function addSignatureType(f) { var types = []; if (f.type && f.type.names) { types = f.type.names; } if (types && types.length) { types = types.map(function(t) { return linkto(t, htmlsafe(t)); }); } f.signature = (f.signature || '') + '<span class="type-signature">'+(types.length? ' :'+types.join('|') : '')+'</span>'; } function addAttribs(f) { var attribs = []; if (f.virtual) { attribs.push('virtual'); } if (f.access && f.access !== 'public') { attribs.push(f.access); } if (f.scope && f.scope !== 'instance' && f.scope !== 'global') { if (f.kind == 'function' || f.kind == 'member' || f.kind == 'constant') { attribs.push(f.scope); } } if (f.readonly === true) { if (f.kind == 'member') { attribs.push('readonly'); } } if (f.kind === 'constant') { attribs.push('constant'); f.kind = 'member'; } f.attribs = '<span class="type-signature">'+htmlsafe(attribs.length? '<'+attribs.join(', ')+'> ' : '')+'</span>'; } data.remove({undocumented: true}); data.remove({ignore: true}); if (!opts.private) { data.remove({access: 'private'}); } data.remove({memberof: '<anonymous>'}); var packageInfo = (find({kind: 'package'}) || []) [0]; //function renderLinks(text) { // return helper.resolveLinks(text); //} data.forEach(function(doclet) { doclet.attribs = ''; if (doclet.examples) { doclet.examples = doclet.examples.map(function(example) { var caption, code; if (example.match(/^\s*<caption>([\s\S]+?)<\/caption>(\s*[\n\r])([\s\S]+)$/i)) { caption = RegExp.$1; code = RegExp.$3; } return { caption: caption || '', code: code || example }; }); } if (doclet.see) { doclet.see.forEach(function(seeItem, i) { doclet.see[i] = hashToLink(doclet, seeItem); }); } }); data.orderBy(['longname', 'version', 'since']); // kinds of containers var globals = find( {kind: ['member', 'function', 'constant', 'typedef'], memberof: {isUndefined: true}} ), modules = find({kind: 'module'}), externals = find({kind: 'external'}), mixins = find({kind: 'mixin'}), namespaces = find({kind: 'namespace'}); var outdir = opts.destination; if (packageInfo && packageInfo.name) { outdir += '/' + packageInfo.name + '/' + packageInfo.version + '/'; } fs.mkPath(outdir); // copy static files to outdir var fromDir = env.dirname + '/' + templatePath + '/static', staticFiles = fs.ls(fromDir, 3); staticFiles.forEach(function(fileName) { var toDir = fs.toDir(fileName.replace(fromDir, outdir)); fs.mkPath(toDir); fs.copyFile(fileName, toDir); }); function linkto(longname, linktext) { var url = helper.longnameToUrl[longname]; return url? '<a href="'+url+'">'+(linktext || longname)+'</a>' : (linktext || longname); } function tutoriallink(tutorial) { return helper.toTutorial(tutorial); } var containers = ['class', 'module', 'external', 'namespace', 'mixin']; data.forEach(function(doclet) { var url = helper.createLink(doclet); helper.registerLink(doclet.longname, url); }); data.forEach(function(doclet) { var url = helper.longnameToUrl[doclet.longname]; if (url.indexOf('#') > -1) { doclet.id = helper.longnameToUrl[doclet.longname].split(/#/).pop(); } else { doclet.id = doclet.name; } if (doclet.kind === 'function' || doclet.kind === 'class') { addSignatureParams(doclet); addSignatureReturns(doclet); addAttribs(doclet); } }); // do this after the urls have all been generated data.forEach(function(doclet) { doclet.ancestors = generateAncestry(doclet); doclet.signature = ''; if (doclet.kind === 'member') { addSignatureType(doclet); addAttribs(doclet); } if (doclet.kind === 'constant') { addSignatureType(doclet); addAttribs(doclet); } }); var nav = '<h2><a href="index.html">Index</a></h2>', seen = {}; var moduleNames = find({kind: 'module'}); moduleNames.sort(function(a, b) { return a.name > b.name; }); if (moduleNames.length) { nav += '<h3>Modules</h3><ul>'; moduleNames.forEach(function(m) { if ( !hasOwnProp.call(seen, m.longname) ) { nav += '<li>'+linkto(m.longname, m.name)+'</li>'; } seen[m.longname] = true; }); nav += '</ul>'; } var externalNames = find({kind: 'external'}); externalNames.sort(function(a, b) { return a.name > b.name; }); if (externalNames.length) { nav += '<h3>Externals</h3><ul>'; externalNames.forEach(function(e) { if ( !hasOwnProp.call(seen, e.longname) ) { nav += '<li>'+linkto( e.longname, e.name.replace(/(^"|"$)/g, '') )+'</li>'; } seen[e.longname] = true; }); nav += '</ul>'; } var classNames = find({kind: 'class'}); classNames.sort(function(a, b) { return a.name > b.name; }); if (classNames.length) { var moduleClasses = 0; classNames.forEach(function(c) { var moduleSameName = find({kind: 'module', longname: c.longname}); if (moduleSameName.length) { c.name = c.name.replace('module:', 'require("')+'")'; moduleClasses++; moduleSameName[0].module = c; } if (moduleClasses !== -1 && moduleClasses < classNames.length) { nav += '<h3>Classes</h3><ul>'; moduleClasses = -1; } if ( !hasOwnProp.call(seen, c.longname) ) { nav += '<li>'+linkto(c.longname, c.name)+'</li>'; } seen[c.longname] = true; }); nav += '</ul>'; } var namespaceNames = find({kind: 'namespace'}); namespaceNames.sort(function(a, b) { return a.name > b.name; }); if (namespaceNames.length) { nav += '<h3>Namespaces</h3><ul>'; namespaceNames.forEach(function(n) { if ( !hasOwnProp.call(seen, n.longname) ) { nav += '<li>'+linkto(n.longname, n.name)+'</li>'; } seen[n.longname] = true; }); nav += '</ul>'; } // var constantNames = find({kind: 'constants'}); // if (constantNames.length) { // nav += '<h3>Constants</h3><ul>'; // constantNames.forEach(function(c) { // if ( !hasOwnProp.call(seen, c.longname) ) { // nav += '<li>'+linkto(c.longname, c.name)+'</li>'; // } // seen[c.longname] = true; // }); // // nav += '</ul>'; // } var mixinNames = find({kind: 'mixin'}); mixinNames.sort(function(a, b) { return a.name > b.name; }); if (mixinNames.length) { nav += '<h3>Mixins</h3><ul>'; mixinNames.forEach(function(m) { if ( !hasOwnProp.call(seen, m.longname) ) { nav += '<li>'+linkto(m.longname, m.name)+'</li>'; } seen[m.longname] = true; }); nav += '</ul>'; } if (tutorials.children.length) { nav += '<h3>Tutorials</h3><ul>'; tutorials.children.forEach(function(t) { nav += '<li>'+tutoriallink(t.name)+'</li>'; }); nav += '</ul>'; } var globalNames = find({kind: ['member', 'function', 'constant', 'typedef'], 'memberof': {'isUndefined': true}}); globalNames.sort(function(a, b) { return a.name > b.name; }); if (globalNames.length) { nav += '<h3>Global</h3><ul>'; globalNames.forEach(function(g) { if ( g.kind !== 'typedef' && !hasOwnProp.call(seen, g.longname) ) { nav += '<li>'+linkto(g.longname, g.name)+'</li>'; } seen[g.longname] = true; }); nav += '</ul>'; } // add template helpers view.find = find; view.linkto = linkto; view.tutoriallink = tutoriallink; view.htmlsafe = htmlsafe; // once for all view.nav = nav; function generate(title, docs, filename) { var data = { title: title, docs: docs }; var path = outdir + '/' + filename, html = view.render('container.tmpl', data); html = helper.resolveLinks(html); // turn {@link foo} into <a href="foodoc.html">foo</a> fs.writeFileSync(path, html); } for (var longname in helper.longnameToUrl) { if ( hasOwnProp.call(helper.longnameToUrl, longname) ) { var classes = find({kind: 'class', longname: longname}); if (classes.length) { generate('Class: '+classes[0].name, classes, helper.longnameToUrl[longname]); } var modules = find({kind: 'module', longname: longname}); if (modules.length) { generate('Module: '+modules[0].name, modules, helper.longnameToUrl[longname]); } var namespaces = find({kind: 'namespace', longname: longname}); if (namespaces.length) { generate('Namespace: '+namespaces[0].name, namespaces, helper.longnameToUrl[longname]); } // var constants = find({kind: 'constant', longname: longname}); // if (constants.length) { generate('Constant: '+constants[0].name, constants, helper.longnameToUrl[longname]); } var mixins = find({kind: 'mixin', longname: longname}); if (mixins.length) { generate('Mixin: '+mixins[0].name, mixins, helper.longnameToUrl[longname]); } var externals = find({kind: 'external', longname: longname}); if (externals.length) { generate('External: '+externals[0].name, externals, helper.longnameToUrl[longname]); } } } if (globals.length) { generate('Global', [{kind: 'globalobj'}], 'global.html'); } // index page displays information from package.json and lists files var files = find({kind: 'file'}), packages = find({kind: 'package'}); generate('Fancytree API Reference', // used as page tile and header. was 'Index' packages.concat( [{kind: 'mainpage', readme: opts.readme, longname: (opts.mainpagetitle) ? opts.mainpagetitle : 'Main Page'}] ).concat(files) , 'index.html'); function generateTutorial(title, tutorial, filename) { var data = { title: title, header: tutorial.title, content: tutorial.parse(), children: tutorial.children }; var path = outdir + '/' + filename, html = view.render('tutorial.tmpl', data); // yes, you can use {@link} in tutorials too! html = helper.resolveLinks(html); // turn {@link foo} into <a href="foodoc.html">foo</a> fs.writeFileSync(path, html); } // tutorials can have only one parent so there is no risk for loops function saveChildren(node) { node.children.forEach(function(child) { generateTutorial('Tutorial: '+child.title, child, helper.tutorialToUrl(child.name)); saveChildren(child); }); } saveChildren(tutorials); }; function hashToLink(doclet, hash) { if ( !/^(#.+)/.test(hash) ) { return hash; } var url = helper.createLink(doclet); url = url.replace(/(#.+|$)/, hash); return '<a href="'+url+'">'+hash+'</a>'; } }());