Skip to content

Commit

Permalink
Merge pull request #65 from OpenF2/1.1.2-wip
Browse files Browse the repository at this point in the history
Release 1.1.2
  • Loading branch information
brianbaker committed Apr 8, 2013
2 parents 4b380ab + 3a927fb commit ee6fcc4
Show file tree
Hide file tree
Showing 158 changed files with 12,486 additions and 324 deletions.
12 changes: 12 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
language: ruby
rvm:
- 1.9.3
notifications:
email: false
before_script:
- "export DISPLAY=:99.0"
- "sh -e /etc/init.d/xvfb start"
script:
- "wget https://raw.github.com/mark-rushakoff/OpenPhantomScripts/master/phantom-jasmine.js"
- "phantomjs phantom-jasmine.js tests/index.html"
- "phantomjs phantom-jasmine.js tests/index-amd.html"
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ To track bugs and issues, we are using [Issues on GitHub](https://github.com/Ope

If you just want to build F2 [containers](http://docs.openf2.org/container-development.html) and/or [apps](http://docs.openf2.org/app-development.html), you can **skip the [Build F2](#build-f2)** section below. You do not need the command line to work with F2.

### Build F2
### Build F2 [![Build Status](https://travis-ci.org/OpenF2/F2.png)](https://travis-ci.org/OpenF2/F2)

For those wishing to contribute back to F2, we've included a `build` file in the project which contains the logic for compiling F2.js and the specification docs. The build script runs on [Node.js](http://nodejs.org/) and has a few dependencies. To install, `cd` to your `F2/build` folder, and run the following commands in npm:

Expand All @@ -58,6 +58,12 @@ For help, run:

We are using [markitdown](https://github.com/markitondemand/markitdown), a lightweight pandoc wrapper, for converting markdown files to HTML for the [docs](http://docs.openf2.org).

#### NuGet Package

Good news if you're using C#! We have an [F2 NuGet package available](https://nuget.org/packages/F2/). In the Package Manager Console run:

`PM> Install-Package F2`

### 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).
Expand Down
16 changes: 8 additions & 8 deletions build/F2.json
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
{
"docs": {
"version": "1.1.0",
"shortVersion": "1.1",
"releaseDate": "2013-03-18T14:42:52.515Z",
"lastUpdateDate": "2013-03-18T14:42:54.875Z",
"lastUpdateDateFormatted": "18 March 2013"
"version": "1.1.2",
"shortVersion": "1.1.2",
"releaseDate": "2013-04-08T14:34:33.095Z",
"lastUpdateDate": "2013-04-08T14:34:35.678Z",
"lastUpdateDateFormatted": "8 April 2013"
},
"sdk": {
"version": "1.1.1",
"version": "1.1.2",
"shortVersion": "1.1",
"releaseDate": "2013-03-18T14:42:52.515Z",
"lastUpdateDate": "2013-03-18T14:42:53.243Z"
"releaseDate": "2013-04-08T14:34:33.095Z",
"lastUpdateDate": "2013-04-08T14:34:33.926Z"
},
"branch": "master"
}
8 changes: 7 additions & 1 deletion build/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Build F2
# Build F2 [![Build Status](https://travis-ci.org/OpenF2/F2.png)](https://travis-ci.org/OpenF2/F2)

For those wishing to contribute back to F2, we've included a `build` file in the project which contains the logic for compiling F2.js and the specification docs. The build script runs on [Node.js](http://nodejs.org/) and has a few dependencies. To install, `cd` to your `F2/build` folder, and run the following commands in npm:

Expand All @@ -18,6 +18,12 @@ For help, run:

Before you begin coding, familiarize yourself with 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).

## NuGet Package

Good news if you're using C#! We have an [F2 NuGet package available](https://nuget.org/packages/F2/). In the Package Manager Console run:

`PM> Install-Package F2`

## Versioning

To adhere to industry standards, F2 will be maintained under the Semantic Versioning guidelines as much as possible.
Expand Down
5 changes: 3 additions & 2 deletions build/build.js
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,8 @@ function docs() {
'./docs/src/index.md',
'./docs/src/app-development.md',
'./docs/src/container-development.md',
'./docs/src/f2js-sdk.md'
'./docs/src/f2js-sdk.md',
'./docs/src/extending-f2.md'
],
dat = new Date();

Expand Down Expand Up @@ -703,4 +704,4 @@ function prepBranch(){
//run all build steps
//start queue
nextStep();
}
}
23 changes: 14 additions & 9 deletions docs/app-development.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<title>F2 - App Development</title>
<meta charset="utf-8">
<meta name="dcterms.date" content="18 March 2013">
<meta name="dcterms.date" content="8 April 2013">
<meta name="gitbranch" content="master">
<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, Open Financial Framework, Markit, Markit On Demand, MOD, web, web framework, apps, context, container, Hub">
Expand All @@ -17,7 +17,7 @@
<script src="./js/respond.min.js"></script>

<link href="./css/prettify.css" rel="stylesheet">
<link href="./css/F2.Docs.css?1.1.0" rel="stylesheet">
<link href="./css/F2.Docs.css?1.1.2" 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" />
Expand Down Expand Up @@ -73,8 +73,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.1.1</span></a></li>
<li class="ghWrapResp"><a href="https://github.com/OpenF2/F2/">View on GitHub (v 1.1.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.1.2</span></a></li>
<li class="ghWrapResp"><a href="https://github.com/OpenF2/F2/">View on GitHub (v 1.1.2)</a></li>
</ul>
</div>
</div>
Expand Down Expand Up @@ -125,7 +125,7 @@
<h1 class="title">App Development</h1>
</header>
<p class="lead">
You've come to the right place if you want to start building F2 apps. Before continuing, make sure you've <a href="https://github.com/OpenF2/F2#quick-start">cloned the F2 repository on GitHub</a> or <a href="index.html#get-started">downloaded the latest framework build</a> (v1.1.1). Secondly, <a href="index.html#framework">read about the F2 Framework</a>. There are a few important concepts to help you better understand apps, containers and context.
You've come to the right place if you want to start building F2 apps. Before continuing, make sure you've <a href="https://github.com/OpenF2/F2#quick-start">cloned the F2 repository on GitHub</a> or <a href="index.html#get-started">downloaded the latest framework build</a> (v1.1.2). Secondly, <a href="index.html#framework">read about the F2 Framework</a>. There are a few important concepts to help you better understand apps, containers and context.
</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>
Expand Down Expand Up @@ -573,10 +573,15 @@ <h3>Namespacing CSS</h3>
<span class="kw">color:</span><span class="dt">red</span><span class="kw">;</span>
<span class="kw">}</span></code></pre>
<p>Note <code>.com_companyName_appName</code> is prefixed on both <code>p</code> and <code>.alert</code> selectors.</p>
<p>While the <a href="http://www.webdesignfromscratch.com/html-css/css-inheritance-cascade/">CSS cascade</a> will assign more points to IDs and prefixing F2 AppIDs on CSS selectors isn't required, it is recommended.</p>
<p>While the <a href="http://www.webdesignfromscratch.com/html-css/css-inheritance-cascade/">CSS cascade</a> will assign more points to IDs and while prefixing F2 AppIDs on CSS selectors isn't required, it is recommended.</p>
<pre class="sourceCode css"><code class="sourceCode css"><span class="fl">.com_companyName_appName</span> <span class="fl">#notice</span> <span class="kw">{</span>
<span class="kw">background-color:</span><span class="dt">yellow</span><span class="kw">;</span>
<span class="kw">}</span></code></pre>
<p><span class="label">Note</span> App Developers should familiarize themselves with <a href="container-development.html#namespacing">CSS namespacing rules for Container Developers</a>. They are largely the same with a couple notable additions.</p>
<section class="level4" id="about-css-resets">
<h4>About CSS Resets</h4>
<p>It is a common web development practice to use <a href="http://meyerweb.com/eric/tools/css/reset/">CSS resets</a>, and it is likely both Container and App Developers will use them. Since there are many ways to normalize built-in browser stylesheets, including <a href="http://necolas.github.com/normalize.css/">Normalize.css</a> which is used by Bootstrap, Container and App Developers must namespace their CSS reset selectors.</p>
</section>
</section>
<section class="level3" id="keeping-javascript-clean">
<h3>Keeping JavaScript Clean</h3>
Expand Down Expand Up @@ -970,7 +975,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.1.0, published 18 March 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.1.2, published 8 April 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">MIT License</a>.<br> Documentation licensed under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.</small></p>
</footer>

Expand All @@ -979,8 +984,8 @@ <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.1.1"></script>
<script src="./js/docs.js?1.1.0"></script>
<script src="./js/f2.js?1.1.2"></script>
<script src="./js/docs.js?1.1.2"></script>
<script>F2.extend('gitbranch', (function(){ return 'master'; }));</script>
</body>
</html>
Loading

0 comments on commit ee6fcc4

Please sign in to comment.