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

Commit 8d200f4

Browse files
committed
organization section now nonfiction; misc small edits
1 parent 263416c commit 8d200f4

File tree

4 files changed

+28
-31
lines changed

4 files changed

+28
-31
lines changed

public/_includes/_util-fns.jade

+10-6
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
33
//- _docsFor: used to identify the language this version of the docs if for;
44
//- Should be one of: 'ts', 'dart' or 'js'. Set in lang specific _util-fns file.
5-
- var _docsFor = '';
5+
- var _docsFor = '';
66

77
//- Should match `_docsFor`, but in this case provides the full capitalized
88
//- name of the language.
@@ -29,6 +29,10 @@
2929
- var _Promise = 'Promise';
3030
- var _Observable = 'Observable';
3131

32+
//- Location of sample code
33+
- var _liveLink = 'live link';
34+
35+
3236
//- Used to prefix identifiers that are private. In Dart this will be '_'.
3337
- var _priv = '';
3438

@@ -46,7 +50,7 @@ mixin adjExPath(path)
4650
| #{adjustExamplePath(path)}
4751
else
4852
| #{path}
49-
53+
5054
mixin includeShared(filePath, region)
5155
- var newPath = translatePath(filePath, region);
5256
!=partial(newPath)
@@ -69,8 +73,8 @@ mixin makeExample(_filePath, region, _title, stylePatterns)
6973
code-example(language="#{language}" format="#{format}")
7074
!= styleString(frag, stylePatterns)
7175

72-
//- Like makeExample, but the first argument is a path that is
73-
//- relative to the project root. Unless title is defined,
76+
//- Like makeExample, but the first argument is a path that is
77+
//- relative to the project root. Unless title is defined,
7478
//- the project relative path will be used.
7579
mixin makeProjExample(projRootRelativePath, region, title, stylePatterns)
7680
- var relPath = projRootRelativePath.trim();
@@ -83,7 +87,7 @@ mixin makeProjExample(projRootRelativePath, region, title, stylePatterns)
8387
+makeExample(filePath, region, title, stylePatterns)
8488

8589
//- Like makeExample, but doesn't show line numbers, and the first
86-
//- argument is a path that is relative to the example project root.
90+
//- argument is a path that is relative to the example project root.
8791
//- Unless title is defined, the project relative path will be used.
8892
//- Title will always end with a phrase in parentheses; if no such
8993
//- ending is given, then the title will be suffixed with
@@ -164,7 +168,7 @@ script.
164168
el.style.display = isVerbose ? 'block' : 'none';
165169
var el = document.querySelector('button.verbose.on');
166170
el.style.display = isVerbose ? 'none' : 'block';
167-
171+
168172
CCSStylesheetRuleStyle('main','.l-verbose-section', 'display',
169173
isVerbose ? 'block' : 'none');
170174
}

public/docs/dart/latest/_util-fns.jade

+3-2
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,14 @@ include ../../../_includes/_util-fns
1111
- var _Lang = 'Dart';
1212
- var _Promise = 'Future';
1313
- var _Observable = 'Stream';
14+
- var _liveLink = 'sample repo';
1415

1516
mixin liveExampleLink(linkText, exampleUrlPartName)
1617
a(href='https://angular-examples.github.io/#{exampleUrlPartName}' target="_blank")= linkText
1718

1819
mixin liveExampleLink2(linkText, exampleUrlPartName)
1920
- var liveExampleSourceLinkText = attributes.srcLinkText || 'view source'
20-
| #[+liveExampleLink(linkText, exampleUrlPartName)]
21+
| #[+liveExampleLink(linkText, exampleUrlPartName)]
2122
| (#[a(href='https://github.com/angular-examples/#{exampleUrlPartName}' target="_blank") #{liveExampleSourceLinkText}])
2223

2324
- var adjustExamplePath = function(_path) {
@@ -29,7 +30,7 @@ mixin liveExampleLink2(linkText, exampleUrlPartName)
2930
- var baseName = getBaseFileName(path) || path; // TODO: have getBaseFileName() return path
3031
- var baseNameNoExt = baseName.substr(0,baseName.length - (extn.length + 1));
3132
- var inWebFolder = baseNameNoExt.match(/^(main|index(\.\d)?)$/);
32-
- // Adjust the folder path, e.g., ts -> dart
33+
- // Adjust the folder path, e.g., ts -> dart
3334
- folder = folder.replace(/(^|\/)ts($|\/)/, '$1dart$2').replace(/(^|\/)app($|\/)/, inWebFolder ? '$1web$2' : '$1lib$2');
3435
- // Special case not handled above: e.g., index.html -> web/index.html
3536
- if(baseNameNoExt.match(/^(index|styles)(\.\d)?$/)) folder = (folder ? folder + '/' : '') + 'web';

public/docs/dart/latest/guide/index.jade

-5
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,3 @@ block example-links
1111
for the [Architecture](architecture.html) chapter's sample.
1212
A running version of that sample is at
1313
https://angular-examples.github.io/architecture/.
14-
15-
A few early chapters are written as tutorials and are clearly marked as such.
16-
Most chapters are *not* tutorials.
17-
They highlight key points in code rather than explain each step necessary to build the sample.
18-
We can still get the full source from the sample repo.

public/docs/ts/latest/guide/index.jade

+15-18
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,16 @@ figure
2727
table(width="100%")
2828
col(width="15%")
2929
col
30+
tr(style=top)
31+
td <b>QuickStart</b>
32+
td
33+
:marked
34+
The foundation for every chapter and sample in this documentation.
3035
tr(style=top)
3136
td <b>Tutorial</b>
3237
td
3338
:marked
34-
A step-by-step, immersive approach to learning Angular.
35-
It begins with the [QuickStart](../quickstart.html),
36-
the foundation for every chapter and sample in this documentation,
37-
followed by the [*Tour of Heroes* tutorial](../tutorial) that
39+
A step-by-step, immersive approach to learning Angular that
3840
introduces the major features of Angular in an application context.
3941
tr(style=top)
4042
td <b>Basics</b>
@@ -52,16 +54,10 @@ table(width="100%")
5254
:marked
5355
Recipes for specific application challenges, mostly code snippets with a minimum of exposition.
5456
tr(style=top)
55-
td <b>Reference</b>
57+
td <b>API Reference</b>
5658
td
5759
:marked
58-
Angular-specific reference material, most notably the [API Guide](../api)
59-
with its authoritative details about each member in the Angular libraries.
60-
tr(style=top)
61-
td <b>Resources</b>
62-
td
63-
:marked
64-
Other places to go for help and information.
60+
Authoritative details about each member of the Angular libraries.
6561
:marked
6662
# Learning path
6763
We don't have to read the guide straight through. Most chapters stand on their own.
@@ -108,18 +104,19 @@ block example-links
108104

109105
The link launches a browser-based code editor where we can inspect, modify, save, and download the code.
110106

111-
A few early chapters are written as tutorials and are clearly marked as such.
112-
Most chapters are *not* tutorials.
113-
They highlight key points in code rather than explain each step necessary to build the sample.
114-
We can always get the full source by way of the live link.
107+
:marked
108+
A few early chapters are written as tutorials and are clearly marked as such.
109+
Most chapters are *not* tutorials.
110+
They highlight key points in code rather than explain each step necessary to build the sample.
111+
We can always get the full source by way of the #{_liveLink}.
115112

116-
## References
113+
# Reference pages
117114

118115
The [Cheat Sheet](cheatsheet.html) lists Angular syntax for common scenarios.
119116

120117
The [Glossary](glossary.html) defines terms that Angular developers should know.
121118

122-
The [API Guide](../api/) is the authority on every public-facing member of the Angular libraries.
119+
The [API Reference](../api/) is the authority on every public-facing member of the Angular libraries.
123120

124121
# Feedback
125122

0 commit comments

Comments
 (0)