Skip to content

Commit 91799ed

Browse files
aboughtabought
committed
Merge remote-tracking branch 'upstream/develop'
Update documentation to reflect the 0.2.0 release
2 parents 7077299 + 5d45c85 commit 91799ed

File tree

169 files changed

+6137
-746
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

169 files changed

+6137
-746
lines changed

‎docs/api.js‎

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ YUI.add("yuidoc-meta", function(Y) {
22
Y.YUIDoc = { meta: {
33
"classes": [
44
"CasAuthenticatedRouteMixin",
5+
"Citation",
56
"Collection",
67
"Comment",
78
"CommentReport",
@@ -45,6 +46,7 @@ YUI.add("yuidoc-meta", function(Y) {
4546
"User",
4647
"ajax-helpers",
4748
"auth",
49+
"citation-widget",
4850
"comment-detail",
4951
"comment-form",
5052
"comment-pane",
@@ -59,13 +61,18 @@ YUI.add("yuidoc-meta", function(Y) {
5961
"file-renderer",
6062
"file-version",
6163
"file-widget",
64+
"fix-special-char",
65+
"fix-special-char-helper",
66+
"fixstring",
67+
"navbar-auth-dropdown",
6268
"oauth-popup",
6369
"osf-copyright",
6470
"osf-footer",
6571
"osf-mode-footer",
6672
"osf-navbar",
6773
"osf-paginator",
6874
"pagination-control",
75+
"permissions",
6976
"search-dropdown",
7077
"sign-up",
7178
"tags-widget"
@@ -75,6 +82,7 @@ YUI.add("yuidoc-meta", function(Y) {
7582
"authenticators",
7683
"authorizers",
7784
"components",
85+
"const",
7886
"ember",
7987
"ember-osf",
8088
"ember-preprints",
@@ -83,6 +91,7 @@ YUI.add("yuidoc-meta", function(Y) {
8391
"models",
8492
"serializers",
8593
"services",
94+
"transforms",
8695
"utils"
8796
],
8897
"allModules": [
@@ -104,7 +113,11 @@ YUI.add("yuidoc-meta", function(Y) {
104113
{
105114
"displayName": "components",
106115
"name": "components",
107-
"description": "Display information about an individual comment, including controls to edit, delete, and report.\nThis component is typically used as part of the `comment-pane` component; see that component for further information.\n\nSample usage:\n```handlebars\n{{comment-detail\n comment=comment\n editComment=attrs.editComment\n deleteComment=attrs.deleteComment\n restoreComment=attrs.restoreComment\n reportComment=attrs.reportComment}}\n```"
116+
"description": "Lists citations for node in APA, MLA, and Chicago formats"
117+
},
118+
{
119+
"displayName": "const",
120+
"name": "const"
108121
},
109122
{
110123
"displayName": "ember",
@@ -132,7 +145,7 @@ YUI.add("yuidoc-meta", function(Y) {
132145
{
133146
"displayName": "models",
134147
"name": "models",
135-
"description": "Model for OSF APIv2 collections\nFor field and usage information, see:\n* https://api.osf.io/v2/docs/#!/v2/Collection_List_GET"
148+
"description": "Model for OSF APIv2 citation styles"
136149
},
137150
{
138151
"displayName": "serializers",
@@ -144,6 +157,11 @@ YUI.add("yuidoc-meta", function(Y) {
144157
"name": "services",
145158
"description": "Access information about the currently logged in user"
146159
},
160+
{
161+
"displayName": "transforms",
162+
"name": "transforms",
163+
"description": "Custom string field transform that uses the `fix-special-char` utility function to clean up malformed text sent\nfrom the server. This allows string fields to be correctly and transparently used in templates without manually fixing\nthese characters for display on each use.\n\n This transform is used when `fixstring` is passed as the type parameter to the DS.attr function.\n ```app/models/score.js\n import DS from 'ember-data';\n export default DS.Model.extend({\n astring: DS.attr('fixstring'),\n });\n ```"
164+
},
147165
{
148166
"displayName": "utils",
149167
"name": "utils",

‎docs/classes/CasAuthenticatedRouteMixin.html‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<meta charset="utf-8">
5-
<title>CasAuthenticatedRouteMixin - Ember OSF</title>
5+
<title>CasAuthenticatedRouteMixin - Ember OSF Addon</title>
66
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
77
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
88
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
@@ -14,10 +14,10 @@
1414
<div id="doc">
1515
<div id="hd" class="yui3-g header">
1616
<div class="yui3-u-3-4">
17-
<h1><img src="https://cos.io/static/img/icons/cos_wide.png" title="Ember OSF"></h1>
17+
<h1><img src="https://cos.io/static/img/icons/cos_wide.png" title="Ember OSF Addon"></h1>
1818
</div>
1919
<div class="yui3-u-1-4 version">
20-
<em>API Docs for: 0.0.1</em>
20+
<em>API Docs for: 0.2.0</em>
2121
</div>
2222
</div>
2323
<div id="bd" class="yui3-g">
@@ -41,6 +41,8 @@ <h2 class="off-left">APIs</h2>
4141
<li><a href="../classes/ajax-helpers.html">ajax-helpers</a></li>
4242
<li><a href="../classes/auth.html">auth</a></li>
4343
<li><a href="../classes/CasAuthenticatedRouteMixin.html">CasAuthenticatedRouteMixin</a></li>
44+
<li><a href="../classes/Citation.html">Citation</a></li>
45+
<li><a href="../classes/citation-widget.html">citation-widget</a></li>
4446
<li><a href="../classes/Collection.html">Collection</a></li>
4547
<li><a href="../classes/Comment.html">Comment</a></li>
4648
<li><a href="../classes/comment-detail.html">comment-detail</a></li>
@@ -67,11 +69,15 @@ <h2 class="off-left">APIs</h2>
6769
<li><a href="../classes/FileItemMixin.html">FileItemMixin</a></li>
6870
<li><a href="../classes/FileProvider.html">FileProvider</a></li>
6971
<li><a href="../classes/FileVersion.html">FileVersion</a></li>
72+
<li><a href="../classes/fix-special-char.html">fix-special-char</a></li>
73+
<li><a href="../classes/fix-special-char-helper.html">fix-special-char-helper</a></li>
74+
<li><a href="../classes/fixstring.html">fixstring</a></li>
7075
<li><a href="../classes/GenericDataADapter.html">GenericDataADapter</a></li>
7176
<li><a href="../classes/InfinityCustomMixin.html">InfinityCustomMixin</a></li>
7277
<li><a href="../classes/Institution.html">Institution</a></li>
7378
<li><a href="../classes/Log.html">Log</a></li>
7479
<li><a href="../classes/Metaschema.html">Metaschema</a></li>
80+
<li><a href="../classes/navbar-auth-dropdown.html">navbar-auth-dropdown</a></li>
7581
<li><a href="../classes/Node.html">Node</a></li>
7682
<li><a href="../classes/NodeActionsMixin.html">NodeActionsMixin</a></li>
7783
<li><a href="../classes/NodeLink.html">NodeLink</a></li>
@@ -97,6 +103,7 @@ <h2 class="off-left">APIs</h2>
97103
<li><a href="../classes/PaginatedControllerMixin.html">PaginatedControllerMixin</a></li>
98104
<li><a href="../classes/PaginatedRouteMixin.html">PaginatedRouteMixin</a></li>
99105
<li><a href="../classes/pagination-control.html">pagination-control</a></li>
106+
<li><a href="../classes/permissions.html">permissions</a></li>
100107
<li><a href="../classes/Preprint.html">Preprint</a></li>
101108
<li><a href="../classes/Registration.html">Registration</a></li>
102109
<li><a href="../classes/RegistrationActionsMixin.html">RegistrationActionsMixin</a></li>
@@ -114,6 +121,7 @@ <h2 class="off-left">APIs</h2>
114121
<li><a href="../modules/authenticators.html">authenticators</a></li>
115122
<li><a href="../modules/authorizers.html">authorizers</a></li>
116123
<li><a href="../modules/components.html">components</a></li>
124+
<li><a href="../modules/const.html">const</a></li>
117125
<li><a href="../modules/ember.html">ember</a></li>
118126
<li><a href="../modules/ember-osf.html">ember-osf</a></li>
119127
<li><a href="../modules/ember-preprints.html">ember-preprints</a></li>
@@ -122,6 +130,7 @@ <h2 class="off-left">APIs</h2>
122130
<li><a href="../modules/models.html">models</a></li>
123131
<li><a href="../modules/serializers.html">serializers</a></li>
124132
<li><a href="../modules/services.html">services</a></li>
133+
<li><a href="../modules/transforms.html">transforms</a></li>
125134
<li><a href="../modules/utils.html">utils</a></li>
126135
</ul>
127136
</div>

0 commit comments

Comments
 (0)