Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

docs(glossary): general cleanup and fix links #2100

Merged
merged 4 commits into from
Aug 18, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 57 additions & 24 deletions public/docs/dart/latest/glossary.jade
Original file line number Diff line number Diff line change
@@ -1,35 +1,68 @@
extends ../../ts/_cache/glossary.jade

block includes
include _util-fns

block var-def
- var fragPath='../../ts/latest/_fragments/';

!=partial(fragPath + 'glossary-intro')
!=partial(fragPath + 'glossary-a1')
!=partial(fragPath + 'glossary-a-2')
!=partial(fragPath + 'glossary-b-c')
!=partial(fragPath + 'glossary-d1')
!=partial(fragPath + 'glossary-d2')
!=partial(fragPath + 'glossary-e1')
!=partial(fragPath + 'glossary-e2')
!=partial(fragPath + 'glossary-f-l')
!=partial(fragPath + 'glossary-m1')
//partial(fragPath + 'glossary-m2') not needed in dart
!=partial(fragPath + 'glossary-n-s-1')
block annotation-defn
:marked
When unqualified, _annotation_ refers to a Dart [metadata
annotation][metadata] (as opposed to, say, a type annotation). A metadata
annotation begins with the character `@`, followed by either a reference
to a compile-time constant (such as [`Component`](#component)) or a call
to a constant constructor. See the [Dart Language Guide][metadata] for
details.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add a paragraph mentioning that in TypeScript, the equivalent term is decorator.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

The corresponding term in TypeScript and JavaScript is
[_decorator_](!{docsPath}/ts/latest/glossary.html#decorator).

[metadata]: https://www.dartlang.org/guides/language/language-tour#metadata

block bootstrap-defn-top
:marked
## snake_case
We launch an Angular application by "bootstrapping" it with the
[bootstrap][bootstrap] method. The `bootstrap` method identifies an
application's top level "root" [Component](#component) and optionally
registers service [providers](#provider) with the [dependency injection
system](#dependency-injection).

.l-sub-section
[bootstrap]: !{docsLatest}/api/angular2.platform.browser/bootstrap.html

block decorator-defn
:marked
When used in this guide, these JavaScript terms are taken as synonymous with
[annotation](#annotation).

block module-defn
//- Taken from the Dart Difference in guide/architecture.jade
:marked
The practice of writing compound words or phrases such that each word is separated by an
underscore (`_`).
In this guide, the term _module_ refers to a Dart compilation unit, such
as a library, or a package. (If a Dart file has no `library` or `part`
directive, then that file itself is a library and thus a compilation
unit.) For more information about compilation units, see
the chapter on "Libraries and Scripts" in the
[Dart Language Specification](https://www.dartlang.org/docs/spec/).

block routing-component-defn
:marked
A [Component](#component) with an attached router.

In most cases, the component became attached to a [router](#router) by means
of a `@RouterConfig` #{decorator} that defined routes to views controlled by this component.

The component's template has a `RouterOutlet` element where it can display views produced by the router.

It likely has anchor tags or buttons with `RouterLink` directives that users can click to navigate.

block append snake-case-defn
:marked
Library and file names are often spelled in snake_case. Examples include:
`angular2_tour_of_heroes` and `app_component.dart`.

This form is also known as **underscore case**.
block zone-defn
:marked
Zones are a mechanism for encapsulating and intercepting
a Dart application's asynchronous activity.

To learn more, consult the [zones article][zones].

!=partial(fragPath + 'glossary-n-s-2')
!=partial(fragPath + 'glossary-t1')
//partial(fragPath + 'glossary-t2') notneeded in dart
!=partial(fragPath + 'glossary-u-z')
[zones]: https://www.dartlang.org/articles/libraries/zones
2 changes: 1 addition & 1 deletion public/docs/dart/latest/guide/glossary.jade
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
extends ../glossary

block var-def
- var fragPath='../../../ts/latest/_fragments/';
include ../_util-fns
37 changes: 3 additions & 34 deletions public/docs/js/latest/glossary.jade
Original file line number Diff line number Diff line change
@@ -1,35 +1,4 @@
include _util-fns
// From ts/glossary.jade, the folder ts/latest/_fragments is generated which contains a bunch of partial files.
// These partials comprise the glossary,a subset of these partials should be used to generate the glossary for
// __javascript__ under BASICS.
!=partial('../../ts/latest/_fragments/glossary-intro')
//!=partial('../../ts/latest/_fragments/glossary-a-1') not needed in javascript
!=partial('../../ts/latest/_fragments/glossary-a-2')
!=partial('../../ts/latest/_fragments/glossary-b-c')
!=partial('../../ts/latest/_fragments/glossary-d1')
!=partial('../../ts/latest/_fragments/glossary-d2')
!=partial('../../ts/latest/_fragments/glossary-e1')
!=partial('../../ts/latest/_fragments/glossary-e2')
!=partial('../../ts/latest/_fragments/glossary-f-l')
!=partial('../../ts/latest/_fragments/glossary-m1')
!=partial('../../ts/latest/_fragments/glossary-m2')
!=partial('../../ts/latest/_fragments/glossary-n-s')
!=partial('../../ts/latest/_fragments/glossary-t1')
!=partial('../../ts/latest/_fragments/glossary-t2')
!=partial('../../ts/latest/_fragments/glossary-u-z')
extends ../../ts/latest/glossary.jade

// NOTE: (ericjim): I am almost certain these lines are doing nothing,
// so instead I use `!=partial` to include the glossary fragments.
//+includeShared('{ts}', 'intro')
//+includeShared('{ts}', 'a2')
//+includeShared('{ts}', 'b-c')
//+includeShared('{ts}', 'd1')
//+includeShared('{ts}', 'd2')
//+includeShared('{ts}', 'e1')
//+includeShared('{ts}', 'e2')
//+includeShared('{ts}', 'f-l')
//+includeShared('{ts}', 'm1')
//+includeShared('{ts}', 'n-s')
//+includeShared('{ts}', 't1')
//+includeShared('{ts}', 't2')
//+includeShared('{ts}', 'u-z')
block includes
include _util-fns
5 changes: 4 additions & 1 deletion public/docs/js/latest/guide/glossary.jade
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
!= partial("../glossary")
extends ../glossary

block var-def
include ../_util-fns
Loading