Merge pull request #130 from OpenF2/1.3-wip

F2 version 1.3.0
OpenF2 · Sep 16, 2013 · 6158655 · 6158655
2 parents d1860d2 + aff22fa
commit 6158655
Show file tree

Hide file tree

Showing 73 changed files with 4,475 additions and 877 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -2,7 +2,8 @@ language: node_js
 node_js:
   - "0.10"
 notifications:
-  email: false
+  email:
+    - [email protected]
 before_script:
   - npm install grunt-cli
 script:

diff --git a/F2.latest.js b/F2.latest.js
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -70,6 +70,14 @@ module.exports = function(grunt) {
 						cwd: 'docs/',
 						src: ['**'],
 						dest: '../gh-pages'
+					},
+					{
+						expand: true,
+						cwd: './',
+						src: ['f2.latest.js'],
+						rename: function(dest,src){
+							return '../gh-pages/js/f2.min.js';//See #35
+						}
 					}
 				]
 			},
@@ -94,7 +102,20 @@ module.exports = function(grunt) {
 					{
 						expand: true,
 						cwd: 'examples/',
-						src: ['**']
+						src: ['**'],
+						dest: 'examples/'
+					},
+					{
+						expand: true,
+						cwd: 'sdk/',
+						src: ['f2.debug.js'],
+						dest: 'sdk/'
+					},
+					{
+						expand: true,
+						cwd: 'sdk/',
+						src: ['src/third-party/require.min.js'],
+						dest: 'sdk/'
 					}
 				]
 			}
@@ -442,9 +463,9 @@ module.exports = function(grunt) {
 		});
 
 		// insert readme markdown
-		Y.Handlebars.registerHelper('readme', function() {
+		/*Y.Handlebars.registerHelper('readme', function() {
 			return builder.markdown(readmeMd, true);	
-		});
+		});*/
 
 		builder = new Y.DocBuilder(docOptions, json);
 		builder.compile(function() {
@@ -460,6 +481,16 @@ module.exports = function(grunt) {
 	grunt.registerTask('js', ['jshint', 'concat:dist', 'concat:no-third-party', 'uglify:dist', 'uglify:sourcemap', 'sourcemap', 'copy:f2ToRoot']);
 	grunt.registerTask('sourcemap', ['uglify:sourcemap', 'fix-sourcemap']);
 	grunt.registerTask('test', ['jshint', 'express', 'jasmine'/*, 'express-keepalive'*/]);
+	grunt.registerTask('packages', [
+		'concat:no-jquery-or-bootstrap',
+		'concat:no-bootstrap',
+		'concat:no-easyXDM',
+		'concat:basic',
+		'uglify:package-no-jquery-or-bootstrap',
+		'uglify:package-no-bootstrap',
+		'uglify:package-no-easyXDM',
+		'uglify:package-basic'
+	]);
 	grunt.registerTask('travis', ['test']);
 
 	// the default task

diff --git a/README.md b/README.md
@@ -94,7 +94,7 @@ Good news if you're using C#! We have an [F2 NuGet package available](https://nu
 
 ### Collaboration 
 
-Join our team and help contribute to F2 on GitHub. Begin by reading our [contribution guidelines](CONTRIBUTING.md), and then start by [forking the repo](https://github.com/OpenF2/F2/fork_select), sending [pull requests](https://help.github.com/articles/using-pull-requests), or [submitting issues](https://github.com/OpenF2/F2/issues).
+Join our team and help contribute to F2 on GitHub. Begin by reading our [contribution guidelines](CONTRIBUTING.md), and then start by [forking the repo](https://github.com/OpenF2/F2/fork), sending [pull requests](https://help.github.com/articles/using-pull-requests), or [submitting issues](https://github.com/OpenF2/F2/issues).
 
 Thank you to the [growing list of contributors](https://github.com/OpenF2/F2/graphs/contributors)!
 

diff --git a/docs/app-development.html b/docs/app-development.html
@@ -3,7 +3,7 @@
 <head>
   <title>F2 - App Development</title>
   <meta charset="utf-8">
-  <meta name="dcterms.date" content="8 August 2013">
+  <meta name="dcterms.date" content="16 September 2013">
   <meta name="description" content="F2: The Open Financial Framework. An open framework created for the financial services industry.">
   <meta name="keywords" content="F2, Open F2, openf2, Open Financial Framework, Markit, Markit On Demand, MOD, web, web framework, apps, context, container">
   <meta name="robots" content="all, index, follow" />
@@ -16,7 +16,7 @@
   <script src="./js/respond.min.js"></script>
 
   <link href="./css/prettify.css" rel="stylesheet">
-  <link href="./css/F2.Docs.css?1.2.1" rel="stylesheet">
+  <link href="./css/F2.Docs.css?1.3.0" rel="stylesheet">
 
   <link rel="icon" href="./img/favicon-32px.png" type="image/png"/>
   <link rel="apple-touch-icon" sizes="57x57" href="./img/touch-icon-57.png" />
@@ -62,7 +62,7 @@
                   <ul class="nav navinset">
                     <li><a href="./">The Basics</a></li>
                     <li><a href="app-development.html">Development</a></li>
-                    <li><a href="./sdk/">Reference</a></li>
+                    <li><a href="./sdk/classes/F2.html">Reference</a></li>
                   </ul>
             </li>
             <li class="divider-vertical"></li>
@@ -72,8 +72,8 @@
             <li class="divider-vertical"></li>
             <li><a href="http://blog.openf2.org" target="_blank">Blog</a></li>
             <li class="divider-vertical"></li>
-            <li class="ghWrap"><a class="gitHubLink" href="https://github.com/OpenF2/F2/"><strong>VIEW </strong><span class="onDecoration">ON</span><strong> GITHUB</strong><span class="F2VersionIndicator">v 1.2.1</span></a></li>
-            <li class="ghWrapResp"><a href="https://github.com/OpenF2/F2/">View on GitHub (v 1.2.1)</a></li>
+            <li class="ghWrap"><a class="gitHubLink" href="https://github.com/OpenF2/F2/"><strong>VIEW </strong><span class="onDecoration">ON</span><strong> GITHUB</strong><span class="F2VersionIndicator">v 1.3.0</span></a></li>
+            <li class="ghWrapResp"><a href="https://github.com/OpenF2/F2/">View on GitHub (v 1.3.0)</a></li>
           </ul>
         </div>
       </div>
@@ -86,7 +86,7 @@
               <ul class="unstyled clearfix">
                 <li class="basics"><a href="./">The Basics</a></li>
                 <li class="dev"><a href="app-development.html">Development</a></li>
-                <li class="ref"><a href="./sdk/">Reference</a></li>
+                <li class="ref"><a href="./sdk/classes/F2.html">Reference</a></li>
               </ul>
           </div>
         </div>
@@ -124,7 +124,7 @@
 <h1 class="title">App Development</h1>
 </header>
 <p class="lead">
-Apps are the building blocks of any F2-enabled solution. F2 apps are web-based, built with HTML5, CSS3, and JavaScript, and contain entitled data. F2 enables App Developers to build once and deploy to any <a href="#container-development.html">container</a> with a simple and modern API. You can <a href="index.html#framework">read more about the framework</a>, <a href="https://github.com/OpenF2/F2#quick-start">download the project on GitHub</a> or <a href="#get-started">get started</a> below. The latest version of F2 is 1.2.1.
+Apps are the building blocks of any F2-enabled solution. F2 apps are web-based, built with HTML5, CSS3, and JavaScript, and contain entitled data. F2 enables App Developers to build once and deploy to any <a href="#container-development.html">container</a> with a simple and modern API. You can <a href="index.html#framework">read more about the framework</a>, <a href="https://github.com/OpenF2/F2#quick-start">download the project on GitHub</a> or <a href="#get-started">get started</a> below. The latest version of F2 is 1.3.0.
 </p>
 
 <p>F2 apps are synonymous with modules, widgets and portlets. Think charts, portfolios, trade tickets, and screeners. F2 apps only need to be programmed once, no matter where they will be used. To start, F2 Apps are either:</p>
@@ -943,7 +943,7 @@ <h3>Considerations</h3>
 	<hr>
 
 	<footer>
-		<p class="pull-left"><small><strong>F2&nbsp;&nbsp;|&nbsp;&nbsp;The Open Financial Framework</strong><br><a href="mailto:[email protected]">[email protected]</a><br>Specification 1.2.1, published 8 August 2013</small></p>
+		<p class="pull-left"><small><strong>F2&nbsp;&nbsp;|&nbsp;&nbsp;The Open Financial Framework</strong><br><a href="mailto:[email protected]">[email protected]</a><br>Specification 1.3.0, published 16 September 2013</small></p>
 		<p class="pull-right"><small>F2 is maintained by <a href="http://www.markitondemand.com/">Markit On Demand</a> on <a href="https://github.com/OpenF2/F2">GitHub</a>.<br>Code licensed under the <a href="https://github.com/OpenF2/F2#copyright-and-license">Apache 2.0 License</a>.<br> Documentation licensed under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.</small></p>
 	</footer>
 
@@ -952,7 +952,7 @@ <h3>Considerations</h3>
 <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script>
 <script src="./js/bootstrap.min.2.3.0.js"></script>
 <script src="./js/prettify.js"></script>
-<script src="./js/f2.js?1.2.1"></script>
-<script src="./js/docs.js?1.2.1"></script>
+<script src="./js/f2.js?1.3.0"></script>
+<script src="./js/docs.js?1.3.0"></script>
 </body>
 </html>
diff --git a/docs/container-development.html b/docs/container-development.html
@@ -3,7 +3,7 @@
 <head>
   <title>F2 - Container Development</title>
   <meta charset="utf-8">
-  <meta name="dcterms.date" content="8 August 2013">
+  <meta name="dcterms.date" content="16 September 2013">
   <meta name="description" content="F2: The Open Financial Framework. An open framework created for the financial services industry.">
   <meta name="keywords" content="F2, Open F2, openf2, Open Financial Framework, Markit, Markit On Demand, MOD, web, web framework, apps, context, container">
   <meta name="robots" content="all, index, follow" />
@@ -16,7 +16,7 @@
   <script src="./js/respond.min.js"></script>
 
   <link href="./css/prettify.css" rel="stylesheet">
-  <link href="./css/F2.Docs.css?1.2.1" rel="stylesheet">
+  <link href="./css/F2.Docs.css?1.3.0" rel="stylesheet">
 
   <link rel="icon" href="./img/favicon-32px.png" type="image/png"/>
   <link rel="apple-touch-icon" sizes="57x57" href="./img/touch-icon-57.png" />
@@ -62,7 +62,7 @@
                   <ul class="nav navinset">
                     <li><a href="./">The Basics</a></li>
                     <li><a href="app-development.html">Development</a></li>
-                    <li><a href="./sdk/">Reference</a></li>
+                    <li><a href="./sdk/classes/F2.html">Reference</a></li>
                   </ul>
             </li>
             <li class="divider-vertical"></li>
@@ -72,8 +72,8 @@
             <li class="divider-vertical"></li>
             <li><a href="http://blog.openf2.org" target="_blank">Blog</a></li>
             <li class="divider-vertical"></li>
-            <li class="ghWrap"><a class="gitHubLink" href="https://github.com/OpenF2/F2/"><strong>VIEW </strong><span class="onDecoration">ON</span><strong> GITHUB</strong><span class="F2VersionIndicator">v 1.2.1</span></a></li>
-            <li class="ghWrapResp"><a href="https://github.com/OpenF2/F2/">View on GitHub (v 1.2.1)</a></li>
+            <li class="ghWrap"><a class="gitHubLink" href="https://github.com/OpenF2/F2/"><strong>VIEW </strong><span class="onDecoration">ON</span><strong> GITHUB</strong><span class="F2VersionIndicator">v 1.3.0</span></a></li>
+            <li class="ghWrapResp"><a href="https://github.com/OpenF2/F2/">View on GitHub (v 1.3.0)</a></li>
           </ul>
         </div>
       </div>
@@ -86,7 +86,7 @@
               <ul class="unstyled clearfix">
                 <li class="basics"><a href="./">The Basics</a></li>
                 <li class="dev"><a href="app-development.html">Development</a></li>
-                <li class="ref"><a href="./sdk/">Reference</a></li>
+                <li class="ref"><a href="./sdk/classes/F2.html">Reference</a></li>
               </ul>
           </div>
         </div>
@@ -124,7 +124,7 @@
 <h1 class="title">Container Development</h1>
 </header>
 <p class="lead">
-The container is the foundation of any F2-enabled solution. By leveraging the <a href="f2js-sdk.html">F2.js SDK</a>, Container Providers offer a consistent and reliable mechanism for all App Developers to load their apps on that container regardless of where it is hosted, who developed it, or what back-end stack it uses. You can <a href="index.html#framework">read more about the framework</a>, <a href="https://github.com/OpenF2/F2#quick-start">download the project on GitHub</a> or <a href="#get-started">get started</a> below. The latest version of F2 is 1.2.1.
+The container is the foundation of any F2-enabled solution. By leveraging the <a href="f2js-sdk.html">F2.js SDK</a>, Container Providers offer a consistent and reliable mechanism for all App Developers to load their apps on that container regardless of where it is hosted, who developed it, or what back-end stack it uses. You can <a href="index.html#framework">read more about the framework</a>, <a href="https://github.com/OpenF2/F2#quick-start">download the project on GitHub</a> or <a href="#get-started">get started</a> below. The latest version of F2 is 1.3.0.
 </p>
 
 <hr>
@@ -248,6 +248,13 @@ <h3>Container Config</h3>
 });</code></pre>
 <p>Review all of the <code>ContainerConfig</code> properties in the <a href="./sdk/classes/F2.ContainerConfig.html">reference documentation</a>.</p>
 <p>To see a more detailed example of <code>F2.init()</code>, <a href="https://github.com/OpenF2/F2/blob/master/examples/container/js/container.js">look at the sample container javascript</a> in the F2 repo on GitHub.</p>
+<section class="level4" id="debug-mode">
+<h4>Debug Mode</h4>
+<p>To enable debug mode in a container, use the following <a href="./sdk/classes/F2.ContainerConfig.html">property</a> in <code>F2.init()</code>. Setting <code>debugMode: true</code> adds additional logging, resource cache busting, etc. For obvious reasons, this property should only be used in a development environment.</p>
+<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">F2</span>.<span class="fu">init</span>({
+   <span class="dt">debugMode</span>: <span class="kw">true</span> 
+});</code></pre>
+</section>
 <section class="level4" id="apprender-beforeapprender-afterapprender">
 <h4>AppRender, BeforeAppRender, AfterAppRender</h4>
 <p>The <code>appRender()</code>, <code>beforeAppRender()</code>, and <code>afterAppRender()</code> methods were deprecated in F2 version 1.2 in favor of <a href="#apphandlers-for-app-layout"><code>F2.AppHandlers</code></a>. Upgrading to F2 1.2 will not break existing containers using any of these methods as they are still present in the SDK.</p>
@@ -271,7 +278,7 @@ <h4>Setting Up a Loading GIF</h4>
 </section>
 <section class="level4" id="override-the-appmanifest-request">
 <h4>Override the AppManifest Request</h4>
-<p>Occasionally Container Developers need more granular control over the <code>AppManifest</code> request mechanism in F2.js. The <a href="./sdk/classes/F2.html#methods-registerApps">manifest request process</a>—intentionally obscured from developers through the <code>F2.registerApps()</code> API—is handled by a simple ajax call to an HTTP endpoint. (F2 relies on <code>jQuery.ajax()</code> for this.) In version 1.2.1 of F2, the <code>AppManifest</code> request can be overridden in the Container Config.</p>
+<p>Occasionally Container Developers need more granular control over the <code>AppManifest</code> request mechanism in F2.js. The <a href="./sdk/classes/F2.html#methods-registerApps">manifest request process</a>—intentionally obscured from developers through the <code>F2.registerApps()</code> API—is handled by a simple ajax call to an HTTP endpoint. (F2 relies on <code>jQuery.ajax()</code> for this.) In version 1.3.0 of F2, the <code>AppManifest</code> request can be overridden in the Container Config.</p>
 <p><span class="label label-info">Note</span> The <code>AppManifest</code> endpoint is configured in the <code>manifestUrl</code> property within each <a href="#appconfigs"><code>AppConfig</code></a>.</p>
 <p>The following example demonstrates how the <code>xhr</code> property of the <code>ContainerConfig</code> is used to override F2.js.</p>
 <pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">F2</span>.<span class="fu">init</span>({
@@ -933,7 +940,7 @@ <h3>Considerations</h3>
 	<hr>
 
 	<footer>
-		<p class="pull-left"><small><strong>F2&nbsp;&nbsp;|&nbsp;&nbsp;The Open Financial Framework</strong><br><a href="mailto:[email protected]">[email protected]</a><br>Specification 1.2.1, published 8 August 2013</small></p>
+		<p class="pull-left"><small><strong>F2&nbsp;&nbsp;|&nbsp;&nbsp;The Open Financial Framework</strong><br><a href="mailto:[email protected]">[email protected]</a><br>Specification 1.3.0, published 16 September 2013</small></p>
 		<p class="pull-right"><small>F2 is maintained by <a href="http://www.markitondemand.com/">Markit On Demand</a> on <a href="https://github.com/OpenF2/F2">GitHub</a>.<br>Code licensed under the <a href="https://github.com/OpenF2/F2#copyright-and-license">Apache 2.0 License</a>.<br> Documentation licensed under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.</small></p>
 	</footer>
 
@@ -942,7 +949,7 @@ <h3>Considerations</h3>
 <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script>
 <script src="./js/bootstrap.min.2.3.0.js"></script>
 <script src="./js/prettify.js"></script>
-<script src="./js/f2.js?1.2.1"></script>
-<script src="./js/docs.js?1.2.1"></script>
+<script src="./js/f2.js?1.3.0"></script>
+<script src="./js/docs.js?1.3.0"></script>
 </body>
 </html>