Skip to content
This repository has been archived by the owner on Apr 12, 2024. It is now read-only.

Commit

Permalink
docs(compiler): update the compiler docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mhevery committed Jan 25, 2012
1 parent e2b1d9e commit 4804c83
Show file tree
Hide file tree
Showing 50 changed files with 866 additions and 792 deletions.
505 changes: 505 additions & 0 deletions docs/content/api/angular.module.ng.$compileProvider.directive.ngdoc

Large diffs are not rendered by default.

4 changes: 1 addition & 3 deletions docs/content/api/index.ngdoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@

## Angular Compiler API

* {@link angular.widget Widgets} - Angular custom DOM element
* {@link angular.directive Directives} - Angular DOM element attributes
* {@link angular.markup Markup} and {@link angular.attrMarkup Attribute Markup}
* {@link angular.module.ng.$compileProvider.directive Directives} - Angular DOM element attributes
* {@link angular.module.ng.$filter Filters} - Angular output filters
* {@link angular.module.ng.$compile $compile} - Template compiler

Expand Down
7 changes: 3 additions & 4 deletions docs/content/cookbook/deeplinking.ngdoc
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,10 @@ The two partials are defined in the following URLs:

* Routes are defined in the `AppCntl` class. The initialization of the controller causes the
initialization of the {@link api/angular.module.ng.$route $route} service with the proper URL
routes.
routes.
* The {@link api/angular.module.ng.$route $route} service then watches the URL and instantiates the
appropriate controller when the URL changes.
* The {@link api/angular.widget.ng:view ng:view} widget loads the view when the URL changes. It
also
sets the view scope to the newly instantiated controller.
* The {@link api/angular.module.ng.$compileProvider.directive.ng:view ng:view} widget loads the
view when the URL changes. It also sets the view scope to the newly instantiated controller.
* Changing the URL is sufficient to change the controller and view. It makes no difference whether
the URL is changed programatically or by the user.
8 changes: 4 additions & 4 deletions docs/content/cookbook/form.ngdoc
Original file line number Diff line number Diff line change
Expand Up @@ -102,12 +102,12 @@ allow a user to enter data.

# Things to notice

* The user data model is initialized {@link api/angular.directive.ng:controller controller} and is
available in
the {@link api/angular.module.ng.$rootScope.Scope scope} with the initial data.
* The user data model is initialized {@link api/angular.module.ng.$compileProvider.directive.ng:controller controller} and is
available in the {@link api/angular.module.ng.$rootScope.Scope scope} with the initial data.
* For debugging purposes we have included a debug view of the model to better understand what
is going on.
* The {@link api/angular.widget.input input widgets} simply refer to the model and are data-bound.
* The {@link api/angular.module.ng.$compileProvider.directive.input input directives} simply refer
to the model and are data-bound.
* The inputs {@link guide/dev_guide.forms validate}. (Try leaving them blank or entering non digits
in the zip field)
* In your application you can simply read from or write to the model and the form will be updated.
Expand Down
3 changes: 2 additions & 1 deletion docs/content/cookbook/helloworld.ngdoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@
Take a look through the source and note:

* The script tag that {@link guide/dev_guide.bootstrap bootstraps} the angular environment.
* The text {@link api/angular.widget.input input widget} which is bound to the greeting name text.
* The text {@link api/angular.module.ng.$compileProvider.directive.input input widget} which is
bound to the greeting name text.
* No need for listener registration and event firing on change events.
* The implicit presence of the `name` variable which is in the root {@link api/angular.module.ng.$rootScope.Scope scope}.
* The double curly brace `{{markup}}`, which binds the name variable to the greeting text.
Expand Down
13 changes: 7 additions & 6 deletions docs/content/guide/dev_guide.bootstrap.ngdoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,19 @@ and manage the whole page. You do this as follows:

You need to declare the angular namespace declaration in the following cases:

* For all browsers if you are using XHTML.
* For Internet Explorer older than version 9 (because older versions of IE do not render widgets
* For all types of browser if you are using XHTML.
* For Internet Explorer older than version 9 (because older versions of IE do not render namespace
properly for either HTML or XHTML).


## Creating Your Own Namespaces

When you are ready to define your own {@link dev_guide.compiler.widgets widgets}, you must create
your own namespace in addition to specifying the angular namespace. You use your own namespace to
form the fully qualified name for widgets that you create.
When you are ready to define your own {@link api/angular.module.ng.$compileProvider.directive
directive}, you may chose to create your own namespace in addition to specifying the angular
namespace. You use your own namespace to form the fully qualified name for directives that you
create.

For example, you could map the alias `my` to your domain, and create a widget called `my:widget`.
For example, you could map the alias `my` to your domain, and create a directive called `my:directive`.
To create your own namespace, simply add another `xmlns` tag to your page, create an alias, and set
it to your unique domain:

Expand Down

This file was deleted.

47 changes: 0 additions & 47 deletions docs/content/guide/dev_guide.compiler.directives.ngdoc

This file was deleted.

47 changes: 0 additions & 47 deletions docs/content/guide/dev_guide.compiler.directives_widgets.ngdoc

This file was deleted.

96 changes: 0 additions & 96 deletions docs/content/guide/dev_guide.compiler.extending_compiler.ngdoc

This file was deleted.

Loading

0 comments on commit 4804c83

Please sign in to comment.