Skip to content
Browse files

cleaning up the docs home page

  • Loading branch information...
1 parent 59e58b1 commit 62a5d7dd6c4f3ea5b608d83a6a3661f9f69e7b9e @seanmonstar committed
View
4 api/class.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html> <html> <head> <title>Shipyard JS: class</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Class: Class<a class="permalink" id="Class" href="#Class" title="Permalink to 'Class: Class'">#</a></h1>
+<!DOCTYPE html> <html> <head> <title>Shipyard JS: class</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Class: Class<a class="permalink" id="Class" href="#Class" title="Permalink to 'Class: Class'">#</a></h1>
<p>Class is a useful construct for describing your classes, using
JavaScript's prototypical inheritance, while removing some of the
verbosity. Used like so:
@@ -57,4 +57,4 @@
<span class="keyword">var</span> b = <span class="keyword">new</span> B();
b.getAge(); <span class="comment">// 6</span></code></pre>
- </article> <aside id="nav"> <p><em>v0.1.0a</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/class.html" class="active">class</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
+ </article> <aside id="nav"> <p><em>v0.1.0</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/class.html" class="active">class</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
View
4 api/events.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html> <html> <head> <title>Shipyard JS: events</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Class: EventEmitter<a class="permalink" id="EventEmitter" href="#EventEmitter" title="Permalink to 'Class: EventEmitter'">#</a></h1>
+<!DOCTYPE html> <html> <head> <title>Shipyard JS: events</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Class: EventEmitter<a class="permalink" id="EventEmitter" href="#EventEmitter" title="Permalink to 'Class: EventEmitter'">#</a></h1>
<p>A class to allow object to listen for certain events, and the
implementor of this class can emit those events at various times.
Models, Views, and Controllers are EventEmitters. Use by doing this:
@@ -84,4 +84,4 @@
<span class="comment">// useful since you didn't keep a reference to the anonymous</span>
<span class="comment">// function passed as the handler above.</span>
listener.detach();</code></pre>
- </article> <aside id="nav"> <p><em>v0.1.0a</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/events.html" class="active">events</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
+ </article> <aside id="nav"> <p><em>v0.1.0</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> <li><a href="/Shipyard/api/events.html" class="active">events</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
View
4 api/fields.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html> <html> <head> <title>Shipyard JS: fields</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Class: Field<a class="permalink" id="Field" href="#Field" title="Permalink to 'Class: Field'">#</a></h1>
+<!DOCTYPE html> <html> <head> <title>Shipyard JS: fields</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Class: Field<a class="permalink" id="Field" href="#Field" title="Permalink to 'Class: Field'">#</a></h1>
<p>All properties on a Model are stored via the help of Fields. Data is
stored with primitive values, but Fields can convert the data to useful
data formats.
@@ -86,4 +86,4 @@
<li>auto - (<em>boolean</em>, optional) Automatically store the current date upon
saving. Useful for last-modified type fields.</li>
</ul>
- </article> <aside id="nav"> <p><em>v0.1.0a</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/fields.html" class="active">fields</a></li> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
+ </article> <aside id="nav"> <p><em>v0.1.0</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/fields.html" class="active">fields</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
View
4 api/model.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html> <html> <head> <title>Shipyard JS: model</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Class: Model<a class="permalink" id="Model" href="#Model" title="Permalink to 'Class: Model'">#</a></h1>
+<!DOCTYPE html> <html> <head> <title>Shipyard JS: model</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Class: Model<a class="permalink" id="Model" href="#Model" title="Permalink to 'Class: Model'">#</a></h1>
<p>Models represent the actual data that an application will be using.
Models also abstract away the specifics of where the data is stored.
Whether you store the data on a server and need Ajax requests to fetch
@@ -112,4 +112,4 @@
<p><em>Inherited from <a href="./observable.html#Observable">Observable</a></em>
</p>
- </article> <aside id="nav"> <p><em>v0.1.0a</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/model.html" class="active">model</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
+ </article> <aside id="nav"> <p><em>v0.1.0</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/model.html" class="active">model</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
View
4 api/observable.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html> <html> <head> <title>Shipyard JS: observable</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Class: Observable<a class="permalink" id="Observable" href="#Observable" title="Permalink to 'Class: Observable'">#</a></h1>
+<!DOCTYPE html> <html> <head> <title>Shipyard JS: observable</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Class: Observable<a class="permalink" id="Observable" href="#Observable" title="Permalink to 'Class: Observable'">#</a></h1>
<p>A class with a get/set interface that makes it easy to manipulate data
on an object allowing others to observe all or only specific changes.
@@ -121,4 +121,4 @@
}
}, <span class="string">'firstName'</span>, <span class="string">'lastName'</span>)
});</code></pre>
- </article> <aside id="nav"> <p><em>v0.1.0a</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/observable.html" class="active">observable</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
+ </article> <aside id="nav"> <p><em>v0.1.0</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/observable.html" class="active">observable</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
View
4 api/sync.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html> <html> <head> <title>Shipyard JS: sync</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Class: Sync<a class="permalink" id="Sync" href="#Sync" title="Permalink to 'Class: Sync'">#</a></h1>
+<!DOCTYPE html> <html> <head> <title>Shipyard JS: sync</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Class: Sync<a class="permalink" id="Sync" href="#Sync" title="Permalink to 'Class: Sync'">#</a></h1>
<p>A base class that all Sync's should extend from.
</p>
@@ -181,4 +181,4 @@
});
<span class="keyword">var</span> t = <span class="keyword">new</span> Task();
task.save(); <span class="comment">// will log the instance to the console</span></code></pre>
- </article> <aside id="nav"> <p><em>v0.1.0a</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> <li><a href="/Shipyard/api/sync.html" class="active">sync</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
+ </article> <aside id="nav"> <p><em>v0.1.0</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/sync.html" class="active">sync</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
View
4 api/utils.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html> <html> <head> <title>Shipyard JS: utils</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Module: type<a class="permalink" id="type" href="#type" title="Permalink to 'Module: type'">#</a></h1>
+<!DOCTYPE html> <html> <head> <title>Shipyard JS: utils</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Module: type<a class="permalink" id="type" href="#type" title="Permalink to 'Module: type'">#</a></h1>
<h2>Method: typeOf<a class="permalink" id="type:typeOf" href="#type:typeOf" title="Permalink to 'Method: typeOf'">#</a></h2>
<p>Better version of <code>typeof</code>, returns a string of the type of the passed
in value.
@@ -88,4 +88,4 @@
<h2>Method: info<a class="permalink" id="log:info" href="#log:info" title="Permalink to 'Method: info'">#</a></h2>
<h2>Method: warn/warning<a class="permalink" id="log:warn_warning" href="#log:warn_warning" title="Permalink to 'Method: warn/warning'">#</a></h2>
<h2>Method: error/critical<a class="permalink" id="log:error_critical" href="#log:error_critical" title="Permalink to 'Method: error/critical'">#</a></h2>
- </article> <aside id="nav"> <p><em>v0.1.0a</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/utils.html" class="active">utils</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
+ </article> <aside id="nav"> <p><em>v0.1.0</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/utils.html" class="active">utils</a></li> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
View
4 api/view.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html> <html> <head> <title>Shipyard JS: view</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Class: View<a class="permalink" id="View" href="#View" title="Permalink to 'Class: View'">#</a></h1>
+<!DOCTYPE html> <html> <head> <title>Shipyard JS: view</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Class: View<a class="permalink" id="View" href="#View" title="Permalink to 'Class: View'">#</a></h1>
<p>A View is an abstract way of showing data to a user on the screen. The
DOM can be confusing and unintuitive, so the View layer allows
developers to work without touching the DOM. Potentially, it also allows
@@ -150,4 +150,4 @@
<p><a href="#CollectionView">CollectionView</a>
</p>
- </article> <aside id="nav"> <p><em>v0.1.0a</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/view.html" class="active">view</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
+ </article> <aside id="nav"> <p><em>v0.1.0</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/view.html" class="active">view</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
View
39 index.html
@@ -1,18 +1,23 @@
-<!DOCTYPE html> <html> <head> <title>Shipyard JS: index</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Shipyard<a class="permalink" id="Shipyard" href="#Shipyard" title="Permalink to 'Shipyard'">#</a></h1>
-<p>A Javascript <a href="http://en.wikipedia.org/wiki/Model%E2%80%93view]E2%80%93controller">MVC</a> application framework. For when you have a full-on application sitting on a web page. So much is going on, you should be able to focus on making the application working, not worrying about XmlHttpRequests and the DOM.
+<!DOCTYPE html> <html> <head> <title>Shipyard JS: index</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Shipyard<a class="permalink" id="Shipyard" href="#Shipyard" title="Permalink to 'Shipyard'">#</a></h1>
+<p>Besides being <a href="http://en.wikipedia.org/wiki/Model%E2%80%93view]E2%80%93controller">MVC</a> in JavaScript, Shipyard is <strong>explictly
+modular</strong>, <strong>easy to test</strong>, and utilizes the power of <strong>Syncs</strong> and
+<strong>View binding</strong>.
</p>
-<h2>What Shipyard is<a class="permalink" id="Shipyard:What_Shipyard_is" href="#Shipyard:What_Shipyard_is" title="Permalink to 'What Shipyard is'">#</a></h2>
-<p>An application framework that covers all the common things any JavaScript application would need to deal with: interacting with a server, storing data, rendering said data in the browser, and responding to user actions. An application built on Shipyard should only have to write that pulls all those things together.
-
-</p>
-<p>If you're application is going to have 1000 lines of JavaScript, would you rather write all those yourself, or have 900 of them be in a framework that is tested and used by others?
+<h2>Get it now!<a class="permalink" id="Shipyard:Get_it_now_" href="#Shipyard:Get_it_now_" title="Permalink to 'Get it now!'">#</a></h2>
+<p>Take a look at the <a href="./topics/tutorial.html">tutorial</a> to make your first
+application, or the <a href="/Shipyard/examples/tasks/">obligatory example Todo app</a>.
</p>
-<p>When starting a web application, you would reach for Django, or CakePHP, or Rails; never would you decide to use just the language itself. Why shouldn't you do the same when the target language is JavaScript?
+<p>Then, install the latest stable version using <code>npm install shipyard</code>, or
+grab the dev version from GitHub:
</p>
-<h2>Goals<a class="permalink" id="Shipyard:Goals" href="#Shipyard:Goals" title="Permalink to 'Goals'">#</a></h2>
+<pre><code>$ git <span class="keyword">clone</span> git:<span class="comment">//github.com/seanmonstar/Shipyard.git</span>
+$ cd Shipyard
+$ npm link
+$ shipyard test</code></pre>
+<h2>What is Shipyard?<a class="permalink" id="Shipyard:What_is_Shipyard_" href="#Shipyard:What_is_Shipyard_" title="Permalink to 'What is Shipyard?'">#</a></h2>
<h3>Framework-wide Goals</h3>
<ol>
<li><strong>Modularity</strong>: Be able to declare dependencies inside the code, and not be bothered with managing them during development or deployment.</li>
@@ -39,13 +44,13 @@
<li><strong>Boilerplate</strong>: Attempt to remove typical boilerplate of attaching
Models to Views with validation in between.</li>
</ol>
-<h2>Getting Started<a class="permalink" id="Shipyard:Getting_Started" href="#Shipyard:Getting_Started" title="Permalink to 'Getting Started'">#</a></h2>
-<pre><code>$ git <span class="keyword">clone</span> git:<span class="comment">//github.com/seanmonstar/Shipyard.git</span>
-$ cd Shipyard
-$ npm link
-$ shipyard test</code></pre>
-<p>Take a look at the <a href="./topics/tutorial.html">tutorial</a> to make your first
-application, or the <a href="/Shipyard/examples/tasks/">obligatory example Todo app</a>.
+<h2>Meta<a class="permalink" id="Shipyard:Meta" href="#Shipyard:Meta" title="Permalink to 'Meta'">#</a></h2>
+<p>The code is <a href="https://github.com/seanmonstar/Shipyard">available on GitHub</a>, the <a href="http://travis-ci.org/#!/seanmonstar/Shipyard">test suite</a> is
+connected to TravisCI, and you can play with it on <a href="http://jsfiddle.net/seanmonstar/JrcF4/">jsFiddle</a>.
+
+</p>
+<p>Bugs and feature requests live at <a href="https://github.com/seanmonstar/Shipyard/issues">GitHub Issues</a>, and you can send tweets
+to <a href="https://twitter.com/shipyardjs">@shipyardjs</a>.
</p>
- </article> <aside id="nav"> <p><em>v0.1.0a</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
+ </article> <aside id="nav"> <p><em>v0.1.0</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
View
4 topics/dom.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html> <html> <head> <title>Shipyard JS: dom</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>The DOM<a class="permalink" id="The_DOM" href="#The_DOM" title="Permalink to 'The DOM'">#</a></h1>
+<!DOCTYPE html> <html> <head> <title>Shipyard JS: dom</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>The DOM<a class="permalink" id="The_DOM" href="#The_DOM" title="Permalink to 'The DOM'">#</a></h1>
<p>When programming with Shipyard, if you ever wish to access a usual
global that is available in a browser, such as <code>window</code>, <code>document</code>, or
<code>XMLHttpRequest</code>, you must access it via the <code>dom</code> module.
@@ -24,4 +24,4 @@
</p>
- </article> <aside id="nav"> <p><em>v0.1.0a</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/dom.html" class="active">dom</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
+ </article> <aside id="nav"> <p><em>v0.1.0</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/dom.html" class="active">dom</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
View
4 topics/installation.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html> <html> <head> <title>Shipyard JS: installation</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Installation<a class="permalink" id="Installation" href="#Installation" title="Permalink to 'Installation'">#</a></h1>
+<!DOCTYPE html> <html> <head> <title>Shipyard JS: installation</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Installation<a class="permalink" id="Installation" href="#Installation" title="Permalink to 'Installation'">#</a></h1>
<h2>Install Node<a class="permalink" id="Installation:Install_Node" href="#Installation:Install_Node" title="Permalink to 'Install Node'">#</a></h2>
<p>Shipyard uses node.js for it's utilty scripts, such as running tests and
minifying your application for deployment. Head over to <a href="http://nodejs.org/#download">nodejs.org</a>, and
@@ -33,4 +33,4 @@
<p>Excellent. Now you can proceed with the <a href="./tutorial.html">tutorial</a>.
</p>
- </article> <aside id="nav"> <p><em>v0.1.0a</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" class="active">installation</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
+ </article> <aside id="nav"> <p><em>v0.1.0</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" class="active">installation</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
View
4 topics/models.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html> <html> <head> <title>Shipyard JS: models</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Models<a class="permalink" id="Models" href="#Models" title="Permalink to 'Models'">#</a></h1>
+<!DOCTYPE html> <html> <head> <title>Shipyard JS: models</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Models<a class="permalink" id="Models" href="#Models" title="Permalink to 'Models'">#</a></h1>
<p>Many applications have data, and they want to store it or fetch it from
various locations. Shiyard <a href="../api/model.html#Model">Models</a> do a couple things that help
organize and make the common operations easier, using Fields and Syncs.
@@ -78,4 +78,4 @@
<span class="comment">// ... elsewhere, save a specific task to localStorage</span>
task.save({ using: <span class="string">'local'</span> });</code></pre>
- </article> <aside id="nav"> <p><em>v0.1.0a</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/models.html" class="active">models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
+ </article> <aside id="nav"> <p><em>v0.1.0</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/models.html" class="active">models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
View
4 topics/modules.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html> <html> <head> <title>Shipyard JS: modules</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Modules<a class="permalink" id="Modules" href="#Modules" title="Permalink to 'Modules'">#</a></h1>
+<!DOCTYPE html> <html> <head> <title>Shipyard JS: modules</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Modules<a class="permalink" id="Modules" href="#Modules" title="Permalink to 'Modules'">#</a></h1>
<p>Shipyard fully embraces a module system, similar to CommonJS or
<a href="http://nodejs.org">nodejs</a>'
modules. In fact, a feature of Shipyard is that you can open a nodejs
@@ -11,4 +11,4 @@
end-users.
</p>
- </article> <aside id="nav"> <p><em>v0.1.0a</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" class="active">modules</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
+ </article> <aside id="nav"> <p><em>v0.1.0</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" class="active">modules</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
View
4 topics/tutorial.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html> <html> <head> <title>Shipyard JS: tutorial</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Your First Shipyard App<a class="permalink" id="Your_First_Shipyard_App" href="#Your_First_Shipyard_App" title="Permalink to 'Your First Shipyard App'">#</a></h1>
+<!DOCTYPE html> <html> <head> <title>Shipyard JS: tutorial</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Your First Shipyard App<a class="permalink" id="Your_First_Shipyard_App" href="#Your_First_Shipyard_App" title="Permalink to 'Your First Shipyard App'">#</a></h1>
<p>Let's learn by example. We'll walk through creating a basic recipe
collection. We'll assume you already have <a href="./installation.html">Shipyard installed</a>. You can
tell it's installed correctly by running <code>shipyard</code> in a terminal and
@@ -282,4 +282,4 @@
details.
</p>
- </article> <aside id="nav"> <p><em>v0.1.0a</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" class="active">tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
+ </article> <aside id="nav"> <p><em>v0.1.0</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" class="active">tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" >views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
View
4 topics/views-and-binding.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html> <html> <head> <title>Shipyard JS: views%20and%20binding</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Views<a class="permalink" id="Views" href="#Views" title="Permalink to 'Views'">#</a></h1>
+<!DOCTYPE html> <html> <head> <title>Shipyard JS: views%20and%20binding</title> <link rel="stylesheet" type="text/css" href="/Shipyard/style.css"> </head> <body> <header> <div> <h1><a href="/Shipyard">Shipyard</a></h1> <p>A modular JavaScript MVC framework</p> </div> </header> <div id="container"> <article id="main"> <h1>Views<a class="permalink" id="Views" href="#Views" title="Permalink to 'Views'">#</a></h1>
<p>After you've defined your <a href="./models.html#Models">data models</a>, it's worth thinking
about Shipyard's <a href="../api/views.html#View">View</a> system. The goal of the view system is to let
a developer programmatically define the user interface once, and
@@ -41,4 +41,4 @@
</p>
- </article> <aside id="nav"> <p><em>v0.1.0a</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" class="active">views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>
+ </article> <aside id="nav"> <p><em>v0.1.0</em></p> <nav> <ul> <li> Topics <ul> <li><a href="/Shipyard/topics/tutorial.html" >tutorial</a></li> <li><a href="/Shipyard/topics/installation.html" >installation</a></li> <li><a href="/Shipyard/topics/models.html" >models</a></li> <li><a href="/Shipyard/topics/modules.html" >modules</a></li> <li><a href="/Shipyard/topics/dom.html" >dom</a></li> <li><a href="/Shipyard/topics/views-and-binding.html" class="active">views and binding</a></li> </ul> </li> <li> API Reference <ul> <li><a href="/Shipyard/api/model.html" >model</a></li> <li><a href="/Shipyard/api/fields.html" >fields</a></li> <li><a href="/Shipyard/api/utils.html" >utils</a></li> <li><a href="/Shipyard/api/class.html" >class</a></li> <li><a href="/Shipyard/api/sync.html" >sync</a></li> <li><a href="/Shipyard/api/view.html" >view</a></li> <li><a href="/Shipyard/api/events.html" >events</a></li> <li><a href="/Shipyard/api/observable.html" >observable</a></li> </ul> </li> </ul> </nav> </aside> <footer>&copy; 2012 <a href="http://seanmonstar.com">Sean McArthur</a>. Source available on <a href="https://github.com/seanmonstar/Shipyard">GitHub</a>.</footer> </div> </body> </html>

0 comments on commit 62a5d7d

Please sign in to comment.
Something went wrong with that request. Please try again.