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

docs(*): misc fixes to prose in support of jade2ng #2266

Merged
merged 1 commit into from
Sep 6, 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
112 changes: 57 additions & 55 deletions public/_includes/_util-fns.jade
Original file line number Diff line number Diff line change
Expand Up @@ -154,64 +154,66 @@ mixin makeJson( filePath, jsonConfig, title, stylePatterns)
else
!= styleString(jsonExtract, stylePatterns)

- // Open (and close) an explanation <div>. See QuickStart
script.
function why(id, backTo) {
var id = "#"+id;
var el = document.querySelector(id);
el.hidden=el.hidden=!el.hidden;

if (el.hidden && backTo){
// the next line is required to work around a bug in WebKit (Chrome / Safari)
location.href = "#";
location.href = "#" + backTo;
if !jade2ng
//- Open (and close) an explanation <div>. See QuickStart
script.
function why(id, backTo) {
var id = "#"+id;
var el = document.querySelector(id);
el.hidden=el.hidden=!el.hidden;

if (el.hidden && backTo){
// the next line is required to work around a bug in WebKit (Chrome / Safari)
location.href = "#";
location.href = "#" + backTo;
}
}
script.
function verbose(isVerbose) {
isVerbose = !! isVerbose;
var el = document.querySelector('button.verbose.off');
el.style.display = isVerbose ? 'block' : 'none';
var el = document.querySelector('button.verbose.on');
el.style.display = isVerbose ? 'none' : 'block';

CCSStylesheetRuleStyle('main','.l-verbose-section', 'display',
isVerbose ? 'block' : 'none');
}
}
script.
function verbose(isVerbose) {
isVerbose = !! isVerbose;
var el = document.querySelector('button.verbose.off');
el.style.display = isVerbose ? 'block' : 'none';
var el = document.querySelector('button.verbose.on');
el.style.display = isVerbose ? 'none' : 'block';

CCSStylesheetRuleStyle('main','.l-verbose-section', 'display',
isVerbose ? 'block' : 'none');
}

script.
function CCSStylesheetRuleStyle(stylesheet, selectorText, style, value){
/* returns the value of the element style of the rule in the stylesheet
* If no value is given, reads the value
* If value is given, the value is changed and returned
* If '' (empty string) is given, erases the value.
* The browser will apply the default one
*
* string stylesheet: part of the .css name to be recognized, e.g. 'default'
* string selectorText: css selector, e.g. '#myId', '.myClass', 'thead td'
* string style: camelCase element style, e.g. 'fontSize'
* string value optional : the new value
*/
var CCSstyle = undefined, rules, sheet;
for(var m in document.styleSheets){
sheet = document.styleSheets[m];
if(sheet.href && sheet.href.indexOf(stylesheet) != -1){
rules = sheet[document.all ? 'rules' : 'cssRules'];
for(var n in rules){
console.log(rules[n].selectorText);
if(rules[n].selectorText == selectorText){
CCSstyle = rules[n].style;
break;

script.
function CCSStylesheetRuleStyle(stylesheet, selectorText, style, value){
/* returns the value of the element style of the rule in the stylesheet
* If no value is given, reads the value
* If value is given, the value is changed and returned
* If '' (empty string) is given, erases the value.
* The browser will apply the default one
*
* string stylesheet: part of the .css name to be recognized, e.g. 'default'
* string selectorText: css selector, e.g. '#myId', '.myClass', 'thead td'
* string style: camelCase element style, e.g. 'fontSize'
* string value optional : the new value
*/
var CCSstyle = undefined, rules, sheet;
for(var m in document.styleSheets){
sheet = document.styleSheets[m];
if(sheet.href && sheet.href.indexOf(stylesheet) != -1){
rules = sheet[document.all ? 'rules' : 'cssRules'];
for(var n in rules){
console.log(rules[n].selectorText);
if(rules[n].selectorText == selectorText){
CCSstyle = rules[n].style;
break;
}
}
break;
}
}
break;
}
if(value == undefined)
return CCSstyle[style]
else
return CCSstyle[style] = value
}
if(value == undefined)
return CCSstyle[style]
else
return CCSstyle[style] = value
}

//---------------------------------------------------------------------------------------------------------
//- Converts the given project-relative path (like 'app/main.ts')
//- to a doc folder relative path (like 'quickstart/ts/app/main.ts')
Expand Down Expand Up @@ -298,7 +300,7 @@ script.
- } else {
- // ``` gets translated to <pre><code>.....</code></pre> and we need
- // to remove this from the fragment prefix is 11 long and suffix is 13 long
- frag = frag.substring(11, frag.length-13);
- frag = jade2ng ? frag : frag.substring(11, frag.length-13);
- // Uncomment next line for debugging.
- // frag = "FileName: " + fullFileName + " Current path: " + current.path + " PathToDocs: " + getPathToDocs() + "\n" + frag;
- return frag;
Expand Down
4 changes: 1 addition & 3 deletions public/docs/ts/latest/cookbook/component-communication.jade
Original file line number Diff line number Diff line change
Expand Up @@ -172,9 +172,7 @@ figure.image-display
:marked
[Back to top](#top)

parent-to-child-local-var
.l-main-section
<a id="parent-to-child-local-var"></a>
.l-main-section#parent-to-child-local-var
:marked
## Parent interacts with child via *local variable*

Expand Down
2 changes: 1 addition & 1 deletion public/docs/ts/latest/cookbook/visual-studio-2015.jade
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ h2#build-and-run Step 7: Build and run the app

.alert.is-important
:marked
Compiler errors such as "*Property map does not exist on type Observable<Response>*" and
Compiler errors such as "*Property `map` does not exist on type `Observable<Response>`*" and
"*Observable cannot be found*" indicate an old release of Visual Studio.
Exit Visual Studio and follow the [instructions here](https://github.com/Microsoft/TypeScript/issues/8518).

Expand Down
4 changes: 2 additions & 2 deletions public/docs/ts/latest/guide/server-communication.jade
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ a#HeroService
:marked
Let's return to our study of the `HeroService`.

l-main-section
.l-main-section
a#extract-data
:marked
## Process the response object
Expand Down Expand Up @@ -410,7 +410,7 @@ block hero-list-comp-add-hero
h2#promises Fall back to Promises
:marked
Although the Angular `http` client API returns an `Observable<Response>` we can turn it into a
[Promise<Response>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) if we prefer.
[`Promise<Response>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) if we prefer.
It's easy to do and a promise-based version looks much like the observable-based version in simple cases.
.l-sub-section
:marked
Expand Down
2 changes: 1 addition & 1 deletion public/docs/ts/latest/guide/webpack.jade
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ code-example(format="").
p.
The <code>app.component.html</code> displays this downloadable Angular logo
<a href="https://raw.githubusercontent.com/angular/angular.io/master/public/resources/images/logos/angular2/angular.png" target="_blank">
<img src="https://raw.githubusercontent.com/angular/angular.io/master/public/resources/images/logos/angular2/angular.png" height="40px" title="download Angular logo"></a>.
<img src="/resources/images/logos/angular2/angular.png" height="40px" title="download Angular logo"></a>.


+makeTabs(
Expand Down
4 changes: 2 additions & 2 deletions public/docs/ts/latest/quickstart.jade
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ h1 Overview

aside.is-right
:marked
The live example link opens the finished application <span if-docs="ts"> in
The live example link opens the finished application in
<a href="http://plnkr.co/" title="Plunker" target="_blank">Plunker</a> so that you can interact
with the code. You'll find live examples at the start of most sections.

Expand All @@ -48,7 +48,7 @@ h2 Build this application!
:marked
- [Prerequisite](#prereq): Install #{_prereq}.
- [Step 1](#create-and-configure): Create and configure the project.
<li if-docs="ts">[Step 2](#ngmodule): Create your application.</li>
<span if-docs="ts"><li>[Step 2](#ngmodule): Create your application.</span>
- [Step !{step++}](#root-component): Create a component and add it to your application.
- [Step !{step++}](#main): Start up your application.
- [Step !{step++}](#index): Define the web page that hosts the application.
Expand Down