From 0e33c075e7eabd106ccaa7956c788991a3c823af Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Sat, 3 Sep 2016 14:02:46 -0700 Subject: [PATCH] docs(*): misc fixes to prose in support of jade2ng MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixes to prose “syntax”. Anomalies detected by jade2ng. Also updated the main _utils-fn.jade in support of jade2ng as well. --- public/_includes/_util-fns.jade | 112 +++++++++--------- .../cookbook/component-communication.jade | 4 +- .../latest/cookbook/visual-studio-2015.jade | 2 +- .../ts/latest/guide/server-communication.jade | 4 +- public/docs/ts/latest/guide/webpack.jade | 2 +- public/docs/ts/latest/quickstart.jade | 4 +- 6 files changed, 64 insertions(+), 64 deletions(-) diff --git a/public/_includes/_util-fns.jade b/public/_includes/_util-fns.jade index 1221883491..c667f8d925 100644 --- a/public/_includes/_util-fns.jade +++ b/public/_includes/_util-fns.jade @@ -154,64 +154,66 @@ mixin makeJson( filePath, jsonConfig, title, stylePatterns) else != styleString(jsonExtract, stylePatterns) -- // Open (and close) an explanation
. 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
. 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') @@ -298,7 +300,7 @@ script. - } else { - // ``` gets translated to 
.....
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; diff --git a/public/docs/ts/latest/cookbook/component-communication.jade b/public/docs/ts/latest/cookbook/component-communication.jade index da69eb5b15..e2d28b0672 100644 --- a/public/docs/ts/latest/cookbook/component-communication.jade +++ b/public/docs/ts/latest/cookbook/component-communication.jade @@ -172,9 +172,7 @@ figure.image-display :marked [Back to top](#top) -parent-to-child-local-var -.l-main-section - +.l-main-section#parent-to-child-local-var :marked ## Parent interacts with child via *local variable* diff --git a/public/docs/ts/latest/cookbook/visual-studio-2015.jade b/public/docs/ts/latest/cookbook/visual-studio-2015.jade index db6562670c..ce6e4b5cad 100644 --- a/public/docs/ts/latest/cookbook/visual-studio-2015.jade +++ b/public/docs/ts/latest/cookbook/visual-studio-2015.jade @@ -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’*" and + Compiler errors such as "*Property `map` does not exist on type `Observable`*" 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). diff --git a/public/docs/ts/latest/guide/server-communication.jade b/public/docs/ts/latest/guide/server-communication.jade index 54dda5372a..e7be54e2ed 100644 --- a/public/docs/ts/latest/guide/server-communication.jade +++ b/public/docs/ts/latest/guide/server-communication.jade @@ -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 @@ -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` we can turn it into a - [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) if we prefer. + [`Promise`](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 diff --git a/public/docs/ts/latest/guide/webpack.jade b/public/docs/ts/latest/guide/webpack.jade index b5a2fb6875..3569b2bed8 100644 --- a/public/docs/ts/latest/guide/webpack.jade +++ b/public/docs/ts/latest/guide/webpack.jade @@ -431,7 +431,7 @@ code-example(format=""). p. The app.component.html displays this downloadable Angular logo - . + . +makeTabs( diff --git a/public/docs/ts/latest/quickstart.jade b/public/docs/ts/latest/quickstart.jade index 3ec32713df..bd966294be 100644 --- a/public/docs/ts/latest/quickstart.jade +++ b/public/docs/ts/latest/quickstart.jade @@ -26,7 +26,7 @@ h1 Overview aside.is-right :marked - The live example link opens the finished application in + The live example link opens the finished application in Plunker so that you can interact with the code. You'll find live examples at the start of most sections. @@ -48,7 +48,7 @@ h2 Build this application! :marked - [Prerequisite](#prereq): Install #{_prereq}. - [Step 1](#create-and-configure): Create and configure the project. -
  • [Step 2](#ngmodule): Create your application.
    • +
  • [Step 2](#ngmodule): Create your application. - [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.