diff options
| author | Peter Bacon Darwin | 2014-02-06 13:33:42 +0000 | 
|---|---|---|
| committer | Peter Bacon Darwin | 2014-02-16 19:03:40 +0000 | 
| commit | c7e815f63b6c22f5bbc798f34386c01fa72cab7d (patch) | |
| tree | 13d8e640ae037112a63f240be22390cc5b3fc522 /docs/content/tutorial | |
| parent | 6483dea08c6fae937e62ce242212152d7ef27d91 (diff) | |
| download | angular.js-c7e815f63b6c22f5bbc798f34386c01fa72cab7d.tar.bz2 | |
docs(bike-shed-migration): fix up links outside the domain
It is safer to use markdown style links and save jsdoc style links for
internal links and code references
Diffstat (limited to 'docs/content/tutorial')
| -rw-r--r-- | docs/content/tutorial/step_00.ngdoc | 3 | ||||
| -rw-r--r-- | docs/content/tutorial/step_01.ngdoc | 3 | ||||
| -rw-r--r-- | docs/content/tutorial/step_02.ngdoc | 14 | ||||
| -rw-r--r-- | docs/content/tutorial/step_03.ngdoc | 7 | ||||
| -rw-r--r-- | docs/content/tutorial/step_04.ngdoc | 6 | ||||
| -rw-r--r-- | docs/content/tutorial/step_05.ngdoc | 7 | ||||
| -rw-r--r-- | docs/content/tutorial/step_06.ngdoc | 8 | ||||
| -rw-r--r-- | docs/content/tutorial/step_07.ngdoc | 13 | ||||
| -rw-r--r-- | docs/content/tutorial/step_08.ngdoc | 8 | ||||
| -rw-r--r-- | docs/content/tutorial/step_09.ngdoc | 4 | ||||
| -rw-r--r-- | docs/content/tutorial/step_10.ngdoc | 8 | ||||
| -rw-r--r-- | docs/content/tutorial/step_11.ngdoc | 12 | ||||
| -rw-r--r-- | docs/content/tutorial/step_12.ngdoc | 12 | ||||
| -rw-r--r-- | docs/content/tutorial/the_end.ngdoc | 5 | 
14 files changed, 37 insertions, 73 deletions
| diff --git a/docs/content/tutorial/step_00.ngdoc b/docs/content/tutorial/step_00.ngdoc index 7e2a6a8b..e1fb89f2 100644 --- a/docs/content/tutorial/step_00.ngdoc +++ b/docs/content/tutorial/step_00.ngdoc @@ -169,8 +169,7 @@ and one static binding, and our model is empty. That will soon change!  ## What are all these files in my working directory? -Most of the files in your working directory come from the {@link -https://github.com/angular/angular-seed angular-seed project} which is typically used to bootstrap +Most of the files in your working directory come from the [angular-seed project](https://github.com/angular/angular-seed) which is typically used to bootstrap  new Angular projects. The seed project includes the latest Angular libraries, test libraries,  scripts and a simple example app, all pre-configured for developing a typical web app. diff --git a/docs/content/tutorial/step_01.ngdoc b/docs/content/tutorial/step_01.ngdoc index 82a2e83e..5c310dce 100644 --- a/docs/content/tutorial/step_01.ngdoc +++ b/docs/content/tutorial/step_01.ngdoc @@ -17,8 +17,7 @@ In this step you will add some basic information about two cell phones to an HTM  The page now contains a list with information about two phones. -The most important changes are listed below. You can see the full diff on {@link -https://github.com/angular/angular-phonecat/compare/step-0...step-1 GitHub}: +The most important changes are listed below. You can see the full diff on [GitHub](https://github.com/angular/angular-phonecat/compare/step-0...step-1):  __`app/index.html`:__  <pre> diff --git a/docs/content/tutorial/step_02.ngdoc b/docs/content/tutorial/step_02.ngdoc index 5710ddaa..42bd42cf 100644 --- a/docs/content/tutorial/step_02.ngdoc +++ b/docs/content/tutorial/step_02.ngdoc @@ -9,8 +9,8 @@ Now it's time to make the web page dynamic — with AngularJS. We'll also add a  code for the controller we are going to add.  There are many ways to structure the code for an application. For Angular apps, we encourage the -use of {@link http://en.wikipedia.org/wiki/Model–View–Controller the Model-View-Controller (MVC) -design pattern} to decouple the code and to separate concerns. With that in mind, let's use a +use of [the Model-View-Controller (MVC) +design pattern](http://en.wikipedia.org/wiki/Model–View–Controller) to decouple the code and to separate concerns. With that in mind, let's use a  little Angular and JavaScript to add model, view, and controller components to our app. @@ -19,8 +19,7 @@ little Angular and JavaScript to add model, view, and controller components to o  The app now contains a list with three phones. -The most important changes are listed below. You can see the full diff on {@link -https://github.com/angular/angular-phonecat/compare/step-1...step-2 GitHub}: +The most important changes are listed below. You can see the full diff on [GitHub](https://github.com/angular/angular-phonecat/compare/step-1...step-2):  ## View and Template @@ -179,12 +178,9 @@ is available to be injected.  ### Writing and Running Tests  Angular developers prefer the syntax of Jasmine's Behavior-driven Development  (BDD) framework when  writing tests. Although Angular does not require you to use Jasmine, we wrote all of the tests in -this tutorial in Jasmine. You can learn about Jasmine on the {@link -http://pivotal.github.com/jasmine/ Jasmine home page} and at the {@link -http://pivotal.github.io/jasmine/ Jasmine docs}. +this tutorial in Jasmine. You can learn about Jasmine on the [Jasmine home page](http://pivotal.github.com/jasmine/) and at the [Jasmine docs](http://pivotal.github.io/jasmine/). -The angular-seed project is pre-configured to run all unit tests using {@link -http://karma-runner.github.io/ Karma}. Ensure that the necessary karma plugins are installed. +The angular-seed project is pre-configured to run all unit tests using [Karma](http://karma-runner.github.io/). Ensure that the necessary karma plugins are installed.  You can do this by issuing `npm install` into your terminal. diff --git a/docs/content/tutorial/step_03.ngdoc b/docs/content/tutorial/step_03.ngdoc index 686f0854..599be309 100644 --- a/docs/content/tutorial/step_03.ngdoc +++ b/docs/content/tutorial/step_03.ngdoc @@ -18,8 +18,7 @@ The app now has a search box. Notice that the phone list on the page changes dep  user types into the search box.  The most important differences between Steps 2 and 3 are listed below. You can see the full diff on -{@link https://github.com/angular/angular-phonecat/compare/step-2...step-3 - GitHub}: +[GitHub](https://github.com/angular/angular-phonecat/compare/step-2...step-3):  ## Controller @@ -117,10 +116,10 @@ test runner}.  To run the end-to-end test, open one of the following in a new browser tab: -* node.js users: {@link http://localhost:8000/test/e2e/runner.html} +* node.js users: http://localhost:8000/test/e2e/runner.html  * users with other http servers:  `http://localhost:[port-number]/[context-path]/test/e2e/runner.html` -* casual reader: {@link http://angular.github.com/angular-phonecat/step-3/test/e2e/runner.html} +* casual reader: http://angular.github.com/angular-phonecat/step-3/test/e2e/runner.html  Previously we've seen how Karma can be used to execute unit tests. Well, it can also run the  end-to-end tests! Use `./scripts/e2e-test.sh` script for that. End-to-end tests are slow, so unlike diff --git a/docs/content/tutorial/step_04.ngdoc b/docs/content/tutorial/step_04.ngdoc index 26e29226..a27195f1 100644 --- a/docs/content/tutorial/step_04.ngdoc +++ b/docs/content/tutorial/step_04.ngdoc @@ -17,7 +17,7 @@ You should see that in addition to the search box, the app displays a drop down  users to control the order in which the phones are listed.  The most important differences between Steps 3 and 4 are listed below. You can see the full diff on -{@link https://github.com/angular/angular-phonecat/compare/step-3...step-4 GitHub}: +[GitHub](https://github.com/angular/angular-phonecat/compare/step-3...step-4):  ## Template @@ -168,9 +168,7 @@ __`test/e2e/scenarios.js`:__  The end-to-end test verifies that the ordering mechanism of the select box is working correctly.  You can now rerun `./scripts/e2e-test.sh` or refresh the browser tab with the end-to-end test -`runner.html` to see the tests run, or you can see them running on {@link -http://angular.github.com/angular-phonecat/step-4/test/e2e/runner.html -Angular's server}. +`runner.html` to see the tests run, or you can see them running on [Angular's server](http://angular.github.com/angular-phonecat/step-4/test/e2e/runner.html).  # Experiments diff --git a/docs/content/tutorial/step_05.ngdoc b/docs/content/tutorial/step_05.ngdoc index ae7fd8fe..568412e8 100644 --- a/docs/content/tutorial/step_05.ngdoc +++ b/docs/content/tutorial/step_05.ngdoc @@ -16,9 +16,7 @@ injection (DI)} to provide the service to the `PhoneListCtrl` controller.  You should now see a list of 20 phones. -The most important changes are listed below. You can see the full diff on {@link -https://github.com/angular/angular-phonecat/compare/step-4...step-5 -GitHub}: +The most important changes are listed below. You can see the full diff on [GitHub](https://github.com/angular/angular-phonecat/compare/step-4...step-5):  ## Data @@ -108,8 +106,7 @@ properties are considered private, and should not be accessed or modified.  ### A Note on Minification  Since Angular infers the controller's dependencies from the names of arguments to the controller's -constructor function, if you were to {@link http://en.wikipedia.org/wiki/Minification_(programming) -minify} the JavaScript code for `PhoneListCtrl` controller, all of its function arguments would be +constructor function, if you were to [minify](http://en.wikipedia.org/wiki/Minification_(programming)) the JavaScript code for `PhoneListCtrl` controller, all of its function arguments would be  minified as well, and the dependency injector would not be able to identify services correctly.  There are two ways to overcome issues caused by minification: diff --git a/docs/content/tutorial/step_06.ngdoc b/docs/content/tutorial/step_06.ngdoc index eaf0ad3c..68981f45 100644 --- a/docs/content/tutorial/step_06.ngdoc +++ b/docs/content/tutorial/step_06.ngdoc @@ -15,9 +15,7 @@ about the phones in the catalog.  You should now see links and images of the phones in the list. -The most important changes are listed below. You can see the full diff on {@link -https://github.com/angular/angular-phonecat/compare/step-5...step-6 -GitHub}: +The most important changes are listed below. You can see the full diff on [GitHub](https://github.com/angular/angular-phonecat/compare/step-5...step-6):  ## Data @@ -85,9 +83,7 @@ We added a new end-to-end test to verify that the app is generating correct link  views that we will implement in the upcoming steps.  You can now rerun `./scripts/e2e-test.sh` or refresh the browser tab with the end-to-end test -runner to see the tests run, or you can see them running on {@link -http://angular.github.com/angular-phonecat/step-6/test/e2e/runner.html -Angular's server}. +runner to see the tests run, or you can see them running on [Angular's server](http://angular.github.com/angular-phonecat/step-6/test/e2e/runner.html).  # Experiments diff --git a/docs/content/tutorial/step_07.ngdoc b/docs/content/tutorial/step_07.ngdoc index 0f6b83ed..77408b4e 100644 --- a/docs/content/tutorial/step_07.ngdoc +++ b/docs/content/tutorial/step_07.ngdoc @@ -17,9 +17,7 @@ and the same phone list appears in the browser. When you click on a phone link t  detail page is displayed. -The most important changes are listed below. You can see the full diff on {@link -https://github.com/angular/angular-phonecat/compare/step-6...step-7 -GitHub}. +The most important changes are listed below. You can see the full diff on [GitHub](https://github.com/angular/angular-phonecat/compare/step-6...step-7).  ## Multiple Views, Routing and Layout Template @@ -39,8 +37,7 @@ Application routes in Angular are declared via the  {@link api/ngRoute.$routeProvider $routeProvider}, which is the provider of the  {@link api/ngRoute.$route $route service}. This service makes it easy to wire together  controllers, view templates, and the current -URL location in the browser. Using this feature we can implement {@link -http://en.wikipedia.org/wiki/Deep_linking deep linking}, which lets us utilize the browser's +URL location in the browser. Using this feature we can implement [deep linking](http://en.wikipedia.org/wiki/Deep_linking), which lets us utilize the browser's  history (back and forward navigation) and bookmarks. @@ -107,7 +104,7 @@ module `phonecatControllers`. By listing these two modules as dependencies of `p  can use the directives and services they provide.  Thus using the `config` API we request the `$routeProvider` to be injected into our config function -and use the {@link api/ngRoute.$routeProvider#methods_when `$routeProvider.when`} API to define our routes. +and use the {@link api/ngRoute.$routeProvider#when `$routeProvider.when`} API to define our routes.  Our application routes are defined as follows: @@ -278,9 +275,7 @@ to various URLs and verify that the correct view was rendered.  You can now rerun `./scripts/e2e-test.sh` or refresh the browser tab with the end-to-end test -runner to see the tests run, or you can see them running on {@link -http://angular.github.com/angular-phonecat/step-7/test/e2e/runner.html -Angular's server}. +runner to see the tests run, or you can see them running on [Angular's server](http://angular.github.com/angular-phonecat/step-7/test/e2e/runner.html).  # Experiments diff --git a/docs/content/tutorial/step_08.ngdoc b/docs/content/tutorial/step_08.ngdoc index 968c9add..ee10e8ee 100644 --- a/docs/content/tutorial/step_08.ngdoc +++ b/docs/content/tutorial/step_08.ngdoc @@ -18,9 +18,7 @@ is displayed.  To implement the phone details view we will use {@link api/ng.$http $http} to fetch  our data, and we'll flesh out the `phone-detail.html` view template. -The most important changes are listed below. You can see the full diff on {@link -https://github.com/angular/angular-phonecat/compare/step-7...step-8 -GitHub}: +The most important changes are listed below. You can see the full diff on [GitHub](https://github.com/angular/angular-phonecat/compare/step-7...step-8):  ## Data @@ -175,9 +173,7 @@ __`test/e2e/scenarios.js`:__  You can now rerun `./scripts/e2e-test.sh` or refresh the browser tab with the end-to-end test -runner to see the tests run, or you can see them running on {@link -http://angular.github.com/angular-phonecat/step-8/test/e2e/runner.html -Angular's server}. +runner to see the tests run, or you can see them running on [Angular's server](http://angular.github.com/angular-phonecat/step-8/test/e2e/runner.html).  # Experiments diff --git a/docs/content/tutorial/step_09.ngdoc b/docs/content/tutorial/step_09.ngdoc index 8f3cb5b9..894c6f96 100644 --- a/docs/content/tutorial/step_09.ngdoc +++ b/docs/content/tutorial/step_09.ngdoc @@ -17,9 +17,7 @@ In the previous step, the details page displayed either "true" or "false" to ind  certain phone features were present or not. We have used a custom filter to convert those text  strings into glyphs: ✓ for "true", and ✘ for "false". Let's see what the filter code looks like. -The most important changes are listed below. You can see the full diff on {@link -https://github.com/angular/angular-phonecat/compare/step-8...step-9 -GitHub}: +The most important changes are listed below. You can see the full diff on [GitHub](https://github.com/angular/angular-phonecat/compare/step-8...step-9):  ## Custom Filter diff --git a/docs/content/tutorial/step_10.ngdoc b/docs/content/tutorial/step_10.ngdoc index ede1a4aa..d1ed37f7 100644 --- a/docs/content/tutorial/step_10.ngdoc +++ b/docs/content/tutorial/step_10.ngdoc @@ -15,9 +15,7 @@ The phone details view displays one large image of the current phone and several  images. It would be great if we could replace the large image with any of the thumbnails just by  clicking on the desired thumbnail image. Let's have a look at how we can do this with Angular. -The most important changes are listed below. You can see the full diff on {@link -https://github.com/angular/angular-phonecat/compare/step-9...step-10 -GitHub}: +The most important changes are listed below. You can see the full diff on [GitHub](https://github.com/angular/angular-phonecat/compare/step-9...step-10):  ## Controller @@ -104,9 +102,7 @@ __`test/e2e/scenarios.js`:__  </pre>  You can now rerun `./scripts/e2e-test.sh` or refresh the browser tab with the end-to-end test -runner to see the tests run, or you can see them running on {@link -http://angular.github.com/angular-phonecat/step-10/test/e2e/runner.html -Angular's server}. +runner to see the tests run, or you can see them running on [Angular's server](http://angular.github.com/angular-phonecat/step-10/test/e2e/runner.html).  # Experiments diff --git a/docs/content/tutorial/step_11.ngdoc b/docs/content/tutorial/step_11.ngdoc index 4b82367d..9a549516 100644 --- a/docs/content/tutorial/step_11.ngdoc +++ b/docs/content/tutorial/step_11.ngdoc @@ -11,14 +11,11 @@ In this step, you will improve the way our app fetches data.  <div doc-tutorial-reset="11"></div> -The next improvement we will make to our app is to define a custom service that represents a {@link -http://en.wikipedia.org/wiki/Representational_State_Transfer RESTful} client. Using this client we +The next improvement we will make to our app is to define a custom service that represents a [RESTful](http://en.wikipedia.org/wiki/Representational_State_Transfer) client. Using this client we  can make XHR requests for data in an easier way, without having to deal with the lower-level {@link  api/ng.$http $http} API, HTTP methods and URLs. -The most important changes are listed below. You can see the full diff on {@link -https://github.com/angular/angular-phonecat/compare/step-10...step-11 -GitHub}: +The most important changes are listed below. You can see the full diff on [GitHub](https://github.com/angular/angular-phonecat/compare/step-10...step-11):  ## Template @@ -55,7 +52,7 @@ controller's constructor in that both can declare dependencies via function argu  service declared a dependency on the `$resource` service.  The {@link api/ngResource.$resource `$resource`} service makes it easy to create a -{@link http://en.wikipedia.org/wiki/Representational_State_Transfer RESTful} client with just a few +[RESTful](http://en.wikipedia.org/wiki/Representational_State_Transfer) client with just a few  lines of code. This client can then be used in our application, instead of the lower-level {@link  api/ng.$http $http} service. @@ -130,8 +127,7 @@ service correctly.  The {@link api/ngResource.$resource $resource} service augments the response object  with methods for updating and deleting the resource. If we were to use the standard `toEqual`  matcher, our tests would fail because the test values would not match the responses exactly. To -solve the problem, we use a newly-defined `toEqualData` {@link -https://github.com/pivotal/jasmine/wiki/Matchers Jasmine matcher}. When the +solve the problem, we use a newly-defined `toEqualData` [Jasmine matcher](https://github.com/pivotal/jasmine/wiki/Matchers). When the  `toEqualData` matcher compares two objects, it takes only object properties into account and  ignores methods. diff --git a/docs/content/tutorial/step_12.ngdoc b/docs/content/tutorial/step_12.ngdoc index b611e072..a444f4fb 100644 --- a/docs/content/tutorial/step_12.ngdoc +++ b/docs/content/tutorial/step_12.ngdoc @@ -22,7 +22,7 @@ then the animation will run in between the standard DOM operation that is being  the given time (e.g. inserting and removing nodes on ngRepeat or adding and removing classes on ngClass).  The most important changes are listed below. You can see the full diff on -{@link https://github.com/angular/angular-phonecat/compare/step-11...step-12 GitHub}: +[GitHub](https://github.com/angular/angular-phonecat/compare/step-11...step-12):  ## How Animations work with `ngAnimate` @@ -183,8 +183,8 @@ around and collapsing the items before removing them from the list.  There's also a nice fade-in and fade-out effect that also occurs at the same time. All of this is handled  by the CSS transition declarations at the top of the example code above. -Although most modern browsers have good support for {@link http://caniuse.com/#feat=css-transitions CSS transitions} -and {@link http://caniuse.com/#feat=css-animation CSS animations}, IE9 and earlier do not. +Although most modern browsers have good support for [CSS transitions](http://caniuse.com/#feat=css-transitions) +and [CSS animations](http://caniuse.com/#feat=css-animation), IE9 and earlier do not.  If you want animations that are backwards-compatible with older browsers, consider using JavaScript-based animations,  which are described in detail below. @@ -284,7 +284,7 @@ loaded the ng-view directive will create a copy of itself, download the template  ensures that all views are contained within a single HTML element which allows for easy animation control.  For more on CSS animations, see the -{@link http://docs.webplatform.org/wiki/css/properties/animations Web Platform documentation}. +[Web Platform documentation](http://docs.webplatform.org/wiki/css/properties/animations).  ## Animating `ngClass` with JavaScript @@ -394,10 +394,10 @@ phonecatAnimations.animation('.phone', function() {  });  </pre> -Note that we're using {@link http://jquery.com/ jQuery} to implement the animation. jQuery +Note that we're using [jQuery](http://jquery.com/) to implement the animation. jQuery  isn't required to do JavaScript animations with AngularJS, but we're going to use it because writing  your own JavaScript animation library is beyond the scope of this tutorial. For more on -`jQuery.animate`, see the {@link http://api.jquery.com/animate/ jQuery documentation}. +`jQuery.animate`, see the [jQuery documentation](http://api.jquery.com/animate/).  The `addClass` and `removeClass` callback functions are called whenever an a class is added or removed  on the element that contains the class we registered, which is in this case `.phone`. When the `.active` diff --git a/docs/content/tutorial/the_end.ngdoc b/docs/content/tutorial/the_end.ngdoc index 3a5fb9f8..46bbcbba 100644 --- a/docs/content/tutorial/the_end.ngdoc +++ b/docs/content/tutorial/the_end.ngdoc @@ -9,11 +9,10 @@ For more details and examples of the Angular concepts we touched on in this tuto  {@link guide/ Developer Guide}.  When you are ready to start developing a project using Angular, we recommend that you bootstrap -your development with the {@link https://github.com/angular/angular-seed angular-seed} project. +your development with the [angular-seed](https://github.com/angular/angular-seed) project.  We hope this tutorial was useful to you and that you learned enough about Angular to make you want  to learn more. We especially hope you are inspired to go out and develop Angular web apps of your  own, and that you might be interested in {@link misc/contribute contributing} to Angular. -If you have questions or feedback or just want to say "hi", please post a message at {@link -https://groups.google.com/forum/#!forum/angular}. +If you have questions or feedback or just want to say "hi", please post a message at (https://groups.google.com/forum/#!forum/angular). | 
