Permalink
Browse files

Adding githublink generated via JS to most pages

  • Loading branch information...
1 parent 5d0ff31 commit f310d0952c497f742e948ff41936603c7b775697 @arjunsanyal arjunsanyal committed Sep 12, 2012
Showing with 219 additions and 69 deletions.
  1. +2 −0 _includes/githublink
  2. +6 −1 _site/assets/app.js
  3. +6 −0 _site/assets/themes/twitter-2.0/css/style.css
  4. +4 −0 _site/howto/background_and_helper_apps/index.html
  5. +4 −0 _site/howto/build_a_rest_app/index.html
  6. +4 −0 _site/howto/build_a_smart_app/index.html
  7. +4 −0 _site/howto/build_smart_frame_ui_apps/index.html
  8. +5 −1 _site/howto/deferred/index.html
  9. +4 −0 _site/howto/got_statins/index.html
  10. +5 −0 _site/howto/intro_to_jsonld/index.html
  11. +4 −0 _site/howto/intro_to_rdf/index.html
  12. +4 −2 _site/howto/rx_reminder/index.html
  13. +4 −0 _site/howto/smart_data/index.html
  14. +14 −8 _site/howto/sparql_examples/index.html
  15. +11 −5 _site/index.html
  16. +5 −0 _site/install/linux/index.html
  17. +5 −1 _site/install/os_x/index.html
  18. +4 −0 _site/libraries/container_javascript/index.html
  19. +4 −0 _site/libraries/java/index.html
  20. +10 −6 _site/libraries/python/index.html
  21. +4 −0 _site/reference/app_manifest/index.html
  22. +6 −2 _site/reference/data_model/index.html
  23. +8 −2 _site/reference/filters/index.html
  24. +5 −2 _site/reference/rest_api/index.html
  25. +6 −1 assets/app.js
  26. +6 −0 assets/themes/twitter-2.0/css/style.css
  27. +2 −0 howto/background_and_helper_apps/index.md
  28. +1 −0 howto/build_a_rest_app/index.md
  29. +2 −0 howto/build_a_smart_app/index.md
  30. +2 −0 howto/build_smart_frame_ui_apps/index.md
  31. +2 −0 howto/deferred/index.md
  32. +2 −0 howto/got_statins/index.md
  33. +4 −0 howto/intro_to_jsonld/index.md
  34. +2 −0 howto/intro_to_rdf/index.md
  35. +2 −3 howto/rx_reminder/index.md
  36. +2 −0 howto/smart_data/index.md
  37. +12 −9 howto/sparql_examples/index.md
  38. +9 −5 index.md
  39. +4 −1 install/linux/index.md
  40. +3 −1 install/os_x/index.md
  41. +2 −2 libraries/container_javascript/index.md
  42. +1 −1 libraries/java/index.md
  43. +8 −9 libraries/python/index.md
  44. +2 −1 reference/app_manifest/index.md
  45. +4 −2 reference/data_model/index.md
  46. +6 −2 reference/filters/index.md
  47. +3 −2 reference/rest_api/index.md
View
@@ -0,0 +1,2 @@
+Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
View
@@ -60,4 +60,9 @@ var Toc = {
}
}
-// expand all code blocks: $('pre').css('overflow-x', 'visible') or 'auto'
+// fill in any ghlinks
+var _gh_branch = 'docs_0_5';
+var _gh_base_url = 'https://github.com/chb/smart-docs/edit/' + _gh_branch;
+var _gh_default_filename = 'index.md';
+var _gh_link = _gh_base_url + window.location.pathname + _gh_default_filename;
+$('.githublink').attr('href', _gh_link);
@@ -101,6 +101,12 @@ footer {
padding: 15px;
}
+.simple_small_box {
+ margin: 35px;
+ border: 2px solid #ddd;
+ padding: 10px;
+}
+
.red_box {
margin: 35px;
border: 4px solid red;
@@ -101,6 +101,10 @@
style="width: 100%; display: block; margin: 20px auto;">
</a></p>
+<div class='simple_small_box'>Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
+</div>
+
<p>So far, we have talked about SMART apps that access medical record data on
behalf of an active user of the EMR/PCHR/data-mining platform. What about apps
that autonomously take action when no one is logged in? An app might want to
@@ -96,6 +96,10 @@
<div id="toc"> </div>
+<div class='simple_small_box'>Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
+</div>
+
<p>This document shows you how to build a more advanced SMART App with server-side
logic and REST API Calls.</p>
@@ -96,6 +96,10 @@
<div id="toc"> </div>
+<div class='simple_small_box'>Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
+</div>
+
<p>This document is a complete SMART-App-Building walk-through. You should first
read the <a href="../../">Main Page</a></p>
@@ -103,6 +103,10 @@
style="width: 100%; display: block; margin: 20px auto;">
</a></p>
+<div class='simple_small_box'>Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
+</div>
+
<p>SMART v0.4 allows developers to build a kind of meta-app, or &quot;Frame UI App&quot; that
can lay out multiple traditional UI Apps at the same time. For example, let's
say you'd like to display a medication list app right alongside a medication
@@ -94,7 +94,11 @@
<h1>Using the jQuery Deferred Object with SMART Connect <small></small></h1>
</div>
- <p>When using the SMART Javascript API you frequently want to make multiple
+ <div class='simple_small_box'>Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
+</div>
+
+<p>When using the SMART Javascript API you frequently want to make multiple
requests for data (for instance to get both demographics and labs for a lab
viewer app) and then do something with the result of both calls. In pure
Javascript, the typical pattern is for a deeply nested and serial chain of
@@ -96,6 +96,10 @@
<h2>The &quot;Got Statins?&quot; App: SMART Connect in Action</h2>
+<div class='simple_small_box'>Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
+</div>
+
<p>If you haven't already, you should read <a href="../build_a_smart_app">HOWTO Build a SMART App</a> first.</p>
<p>Here, we build a complete SMART Connect app from pure HTML and Javascript.
@@ -97,9 +97,14 @@
<div id="toc"></div>
<div class='simple_box'>
+ <p>
This is a new API in the SMART v0.5 release. It is stable enough for
use, however it is likely that minor elements of the API may change in
future releases of the SMART API.
+ </p>
+ Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
+
</div>
<p>The SMART JSON-LD API provides an additional interface to the SMART datamodel
@@ -100,6 +100,10 @@
you've never used (or even heard of!) RDF, this document should help you get up
to speed. So let's jump right in!</p>
+<div class='simple_small_box'>Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
+</div>
+
<h2>What is RDF, anyway?</h2>
<p>RDF, the Resource Description Framework, is a web standard &quot;for representing
@@ -94,9 +94,11 @@
<h1>The RxReminder Sample App <small></small></h1>
</div>
- <div id="toc"> </div>
+ <h2>RxReminder: SMART REST in Action</h2>
-<h2>RxReminder: SMART REST in Action</h2>
+<div class='simple_small_box'>Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
+</div>
<p>You should read <a href="../build_a_rest_app">HOWTO Build a SMART App - REST API</a> Calls
first.</p>
@@ -98,6 +98,10 @@
<h1>Best Practices for Consuming SMART RDF Data</h1>
+<div class='simple_small_box'>Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
+</div>
+
<h2>Treat SMART data payloads as RDF</h2>
<p>SMART Containers supply your app with medical record data in the form of an RDF
@@ -98,17 +98,23 @@
<h1>SPARQL by Example</h1>
-<p>This page provides a set of example queries to help you get started interacting
-with SMART patient record data. We'll build out several example SPARQL queries,
-but please feel free to add on new material as you discover useful tidbits!</p>
+<div class='simple_small_box'>Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
+</div>
+
+<p>This page provides a set of example queries to help you get started
+interacting with SMART patient record data. We'll build out several
+example SPARQL queries, but please feel free to add on new material as
+you discover useful tidbits!</p>
<h2>Running Queries: Live In-browser or in Your Own Environment</h2>
-<p>You can use the form below to try out queries right away. Please note that to
-use the live query tool, you'll need to include a <code>FROM &lt;graph&gt;</code> clause in your
-query to supply data. If you're running these queries in your own environment,
-you'll run them in the context of a particular graph (e.g. Patient Smith's
-medication graph), rather than specifying <code>FROM</code> directly in the query.</p>
+<p>You can use the form below to try out queries right away. Please note
+that to use the live query tool, you'll need to include a <code>FROM &lt;graph&gt;</code>
+clause in your query to supply data. If you're running these queries in
+your own environment, you'll run them in the context of a particular
+graph (e.g. Patient Smith's medication graph), rather than specifying
+<code>FROM</code> directly in the query.</p>
<p>Or you could run these examples on your own via:</p>
View
@@ -95,11 +95,17 @@
</div>
<div class='simple_box'>
- This Guide is intended for software developers who want to write SMART apps
- &mdash; and it's a work in progress! If you have any questions, please drop a
- note in our <a
- href="http://groups.google.com/group/smart-app-developers">SMART App
- Developers Group</a>
+ <p>
+ This Guide is intended for software developers who want to write SMART apps
+ &mdash; and it's a work in progress! If you have any questions, please drop a
+ note in our <a
+ href="http://groups.google.com/group/smart-app-developers">SMART App
+ Developers Group</a>.
+ </p>
+
+ Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
+
</div>
<h2>What is SMART?</h2>
@@ -95,10 +95,15 @@
</div>
<div class="simple_box">
+ <p>
The SMART reference EMR documentation is rapidly evolving. If something in
this document looks strange, confusing, or wrong, please ask about it at <a
href='http://groups.google.com/group/smart-app-developers'>the SMART
Developer's Google Group</a>
+ </p>
+ Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
+
</div>
<h1>Repositories</h1>
@@ -94,7 +94,11 @@
<h1>Installing SMART on OS X <small></small></h1>
</div>
- <p>This walks you through installing an <em>insecure SMART testing environment</em> on
+ <div class='simple_small_box'>Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
+</div>
+
+<p>This walks you through installing an <em>insecure SMART testing environment</em> on
Mac OS X. We will be installing everything needed for SMART into the directory
<code>/Library/SMART</code>, all the instructions assume that you are running a Terminal
open from this location. Of course you can use your own location, just remember
@@ -96,6 +96,10 @@
<div id="toc"> </div>
+<div class='simple_small_box'>Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
+</div>
+
<h2>What is smart-api-container.js?</h2>
<p><code>smart-api-container.js</code> enables a SMART container to talk with SMART apps,
@@ -96,6 +96,10 @@
<div id="toc"></div>
+<div class='simple_small_box'>Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
+</div>
+
<p>This document describes the SMART Java Client Library, which you can use from a
Java application to make authenticated REST calls into a SMART container.</p>
@@ -95,13 +95,17 @@
</div>
<div class='simple_box'>
- This document describes the SMART Python Library, which you can use from a
- Python application to make authenticated REST calls into a SMART container.
+ <p>
+ This document describes the SMART Python Library, which you can use from a
+ Python application to make authenticated REST calls into a SMART container.
+ </p>
+ <p>
+ You probably want to read the [SMART REST HOWTO][] to understand when you
+ might want to use this library.
+ </p>
+ Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
- <br />
-
- You probably want to read the [SMART REST HOWTO][] to understand when you
- might want to use this library.
</div>
<div id="toc"> </div>
@@ -96,6 +96,10 @@
<div id="toc"></div>
+<div class='simple_small_box'>Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
+</div>
+
<h1>Introducing SMART Manifests</h1>
<p>Each SMART app should provide a JSON manifest to declare itself to the
@@ -105,9 +105,13 @@
</div>
<div class='simple_box'>
- This is highly preliminary, not a commitment or final version of any
+ <p>This is highly preliminary, not a commitment or final version of any
particular API or data model. This is purely for internal collaboration and
- preview purposes.
+ preview purposes.</p>
+
+ Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
+
</div>
<div id="toc"></div>
@@ -95,8 +95,14 @@
</div>
<div class='simple_box'>
- This is a new API feature in the SMART v0.5 release. It is stable enough for
- use, however it is likely that minor elements of the API may change over time.
+ <p>
+ This is a new API feature in the SMART v0.5 release. It is stable
+enough for use, however it is likely that minor elements of the API may
+change over time.
+ </p>
+ Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
+
</div>
<div id="toc"></div>
@@ -95,9 +95,12 @@
</div>
<div class="simple_box">
- N.B. This is highly preliminary, not a commitment or final version of any
+ <p>N.B. This is highly preliminary, not a commitment or final version of any
particular API or data model. This is purely for internal collaboration and
- preview purposes.
+ preview purposes.</p>
+ Help us improve! You can correct errors or add to this page by clicking
+<a class='githublink' href=''>here</a> to edit this page on Github.
+
</div>
<div id="toc"></div>
View
@@ -60,4 +60,9 @@ var Toc = {
}
}
-// expand all code blocks: $('pre').css('overflow-x', 'visible') or 'auto'
+// fill in any ghlinks
+var _gh_branch = 'docs_0_5';
+var _gh_base_url = 'https://github.com/chb/smart-docs/edit/' + _gh_branch;
+var _gh_default_filename = 'index.md';
+var _gh_link = _gh_base_url + window.location.pathname + _gh_default_filename;
+$('.githublink').attr('href', _gh_link);
@@ -101,6 +101,12 @@ footer {
padding: 15px;
}
+.simple_small_box {
+ margin: 35px;
+ border: 2px solid #ddd;
+ padding: 10px;
+}
+
.red_box {
margin: 35px;
border: 4px solid red;
@@ -12,6 +12,8 @@ includenav: smartnav.markdown
style="width: 100%; display: block; margin: 20px auto;">
</a>
+<div class='simple_small_box'>{% include githublink %}</div>
+
So far, we have talked about SMART apps that access medical record data on
behalf of an active user of the EMR/PCHR/data-mining platform. What about apps
that autonomously take action when no one is logged in? An app might want to
@@ -8,6 +8,7 @@ includenav: smartnav.markdown
<div id="toc"> </div>
+<div class='simple_small_box'>{% include githublink %}</div>
This document shows you how to build a more advanced SMART App with server-side
logic and REST API Calls.
@@ -9,6 +9,8 @@ includenav: smartnav.markdown
<div id="toc"> </div>
+<div class='simple_small_box'>{% include githublink %}</div>
+
This document is a complete SMART-App-Building walk-through. You should first
read the [Main Page](../../)
@@ -15,6 +15,8 @@ includenav: smartnav.markdown
style="width: 100%; display: block; margin: 20px auto;">
</a>
+<div class='simple_small_box'>{% include githublink %}</div>
+
SMART v0.4 allows developers to build a kind of meta-app, or "Frame UI App" that
can lay out multiple traditional UI Apps at the same time. For example, let's
say you'd like to display a medication list app right alongside a medication
Oops, something went wrong.

0 comments on commit f310d09

Please sign in to comment.