diff options
| author | Igor Minar | 2010-11-05 21:12:37 -0700 |
|---|---|---|
| committer | Igor Minar | 2010-11-09 22:27:31 -0800 |
| commit | 324694a58b6d0ed33e05b511be4767573d9187dd (patch) | |
| tree | 0b7243e721da17e9b5c5a1111ed9c0d28829b309 | |
| parent | effcd340e9d41a2ab8368e4de06a1a83a206ac32 (diff) | |
| download | angular.js-324694a58b6d0ed33e05b511be4767573d9187dd.tar.bz2 | |
Better example widget
- syntax highlighting
- tabless design
- rename widget to doc:example
- rename widget files (wiki_widget.* -> doc_widget.*)
- example section is now optional
| -rw-r--r-- | docs/collect.js | 4 | ||||
| -rw-r--r-- | docs/doc_widgets.css | 36 | ||||
| -rw-r--r-- | docs/doc_widgets.js | 49 | ||||
| -rw-r--r-- | docs/filter.template | 15 | ||||
| -rw-r--r-- | docs/formatter.template | 15 | ||||
| -rw-r--r-- | docs/index.html | 12 | ||||
| -rw-r--r-- | docs/overview.template | 15 | ||||
| -rw-r--r-- | docs/validator.template | 14 | ||||
| -rw-r--r-- | docs/widget.template | 15 | ||||
| -rw-r--r-- | docs/wiki_widgets.css | 58 | ||||
| -rw-r--r-- | docs/wiki_widgets.js | 51 | ||||
| -rw-r--r-- | src/Angular.js | 26 | ||||
| -rw-r--r-- | src/formatters.js | 4 | ||||
| -rw-r--r-- | src/validators.js | 26 | ||||
| -rw-r--r-- | src/widgets.js | 10 |
15 files changed, 189 insertions, 161 deletions
diff --git a/docs/collect.js b/docs/collect.js index 04735985..acfdf008 100644 --- a/docs/collect.js +++ b/docs/collect.js @@ -42,8 +42,8 @@ var work = callback.chain(function () { copy('docs-scenario.html', callback.chain()); copy('index.html', callback.chain()); mergeTemplate('docs.js', 'docs.js', documentation, callback.chain()); - mergeTemplate('wiki_widgets.css', 'wiki_widgets.css', documentation, callback.chain()); - mergeTemplate('wiki_widgets.js', 'wiki_widgets.js', documentation, callback.chain()); + mergeTemplate('doc_widgets.css', 'doc_widgets.css', documentation, callback.chain()); + mergeTemplate('doc_widgets.js', 'doc_widgets.js', documentation, callback.chain()); console.log('DONE'); }); if (!this.testmode) work(); diff --git a/docs/doc_widgets.css b/docs/doc_widgets.css new file mode 100644 index 00000000..f4ef70bd --- /dev/null +++ b/docs/doc_widgets.css @@ -0,0 +1,36 @@ +@namespace doc url("http://docs.angularjs.org/"); + +doc\:example { + display: none; +} + +ul.doc-example { + list-style-type: none; + position: relative; + width: 700px; + font-size: 14px; +} + +ul.doc-example > li { + border: 2px solid gray; + border-radius: 5px; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + background-color: white; + margin-bottom: 20px; +} + +ul.doc-example > li.doc-example-heading { + border: none; + border-radius: none; + margin-bottom: -10px; +} + +li.doc-example-live { + padding: 10px; + font-size: 1.2em; +} + +div.syntaxhighlighter { + padding-bottom: 1px !important; /* fix to remove unnecessary scrollbars http://is.gd/gSMgC */ +}
\ No newline at end of file diff --git a/docs/doc_widgets.js b/docs/doc_widgets.js new file mode 100644 index 00000000..7d723bb3 --- /dev/null +++ b/docs/doc_widgets.js @@ -0,0 +1,49 @@ +(function(){ + var HTML_TEMPLATE = + '<!DOCTYPE HTML>\n' + + '<html xmlns:ng="http://angularjs.org">\n' + + ' <head>\n' + + ' <title>Angular Example</title>\n' + + ' <script type="text/javascript"\n' + + ' src="../angular.js" ng:autobind></script>\n' + + ' </head>\n' + + ' <body>\n' + + '_HTML_SOURCE_\n' + + ' </body>\n' + + '</html>'; + + angular.widget('doc:example', function(element){ + this.descend(true); //compile the example code + element.hide(); + + var example = element.find('doc\\:source').eq(0), + exampleSrc = example.text(), + scenario = element.find('doc\\:scenario').eq(0); + + var tabs = angular.element( + '<ul class="doc-example">' + + '<li class="doc-example-heading"><h3>Source</h3></li>' + + '<li class="doc-example-source" ng:non-bindable><pre class="brush: js"></pre></li>' + + '<li class="doc-example-heading"><h3>Live Preview</h3></li>' + + '<li class="doc-example-live">' + exampleSrc +'</li>' + + '<li class="doc-example-heading"><h3>Scenario Test</h3></li>' + + '<li class="doc-example-scenario"><pre class="brush: js">' + scenario.text() + '</pre></li>' + + '</ul>'); + tabs.find('li.doc-example-source > pre').text(exampleSrc); + + element.html(''); + element.append(tabs); + element.show(); + + var script = (exampleSrc.match(/<script[^\>]*>([\s\S]*)<\/script>/) || [])[1] || ''; + try { + eval(script); + } catch (e) { + alert(e); + } + + return function() { + SyntaxHighlighter.highlight(); + } + }); +})();
\ No newline at end of file diff --git a/docs/filter.template b/docs/filter.template index 9375f422..4875798e 100644 --- a/docs/filter.template +++ b/docs/filter.template @@ -28,6 +28,15 @@ angular.filter.{{shortName}}({{paramFirst.name}}{{#paramRest}}, {{name}}{{/param <h3>CSS</h3> {{{css}}} -<WIKI:SOURCE style="display:block;"> -{{{example}}} -</WIKI:SOURCE>
\ No newline at end of file +{{#example}} +<h2>Example</h2> +{{{exampleDescription}}} +<doc:example> + <doc:source> +{{/example}} + {{{example}}} +{{#example}} + </doc:source> + <doc:scenario>{{{scenario}}}</doc:scenario> +</doc:example> +{{/example}} diff --git a/docs/formatter.template b/docs/formatter.template index 19611ca1..dd8fcb99 100644 --- a/docs/formatter.template +++ b/docs/formatter.template @@ -19,6 +19,15 @@ var modelValue = angular.formatter.{{shortName}}.parse(userInputString); <h3>CSS</h3> {{{css}}} -<WIKI:SOURCE style="display:block;"> -{{{example}}} -</WIKI:SOURCE>
\ No newline at end of file +{{#example}} +<h2>Example</h2> +{{{exampleDescription}}} +<doc:example> + <doc:source> +{{/example}} + {{{example}}} +{{#example}} + </doc:source> + <doc:scenario>{{{scenario}}}</doc:scenario> +</doc:example> +{{/example}} diff --git a/docs/index.html b/docs/index.html index 2f5a8234..07eac809 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,12 +1,18 @@ <!DOCTYPE HTML> -<html xmlns:ng="http://angularjs.org" wiki:ng="http://angularjs.org"> +<html xmlns:ng="http://angularjs.org/" xmlns:doc="http://docs.angularjs.org/"> <head> <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.4.3/jquery.min.js"></script> <script type="text/javascript" src="docs-data.js"></script> <script type="text/javascript" src="../angular.min.js" ng:autobind></script> - <script type="text/javascript" src="wiki_widgets.js"></script> - <link rel="stylesheet" href="wiki_widgets.css" type="text/css" media="screen" /> + <script type="text/javascript" src="doc_widgets.js"></script> + <link rel="stylesheet" href="doc_widgets.css" type="text/css" media="screen" /> + <script type="text/javascript" src="http://alexgorbatchev.com/pub/sh/current/scripts/shCore.js"></script> + <script type="text/javascript" src="http://alexgorbatchev.com/pub/sh/current/scripts/shBrushJScript.js"></script> + <link rel="stylesheet" href="http://alexgorbatchev.com/pub/sh/current/styles/shCore.css" type="text/css" media="screen" /> + <link rel="stylesheet" href="http://alexgorbatchev.com/pub/sh/current/styles/shThemeDefault.css" type="text/css" media="screen" /> <script type="text/javascript"> + SyntaxHighlighter['defaults'].toolbar = false; + function DocsController() { this.docs = NG_DOC; window.$root = this.$root; diff --git a/docs/overview.template b/docs/overview.template index f7540999..6207d41b 100644 --- a/docs/overview.template +++ b/docs/overview.template @@ -1,6 +1,15 @@ <h1><tt>{{name}}</tt></h1> {{{description}}} -{{#example}}<WIKI:SOURCE style="display:block;">{{/example}} -{{{example}}} -{{#example}}</WIKI:SOURCE>{{/example}} +{{#example}} +<h2>Example</h2> +{{{exampleDescription}}} +<doc:example> + <doc:source> +{{/example}} + {{{example}}} +{{#example}} + </doc:source> + <doc:scenario>{{{scenario}}}</doc:scenario> +</doc:example> +{{/example}} diff --git a/docs/validator.template b/docs/validator.template index 2d5d4bc9..124f35b9 100644 --- a/docs/validator.template +++ b/docs/validator.template @@ -25,9 +25,15 @@ angular.validator.{{shortName}}({{paramFirst.name}}{{#paramRest}}{{^default}}, { <h3>CSS</h3> {{{css}}} +{{#example}} <h2>Example</h2> {{{exampleDescription}}} - -<WIKI:SOURCE style="display:block;"> -{{{example}}} -</WIKI:SOURCE>
\ No newline at end of file +<doc:example> + <doc:source> +{{/example}} + {{{example}}} +{{#example}} + </doc:source> + <doc:scenario>{{{scenario}}}</doc:scenario> +</doc:example> +{{/example}} diff --git a/docs/widget.template b/docs/widget.template index f07bd9b2..9b280775 100644 --- a/docs/widget.template +++ b/docs/widget.template @@ -25,6 +25,15 @@ <h3>CSS</h3> {{{css}}} -<WIKI:SOURCE style="display:block;"> -{{{example}}} -</WIKI:SOURCE>
\ No newline at end of file +{{#example}} +<h2>Example</h2> +{{{exampleDescription}}} +<doc:example> + <doc:source> +{{/example}} + {{{example}}} +{{#example}} + </doc:source> + <doc:scenario>{{{scenario}}}</doc:scenario> +</doc:example> +{{/example}} diff --git a/docs/wiki_widgets.css b/docs/wiki_widgets.css deleted file mode 100644 index a1f6e939..00000000 --- a/docs/wiki_widgets.css +++ /dev/null @@ -1,58 +0,0 @@ -WIKI\:SOURCE, -WIKI\:SOURCE>ul.tabs, -WIKI\:SOURCE>ul.tabs>li { - display: block; - margin: 0; - padding: 0; -} -WIKI\:SOURCE>ul.tabs { - margin: 0 !important; - padding: 0 !important; -} - -WIKI\:SOURCE > ul.tabs > li.tab { - margin: 0 0 0 .8em !important; - display: inline-block; - border: 1px solid gray; - padding: .1em .8em .4em .8em !important; - -moz-border-radius-topleft: 5px; - -moz-border-radius-topright: 5px; - -webkit-border-top-left-radius: 5px; - -webkit-border-top-right-radius: 5px; - border-bottom: none; - cursor: pointer; - background-color: lightgray; - margin-bottom: -2px; - position: relative; - z-index: 0; -} - -WIKI\:SOURCE > ul.tabs > li.tab.selected { - z-index: 2; - background-color: white; - font-weight: bold; - border-width: 2px; -} - -WIKI\:SOURCE > ul.tabs > li.pane { - border: 2px solid gray; - border-radius: 5px; - -moz-border-radius: 5px; - -webkit-border-radius: 5px; - background-color: white; - padding: 5px !important; -} - -WIKI\:SOURCE > ul.tabs > li.pane { - display:none; -} - -WIKI\:SOURCE > ul.tabs > li.pane.selected { - position: relative; - z-index: 1; - display:block; -} -WIKI\:SOURCE > ul.tabs > li.pane.source { - font-size: .8em !important; -} -//////////////////
\ No newline at end of file diff --git a/docs/wiki_widgets.js b/docs/wiki_widgets.js deleted file mode 100644 index 771d3f8c..00000000 --- a/docs/wiki_widgets.js +++ /dev/null @@ -1,51 +0,0 @@ -(function(){ - var HTML_TEMPLATE = - '<!DOCTYPE HTML>\n' + - '<html xmlns:ng="http://angularjs.org">\n' + - ' <head>\n' + - ' <script type="text/javascript"\n' + - ' src="http://angularjs.org/ng/js/angular-debug.js" ng:autobind></script>\n' + - ' </head>\n' + - ' <body>\n' + - '_HTML_SOURCE_\n' + - ' </body>\n' + - '</html>'; - - angular.widget('WIKI:SOURCE', function(element){ - this.descend(true); - var html = element.text(); - element.show(); - var tabs = angular.element( - '<ul class="tabs">' + - '<li class="tab selected" to="angular"><angular/></li>' + - '<li class="tab" to="plain">plain</li>' + - '<li class="tab" to="source">source</li>' + - '<li class="pane selected angular example">' + html + '</li>' + - '<li class="pane plain" ng:non-bindable>' + html + '</li>' + - '<li class="pane source" ng:non-bindable><pre class="brush: js; html-script: true"></pre></li>' + - '</ul>'); - var pre = tabs. - find('>li.source>pre'). - text(HTML_TEMPLATE.replace('_HTML_SOURCE_', html)); - var color = element.attr('color') || 'white'; - element.html(''); - element.append(tabs); - element.find('>ul.tabs>li.pane').css('background-color', color); - var script = (html.match(/<script[^\>]*>([\s\S]*)<\/script>/) || [])[1] || ''; - try { - eval(script); - } catch (e) { - alert(e); - } - return function(element){ - element.find('>ul.tabs>li.tab').click(function(){ - if ($(this).is(".selected")) return; - element. - find('>ul.tabs>li.selected'). - add(this). - add(element.find('>ul>li.pane.' + angular.element(this).attr('to'))). - toggleClass('selected'); - }); - }; - }); -})();
\ No newline at end of file diff --git a/src/Angular.js b/src/Angular.js index 9934b401..985d7bc4 100644 --- a/src/Angular.js +++ b/src/Angular.js @@ -165,9 +165,11 @@ var _undefined = undefined, * # Syntax * Attach a validator on user input widgets using the `ng:validate` attribute. * - * <WIKI:SOURCE> + * <doc:example> + * <doc:source> * Change me: <input type="text" name="number" ng:validate="integer" value="123"> - * </WIKI:SOURCE> + * </doc:source> + * </doc:example> * * # Writing your own Validators * Writing your own validator is easy. To make a function available as a @@ -255,6 +257,11 @@ var _undefined = undefined, * the DOM in addition to transforming the input. * * + * @exampleDescription + * The following example filter reverses a text string. In addition, it conditionally makes the + * text upper-case (to demonstrate optional arguments) and assigns color (to demonstrate DOM + * modification). + * * @example <script type="text/javascript"> angular.filter('reverse', function(input, uppercase, color) { @@ -271,11 +278,6 @@ var _undefined = undefined, return out; }); </script> - The following example filter reverses a text string. In addition, it conditionally makes the - text upper-case (to demonstrate optional arguments) and assigns color (to demonstrate DOM - modification). - - <hr/> <span ng:non-bindable="true">{{"hello"|reverse}}</span>: {{"hello"|reverse}}<br> <span ng:non-bindable="true">{{"hello"|reverse:true}}</span>: {{"hello"|reverse:true}}<br> <span ng:non-bindable="true">{{"hello"|reverse:true:"blue"}}</span>: @@ -340,20 +342,22 @@ var _undefined = undefined, * } * }); * </script> + * * Formatted: <input type="text" name="data" value="<angular/>" ng:format="reverse"/><br/> * Stored: <input type="text" name="data"/><br/> * <pre>{{data}}</pre> + * * * @scenario * it('should store reverse', function(){ - * expect(element('.example :input:first').val()).toEqual('<angular/>'); - * expect(element('.example :input:last').val()).toEqual('>/RALUGNA<'); + * expect(element('.doc-example input:first').val()).toEqual('<angular/>'); + * expect(element('.doc-example input:last').val()).toEqual('>/RALUGNA<'); * * this.addFutureAction('change to XYZ', function($window, $document, done){ - * $document.elements('.example :input:last').val('XYZ').trigger('change'); + * $document.elements('.doc-example input:last').val('XYZ').trigger('change'); * done(); * }); - * expect(element('.example :input:first').val()).toEqual('zyx'); + * expect(element('input:first').val()).toEqual('zyx'); * }); */ angularFormatter = extensionMap(angular, 'formatter'), diff --git a/src/formatters.js b/src/formatters.js index 5c602cc8..38175d7d 100644 --- a/src/formatters.js +++ b/src/formatters.js @@ -103,7 +103,7 @@ angularFormatter.number = formatter(toString, function(obj){ * it('should format lists', function(){ * expect(binding('value')).toEqual('value=["chair","table"]'); * this.addFutureAction('change to XYZ', function($window, $document, done){ - * $document.elements('.example :input:last').val(',,a,b,').trigger('change'); + * $document.elements('.doc-example :input:last').val(',,a,b,').trigger('change'); * done(); * }); * expect(binding('value')).toEqual('value=["a","b"]'); @@ -140,7 +140,7 @@ angularFormatter.list = formatter( * it('should format trim', function(){ * expect(binding('value')).toEqual('value="book"'); * this.addFutureAction('change to XYZ', function($window, $document, done){ - * $document.elements('.example :input:last').val(' text ').trigger('change'); + * $document.elements('.doc-example :input:last').val(' text ').trigger('change'); * done(); * }); * expect(binding('value')).toEqual('value="text"'); diff --git a/src/validators.js b/src/validators.js index 9715be59..f4874e68 100644 --- a/src/validators.js +++ b/src/validators.js @@ -17,7 +17,7 @@ extend(angularValidator, { * * @scenario * it('should invalidate non ssn', function(){ - * var textBox = element('.example :input'); + * var textBox = element('.doc-example :input'); * expect(textBox.attr('className')).not().toMatch(/ng-validation-error/); * expect(textBox.val()).toEqual('123-45-6789'); * @@ -54,17 +54,17 @@ extend(angularValidator, { * * @scenario * it('should invalidate number', function(){ - * var n1 = element('.example :input[name=n1]'); + * var n1 = element('.doc-example :input[name=n1]'); * expect(n1.attr('className')).not().toMatch(/ng-validation-error/); * input('n1').enter('1.x'); * expect(n1.attr('className')).toMatch(/ng-validation-error/); * - * var n2 = element('.example :input[name=n2]'); + * var n2 = element('.doc-example :input[name=n2]'); * expect(n2.attr('className')).not().toMatch(/ng-validation-error/); * input('n2').enter('9'); * expect(n2.attr('className')).toMatch(/ng-validation-error/); * - * var n3 = element('.example :input[name=n3]'); + * var n3 = element('.doc-example :input[name=n3]'); * expect(n3.attr('className')).not().toMatch(/ng-validation-error/); * input('n3').enter('201'); * expect(n3.attr('className')).toMatch(/ng-validation-error/); @@ -106,17 +106,17 @@ extend(angularValidator, { * * @scenario * it('should invalidate integer', function(){ - * var n1 = element('.example :input[name=n1]'); + * var n1 = element('.doc-example :input[name=n1]'); * expect(n1.attr('className')).not().toMatch(/ng-validation-error/); * input('n1').enter('1.1'); * expect(n1.attr('className')).toMatch(/ng-validation-error/); * - * var n2 = element('.example :input[name=n2]'); + * var n2 = element('.doc-example :input[name=n2]'); * expect(n2.attr('className')).not().toMatch(/ng-validation-error/); * input('n2').enter('10.1'); * expect(n2.attr('className')).toMatch(/ng-validation-error/); * - * var n3 = element('.example :input[name=n3]'); + * var n3 = element('.doc-example :input[name=n3]'); * expect(n3.attr('className')).not().toMatch(/ng-validation-error/); * input('n3').enter('100.1'); * expect(n3.attr('className')).toMatch(/ng-validation-error/); @@ -148,7 +148,7 @@ extend(angularValidator, { * * @scenario * it('should invalidate date', function(){ - * var n1 = element('.example :input'); + * var n1 = element('.doc-example :input'); * expect(n1.attr('className')).not().toMatch(/ng-validation-error/); * input('text').enter('123/123/123'); * expect(n1.attr('className')).toMatch(/ng-validation-error/); @@ -180,7 +180,7 @@ extend(angularValidator, { * * @scenario * it('should invalidate email', function(){ - * var n1 = element('.example :input'); + * var n1 = element('.doc-example :input'); * expect(n1.attr('className')).not().toMatch(/ng-validation-error/); * input('text').enter('a@b.c'); * expect(n1.attr('className')).toMatch(/ng-validation-error/); @@ -209,7 +209,7 @@ extend(angularValidator, { * * @scenario * it('should invalidate phone', function(){ - * var n1 = element('.example :input'); + * var n1 = element('.doc-example :input'); * expect(n1.attr('className')).not().toMatch(/ng-validation-error/); * input('text').enter('+12345678'); * expect(n1.attr('className')).toMatch(/ng-validation-error/); @@ -241,7 +241,7 @@ extend(angularValidator, { * * @scenario * it('should invalidate url', function(){ - * var n1 = element('.example :input'); + * var n1 = element('.doc-example :input'); * expect(n1.attr('className')).not().toMatch(/ng-validation-error/); * input('text').enter('abc://server/path'); * expect(n1.attr('className')).toMatch(/ng-validation-error/); @@ -271,7 +271,7 @@ extend(angularValidator, { * * @scenario * it('should invalidate json', function(){ - * var n1 = element('.example :input'); + * var n1 = element('.doc-example :input'); * expect(n1.attr('className')).not().toMatch(/ng-validation-error/); * input('json').enter('{name}'); * expect(n1.attr('className')).toMatch(/ng-validation-error/); @@ -344,7 +344,7 @@ extend(angularValidator, { * * @scenario * it('should change color in delayed way', function(){ - * var textBox = element('.example :input'); + * var textBox = element('.doc-example :input'); * expect(textBox.attr('className')).not().toMatch(/ng-input-indicator-wait/); * expect(textBox.attr('className')).not().toMatch(/ng-validation-error/); * diff --git a/src/widgets.js b/src/widgets.js index 43a16c8c..3666486d 100644 --- a/src/widgets.js +++ b/src/widgets.js @@ -398,15 +398,15 @@ angularWidget('option', function(){ * * @scenario * it('should load date filter', function(){ - * expect(element('.example ng\\:include').text()).toMatch(/angular\.filter\.date/); + * expect(element('.doc-example ng\\:include').text()).toMatch(/angular\.filter\.date/); * }); * it('should change to hmtl filter', function(){ * select('url').option('angular.filter.html.html'); - * expect(element('.example ng\\:include').text()).toMatch(/angular\.filter\.html/); + * expect(element('.doc-example ng\\:include').text()).toMatch(/angular\.filter\.html/); * }); * it('should change to blank', function(){ * select('url').option('(blank)'); - * expect(element('.example ng\\:include').text()).toEqual(''); + * expect(element('.doc-example ng\\:include').text()).toEqual(''); * }); */ angularWidget('ng:include', function(element){ @@ -489,11 +489,11 @@ angularWidget('ng:include', function(element){ * * @scenario * it('should start in settings', function(){ - * expect(element('.example ng\\:switch').text()).toEqual('Settings Div'); + * expect(element('.doc-example ng\\:switch').text()).toEqual('Settings Div'); * }); * it('should change to home', function(){ * select('switch').option('home'); - * expect(element('.example ng\\:switch').text()).toEqual('Home Span'); + * expect(element('.doc-example ng\\:switch').text()).toEqual('Home Span'); * }); */ var ngSwitch = angularWidget('ng:switch', function (element){ |
