Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 192 lines (189 sloc) 8.655 kB
ec383f1 @wycats Initial commit
wycats authored
1 title: SproutCore Guides
4aa5ed3 @indirect throw in the guides icon and style the feature text
indirect authored
2 description: These guides are designed to help you write and perfect your code.
ec383f1 @wycats Initial commit
wycats authored
3
df1441c @indirect Style credits content, change missing photo picture
indirect authored
4 team_name: The People That Make It Happen
ec383f1 @wycats Initial commit
wycats authored
5 authors:
6 Documentation Team:
539a97c @wagenet Added Fixtures Guide
wagenet authored
7 - name: Peter Wagenet
8 nick: pwagenet
6dce937 @indirect Sort the credits images
indirect authored
9 image: credits/pwagenet.jpg
d53f441 @geojeff Changed contributor descriptions to be single full names, because man…
geojeff authored
10 description: Peter Wagenet
1a5feb3 @publickeating Added myself and sorted alphabetically by first nom
publickeating authored
11 - name: Yehuda Katz
12 nick: wycats
48881ef @wifelette Updates to Guides Credits and header
wifelette authored
13 image: credits/ykatz.jpg
d53f441 @geojeff Changed contributor descriptions to be single full names, because man…
geojeff authored
14 description: Yehuda Katz
5cbf1fe First pass at the user install guide.
Shawn Morel authored
15 Contributors:
1a5feb3 @publickeating Added myself and sorted alphabetically by first nom
publickeating authored
16 - name: Mike Ball
17 nick: onkis
48881ef @wifelette Updates to Guides Credits and header
wifelette authored
18 image: credits/mball.png
d53f441 @geojeff Changed contributor descriptions to be single full names, because man…
geojeff authored
19 description: Mike Ball
1a5feb3 @publickeating Added myself and sorted alphabetically by first nom
publickeating authored
20 - name: Peter Bergstrom
21 nick: pbergstrom
48881ef @wifelette Updates to Guides Credits and header
wifelette authored
22 image: credits/pbergstrom.jpg
d53f441 @geojeff Changed contributor descriptions to be single full names, because man…
geojeff authored
23 description: Peter Bergstrom
6dce937 @indirect Sort the credits images
indirect authored
24 - name: Kyle Carriedo
25 nick: kcarriedo
d53f441 @geojeff Changed contributor descriptions to be single full names, because man…
geojeff authored
26 description: Kyle Carriedo
1a5feb3 @publickeating Added myself and sorted alphabetically by first nom
publickeating authored
27 - name: Tom Dale
28 nick: tomdale
48881ef @wifelette Updates to Guides Credits and header
wifelette authored
29 image: credits/tdale.jpg
d53f441 @geojeff Changed contributor descriptions to be single full names, because man…
geojeff authored
30 description: Tom Dale
6dce937 @indirect Sort the credits images
indirect authored
31 - name: Geoffrey Donaldson
32 nick: geoffreyd
48881ef @wifelette Updates to Guides Credits and header
wifelette authored
33 image: credits/gdonaldson.jpg
d53f441 @geojeff Changed contributor descriptions to be single full names, because man…
geojeff authored
34 description: Geoffrey Donaldson
6dce937 @indirect Sort the credits images
indirect authored
35 - name: Chad Eubanks
36 nick: ceubanks
d53f441 @geojeff Changed contributor descriptions to be single full names, because man…
geojeff authored
37 description: Chad Eubanks
1a5feb3 @publickeating Added myself and sorted alphabetically by first nom
publickeating authored
38 - name: Topher Fangio
39 nick: topherfangio
48881ef @wifelette Updates to Guides Credits and header
wifelette authored
40 image: credits/tfangio.jpg
d53f441 @geojeff Changed contributor descriptions to be single full names, because man…
geojeff authored
41 description: Topher Fangio
6dce937 @indirect Sort the credits images
indirect authored
42 - name: Jason Gignac
43 nick: jgignac
d53f441 @geojeff Changed contributor descriptions to be single full names, because man…
geojeff authored
44 description: Jason Gignac
1a5feb3 @publickeating Added myself and sorted alphabetically by first nom
publickeating authored
45 - name: Vibul Imtarnasan
46 nick: veebs
48881ef @wifelette Updates to Guides Credits and header
wifelette authored
47 image: credits/vimtarnasan.jpg
d53f441 @geojeff Changed contributor descriptions to be single full names, because man…
geojeff authored
48 description: Vibul Imtarnasan
6dce937 @indirect Sort the credits images
indirect authored
49 - name: Alex Iskander
50 nick: ialexi
d53f441 @geojeff Changed contributor descriptions to be single full names, because man…
geojeff authored
51 description: Alex Iskander
6dce937 @indirect Sort the credits images
indirect authored
52 - name: Tyler Keating
53 nick: publickeating
48881ef @wifelette Updates to Guides Credits and header
wifelette authored
54 image: credits/tkeating.jpg
d53f441 @geojeff Changed contributor descriptions to be single full names, because man…
geojeff authored
55 description: Tyler Keating
6dce937 @indirect Sort the credits images
indirect authored
56 - name: Florian Kugler
57 nick: fkugler
48881ef @wifelette Updates to Guides Credits and header
wifelette authored
58 image: credits/fkugler.jpg
d53f441 @geojeff Changed contributor descriptions to be single full names, because man…
geojeff authored
59 description: Florian Kugler
6dce937 @indirect Sort the credits images
indirect authored
60 - name: Shawn Morel
61 nick: shawnmorel
d53f441 @geojeff Changed contributor descriptions to be single full names, because man…
geojeff authored
62 description: Shawn Morel
6dce937 @indirect Sort the credits images
indirect authored
63 - name: Erich Ocean
64 nick: erichocean
48881ef @wifelette Updates to Guides Credits and header
wifelette authored
65 image: credits/eocean.jpg
d53f441 @geojeff Changed contributor descriptions to be single full names, because man…
geojeff authored
66 description: Erich Ocean
6dce937 @indirect Sort the credits images
indirect authored
67 - name: Piotr Sarnacki
68 nick: drogus
48881ef @wifelette Updates to Guides Credits and header
wifelette authored
69 image: credits/psarnacki.jpg
d53f441 @geojeff Changed contributor descriptions to be single full names, because man…
geojeff authored
70 description: Piotr Sarnacki
71 - name: Scott Smith
6dce937 @indirect Sort the credits images
indirect authored
72 nick: oldfartdeveloper
48881ef @wifelette Updates to Guides Credits and header
wifelette authored
73 image: credits/ssmith.jpg
d53f441 @geojeff Changed contributor descriptions to be single full names, because man…
geojeff authored
74 description: Scott Smith
6dce937 @indirect Sort the credits images
indirect authored
75 - name: Majd Taby
76 nick: mtaby
d53f441 @geojeff Changed contributor descriptions to be single full names, because man…
geojeff authored
77 description: Majd Taby
6dce937 @indirect Sort the credits images
indirect authored
78 - name: Devin Torres
79 nick: dtorres
48881ef @wifelette Updates to Guides Credits and header
wifelette authored
80 image: credits/dtorres.jpg
d53f441 @geojeff Changed contributor descriptions to be single full names, because man…
geojeff authored
81 description: Devin Torres
3a81d4f @topherfangio Closes #108 - TDD Guide doesn't properly attribute Greg Moeck.
topherfangio authored
82 - name: Greg Moeck
83 nick: gmoeck
84 description: Greg Moeck
ec383f1 @wycats Initial commit
wycats authored
85
86 index:
87 Start Here:
20e49d0 Import drogus' part 2 guide, improve some stylistic aspects
tomhuda authored
88 - title: "Getting Started: Part 1"
ec383f1 @wycats Initial commit
wycats authored
89 url: getting_started
c8f4d92 @topherfangio Finished Getting Started: Part 2, fixed some styles, added links in t…
topherfangio authored
90 text: "Learn how to get your first SproutCore app up-and-running."
20e49d0 Import drogus' part 2 guide, improve some stylistic aspects
tomhuda authored
91 - title: "Getting Started: Part 2"
92 url: getting_started_2
c8f4d92 @topherfangio Finished Getting Started: Part 2, fixed some styles, added links in t…
topherfangio authored
93 text: "Spring forward with the information you learned in Part 1 and learn about statecharts and views."
94 - title: "Getting Started: Part 3"
95 url: getting_started_3
96 text: "Expand upon your knowledge from the first two guides, and build a full-scale Todos application."
5d72e4f @publickeating Edits the Core Concept guide for clarity and ease-of-reading and spli…
publickeating authored
97 - title: "Classes and SC.Object"
98 url: core_concepts_sc_object
99 text: "In this guide, we will touch on SC.Object, the basis for SproutCore's class-like object-oriented programming structure."
100 - title: "Computed Properties, Observers and Bindings"
101 url: core_concepts_kvo
102 text: "In this guide, we will touch on KVO in SproutCore."
d994103 Make HTML-based tutorial the first tutorial. Re-organize order of tut…
tomhuda authored
103 Views:
104 - title: Core View Concepts
105 url: views
106 text: "In this guide, we will cover the basics of SproutCore views, and show you how to customize the built-in SproutCore views for your own use."
107 - title: Building Your Own Views
108 url: custom_views
109 text: "Most applications will quickly go beyond the built-in SproutCore views. In this guide, we will cover how to build and style your own views."
110 construction: true
111 - title: Animations
112 url: animate
113 text: "In this guide, we will cover the basics of using animations in SproutCore, and show you how to add SC.View#animate in your code."
114 construction: true
ec383f1 @wycats Initial commit
wycats authored
115 Models:
116 - title: SproutCore Records
117 url: records
969bcf4 First partial draft of records guide
Florian authored
118 text: "The SproutCore data framework is a full-featured ORM-like framework for working with data in SproutCore. Learn about the SproutCore data framework and how you can use it to interact with your data sources."
eae871b @publickeating Reordered the guides index a big (not actually live so it doesn't mat…
publickeating authored
119 - title: Understanding the Record Lifecycle
120 url: record_lifecycle
121 text: "Records in SproutCore travel through a series of simple statuses. Understanding these statuses can help you to build better, less buggy SproutCore apps. This guide walks you through a description of the details of the lifecycle of a record."
122 construction: true
ec383f1 @wycats Initial commit
wycats authored
123 - title: Hooking Up to a Backend
6190525 @geoffreyd Fix the link to the dataSource guide in the index
geoffreyd authored
124 url: connect_server
c340976 @publickeating SprutCore ftw!
publickeating authored
125 text: "Learn how to connect your SproutCore app to your backend server."
ec383f1 @wycats Initial commit
wycats authored
126 construction: true
eae871b @publickeating Reordered the guides index a big (not actually live so it doesn't mat…
publickeating authored
127 - title: Creating a DataSource
128 url: data_source
129 text: "This guide covers how to create a SproutCore data source, which will retrieve data from your servers and make them available to the SproutCore Records you designed in the previous guide."
130 construction: true
5bd0d83 @wycats Edit the app theming guide
wycats authored
131 - title: Transactions Using Nested Stores
4d9f44b @wycats Adding nested stores
wycats authored
132 url: nested_stores
133 text: "SproutCore provides a powerful facility for allowing your app's users to make changes to local data, then commit or rollback the changes as needed. Learn how to use 'nested stores' to manage the state of your data as it moves through your user's edits."
134 construction: true
ec383f1 @wycats Initial commit
wycats authored
135 - title: Using Fixtures
136 url: fixtures
e669348 @wycats Updated the guides with a new themes section
wycats authored
137 text: "In order to facilitate rapid development, SproutCore provides a facility for using pre-set fixture data as your data source. This guide covers how to set up your fixtures, and how to replace them with your real server once you're ready to get going."
138 Theming:
d994103 Make HTML-based tutorial the first tutorial. Re-organize order of tut…
tomhuda authored
139 - title: "Using Chance, SproutCore's CSS Framework"
140 url: chance
141 text: "Chance is SproutCore's CSS preprocessor. In this guide, you will learn how to use the CSS extensions that come with Chance to streamline your styling workflow."
f111664 @wycats Typo
wycats authored
142 - title: Theming Your App
e669348 @wycats Updated the guides with a new themes section
wycats authored
143 url: theming_app
144 text: "In this guide, we'll cover how to change the style of SproutCore controls in your app. As an example, we'll re-theme an SC.ButtonView."
2e84978 @wycats Add two new theming guides
wycats authored
145 - title: Writing Themeable Controls
146 url: themeable_controls
147 text: "In this guide, we'll go over to how to develop a control that can be themed. This can be useful if you want to have different visual displays in your application (like a regular and overlay theme) or when distributing a theme for wider use."
4d9f44b @wycats Adding nested stores
wycats authored
148 construction: true
7926b4d @oldfartdeveloper Adding the testing guides
oldfartdeveloper authored
149 Testing:
150 - title: "Unit Testing"
151 url: unit_test_framework
152 text: "SproutCore has an easy-to-learn unit test facility that can be used to drive SproutCore test-driven development. This guide describes the basic SproutCore test commands."
153 - title: "Adding a Unit Test"
154 url: adding_unit_test
155 text: "Adding a unit test automatically or manually."
156 - title: "Writing Unit Tests"
157 url: writing_unit_tests
c7cf8a9 @wagenet Can't use formatting in guide descriptions
wagenet authored
158 text: "Describes how to write unit tests using module and test functions"
7926b4d @oldfartdeveloper Adding the testing guides
oldfartdeveloper authored
159 - title: "Running Unit Tests"
160 url: running_unit_tests
161 text: "How tests are loaded and executed by the test runner."
162 - title: "Testing Guidelines in SproutCore"
163 url: testing_guidelines
164 text: "Developing a SproutCore application using test-driven development (TDD)."
165 construction: true
166 - title: "SproutCore Development Using TDD"
167 url: todos_tdd
168 text: "Show implementing the TODOs project using TDD."
9301d4b @publickeating Moved Enumerables into an "Extras" section and added "Build Tools" gu…
publickeating authored
169 Extras:
12113e7 @publickeating Put Build Tools reference back in.
publickeating authored
170 - title: Build Tools
171 url: build_tools
172 text: "Discover the many performance advantages and development benefits of SproutCore's build tools."
cd4cf86 @publickeating Adds new guide on the Run Loop.
publickeating authored
173 - title: "The Run Loop"
174 url: run_loop
175 text: "An indepth look at SproutCore's Run Loop for an advanced understanding of the framework."
9301d4b @publickeating Moved Enumerables into an "Extras" section and added "Build Tools" gu…
publickeating authored
176 - title: Enumerables
177 url: enumerables
178 text: "To simplify working with various kinds of lists, SproutCore provides a unified Enumerable interface. This guide explores which SproutCore objects are Enumerable, and how to use the Enumerable API."
2338759 @publickeating Moves the Handlebars guide out from its prominent position.
publickeating authored
179 - title: Using Handlebars Templates
180 url: using_handlebars
181 text: "Learn how to make your application come to life by leveraging the tight integration between SproutCore and Handlebars, a semantic templating language."
bde47bf @wagenet Cleanup to Framework Contributor guides
wagenet authored
182 Contributing to SproutCore:
4ec6fb3 @onkis added urls to guides
onkis authored
183 - title: "Javascript Style Guide"
184 url: "style_guide"
60994d5 Fixed links in Author credits page.
tomhuda authored
185 text: "This guide covers the style of SproutCore framework code."
186 - title: "Committer Guidelines"
4ec6fb3 @onkis added urls to guides
onkis authored
187 url: "commit_code"
60994d5 Fixed links in Author credits page.
tomhuda authored
188 text: "A detailed checklist of the do's and don'ts of SC framework code."
98fbce0 @wagenet Minor fixes and addition of credits to Documentation Guide
wagenet authored
189 - title: "Documentation Guidelines"
190 url: "documentation_guidelines"
60994d5 Fixed links in Author credits page.
tomhuda authored
191 text: "Writing and generating jsdoc documentation."
Something went wrong with that request. Please try again.