Hopiu/angular.js
1
0
Fork 0
mirror of https://github.com/Hopiu/angular.js.git synced 2026-03-25 18:50:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
angular.js/docs/src/templates/doc_widgets.js

171 lines
6.2 KiB
JavaScript
Raw Normal View History

Better example widget - syntax highlighting - tabless design - rename widget to doc:example - rename widget files (wiki_widget.* -> doc_widget.*) - example section is now optional
2010-11-06 04:12:37 +00:00
(function(){
fixed example rendering, add tests for it.
2011-01-19 23:42:11 +00:00
Example snippets now have full html snippets
2010-11-10 23:31:15 +00:00
var angularJsUrl;
var scripts = document.getElementsByTagName("script");
fix documentation for ie
2011-02-22 22:48:53 +00:00
var angularJsRegex = /^(|.*\/)angular(-.*?)?(\.min)?.js(\?[^#]*)?(#(.*))?$/;
Example snippets now have full html snippets
2010-11-10 23:31:15 +00:00
for(var j = 0; j < scripts.length; j++) {
var src = scripts[j].src;
fix angular.js file path detection in docs
2011-02-04 22:09:17 +00:00
if (src && src.match(angularJsRegex)) {
doc widgets examples should display angular src as CAO instead of DAO
2011-01-18 22:15:53 +00:00
angularJsUrl = src.replace('docs.angularjs.org', 'code.angularjs.org');
fix angular.js file path detection in docs
2011-02-04 22:09:17 +00:00
continue;
Example snippets now have full html snippets
2010-11-10 23:31:15 +00:00
}
}
fixed example rendering, add tests for it.
2011-01-19 23:42:11 +00:00
Better example widget - syntax highlighting - tabless design - rename widget to doc:example - rename widget files (wiki_widget.* -> doc_widget.*) - example section is now optional
2010-11-06 04:12:37 +00:00
var HTML_TEMPLATE =
Example snippets now have full html snippets
2010-11-10 23:31:15 +00:00
'<!doctype html>\n' +
Better example widget - syntax highlighting - tabless design - rename widget to doc:example - rename widget files (wiki_widget.* -> doc_widget.*) - example section is now optional
2010-11-06 04:12:37 +00:00
'<html xmlns:ng="http://angularjs.org">\n' +
remove script.type attribute from example widgets since its optional in html5
2011-01-18 21:59:55 +00:00
' <script src="' + angularJsUrl + '" ng:autobind></script>\n' +
Example snippets now have full html snippets
2010-11-10 23:31:15 +00:00
' <body>\n' +
Better example widget - syntax highlighting - tabless design - rename widget to doc:example - rename widget files (wiki_widget.* -> doc_widget.*) - example section is now optional
2010-11-06 04:12:37 +00:00
'_HTML_SOURCE_\n' +
Example snippets now have full html snippets
2010-11-10 23:31:15 +00:00
' </body>\n' +
Better example widget - syntax highlighting - tabless design - rename widget to doc:example - rename widget files (wiki_widget.* -> doc_widget.*) - example section is now optional
2010-11-06 04:12:37 +00:00
'</html>';
angular.widget('doc:example', function(element){
this.descend(true); //compile the example code
element.hide();
fix documentation for ie
2011-02-22 22:48:53 +00:00
var example = element.find('pre.doc-source').eq(0),
Better example widget - syntax highlighting - tabless design - rename widget to doc:example - rename widget files (wiki_widget.* -> doc_widget.*) - example section is now optional
2010-11-06 04:12:37 +00:00
exampleSrc = example.text(),
fix documentation for ie
2011-02-22 22:48:53 +00:00
scenario = element.find('pre.doc-scenario').eq(0);
Better example widget - syntax highlighting - tabless design - rename widget to doc:example - rename widget files (wiki_widget.* -> doc_widget.*) - example section is now optional
2010-11-06 04:12:37 +00:00
Example snippets now have full html snippets
2010-11-10 23:31:15 +00:00
var code = indent(exampleSrc);
addded cookbook
2011-02-01 18:01:02 +00:00
var tabHtml =
'<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; html-script: true; highlight: [' +
code.hilite + ']; toolbar: false;"></pre></li>' +
'<li class="doc-example-heading"><h3>Live Preview</h3></li>' +
'<li class="doc-example-live">' + exampleSrc +'</li>';
if (scenario.text()) {
tabHtml +=
'<li class="doc-example-heading"><h3>Scenario Test</h3></li>' +
'<li class="doc-example-scenario"><pre class="brush: js">' + scenario.text() + '</pre></li>';
}
tabHtml +=
'</ul>';
var tabs = angular.element(tabHtml);
fixed example rendering, add tests for it.
2011-01-19 23:42:11 +00:00
Example snippets now have full html snippets
2010-11-10 23:31:15 +00:00
tabs.find('li.doc-example-source > pre').text(HTML_TEMPLATE.replace('_HTML_SOURCE_', code.html));
Better example widget - syntax highlighting - tabless design - rename widget to doc:example - rename widget files (wiki_widget.* -> doc_widget.*) - example section is now optional
2010-11-06 04:12:37 +00:00
element.html('');
element.append(tabs);
element.show();
var script = (exampleSrc.match(/<script[^\>]*>([\s\S]*)<\/script>/) || [])[1] || '';
try {
eval(script);
} catch (e) {
alert(e);
}
});
fixed example rendering, add tests for it.
2011-01-19 23:42:11 +00:00
Example snippets now have full html snippets
2010-11-10 23:31:15 +00:00
function indent(text) {
Developer guide documentation
2011-01-31 19:55:44 +00:00
if (!text) return text;
fix indentation regexp for doc:examples
2011-04-07 19:34:34 +00:00
var lines = text.split(/\r?\n/);
Example snippets now have full html snippets
2010-11-10 23:31:15 +00:00
var lineNo = [];
Added part of guide documentation and supporting changes to doc generator
2011-01-26 05:55:11 +00:00
// remove any leading blank lines
Example snippets now have full html snippets
2010-11-10 23:31:15 +00:00
while (lines[0].match(/^\s*$/)) lines.shift();
Added part of guide documentation and supporting changes to doc generator
2011-01-26 05:55:11 +00:00
// remove any trailing blank lines
Example snippets now have full html snippets
2010-11-10 23:31:15 +00:00
while (lines[lines.length - 1].match(/^\s*$/)) lines.pop();
Added part of guide documentation and supporting changes to doc generator
2011-01-26 05:55:11 +00:00
var minIndent = 999;
Example snippets now have full html snippets
2010-11-10 23:31:15 +00:00
for ( var i = 0; i < lines.length; i++) {
Added part of guide documentation and supporting changes to doc generator
2011-01-26 05:55:11 +00:00
var line = lines[0];
var indent = line.match(/^\s*/)[0];
if (indent !== line && indent.length < minIndent) {
minIndent = indent.length;
}
}
for ( var i = 0; i < lines.length; i++) {
lines[i] = ' ' + lines[i].substring(minIndent);
lineNo.push(5 + i);
Example snippets now have full html snippets
2010-11-10 23:31:15 +00:00
}
return {html: lines.join('\n'), hilite: lineNo.join(',') };
};
fixed example rendering, add tests for it.
2011-01-19 23:42:11 +00:00
Add doc:tutorial-instructions widget
2011-05-23 22:49:33 +00:00
var HTML_TPL =
'<a ng:init="showInstructions = {show}" ng:show="!showInstructions" ng:click="showInstructions = true" href>Show Instructions</a>' +
'<div ng:controller="TutorialInstructionsCtrl" ng:show="showInstructions">' +
'<div class="tabs-nav">' +
'<ul>' +
'</ul>' +
'</div>' +
'<div class="tabs-content"><div class="tabs-content-inner">' +
'</div></div>' +
'</div>';
var HTML_NAV = '<li ng:class="currentCls(\'{id}\')"><a ng:click="select(\'{id}\')" href>{title}</a></li>';
var HTML_CONTENT = '<div ng:show="selected==\'{id}\'">{content}</div>';
var DEFAULT_NAV =
'<li ng:class="currentCls(\'git-mac\')"><a ng:click="select(\'git-mac\')" href>Git on Mac/Linux</a></li>' +
'<li ng:class="currentCls(\'git-win\')"><a ng:click="select(\'git-win\')" href>Git on Windows</a></li>' +
'<li ng:class="currentCls(\'ss-mac\')"><a ng:click="select(\'ss-mac\')" href>Snapshots on Mac/Linux</a></li>' +
'<li ng:class="currentCls(\'ss-win\')"><a ng:click="select(\'ss-win\')" href>Snapshots on Windows</a></li>';
var DEFAULT_CONTENT =
'<div ng:show="selected==\'git-mac\'">' +
'<ol>' +
'<li><p>Reset the workspace to step {step}.</p>' +
'<pre><code> git checkout -f step-{step}</code></pre></li>' +
'<li><p>Refresh your browser or check the app out on <a href="http://angular.github.com/angular-phonecat/step-{step}/app">anglar\'s server</a>.</p></li>' +
'</ol>' +
'</div>' +
'<div ng:show="selected==\'git-win\'">' +
'<ol>' +
'<li><p>Reset the workspace to step {step}.</p>' +
'<pre><code> git checkout -f step-{step}</code></pre></li>' +
'<li><p>Refresh your browser or check the app out on <a href="http://angular.github.com/angular-phonecat/step-{step}/app">anglar\'s server</a>.</p></li>' +
'</ol>' +
'</div>' +
'<div ng:show="selected==\'ss-mac\'">' +
'<ol>' +
'<li><p>Reset the workspace to step {step}.</p>' +
'<pre><code> ./goto_step.sh {step}</code></pre></li>' +
'<li><p>Refresh your browser or check the app out on <a href="http://angular.github.com/angular-phonecat/step-{step}/app">anglar\'s server</a>.</p></li>' +
'</ol>' +
'</div>' +
'<div ng:show="selected==\'ss-win\'">' +
'<ol>' +
'<li><p>Reset the workspace to step {step}.</p>' +
'<pre><code> ./goto_step.bat {step}</code></pre></li>' +
'<li><p>Refresh your browser or check the app out on <a href="http://angular.github.com/angular-phonecat/step-{step}/app">anglar\'s server</a>.</p></li>' +
'</ol>' +
'</div>';
angular.widget('doc:tutorial-instructions', function(element) {
element.hide();
this.descend(true);
var tabs = angular.element(HTML_TPL.replace('{show}', element.attr('show') || 'false')),
nav = tabs.find('.tabs-nav ul'),
content = tabs.find('.tabs-content-inner'),
children = element.children();
if (children.length) {
// load custom content
angular.forEach(element.children(), function(elm) {
var elm = angular.element(elm),
id = elm.attr('id');
nav.append(HTML_NAV.replace('{title}', elm.attr('title')).replace(/\{id\}/g, id));
content.append(HTML_CONTENT.replace('{id}', id).replace('{content}', elm.html()));
});
} else {
// default
nav.append(DEFAULT_NAV);
content.append(DEFAULT_CONTENT.replace(/\{step\}/g, element.attr('step')));
}
element.html('');
element.append(tabs);
element.show();
});
fixed example rendering, add tests for it.
2011-01-19 23:42:11 +00:00
})();
Reference in a new issue Copy permalink