1
- include ../_util-fns
1
+ block includes
2
+ include ../_util-fns
2
3
3
4
// #docregion intro
4
5
- var langName = current .path [1 ] == ' ts' ? ' TypeScript' : ' JavaScript'
17
18
<a id =" learning-path" ></a >
18
19
:marked
19
20
# Organization
20
-
21
+
21
22
The documentation is divided into major thematic sections, each
22
23
a collection of chapters devoted to that theme.
23
24
// #enddocregion how-to-read-1
@@ -26,14 +27,16 @@ figure
26
27
table( width ="100%" )
27
28
col( width ="15%" )
28
29
col
30
+ tr( style =top)
31
+ td <b >QuickStart</b >
32
+ td
33
+ :marked
34
+ The foundation for every chapter and sample in this documentation.
29
35
tr( style =top)
30
36
td <b >Tutorial</b >
31
37
td
32
38
:marked
33
- A step-by-step, immersive approach to learning Angular.
34
- It begins with the [QuickStart](../quickstart.html),
35
- the foundation for every chapter and sample in this documentation,
36
- followed by the [*Tour of Heroes* tutorial](../tutorial) that
39
+ A step-by-step, immersive approach to learning Angular that
37
40
introduces the major features of Angular in an application context.
38
41
tr( style =top)
39
42
td <b >Basics</b >
@@ -44,86 +47,83 @@ table(width="100%")
44
47
td <b >Developer Guide</b >
45
48
td
46
49
:marked
47
- In depth analysis of Angular features and development practices.
50
+ In- depth analysis of Angular features and development practices.
48
51
tr( style =top)
49
52
td <b >Cookbook</b >
50
53
td
51
54
:marked
52
55
Recipes for specific application challenges, mostly code snippets with a minimum of exposition.
53
56
tr( style =top)
54
- td <b >Reference</b >
57
+ td <b >API Reference</b >
55
58
td
56
59
:marked
57
- Angular-specific reference material, most notably the [API Guide](../api)
58
- with its authoritative details about each member in the Angular libraries.
59
- tr( style =top)
60
- td <b >Resources</b >
61
- td
62
- :marked
63
- Other places to go for help and information.
60
+ Authoritative details about each member of the Angular libraries.
64
61
:marked
65
- # Learning Path
66
- We don't have to read the guide straight through. Most chapters stand on their own.
67
-
68
- We recommend a learning path for those new to Angular.
62
+ # Learning path
63
+ We don't have to read the guide straight through. Most chapters stand on their own.
64
+
65
+ We recommend a learning path for those new to Angular.
69
66
Most of that path runs through the *Basics* section:
70
67
71
- 1. Read the [Architecture Overview ](architecture.html) to get the big picture.
72
-
73
- 1. Try the [QuickStart](../quickstart.html). The QuickStart is the "Hello, World" of Angular 2.
74
- It shows us how to setup the libraries and tools we'll need to write *any* Angular app.
75
-
76
- 1. Take the *Tour of Heroes* [Tutorial](../tutorial) which picks up from where the QuickStart leaves off
77
- and builds a simple data-driven app.
68
+ 1. Read the [Architecture](architecture.html) overview to get the big picture.
69
+
70
+ 1. Try the [QuickStart](../quickstart.html). The QuickStart is the "Hello, World" of Angular 2.
71
+ It shows us how to set up the libraries and tools we'll need to write *any* Angular app.
72
+
73
+ 1. Take the *Tour of Heroes* [Tutorial](../tutorial), which picks up from where the QuickStart leaves off
74
+ and builds a simple data-driven app.
78
75
Simple, yes, but with the essential characteristics we'd expect of a professional application:
79
- a sensible project structure, data binding, master/detail, services, dependency injection, navigation, and remote data access.
80
-
76
+ a sensible project structure, data binding, master/detail, services, dependency injection, navigation, and remote data access.
77
+
81
78
Return to the *Basics* section and continue in the suggested order:
82
-
79
+
83
80
1. [Displaying Data](displaying-data.html) explains how to get information on to the screen.
84
-
81
+
85
82
1. [User Input](user-input.html) covers the basics of responding to user behavior.
86
-
83
+
87
84
1. [Forms](forms.html) handle user data entry and validation within the UI.
88
-
85
+
89
86
1. [Dependency Injection](dependency-injection.html) is the way we build large, maintainable applications
90
- from small, single purpose parts.
91
-
92
- 1. [Template Syntax](template-syntax.html) is a comprehensive study of Angular template HTML.
87
+ from small, single- purpose parts.
88
+
89
+ 1. [Template Syntax](template-syntax.html) is a comprehensive study of Angular template HTML.
93
90
94
91
With this foundation, we can read and understand any chapter in the guide.
95
92
// #enddocregion how-to-read-2
96
93
// #docregion the-rest
97
94
:marked
98
- # Code Samples
99
-
100
- Every chapter includes code snippets that we can reuse in our own applications.
95
+ # Code samples
96
+
97
+ Every chapter includes code snippets that we can reuse in our own applications.
101
98
These snippets are excerpts from a sample application that accompanies the chapter.
102
-
103
- Look for a link to a running version of that sample near the top of each page
104
- such as this [live example](/resources/live-examples/architecture/ts/plnkr.html) from the [Architecture](architecture.html) chapter.
105
-
106
- The link launches a browser-based code editor where we can inspect, modify, save, and download the code.
107
-
108
- A few early chapters are written as tutorials and are clearly marked as such.
109
- Most chapters are *not* tutorials.
99
+
100
+ block example-links
101
+ :marked
102
+ Look for a link to a running version of that sample near the top of each page,
103
+ such as this [live example](/resources/live-examples/architecture/ts/plnkr.html) from the [Architecture](architecture.html) chapter.
104
+
105
+ The link launches a browser-based code editor where we can inspect, modify, save, and download the code.
106
+
107
+ :marked
108
+ A few early chapters are written as tutorials and are clearly marked as such.
109
+ Most chapters are *not* tutorials.
110
110
They highlight key points in code rather than explain each step necessary to build the sample.
111
- We can always get the full source by way of the live link .
112
-
113
- ## References
114
-
111
+ We can always get the full source by way of the #{_liveLink} .
112
+
113
+ # Reference pages
114
+
115
115
The [Cheat Sheet](cheatsheet.html) lists Angular syntax for common scenarios.
116
-
116
+
117
117
The [Glossary](glossary.html) defines terms that Angular developers should know.
118
-
119
- The [API Guide ](../api/) is the authority on every public-facing member of the Angular libraries.
120
-
118
+
119
+ The [API Reference ](../api/) is the authority on every public-facing member of the Angular libraries.
120
+
121
121
# Feedback
122
-
122
+
123
123
We welcome feedback! Leave a comment by clicking the icon in upper right corner of the banner.
124
-
125
- Post *documentation* issues and pull requests on the
124
+
125
+ Post *documentation* issues and pull requests on the
126
126
[angular.io](https://github.com/angular/angular.io) github repository.
127
-
127
+
128
128
Post issues with *Angular 2 itself* to the [angular](https://github.com/angular/angular) github repository.
129
129
// #enddocregion the-rest
0 commit comments