Skip to content

Commit

Permalink
Updated modules data with alias information
Browse files Browse the repository at this point in the history
  • Loading branch information
@davglass
davglass committed Jan 6, 2012
1 parent 72d545a commit b2b6db1
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 40 deletions.
68 changes: 34 additions & 34 deletions src/yui/docs/partials/modules.mustache
View file
Expand Up @@ -12,7 +12,7 @@
</tr>
<tr>
<td>`anim`</td>
<td>Provides the base Anim class, for animating numeric properties.</td>
<td>Alias module for: `anim-base, anim-color, anim-curve, anim-easing, anim-node-plugin, anim-scroll, anim-xy`</td>
</tr>
<tr>
<td>`anim-base`</td>
Expand Down Expand Up @@ -44,7 +44,7 @@
</tr>
<tr>
<td>`app`</td>
<td>The App Framework provides simple MVC-like building blocks (models, model lists,</td>
<td>Alias module for: `app-base, model, model-list, router, view`</td>
</tr>
<tr>
<td>`app-base`</td>
Expand Down Expand Up @@ -84,7 +84,7 @@
</tr>
<tr>
<td>`attribute`</td>
<td>Adds support for attribute providers to handle complex attributes in the constructor</td>
<td>Alias module for: `attribute-base, attribute-complex`</td>
</tr>
<tr>
<td>`attribute-base`</td>
Expand All @@ -108,7 +108,7 @@
</tr>
<tr>
<td>`autocomplete`</td>
<td>Provides automatic input completion or suggestions for text input fields and</td>
<td>Alias module for: `autocomplete-base, autocomplete-sources, autocomplete-list, autocomplete-plugin`</td>
</tr>
<tr>
<td>`autocomplete-base`</td>
Expand Down Expand Up @@ -148,7 +148,7 @@
</tr>
<tr>
<td>`base`</td>
<td>The base-pluginhost submodule adds Plugin support to Base, by augmenting Base with </td>
<td>Alias module for: `base-base, base-pluginhost, base-build`</td>
</tr>
<tr>
<td>`base-base`</td>
Expand All @@ -168,11 +168,11 @@
</tr>
<tr>
<td>`button`</td>
<td>Provides an interface for working with button-like DOM nodes</td>
<td>Alias module for: `button-base, button-group, cssbutton`</td>
</tr>
<tr>
<td>`cache`</td>
<td>Provides support to use Cache as a Plugin to a Base-based class.</td>
<td>Alias module for: `cache-base, cache-offline, cache-plugin`</td>
</tr>
<tr>
<td>`cache-base`</td>
Expand Down Expand Up @@ -212,7 +212,7 @@
</tr>
<tr>
<td>`collection`</td>
<td>Collection utilities beyond what is provided in the YUI core</td>
<td>Alias module for: `array-extras, arraylist, arraylist-add, arraylist-filter, array-invoke`</td>
</tr>
<tr>
<td>`console`</td>
Expand All @@ -232,7 +232,7 @@
</tr>
<tr>
<td>`dataschema`</td>
<td>The DataSchema utility provides a common configurable interface for widgets to</td>
<td>Alias module for: `dataschema-base, dataschema-json, dataschema-xml, dataschema-array, dataschema-text`</td>
</tr>
<tr>
<td>`dataschema-array`</td>
Expand All @@ -256,7 +256,7 @@
</tr>
<tr>
<td>`datasource`</td>
<td>The DataSource utility provides a common configurable interface for widgets to</td>
<td>Alias module for: `datasource-local, datasource-io, datasource-get, datasource-function, datasource-cache, datasource-jsonschema, datasource-xmlschema, datasource-arrayschema, datasource-textschema, datasource-polling`</td>
</tr>
<tr>
<td>`datasource-arrayschema`</td>
Expand Down Expand Up @@ -300,7 +300,7 @@
</tr>
<tr>
<td>`datatable`</td>
<td>The DataTable widget provides a progressively enhanced DHTML control for</td>
<td>Alias module for: `datatable-base, datatable-datasource, datatable-sort, datatable-scroll`</td>
</tr>
<tr>
<td>`datatable-base`</td>
Expand All @@ -320,11 +320,11 @@
</tr>
<tr>
<td>`datatype`</td>
<td>The DataType Utility provides type-conversion and string-formatting</td>
<td>Alias module for: `datatype-number, datatype-date, datatype-xml`</td>
</tr>
<tr>
<td>`datatype-date`</td>
<td>Date submodule.</td>
<td>Alias module for: `datatype-date-parse, datatype-date-format`</td>
</tr>
<tr>
<td>`datatype-date-format`</td>
Expand All @@ -340,7 +340,7 @@
</tr>
<tr>
<td>`datatype-number`</td>
<td>Number submodule.</td>
<td>Alias module for: `datatype-number-parse, datatype-number-format`</td>
</tr>
<tr>
<td>`datatype-number-format`</td>
Expand All @@ -352,7 +352,7 @@
</tr>
<tr>
<td>`datatype-xml`</td>
<td>XML submodule.</td>
<td>Alias module for: `datatype-xml-parse, datatype-xml-format`</td>
</tr>
<tr>
<td>`datatype-xml-format`</td>
Expand All @@ -364,7 +364,7 @@
</tr>
<tr>
<td>`dd`</td>
<td>The Drag & Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic.</td>
<td>Alias module for: `dd-ddm-base, dd-ddm, dd-ddm-drop, dd-drag, dd-proxy, dd-constrain, dd-drop, dd-scroll, dd-delegate`</td>
</tr>
<tr>
<td>`dd-constrain`</td>
Expand Down Expand Up @@ -416,7 +416,7 @@
</tr>
<tr>
<td>`dom`</td>
<td>The DOM utility provides a cross-browser abtraction layer</td>
<td>Alias module for: `dom-base, dom-screen, dom-style, selector-native, selector`</td>
</tr>
<tr>
<td>`dom-base`</td>
Expand All @@ -436,7 +436,7 @@
</tr>
<tr>
<td>`editor`</td>
<td>Base class for Editor. Handles the business logic of Editor, no GUI involved only utility methods and events.</td>
<td>Alias module for: `frame, selection, exec-command, editor-base, editor-para, editor-br, editor-bidi, editor-tab, createlink-base`</td>
</tr>
<tr>
<td>`editor-base`</td>
Expand Down Expand Up @@ -468,15 +468,15 @@
</tr>
<tr>
<td>`event`</td>
<td>The event utility provides functions to add and remove event listeners,</td>
<td>Alias module for: `event-base, event-delegate, event-synthetic, event-mousewheel, event-mouseenter, event-key, event-focus, event-resize, event-hover, event-outside, event-touch, event-move, event-flick, event-valuechange`</td>
</tr>
<tr>
<td>`event-base`</td>
<td>DOM event listener abstraction layer</td>
</tr>
<tr>
<td>`event-custom`</td>
<td>Custom event engine, DOM event listener abstraction layer, synthetic DOM</td>
<td>Alias module for: `event-custom-base, event-custom-complex`</td>
</tr>
<tr>
<td>`event-custom-base`</td>
Expand All @@ -500,7 +500,7 @@
</tr>
<tr>
<td>`event-gestures`</td>
<td>Adds lower level support for "gesturemovestart", "gesturemove" and "gesturemoveend" events, which can be used to create drag/drop</td>
<td>Alias module for: `event-flick, event-move`</td>
</tr>
<tr>
<td>`event-hover`</td>
Expand Down Expand Up @@ -572,7 +572,7 @@
</tr>
<tr>
<td>`handlebars`</td>
<td>Handlebars is a simple template language inspired by Mustache.</td>
<td>Alias module for: `handlebars-compiler`</td>
</tr>
<tr>
<td>`handlebars-base`</td>
Expand All @@ -584,7 +584,7 @@
</tr>
<tr>
<td>`highlight`</td>
<td>Provides methods for highlighting strings within other strings by wrapping</td>
<td>Alias module for: `highlight-base, highlight-accentfold`</td>
</tr>
<tr>
<td>`highlight-accentfold`</td>
Expand All @@ -596,7 +596,7 @@
</tr>
<tr>
<td>`history`</td>
<td>Provides browser history management functionality using a simple</td>
<td>Alias module for: `history-base, history-hash, history-hash-ie, history-html5`</td>
</tr>
<tr>
<td>`history-base`</td>
Expand Down Expand Up @@ -644,7 +644,7 @@
</tr>
<tr>
<td>`json`</td>
<td>The JSON module adds support for serializing JavaScript objects into</td>
<td>Alias module for: `json-parse, json-stringify`</td>
</tr>
<tr>
<td>`json-parse`</td>
Expand All @@ -664,7 +664,7 @@
</tr>
<tr>
<td>`loader`</td>
<td>Loader dynamically loads script and css files. It includes the dependency</td>
<td>Alias module for: `loader-base, loader-rollup, loader-yui3`</td>
</tr>
<tr>
<td>`loader-base`</td>
Expand All @@ -680,7 +680,7 @@
</tr>
<tr>
<td>`node`</td>
<td>The Node Utility provides a DOM-like interface for interacting with DOM nodes.</td>
<td>Alias module for: `node-base, node-event-delegate, node-pluginhost, node-screen, node-style`</td>
</tr>
<tr>
<td>`node-base`</td>
Expand Down Expand Up @@ -768,7 +768,7 @@
</tr>
<tr>
<td>`pluginhost`</td>
<td>Provides the augmentable PluginHost interface, which can be added to any class.</td>
<td>Alias module for: `pluginhost-base, pluginhost-config`</td>
</tr>
<tr>
<td>`pluginhost-base`</td>
Expand All @@ -784,7 +784,7 @@
</tr>
<tr>
<td>`querystring`</td>
<td>The QueryString module adds support for serializing JavaScript objects into</td>
<td>Alias module for: `querystring-parse, querystring-stringify`</td>
</tr>
<tr>
<td>`querystring-parse`</td>
Expand Down Expand Up @@ -812,7 +812,7 @@
</tr>
<tr>
<td>`recordset`</td>
<td>The Recordset utility provides a standard way for dealing with</td>
<td>Alias module for: `recordset-base, recordset-sort, recordset-filter, recordset-indexer`</td>
</tr>
<tr>
<td>`recordset-base`</td>
Expand All @@ -832,7 +832,7 @@
</tr>
<tr>
<td>`resize`</td>
<td>The Resize Utility allows you to make an HTML element resizable.</td>
<td>Alias module for: `resize-base, resize-proxy, resize-constrain`</td>
</tr>
<tr>
<td>`resize-contrain`</td>
Expand Down Expand Up @@ -900,7 +900,7 @@
</tr>
<tr>
<td>`slider`</td>
<td>Create a sliding value range input visualized as a draggable thumb on a</td>
<td>Alias module for: `slider-base, slider-value-range, clickable-rail, range-slider`</td>
</tr>
<tr>
<td>`slider-base`</td>
Expand Down Expand Up @@ -948,7 +948,7 @@
</tr>
<tr>
<td>`text`</td>
<td>Provides utility methods for splitting strings on word breaks and determining</td>
<td>Alias module for: `text-accentfold, text-wordbreak`</td>
</tr>
<tr>
<td>`text-accentfold`</td>
Expand All @@ -972,7 +972,7 @@
</tr>
<tr>
<td>`widget`</td>
<td>Provides the base Widget class, with HTML Parser support</td>
<td>Alias module for: `widget-base, widget-htmlparser, widget-uievents, widget-skin`</td>
</tr>
<tr>
<td>`widget-anim`</td>
Expand Down
14 changes: 8 additions & 6 deletions src/yui/scripts/build_doc_modules.js
View file
@@ -1,11 +1,10 @@
#!/usr/bin/env node

var path = require('path'),
fs = require('fs');

var base = path.join(__dirname, '../../../api-js/data.json');

var out = path.join(__dirname, '../docs/partials/modules.mustache');
fs = require('fs'),
base = path.join(__dirname, '../../../api-js/data.json'),
alias_json = path.join(__dirname, '../../loader/js/yui3.json'),
out = path.join(__dirname, '../docs/partials/modules.mustache');

if (!path.existsSync(base)) {
console.error('\n[error] Please run `yuidoc` first to generate API documentation!');
Expand All @@ -14,6 +13,7 @@ if (!path.existsSync(base)) {

console.log('[info] Loading module meta data');
var data = JSON.parse(fs.readFileSync(base, 'utf8'));
var alias_data = JSON.parse(fs.readFileSync(alias_json, 'utf8'));

var nameSort = function(a, b) {
if (!a.name || !b.name) {
Expand Down Expand Up @@ -41,7 +41,9 @@ Object.keys(data.modules).forEach(function(i) {

d = d.split('\n')[0].replace('<p>', '').replace('</p>', '');


if (alias_data[v.name] && alias_data[v.name].use) {
d = 'Alias module for: `' + alias_data[v.name].use.join(', ') + '`';
}

var o = {
name: v.name,
Expand Down

0 comments on commit b2b6db1

Please sign in to comment.