iSharkFly-Docs
/
angular-docs-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Copyedit of JS quick start

This commit is contained in:
Kathy Walrath 2015-03-04 16:21:24 -08:00
parent 0bbe4927c9
commit b3d8bea11c
2 changed files with 86 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
public/docs/dart/latest/quickstart.jade
View File

@ -52,7 +52,6 @@ p.
will be higher than alpha 6. That's fine. will be higher than alpha 6. That's fine.
// PENDING: Update once 1.9 is on stable channel. // PENDING: Update once 1.9 is on stable channel.
// TODO: Convert the above to a callout.
// STEP 2 - Import Angular ########################## // STEP 2 - Import Angular ##########################
@ -152,16 +151,11 @@ p.
of its component controller. of its component controller.
The template above binds to a <code>name</code> property through The template above binds to a <code>name</code> property through
the double-mustache syntax (<code ng-non-bindable>{{ ... }}</code>). the double-mustache syntax (<code ng-non-bindable>{{ ... }}</code>).
p.
The component controller assigns "Alice" to the name property. When the The component controller assigns "Alice" to the name property. When the
template renders, "Hello Alice" appears instead of template renders, "Hello Alice" appears instead of
<span ng-non-bindable>"Hello {{ name }}"</span>. <span ng-non-bindable>"Hello {{ name }}"</span>.
// [PENDING: Do we really want to use the term "component controller"?
// If so, set it up beforehand.
// In the original text, what does "the backing" mean, and is it
// important that we keep it?]
pre.prettyprint pre.prettyprint
code. code.
class AppComponent { class AppComponent {
@ -264,4 +258,4 @@ p.
to get the latest version of Angular 2. to get the latest version of Angular 2.
// [PENDING: really?] Perhaps point to dartlang.org. // [PENDING: Perhaps point to dartlang.org.]

157
public/docs/js/latest/quickstart.jade
View File

@ -20,7 +20,7 @@ p.
.l-main-section .l-main-section
h2#section-add-es6-shim 2. Add the es6-shim h2#section-add-es6-shim 2. Add the es6-shim
p. Within your project, clone the es6-shim repository: p Within your project, clone the es6-shim repository:
pre.prettyprint pre.prettyprint
code git clone https://github.com/davideast/conscious.git es6-shim code git clone https://github.com/davideast/conscious.git es6-shim
@ -28,7 +28,7 @@ p.
p. p.
For the sake of this quickstart we recommend using the For the sake of this quickstart we recommend using the
<a href="https://github.com/davideast/conscious"> <code>es6-shim</code> GitHub repository</a>. <a href="https://github.com/davideast/conscious"> <code>es6-shim</code> GitHub repository</a>.
This repository will provides a faster start than building from <code>npm</code>. The <code>es6-shim</code> includes Angular and dependencies to compile ES6 in incompatible browsers. This repository provides a faster start than building from <code>npm</code>. The <code>es6-shim</code> includes Angular and dependencies to compile ES6 in incompatible browsers.
.l-sub-section .l-sub-section
h3 ES6, AtScript, and the es6-shim h3 ES6, AtScript, and the es6-shim
@ -36,19 +36,22 @@ p.
h4 AtScript h4 AtScript
p. p.
Angular is built with <strong>AtScript</strong>. AtScript is an extension of ES6 (ECMAScript 6), the new specification Angular is built with <strong>AtScript</strong>. AtScript is an extension of ES6 (ECMAScript 6), the new specification
of the JavaScript language. This quickstart will be written in AtScript, but it is not required in Angular. of the JavaScript language. This quickstart features AtScript, but Angular
doesn't require you to write AtScript.
h4 ES6 h4 ES6
p. p.
AtScript compiles to <strong>ES6</strong>. ES6 is not widely supported in all browsers today. AtScript compiles to <strong>ES6</strong>, which is not widely supported in all browsers today.
The es6-shim repository allows you to use ES6 or AtScript in the browser. The es6-shim repository allows you to use ES6 or AtScript in the browser.
h4 es6-shim h4 es6-shim
p. p.
The <strong>es6-shim</strong> package includes Angular and dependencies needed to compile The <strong>es6-shim</strong> package includes Angular and dependencies
ES6 in the browser, such as Traceur. Traceur is an ES6 compiler that transpiles ES6 to ES5 code. (such as Traceur) needed to compile
Think of the es6-shim repository as package rather than a project. ES6 in the browser. Traceur is an ES6 compiler that transpiles ES6 to ES5 code.
Think of the es6-shim repository as a package rather than a project.
// PENDING: "Think of ... as a package" could be clearer.
// STEP 2 - Import Angular ########################## // STEP 2 - Import Angular ##########################
@ -56,20 +59,24 @@ p.
h2#section-transpile 2. Import Angular h2#section-transpile 2. Import Angular
p. p.
Create two files for this quickstart, an <code>index.html</code> and a Create two files, <code>index.html</code> and
<code>app.es6</code>. Both of these files will be at the root of the project. <code>app.es6</code>, both at the root of the project:
The <code>.es6</code> extension signifies that the file uses ES6 syntax.
pre.prettyprint.linenums pre.prettyprint
code touch index.html code.
| touch app.es6 touch index.html
touch app.es6
p Inside of <code>app.es6</code>, use the ES6 module syntax you can import the required modules from Angular. .alert.is-helpful The <code>.es6</code> extension signifies that the file uses ES6 syntax.
p Inside of <code>app.es6</code>, import the required modules from Angular:
pre.prettyprint.linenums pre.prettyprint.linenums
code import {Component, Template, bootstrap} from 'angular2/angular2'; code import {Component, Template, bootstrap} from 'angular2/angular2';
p The above import statement will import three modules from Angular. These modules load at runtime. p.
The above import statement uses ES6 module syntax to import three modules from Angular.
These modules load at runtime.
// STEP 3 - Create a component ########################## // STEP 3 - Create a component ##########################
@ -78,24 +85,23 @@ p.
h2#section-angular-create-account 3. Define a component h2#section-angular-create-account 3. Define a component
p. p.
Components structure and represent the UI. This quickstart demonstrates the process of creating a component. Components structure and represent the UI. This quickstart demonstrates the process of creating a component
The component will have an HTML tag named app, that has an HTML tag named <strong><code>&lt;my-app&gt;</code></strong>.
<strong><code>&lt;my-app&gt;&lt;/my-app&gt;</code></strong>.
p. p.
A component consists of two parts; the <strong>annotation section</strong> A component consists of two parts, the <strong>annotation section</strong>
and the <strong>component controller</strong>. and the <strong>component controller</strong>.
pre.prettyprint.linenums pre.prettyprint.linenums
code. code.
// Annotation Section // Annotation section
@Component({ @Component({
selector: 'my-app' selector: 'my-app'
}) })
@Template({ @Template({
inline: '&lt;h1&gt;Hello {{ name }}&lt;/h1&gt;' inline: '&lt;h1&gt;Hello {{ name }}&lt;/h1&gt;'
}) })
// Component Controller // Component controller
class MyAppComponent { class MyAppComponent {
constructor() { constructor() {
this.name = 'Alice'; this.name = 'Alice';
@ -103,20 +109,20 @@ p.
} }
.l-sub-section .l-sub-section
h3 Component Annotations h3 Component annotations
p. p.
A component annotation provides metadata about the component. A component annotation provides metadata about the component.
An annotation can always identified by its at-sign (<code>@</code>). An annotation can be identified by its at-sign (<code>@</code>).
p. p.
The <code>@Component</code> annotation defines the HTML tag for the component. The <code>@Component</code> annotation defines
The <code>selector</code> property is a CSS selector which specifies the HTML tag for the component. the HTML tag for the component by specifying the component's CSS selector.
p. p.
The <code>@Template</code> annotation defines the template to apply to the component. The <code>@Template</code> annotation defines the HTML that
This component uses an inline template, but external templates are represents the component. This component uses an inline template,
available as well. To use an external template specify a <code>url</code> property but you can also have an external template. To use an external template,
and give it the path to the html file. specify a <code>url</code> property
and give it the path to the HTML file.
pre.prettyprint.linenums pre.prettyprint.linenums
code. code.
@ -128,11 +134,11 @@ p.
}) })
p. p.
The component created above has a HTML tag of <code>&lt;my-app&gt;&lt;/my-app&gt;</code> The annotations above specify an HTML tag of <code>&lt;my-app&gt;</code>
and a template of <code>&lt;h1&gt;Hello <code>{{</code> name }}&lt;/h1&gt;</code>. and a template of <code ng-non-bindable>&lt;h1&gt;Hello &#123;&#123; name }}&lt;/h1&gt;</code>.
.l-sub-section .l-sub-section
h3 Component Controller h3 The template and the component controller
p. p.
The component controller is the backing of the component's template. A component The component controller is the backing of the component's template. A component
@ -151,9 +157,11 @@ p.
or functions placed on the component controller. or functions placed on the component controller.
p. p.
The template above binds to a <code>name</code> property through the <code>{{ }}</code> The template above binds to a <code>name</code> property through
syntax.The body of the constructor assigns "Alice" to the name property. When the the double-mustache syntax (<code ng-non-bindable>{{ ... }}</code>).
template renders, Alice will appear instead of <code>{{ name }}</code>. The body of the constructor assigns "Alice" to the name property. When the
template renders, "Hello Alice" appears instead of
<span ng-non-bindable>"Hello {{ name }}"</span>.
@ -161,17 +169,18 @@ p.
.l-main-section .l-main-section
h2#section-transpile 4. Bootstrap h2#section-transpile 4. Bootstrap
p The last step to load the component on the page. At the bottom of <code>app.es6</code> call the <code>bootstrap()</code> function. p.
At the bottom of <code>app.es6</code>, call the <code>bootstrap()</code> function
to load your new component into its page:
pre.prettyprint.linenums pre.prettyprint.linenums
code bootstrap(MyAppComponent); code bootstrap(MyAppComponent);
p. p.
Angular provides a <code>bootstrap</code> function that renders a The <code>bootstrap()</code> function takes a
component to the page. The <code>bootstrap</code> function takes a component as a parameter, enabling the component
component as a parameter. Any child components inside of the parent (as well as any child components it contains) to render.
component will render as well.
// STEP 5 - Declare the HTML ########################## // STEP 5 - Declare the HTML ##########################
@ -180,8 +189,9 @@ p.
h2#section-angular-create-account 5. Declare the HTML h2#section-angular-create-account 5. Declare the HTML
p. p.
Inside of the <code>index.html</code>, include the <code>es6-shim.js</code> file in the <code>head</code> tag. Inside the <code>head</code> tag of <code>index.html</code>, include the <code>es6-shim.js</code> file.
Now, declare the app component the <code>body</code>. The es6-shim must load before any application code. (The es6-shim code must load before any application code.)
Then instantiate the <code>my-app</code> component in the <code>body</code>.
pre.prettyprint.linenums pre.prettyprint.linenums
code. code.
@ -202,53 +212,54 @@ p.
// STEP 6 - Declare the HTML ########################## // STEP 6 - Declare the HTML ##########################
.l-main-section .l-main-section
h2#section-load-component-module 5. Load the component h2#section-load-component-module 6. Load the component
p. p.
The last step is to load the module for the my-app component. The last step is to load the module for the <code>my-app</code> component.
The es6-shim file comes packaged with the System library. We'll To do this, we'll use the System library,
use System to load the component we created above. which is included in es6-shim.
.l-sub-section .l-sub-section
h3 System.js h3 System.js
p. p.
System is a third-party open sourced library. Most browsers today do not support ES6 module loading. System System is a third-party open-source library that
provides module loading functionality to these browsers. adds ES6 module loading functionality to browsers.
p. p.
To load the needed modules, System needs to know where to Add the following module-loading code to <code>index.html</code>:
load the files from. The paths property in System specifies
the location of the files.
p Tell System about three paths: pre.prettyprint.linenums
ol code.
li Angular: The Angular framework. &lt;my-app&gt;&lt;/my-app&gt;
li Runtime assertions: Optional assertions for runtime type checking.
li The my-app component created above: The component to display on the page.
pre.prettyprint.linenums &lt;script&gt;
code. // Rewrite the paths to load the files
&lt;my-app&gt;&lt;/my-app&gt; System.paths = {
'angular2/*':'/es6-shim/angular2/*.js', // Angular
'rtts_assert/*': '/es6-shim/rtts_assert/*.js', //Runtime assertions
'app': 'app.es6' // The my-app component
};
&lt;script&gt; // Kick off the application
// Rewrite the paths to load the files System.import('app');
System.paths = { &lt;/script&gt;
'angular2/*':'/es6-shim/angular2/*.js', // Angular
'rtts_assert/*': '/es6-shim/rtts_assert/*.js', //Runtime assertions
'app': 'app.es6' // The my-app component
};
// Kick off the application p.
System.import('app'); The <code>System.paths</code> property above specifies
&lt;/script&gt; the paths to the following modules:
ul
li The Angular framework
li Optional assertions for runtime type checking
li The component to display on the page
// STEP 6 - Declare the HTML ##########################
// STEP 6 - Run a local server ##########################
.l-main-section .l-main-section
h2#section-load-component-module 5. Run a local server h2#section-load-component-module 6. Run a local server
// PENDING: add directions (or at least hints) here
// WHAT'S NEXT... ########################## // WHAT'S NEXT... ##########################
.l-main-section .l-main-section