Skip to content

Commit 2274dc7

Browse files
gkalpakpetebacondarwin
gkalpak
authored and
petebacondarwin
committed
docs(misc/downloading): update content - include missing modules
Closes angular#14746
1 parent f82e135 commit 2274dc7

File tree

1 file changed

+97
-61
lines changed

1 file changed

+97
-61
lines changed

‎docs/content/misc/downloading.ngdoc

+97-61
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22
@name Downloading
33
@description
44

5-
# Including angular scripts from the Google CDN
6-
The quickest way to get started is to point your html `<script>` tag to a Google CDN URL.
5+
# Including Angular scripts from the Google CDN
6+
The quickest way to get started is to point your html `<script>` tag to a
7+
[Google CDN](https://developers.google.com/speed/libraries/#angularjs) URL.
78
This way, you don't have to download anything or maintain a local copy.
89

9-
There are two types of angular script URLs you can point to, one for development and one for
10+
There are two types of Angular script URLs you can point to, one for development and one for
1011
production:
1112

12-
* __angular.js__ — This is the human-readable, non-minified version, suitable for web
13-
development.
13+
* __angular.js__ — This is the human-readable, non-minified version, suitable for web development.
1414
* __angular.min.js__ — This is the minified version, which we strongly suggest you use in
15-
production.
15+
production.
1616

17-
To point your code to an angular script on the Google CDN server, use the following template. This
17+
To point your code to an angular script on the Google CDN server, use the following template. This
1818
example points to the minified version 1.5.6:
1919

20-
```
20+
```html
2121
<!doctype html>
2222
<html ng-app>
2323
<head>
@@ -29,58 +29,94 @@ example points to the minified version 1.5.6:
2929
</html>
3030
```
3131

32-
Note that only versions 1.0.1 and above are available on the CDN, if you need an earlier version
33-
you can use the <http://code.angularjs.org/> URL which was the previous recommended location for
34-
hosted code source. If you're still using the angular server you should switch to the CDN version
35-
for even faster loading times.
32+
<div class="alert alert-info">
33+
Note that only versions 1.0.1 and above are available on the CDN. If you need an earlier version
34+
(which you shouldn't) you can use the https://code.angularjs.org/ URL, which was the previous
35+
recommended location for hosted code source. If you're still using the Angular server you should
36+
switch to the CDN version for even faster loading times.
37+
</div>
3638

39+
<br />
3740
# Downloading and hosting angular files locally
38-
This option is for those who want to work with angular offline, or those who want to host the
39-
angular files on their own servers.
40-
41-
If you navigate to <http://code.angularjs.org/>, you'll see a directory listing with all of the
42-
angular versions since we started releasing versioned build artifacts (quite late in the project
43-
lifetime). Each directory contains all artifacts that we released for a particular version.
44-
Download the version you want and have fun.
45-
46-
Each directory under <http://code.angularjs.org/> includes the following set of files:
47-
48-
* __`angular.js`__ — This file is non-obfuscated, non-minified, and human-readable by
49-
opening it in any editor or browser. In order to get better error messages during development, you
50-
should always use this non-minified angular script.
51-
52-
* __`angular.min.js`__ — This is a minified and obfuscated version of
53-
`angular.js` created with the Closure compiler. Use this version for production in order
54-
to minimize the size of the application that is downloaded by your user's browser.
55-
56-
* __`angular.zip`__ — This is a zip archive that contains all of the files released
57-
for this angular version. Use this file to get everything in a single download.
58-
59-
* __`angular-mocks.js`__ — This file contains an implementation of mocks that makes
60-
testing angular apps even easier. Your unit/integration test harness should load this file after
61-
`angular.js` is loaded.
62-
63-
* __`angular-scenario.js`__ — This file is a very nifty JavaScript file that allows you
64-
to write and execute end-to-end tests for angular applications.
65-
66-
* __`angular-loader.min.js`__ — Module loader for Angular modules. If you are loading multiple script files containing
67-
Angular modules, you can load them asynchronously and in any order as long as you load this file first. Often the
68-
contents of this file are copy&pasted into the `index.html` to avoid even the initial request to `angular-loader.min.js`.
69-
See [angular-seed](https://github.com/angular/angular-seed/blob/master/app/index-async.html) for an example of usage.
70-
71-
* __Additional Angular modules:__ optional modules with additional functionality. These files should be loaded
72-
after the core `angular.js` file:
73-
* __`angular-animate.js`__ - Enable animation support
74-
* __`angular-cookies.js`__ - A convenient wrapper for reading and writing browser cookies
75-
* __`angular-resource.js`__ - Interaction support with RESTful services via the $resource service
76-
* __`angular-route.js`__ - Routing and deeplinking services and directives for angular apps
77-
* __`angular-sanitize.js`__ - Functionality to sanitize HTML
78-
* __`angular-touch.js`__ - Touch events and other helpers for touch-enabled devices
79-
80-
81-
* __`docs`__ — this directory contains all the files that compose the
82-
<http://docs.angularjs.org/> documentation app. These files are handy to see the older version of
83-
our docs, or even more importantly, view the docs offline.
84-
85-
* __`i18n`__ - this directory contains locale specific `ngLocale` angular modules to override the defaults
86-
defined in the `ng` module.
41+
This option is for those who want to work with Angular offline, or those who want to host the
42+
Angular files on their own servers.
43+
44+
If you navigate to https://code.angularjs.org/, you'll see a directory listing with all of the
45+
Angular versions since we started releasing versioned build artifacts. Each directory contains all
46+
artifacts that we released for a particular version. Download the version you want and have fun.
47+
48+
<div class="alert alert-warning">
49+
You can ignore directories starting with `2.` (e.g. `2.0.0-beta.17`) — they are not related to
50+
AngularJS. They contain build artifacts from [Angular 2](https://angular.io) versions.
51+
</div>
52+
53+
<br />
54+
Each directory under https://code.angularjs.org/ includes a set of files that comprise the
55+
corresponding version. All JavaScript files (except for `angular-mocks` which is only used during
56+
development) come in two flavors — one suitable for development, the other for production:
57+
58+
* __`<filename>.js`__ — These files are non-obfuscated, non-minified, and human-readable by opening
59+
them in any editor or browser. In order to get better error messages during development, you
60+
should always use these non-minified scripts.
61+
62+
* __`<filename>.min.js`__ — These are minified and obfuscated versions, created with the
63+
[Closure compiler](https://developers.google.com/closure/compiler/). Use these versions for
64+
production in order to minimize the size of the application that is downloaded by your user's
65+
browser.
66+
67+
* __`<filename>.min.js.map`__ — These are
68+
[sourcemap files](http://www.html5rocks.com/en/tutorials/developertools/sourcemaps/). You can
69+
serve them alongside the `.min.js` files in order to be able to debug the minified code (e.g. on a
70+
production deployment) more easily, but without impacting performance.
71+
72+
<br />
73+
The set of files included in each version directory are:
74+
75+
* __`angular.zip`__ — This is a zip archive that contains all of the files released for this Angular
76+
version. Use this file to get everything in a single download.
77+
78+
* __`angular.js`__ — The core Angular framework. This is all you need to get your Angular app
79+
running.
80+
81+
* __`angular-csp.css`__ — You only need this file if you are using
82+
[CSP (Content Security Policy)](https://developer.mozilla.org/en/Security/CSP). See
83+
{@link directive:ngCsp here} for more info.
84+
85+
* __`angular-mocks.js`__ — This file contains an implementation of mocks that makes testing angular
86+
apps even easier. Your unit/integration test harness should load this file after `angular.js` is
87+
loaded.
88+
89+
* __`angular-loader.js`__ — Module loader for Angular modules. If you are loading multiple
90+
script files containing Angular modules, you can load them asynchronously and in any order as long
91+
as you load this file first. Often the contents of this file are copy&pasted into the `index.html`
92+
to avoid even the initial request to `angular-loader[.min].js`.
93+
See [angular-seed](https://github.com/angular/angular-seed/blob/master/app/index-async.html) for
94+
an example of usage.
95+
96+
* __Additional Angular modules:__ Optional modules with additional functionality. These files
97+
should be loaded after the core `angular[.min].js` file:
98+
* __`angular-animate.js`__ — Enable animation support. ({@link module:ngAnimate API docs})
99+
* __`angular-aria.js`__ — Make your apps [accessible](http://www.w3.org/TR/wai-aria/) to users of
100+
assistive technologies. ({@link module:ngAria API docs})
101+
* __`angular-cookies.js`__ — A convenient wrapper for reading and writing browser cookies.
102+
({@link module:ngCookies API docs})
103+
<!-- * __`angular-message-format.js`__ — ({@link module:ngMessageFormat API docs}) -->
104+
* __`angular-messages.js`__ — Enhanced support for displaying validation messages.
105+
({@link module:ngMessages API docs})
106+
* __`angular-parse-ext.js`__ — Allow Unicode characters in identifiers inside Angular expressions.
107+
({@link module:ngParseExt API docs})
108+
* __`angular-resource.js`__ — Easy interaction with RESTful services.
109+
({@link module:ngResource API docs})
110+
* __`angular-route.js`__ — Routing and deep-linking services and directives for Angular apps.
111+
({@link module:ngRoute API docs})
112+
* __`angular-sanitize.js`__ — Functionality to sanitize HTML. ({@link module:ngSanitize API docs})
113+
* __`angular-touch.js`__ — Touch events and other helpers for touch-enabled devices.
114+
({@link module:ngTouch API docs})
115+
116+
117+
* __`docs/`__ — This directory contains all the files that compose the https://docs.angularjs.org/
118+
documentation app. These files are handy to see the older versions of our docs, or even more
119+
importantly, view the docs offline.
120+
121+
* __`i18n/`__ - This directory contains [locale specific](https://docs.angularjs.org/guide/i18n)
122+
`ngLocale` Angular modules to override the defaults defined in the main `ng` module.

0 commit comments

Comments
 (0)