Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gnovos committed Jul 27, 2015
1 parent 9300da9 commit 08a7474
Show file tree
Hide file tree
Showing 129 changed files with 8,982 additions and 865 deletions.
1 change: 1 addition & 0 deletions docs/api/data-4a543d7d078c3f954b43376d15934fb1.js

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion docs/api/data-ab1b8e3c387bdacd5b73b0388808e963.js

This file was deleted.

1 change: 1 addition & 0 deletions docs/api/guides/plugins/README.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

61 changes: 61 additions & 0 deletions docs/api/guides/plugins/README.md
@@ -0,0 +1,61 @@
# Dreem Plugin Guide

[//]: # This introduction to building plugins in Dreem.

Plugins allow you to provide additional classes and server behavior to a composition. The structure of a plugin is almost
identical composition (though typically without `<screen>` tags), and is contained within the `<plugin></plugin>` tag.
Plugins are added to the server at startup with one or more `-plugin /path/to/plugin/` command line switches, like so:

node ./server.js -plugin ../plugins/teem-sample_component/ -plugin ../plugins/soundcloud/

## Directory Structure

./index.dre - the main plugin code
./package.json - names the plugin and provides for a dependencies
./node_modules/ - node modules that plugin depends on
./examples/*.dre - optional example compositions that use the plugin

The examples will automatically be mounted at `/plugins/plugin-name/examples/filename.dre`

## Plugin File Structure

Here is a sample index.dre (explained in more detail below):

<plugin>
<classes>
<class name="webrequest">
<attribute name="src" value="" type="string"></attribute>
<setter name="src" args="val">
if (val) {
dr.teem.server.request(val).then((function (ret) {
this.setAttribute('response', ret);
}).bind(this));
}
return val;
</setter>
<attribute name="response" value="" type="string"></attribute>
</class>
</classes>

<server>
<handler event="init">
this.__srequest = require('$PLUGIN/sync-request');
</handler>
<method name="request" args="url">
if (/^https?:.*/.test(url)) {
try {
var res = this.__srequest('GET', url);
var body = res.getBody().toString();
return body;
} catch(err) {
return ['[ERROR]', err.message].join(' ');
}
} else {
return "Cannot parse URL:" + url;
}
</method>
</server>
</plugin>

This plugin provides a simple "webrequest" object which can be used in compositions to have the server fetch web pages
from a given URL in it's `src` attribute, which is then stored in it's `response` attribute.
Binary file added docs/api/guides/plugins/icon.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 20 additions & 1 deletion docs/api/index.html
Expand Up @@ -13,7 +13,7 @@
<link rel="stylesheet" href="styles-7db15577398814fbd56ff70520f45e51.css" type="text/css" />

<script type="text/javascript" src="extjs/ext-all.js"></script>
<script type="text/javascript" src="data-ab1b8e3c387bdacd5b73b0388808e963.js"></script>
<script type="text/javascript" src="data-4a543d7d078c3f954b43376d15934fb1.js"></script>

<script type="text/javascript" src="app-0c945a27f43452df695771ddb60b3d14.js"></script>

Expand Down Expand Up @@ -41,7 +41,17 @@ <h3>All Classes</h3>
<li><a href="#!/api/dr.constantlayout" rel="dr.constantlayout" class="docClass">dr.constantlayout</a></li>
<li><a href="#!/api/dr.datapath" rel="dr.datapath" class="docClass">dr.datapath</a></li>
<li><a href="#!/api/dr.dataset" rel="dr.dataset" class="docClass">dr.dataset</a></li>
<li><a href="#!/api/dr.dropdown" rel="dr.dropdown" class="docClass">dr.dropdown</a></li>
<li><a href="#!/api/dr.dropdownfont" rel="dr.dropdownfont" class="docClass">dr.dropdownfont</a></li>
<li><a href="#!/api/dr.editor.attrundoable" rel="dr.editor.attrundoable" class="docClass">dr.editor.attrundoable</a></li>
<li><a href="#!/api/dr.editor.compoundundoable" rel="dr.editor.compoundundoable" class="docClass">dr.editor.compoundundoable</a></li>
<li><a href="#!/api/dr.editor.createundoable" rel="dr.editor.createundoable" class="docClass">dr.editor.createundoable</a></li>
<li><a href="#!/api/dr.editor.deleteundoable" rel="dr.editor.deleteundoable" class="docClass">dr.editor.deleteundoable</a></li>
<li><a href="#!/api/dr.editor.orderundoable" rel="dr.editor.orderundoable" class="docClass">dr.editor.orderundoable</a></li>
<li><a href="#!/api/dr.editor.undoable" rel="dr.editor.undoable" class="docClass">dr.editor.undoable</a></li>
<li><a href="#!/api/dr.editor.undostack" rel="dr.editor.undostack" class="docClass">dr.editor.undostack</a></li>
<li><a href="#!/api/dr.expectedoutput" rel="dr.expectedoutput" class="docClass">dr.expectedoutput</a></li>
<li><a href="#!/api/dr.fontdetect" rel="dr.fontdetect" class="docClass">dr.fontdetect</a></li>
<li><a href="#!/api/dr.indicator" rel="dr.indicator" class="docClass">dr.indicator</a></li>
<li><a href="#!/api/dr.inputtext" rel="dr.inputtext" class="docClass">dr.inputtext</a></li>
<li><a href="#!/api/dr.labelbutton" rel="dr.labelbutton" class="docClass">dr.labelbutton</a></li>
Expand All @@ -58,6 +68,8 @@ <h3>All Classes</h3>
<li><a href="#!/api/dr.style" rel="dr.style" class="docClass">dr.style</a></li>
<li><a href="#!/api/dr.testingtimer" rel="dr.testingtimer" class="docClass">dr.testingtimer</a></li>
<li><a href="#!/api/dr.text" rel="dr.text" class="docClass">dr.text</a></li>
<li><a href="#!/api/dr.textlistbox" rel="dr.textlistbox" class="docClass">dr.textlistbox</a></li>
<li><a href="#!/api/dr.textlistboxitem" rel="dr.textlistboxitem" class="docClass">dr.textlistboxitem</a></li>
<li><a href="#!/api/dr.variablelayout" rel="dr.variablelayout" class="docClass">dr.variablelayout</a></li>
<li><a href="#!/api/dr.videoplayer" rel="dr.videoplayer" class="docClass">dr.videoplayer</a></li>
<li><a href="#!/api/dr.view" rel="dr.view" class="docClass">dr.view</a></li>
Expand All @@ -74,6 +86,7 @@ <h3>Internal</h3>
<li><a href="#!/api/DreemCompiler" rel="DreemCompiler" class="docClass">DreemCompiler</a></li>
<li><a href="#!/api/DreemError" rel="DreemError" class="docClass">DreemError</a></li>
<li><a href="#!/api/NodeWebSocket" rel="NodeWebSocket" class="docClass">NodeWebSocket</a></li>
<li><a href="#!/api/PluginLoader" rel="PluginLoader" class="docClass">PluginLoader</a></li>
<li><a href="#!/api/RunMonitor" rel="RunMonitor" class="docClass">RunMonitor</a></li>
<li><a href="#!/api/TeemServer" rel="TeemServer" class="docClass">TeemServer</a></li>
<li><a href="#!/api/parser.Compiler" rel="parser.Compiler" class="docClass">parser.Compiler</a></li>
Expand Down Expand Up @@ -102,7 +115,10 @@ <h3>UI Components</h3>
<li><a href="#!/api/dr.bitmap" rel="dr.bitmap" class="docClass">dr.bitmap</a></li>
<li><a href="#!/api/dr.buttonbase" rel="dr.buttonbase" class="docClass">dr.buttonbase</a></li>
<li><a href="#!/api/dr.checkbutton" rel="dr.checkbutton" class="docClass">dr.checkbutton</a></li>
<li><a href="#!/api/dr.dropdown" rel="dr.dropdown" class="docClass">dr.dropdown</a></li>
<li><a href="#!/api/dr.dropdownfont" rel="dr.dropdownfont" class="docClass">dr.dropdownfont</a></li>
<li><a href="#!/api/dr.expectedoutput" rel="dr.expectedoutput" class="docClass">dr.expectedoutput</a></li>
<li><a href="#!/api/dr.fontdetect" rel="dr.fontdetect" class="docClass">dr.fontdetect</a></li>
<li><a href="#!/api/dr.indicator" rel="dr.indicator" class="docClass">dr.indicator</a></li>
<li><a href="#!/api/dr.inputtext" rel="dr.inputtext" class="docClass">dr.inputtext</a></li>
<li><a href="#!/api/dr.labelbutton" rel="dr.labelbutton" class="docClass">dr.labelbutton</a></li>
Expand All @@ -114,6 +130,8 @@ <h3>UI Components</h3>
<li><a href="#!/api/dr.style" rel="dr.style" class="docClass">dr.style</a></li>
<li><a href="#!/api/dr.testingtimer" rel="dr.testingtimer" class="docClass">dr.testingtimer</a></li>
<li><a href="#!/api/dr.text" rel="dr.text" class="docClass">dr.text</a></li>
<li><a href="#!/api/dr.textlistbox" rel="dr.textlistbox" class="docClass">dr.textlistbox</a></li>
<li><a href="#!/api/dr.textlistboxitem" rel="dr.textlistboxitem" class="docClass">dr.textlistboxitem</a></li>
<li><a href="#!/api/dr.videoplayer" rel="dr.videoplayer" class="docClass">dr.videoplayer</a></li>
<li><a href="#!/api/dr.view" rel="dr.view" class="docClass">dr.view</a></li>
<li><a href="#!/api/dr.webpage" rel="dr.webpage" class="docClass">dr.webpage</a></li>
Expand Down Expand Up @@ -148,6 +166,7 @@ <h3>Dreem Guides</h3>
<li><a href='#!/guide/constraints'>Dynamically Constraining Attributes with JavaScript Expressions</a></li>
<li><a href='#!/guide/debug'>Troubleshooting and Debugging Dreem Applications</a></li>
<li><a href='#!/guide/packages'>Dreem Class Packages Guide</a></li>
<li><a href='#!/guide/plugins'>Dreem Plugin Guide</a></li>
<li><a href='#!/guide/startingwithdreem'>Starting out with Dreem (using windows)</a></li>
<li><a href='#!/guide/subclassing'>Dreem Language Guide</a></li>
</ul>
Expand Down

0 comments on commit 08a7474

Please sign in to comment.