rapi_doc 0.4.0 → 0.5.0
Sign up to get free protection for your applications and to get access to all the features.
- data/README.md +11 -5
- data/VERSION +1 -1
- data/lib/rapi_doc.rb +28 -12
- data/lib/rapi_doc/method_doc.rb +24 -4
- data/lib/rapi_doc/resource_doc.rb +1 -1
- data/lib/rapi_doc/tasks/rapi_doc_tasks.rake +11 -6
- data/rapi_doc.gemspec +94 -0
- data/templates/_resource_method.html.haml +15 -12
- data/templates/beautify.js +1255 -0
- data/templates/index.html.haml +40 -34
- data/templates/prettify.css +1 -0
- data/templates/prettify.js +42 -0
- data/templates/scripts.js +83 -15
- data/templates/search.png +0 -0
- data/templates/styles.css +165 -16
- metadata +72 -24
- data/.rvmrc +0 -1
- data/templates/Search.png +0 -0
data/templates/index.html.haml
CHANGED
@@ -2,39 +2,45 @@
|
|
2
2
|
%html
|
3
3
|
%head
|
4
4
|
%meta{:content => "text/html; charset=utf-8", "http-equiv" => "Content-Type"}/
|
5
|
-
%link{:href => "
|
6
|
-
%
|
7
|
-
%
|
8
|
-
%title apidoc
|
5
|
+
%link{:href => "prettify.css", :rel => "stylesheet", :type => "text/css"}/
|
6
|
+
%link{:href => "styles.css", :rel => "stylesheet", :type => "text/css"}/
|
7
|
+
%title App Name - API doc
|
9
8
|
%body
|
10
|
-
#
|
11
|
-
%
|
12
|
-
%
|
13
|
-
|
14
|
-
|
15
|
-
|
9
|
+
#header.clearfix
|
10
|
+
%span#app-name.active
|
11
|
+
%a{:href => "#"} API Doc
|
12
|
+
%span#api-version= "Updated at: #{Time.now.utc}"
|
13
|
+
|
14
|
+
#wrapper.clearfix
|
15
|
+
#resource_index.blue
|
16
|
+
%form{:onsubmit => "return false;"}
|
17
|
+
.search-container
|
18
|
+
%input.search-input{:type => "text", :placeholder => "Search"}/
|
19
|
+
%h3 Resources
|
20
|
+
%ul#api-navigation
|
21
|
+
- resource_docs.each do |resource|
|
22
|
+
%li.resource-container
|
23
|
+
%span.resource-name-container
|
24
|
+
%a.resource-name{:href => "##{resource.name}"}= resource.name
|
25
|
+
- if resource.function_blocks.any?
|
26
|
+
%ul
|
27
|
+
- resource.function_blocks.each do |method_block|
|
28
|
+
%li
|
29
|
+
%span.api-endpoint-container
|
30
|
+
%a.api-endpoint{:href => "##{resource.name}_method_#{method_block.method_order}"}
|
31
|
+
= method_block.name
|
32
|
+
#resources
|
16
33
|
- resource_docs.each do |resource|
|
17
|
-
%
|
18
|
-
|
19
|
-
- if resource.
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
%li
|
31
|
-
%strong Show JSON
|
32
|
-
%a{:href => "#", :onclick => "$('.json').toggle();"} toggle
|
33
|
-
- resource_docs.each do |resource|
|
34
|
-
%a{:id => "#{resource.name}"}
|
35
|
-
.resource
|
36
|
-
- if resource.resource_header
|
37
|
-
= resource.resource_header
|
38
|
-
- if resource.resource_methods
|
39
|
-
- resource.resource_methods.each do |method|
|
40
|
-
= method
|
34
|
+
%a{:id => "#{resource.name}"}
|
35
|
+
.resource
|
36
|
+
- if resource.resource_header
|
37
|
+
= resource.resource_header
|
38
|
+
- if resource.resource_methods
|
39
|
+
- resource.resource_methods.each do |method|
|
40
|
+
= method
|
41
|
+
|
42
|
+
%script{:src => "http://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js", :type => "text/javascript"}
|
43
|
+
%script{:src => "http://ajax.googleapis.com/ajax/libs/jqueryui/1.9.2/jquery-ui.min.js", :type => "text/javascript"}
|
44
|
+
%script{:src => "scripts.js", :type => "text/javascript"}
|
45
|
+
%script{:src => "prettify.js", :type => "text/javascript"}
|
46
|
+
%script{:src => "beautify.js", :type => "text/javascript"}
|
@@ -0,0 +1 @@
|
|
1
|
+
.pln{color:#000}@media screen{.str{color:#080}.kwd{color:#008}.com{color:#800}.typ{color:#606}.lit{color:#066}.pun,.opn,.clo{color:#660}.tag{color:#008}.atn{color:#606}.atv{color:#080}.dec,.var{color:#606}.fun{color:red}}@media print,projection{.str{color:#060}.kwd{color:#006;font-weight:bold}.com{color:#600;font-style:italic}.typ{color:#404;font-weight:bold}.lit{color:#044}.pun,.opn,.clo{color:#440}.tag{color:#006;font-weight:bold}.atn{color:#404}.atv{color:#060}}pre.prettyprint{padding:2px;border:1px solid #888}ol.linenums{margin-top:0;margin-bottom:0}li.L0,li.L1,li.L2,li.L3,li.L5,li.L6,li.L7,li.L8{list-style-type:none}li.L1,li.L3,li.L5,li.L7,li.L9{background:#eee}
|
@@ -0,0 +1,42 @@
|
|
1
|
+
// Copyright (C) 2006 Google Inc.
|
2
|
+
//
|
3
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
// you may not use this file except in compliance with the License.
|
5
|
+
// You may obtain a copy of the License at
|
6
|
+
//
|
7
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
//
|
9
|
+
// Unless required by applicable law or agreed to in writing, software
|
10
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
// See the License for the specific language governing permissions and
|
13
|
+
// limitations under the License.
|
14
|
+
|
15
|
+
var q=null;window.PR_SHOULD_USE_CONTINUATION=!0;
|
16
|
+
(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a=
|
17
|
+
[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c<i;++c){var j=f[c];if(/\\[bdsw]/i.test(j))a.push(j);else{var j=m(j),d;c+2<i&&"-"===f[c+1]?(d=m(f[c+2]),c+=2):d=j;b.push([j,d]);d<65||j>122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;c<b.length;++c)i=b[c],i[0]<=j[1]+1?j[1]=Math.max(j[1],i[1]):f.push(j=i);b=["["];o&&b.push("^");b.push.apply(b,a);for(c=0;c<
|
18
|
+
f.length;++c)i=f[c],b.push(e(i[0])),i[1]>i[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c<b;++c){var j=f[c];j==="("?++i:"\\"===j.charAt(0)&&(j=+j.substring(1))&&j<=i&&(d[j]=-1)}for(c=1;c<d.length;++c)-1===d[c]&&(d[c]=++t);for(i=c=0;c<b;++c)j=f[c],j==="("?(++i,d[i]===void 0&&(f[c]="(?:")):"\\"===j.charAt(0)&&
|
19
|
+
(j=+j.substring(1))&&j<=i&&(f[c]="\\"+d[i]);for(i=c=0;c<b;++c)"^"===f[c]&&"^"!==f[c+1]&&(f[c]="");if(a.ignoreCase&&s)for(c=0;c<b;++c)j=f[c],a=j.charAt(0),j.length>=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p<d;++p){var g=a[p];if(g.ignoreCase)l=!0;else if(/[a-z]/i.test(g.source.replace(/\\u[\da-f]{4}|\\x[\da-f]{2}|\\[^UXux]/gi,""))){s=!0;l=!1;break}}for(var r=
|
20
|
+
{b:8,t:9,n:10,v:11,f:12,r:13},n=[],p=0,d=a.length;p<d;++p){g=a[p];if(g.global||g.multiline)throw Error(""+g);n.push("(?:"+y(g)+")")}return RegExp(n.join("|"),l?"gi":"g")}function M(a){function m(a){switch(a.nodeType){case 1:if(e.test(a.className))break;for(var g=a.firstChild;g;g=g.nextSibling)m(g);g=a.nodeName;if("BR"===g||"LI"===g)h[s]="\n",t[s<<1]=y++,t[s++<<1|1]=a;break;case 3:case 4:g=a.nodeValue,g.length&&(g=p?g.replace(/\r\n?/g,"\n"):g.replace(/[\t\n\r ]+/g," "),h[s]=g,t[s<<1]=y,y+=g.length,
|
21
|
+
t[s++<<1|1]=a)}}var e=/(?:^|\s)nocode(?:\s|$)/,h=[],y=0,t=[],s=0,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=document.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);m(a);return{a:h.join("").replace(/\n$/,""),c:t}}function B(a,m,e,h){m&&(a={a:m,d:a},e(a),h.push.apply(h,a.e))}function x(a,m){function e(a){for(var l=a.d,p=[l,"pln"],d=0,g=a.a.match(y)||[],r={},n=0,z=g.length;n<z;++n){var f=g[n],b=r[f],o=void 0,c;if(typeof b===
|
22
|
+
"string")c=!1;else{var i=h[f.charAt(0)];if(i)o=f.match(i[1]),b=i[0];else{for(c=0;c<t;++c)if(i=m[c],o=f.match(i[1])){b=i[0];break}o||(b="pln")}if((c=b.length>=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m),
|
23
|
+
l=[],p={},d=0,g=e.length;d<g;++d){var r=e[d],n=r[3];if(n)for(var k=n.length;--k>=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/,
|
24
|
+
q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/,
|
25
|
+
q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g,
|
26
|
+
"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a),
|
27
|
+
a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e}
|
28
|
+
for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g<d.length;++g)e(d[g]);m===(m|0)&&d[0].setAttribute("value",
|
29
|
+
m);var r=s.createElement("OL");r.className="linenums";for(var n=Math.max(0,m-1|0)||0,g=0,z=d.length;g<z;++g)l=d[g],l.className="L"+(g+n)%10,l.firstChild||l.appendChild(s.createTextNode("\xa0")),r.appendChild(l);a.appendChild(r)}function k(a,m){for(var e=m.length;--e>=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*</.test(m)?"default-markup":"default-code";return A[a]}function E(a){var m=
|
30
|
+
a.g;try{var e=M(a.h),h=e.a;a.a=h;a.c=e.c;a.d=0;C(m,h)(a);var k=/\bMSIE\b/.test(navigator.userAgent),m=/\n/g,t=a.a,s=t.length,e=0,l=a.c,p=l.length,h=0,d=a.e,g=d.length,a=0;d[g]=s;var r,n;for(n=r=0;n<g;)d[n]!==d[n+2]?(d[r++]=d[n++],d[r++]=d[n++]):n+=2;g=r;for(n=r=0;n<g;){for(var z=d[n],f=d[n+1],b=n+2;b+2<=g&&d[b+1]===f;)b+=2;d[r++]=z;d[r++]=f;n=b}for(d.length=r;h<p;){var o=l[h+2]||s,c=d[a+2]||s,b=Math.min(o,c),i=l[h+1],j;if(i.nodeType!==1&&(j=t.substring(e,b))){k&&(j=j.replace(m,"\r"));i.nodeValue=
|
31
|
+
j;var u=i.ownerDocument,v=u.createElement("SPAN");v.className=d[a+1];var x=i.parentNode;x.replaceChild(v,i);v.appendChild(i);e<o&&(l[h+1]=i=u.createTextNode(t.substring(b,o)),x.insertBefore(i,v.nextSibling))}e=b;e>=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"],
|
32
|
+
"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"],
|
33
|
+
H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"],
|
34
|
+
J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+
|
35
|
+
I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^<?]+/],["dec",/^<!\w[^>]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^<xmp\b[^>]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^<script\b[^>]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^<style\b[^>]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]),
|
36
|
+
["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css",
|
37
|
+
/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}),
|
38
|
+
["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes",
|
39
|
+
hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p<h.length&&l.now()<e;p++){var n=h[p],k=n.className;if(k.indexOf("prettyprint")>=0){var k=k.match(g),f,b;if(b=
|
40
|
+
!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p<h.length?setTimeout(m,
|
41
|
+
250):a&&a()}for(var e=[document.getElementsByTagName("pre"),document.getElementsByTagName("code"),document.getElementsByTagName("xmp")],h=[],k=0;k<e.length;++k)for(var t=0,s=e[k].length;t<s;++t)h.push(e[k][t]);var e=q,l=Date;l.now||(l={now:function(){return+new Date}});var p=0,d,g=/\blang(?:uage)?-([\w.]+)(?!\S)/;m()};window.PR={createSimpleLexer:x,registerLangHandler:k,sourceDecorator:u,PR_ATTRIB_NAME:"atn",PR_ATTRIB_VALUE:"atv",PR_COMMENT:"com",PR_DECLARATION:"dec",PR_KEYWORD:"kwd",PR_LITERAL:"lit",
|
42
|
+
PR_NOCODE:"nocode",PR_PLAIN:"pln",PR_PUNCTUATION:"pun",PR_SOURCE:"src",PR_STRING:"str",PR_TAG:"tag",PR_TYPE:"typ"}})();
|
data/templates/scripts.js
CHANGED
@@ -2,21 +2,89 @@
|
|
2
2
|
* created by: salilwadnerkar
|
3
3
|
* Date: 11/4/12
|
4
4
|
*/
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
5
|
+
|
6
|
+
helper = {
|
7
|
+
pretty_print: function(source_selector){
|
8
|
+
if(!source_selector || $(source_selector).length <= 0)
|
9
|
+
return false;
|
10
|
+
|
11
|
+
$(source_selector).each(function(idx){
|
12
|
+
var source = $(this);
|
13
|
+
var opts = {
|
14
|
+
"indent_size":"4",
|
15
|
+
"indent_char":" ",
|
16
|
+
"preserve_newlines":true,
|
17
|
+
"brace_style":"collapse",
|
18
|
+
"keep_array_indentation":false,
|
19
|
+
"space_after_anon_function":true,
|
20
|
+
"space_before_conditional":true,
|
21
|
+
"indent_scripts":"normal"
|
22
|
+
};
|
23
|
+
var v = js_beautify($(source).html(), opts);
|
24
|
+
$(source).html(v);
|
25
|
+
});
|
26
|
+
prettyPrint();
|
27
|
+
},
|
28
|
+
|
29
|
+
scroll_to: function(element, delay_time, padding_top){
|
30
|
+
if (!delay_time)
|
31
|
+
delay_time = 300;
|
32
|
+
|
33
|
+
if(!padding_top)
|
34
|
+
padding_top = 60;
|
35
|
+
|
36
|
+
$('html, body').animate({ scrollTop: $(element).offset().top - padding_top}, delay_time);
|
37
|
+
}
|
38
|
+
};
|
39
|
+
|
40
|
+
$(document).ready(function(){
|
41
|
+
var api_endpoints = $("#resource_index ul li");
|
42
|
+
var search = function(query){
|
43
|
+
var search_regex = new RegExp(query, 'gi');
|
44
|
+
api_endpoints.each ( function() {
|
45
|
+
var elem = $(this);
|
46
|
+
var h_elem = elem.find('a')[0];
|
47
|
+
var link_txt = $.trim($(h_elem).text());
|
48
|
+
var match = link_txt.match(search_regex);
|
49
|
+
if(match){
|
50
|
+
// Show the parent container first
|
51
|
+
elem.parents("li.resource-container").show();
|
52
|
+
elem.show();
|
19
53
|
}
|
54
|
+
else
|
55
|
+
elem.hide();
|
56
|
+
});
|
57
|
+
};
|
58
|
+
|
59
|
+
|
60
|
+
$('#resource_index input').keyup(function(event) {
|
61
|
+
if ( event.keyCode == 13 ){
|
62
|
+
event.preventDefault();
|
63
|
+
}
|
64
|
+
search($(this).val());
|
20
65
|
});
|
21
|
-
});
|
22
66
|
|
67
|
+
// Pretty print code.
|
68
|
+
helper.pretty_print(".prettyprint, code");
|
69
|
+
|
70
|
+
// Auto scroll to API endpoint.
|
71
|
+
var id = window.location.hash.replace('#', '');
|
72
|
+
var elem = $("a[id='" + id + "']" );
|
73
|
+
if(elem && elem.length > 0) {
|
74
|
+
helper.scroll_to(elem);
|
75
|
+
}
|
76
|
+
|
77
|
+
$("#api-navigation a").click(function(e){
|
78
|
+
e.preventDefault();
|
79
|
+
var id = $(this).attr('href');
|
80
|
+
if(id){
|
81
|
+
id = id.replace('#', '');
|
82
|
+
var elem = $("a[id='" + id + "']" );
|
83
|
+
helper.scroll_to(elem);
|
84
|
+
}
|
85
|
+
|
86
|
+
// Highlight the current entry
|
87
|
+
$("#api-navigation .active").removeClass("active");
|
88
|
+
$(this).parent().addClass("active");
|
89
|
+
});
|
90
|
+
});
|
Binary file
|
data/templates/styles.css
CHANGED
@@ -1,29 +1,114 @@
|
|
1
1
|
html, body {
|
2
2
|
width: 100%;
|
3
3
|
height: 100%;
|
4
|
+
margin: 0;
|
5
|
+
font-family: Helvetica,Arial,sans-serif;
|
4
6
|
}
|
5
7
|
|
6
8
|
body {
|
7
|
-
line-height:
|
9
|
+
line-height: 20px;
|
10
|
+
font-size: 14px;
|
11
|
+
}
|
12
|
+
|
13
|
+
h1, h2, h3, h4, h5{
|
14
|
+
padding: 0;
|
15
|
+
margin: 0;
|
16
|
+
}
|
17
|
+
|
18
|
+
.clearfix:after { clear: both; content: ' '; display: block; font-size: 0; height: 0; line-height: 0; visibility: hidden; width: 0; }
|
19
|
+
* html .clearfix,
|
20
|
+
*:first-child+html .clearfix { zoom: 1; }
|
21
|
+
|
22
|
+
#header{
|
23
|
+
position: fixed;
|
24
|
+
background-color: #6699AA;
|
25
|
+
color: white;
|
26
|
+
width: 100%;
|
27
|
+
height: 30px;
|
28
|
+
padding-top: 10px;
|
29
|
+
background-image: -moz-linear-gradient(top, #222222, #111111);
|
30
|
+
background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#222222), to(#111111));
|
31
|
+
background-image: -webkit-linear-gradient(top, #222222, #111111);
|
32
|
+
background-image: -o-linear-gradient(top, #222222, #111111);
|
33
|
+
background-image: linear-gradient(to bottom, #222222, #111111);
|
34
|
+
background-repeat: repeat-x;
|
35
|
+
border-color: #252525;
|
36
|
+
filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff222222', endColorstr='#ff111111', GradientType=0);
|
37
|
+
-webkit-box-shadow: 0 1px 10px rgba(0, 0, 0, 0.1);
|
38
|
+
-moz-box-shadow: 0 1px 10px rgba(0, 0, 0, 0.1);
|
39
|
+
box-shadow: 0 1px 10px rgba(0, 0, 0, 0.1);
|
40
|
+
}
|
41
|
+
|
42
|
+
#header span{
|
43
|
+
display: inline-block;
|
44
|
+
padding-left: 10px;
|
45
|
+
padding-right: 10px;
|
46
|
+
color: #999999;
|
47
|
+
}
|
48
|
+
|
49
|
+
#header span.active, #header span.active a {
|
50
|
+
color: #ffffff;
|
51
|
+
}
|
52
|
+
|
53
|
+
#header span a{
|
54
|
+
color: #999999;
|
55
|
+
text-decoration: none;
|
56
|
+
}
|
57
|
+
|
58
|
+
#app-name{
|
59
|
+
padding-left: 10px;
|
60
|
+
}
|
61
|
+
|
62
|
+
#api-version{
|
63
|
+
display: inline-block;
|
64
|
+
font-size: 12px;
|
65
|
+
}
|
66
|
+
|
67
|
+
#wrapper{
|
68
|
+
padding-top: 40px;
|
8
69
|
}
|
9
70
|
|
10
71
|
#resources {
|
11
72
|
float: right;
|
12
|
-
|
73
|
+
padding-right: 10px;
|
74
|
+
width: 75.5%;
|
75
|
+
}
|
76
|
+
|
77
|
+
.blue{
|
78
|
+
background-color: #2FC3F1;
|
79
|
+
background-image: -moz-linear-gradient(top, #2FC3F1, #0095C2);
|
80
|
+
background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#2FC3F1), to(#0095C2));
|
81
|
+
background-image: -webkit-linear-gradient(top, #2FC3F1, #0095C2);
|
82
|
+
background-image: -o-linear-gradient(top, #2FC3F1, #0095C2);
|
83
|
+
background-image: linear-gradient(to bottom, #2FC3F1, #0095C2);
|
84
|
+
background-repeat: repeat-x;
|
85
|
+
border-color: #252525;
|
86
|
+
filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff2FC3F1', endColorstr='#ff0095C2', GradientType=0);
|
87
|
+
}
|
88
|
+
|
89
|
+
.search-input{
|
90
|
+
background: url("/apidoc/search.png") no-repeat scroll 7px 7px #FCFCFC;
|
91
|
+
border: 1px solid #605F5F;
|
92
|
+
height: 18px;
|
93
|
+
outline: medium none;
|
94
|
+
padding: 5px 9px 5px 27px;
|
95
|
+
-webkit-border-radius: 15px;
|
96
|
+
-moz-border-radius: 15px;
|
97
|
+
border-radius: 15px;
|
13
98
|
}
|
14
99
|
|
15
100
|
#resource_index {
|
16
101
|
float: left;
|
17
102
|
height: 100%;
|
18
103
|
position: fixed;
|
19
|
-
width:
|
20
|
-
|
104
|
+
width: 22%;
|
105
|
+
min-width: 270px;
|
106
|
+
color: #222222;
|
107
|
+
overflow-x: hidden;
|
21
108
|
}
|
22
109
|
|
23
110
|
#resource_index li {
|
24
|
-
background-color: #6699AA;
|
25
111
|
color:white;
|
26
|
-
padding: 5px 10px 0;
|
27
112
|
}
|
28
113
|
|
29
114
|
#resource_index li a {
|
@@ -33,13 +118,47 @@ body {
|
|
33
118
|
color:#ffffff;
|
34
119
|
}
|
35
120
|
|
121
|
+
#resource_index .resource-name{
|
122
|
+
padding: 2px 6px 2px 5px;
|
123
|
+
}
|
124
|
+
|
125
|
+
#resource_index .api-endpoint{
|
126
|
+
padding: 2px 6px 2px 15px;
|
127
|
+
}
|
128
|
+
|
36
129
|
#resource_index form img {
|
37
130
|
height: 25px;
|
38
131
|
width: 25px;
|
39
132
|
}
|
133
|
+
#resource_index .resource-name-container, #resource_index .api-endpoint-container{
|
134
|
+
display: block;
|
135
|
+
}
|
40
136
|
|
41
|
-
#
|
137
|
+
#resource_index .resource-name-container.active,
|
138
|
+
#resource_index .api-endpoint-container.active,
|
139
|
+
#resource_index .resource-name-container:hover,
|
140
|
+
#resource_index .api-endpoint-container:hover{
|
42
141
|
background-color: #6699AA;
|
142
|
+
background-image: -moz-linear-gradient(top, #222222, #111111);
|
143
|
+
background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#222222), to(#111111));
|
144
|
+
background-image: -webkit-linear-gradient(top, #222222, #111111);
|
145
|
+
background-image: -o-linear-gradient(top, #222222, #111111);
|
146
|
+
background-image: linear-gradient(to bottom, #222222, #111111);
|
147
|
+
background-repeat: repeat-x;
|
148
|
+
border-color: #252525;
|
149
|
+
filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff222222', endColorstr='#ff111111', GradientType=0);
|
150
|
+
-webkit-box-shadow: 0 1px 10px rgba(0, 0, 0, 0.1);
|
151
|
+
-moz-box-shadow: 0 1px 10px rgba(0, 0, 0, 0.1);
|
152
|
+
box-shadow: 0 1px 10px rgba(0, 0, 0, 0.1);
|
153
|
+
}
|
154
|
+
|
155
|
+
#resources h2.api-name {
|
156
|
+
border-bottom: 1px solid #AAAAAA;
|
157
|
+
margin: 2.4em 0 0.5em;
|
158
|
+
padding: 0 0 3px;
|
159
|
+
}
|
160
|
+
|
161
|
+
#resources h2.api-url {
|
43
162
|
color:white;
|
44
163
|
}
|
45
164
|
|
@@ -49,11 +168,6 @@ ul, ul li {
|
|
49
168
|
list-style: none outside;
|
50
169
|
}
|
51
170
|
|
52
|
-
h1, h2, h3 {
|
53
|
-
padding-top: 10px;
|
54
|
-
padding-bottom: 10px;
|
55
|
-
}
|
56
|
-
|
57
171
|
textarea {
|
58
172
|
width:100%;
|
59
173
|
height:200px;
|
@@ -71,10 +185,45 @@ textarea {
|
|
71
185
|
margin-right:20px;'
|
72
186
|
}
|
73
187
|
|
74
|
-
.description{
|
75
|
-
font-size: 1.4em;
|
76
|
-
color:#262626;
|
77
|
-
}
|
78
188
|
.code {
|
79
189
|
font-family: monospace;
|
80
190
|
}
|
191
|
+
|
192
|
+
.search-container{
|
193
|
+
margin: 10px 0;
|
194
|
+
}
|
195
|
+
|
196
|
+
.search-container input, .search-container img{
|
197
|
+
vertical-align: middle;
|
198
|
+
}
|
199
|
+
|
200
|
+
.api-url{
|
201
|
+
margin-top: 10px;
|
202
|
+
padding: 3px;
|
203
|
+
}
|
204
|
+
|
205
|
+
pre.prettyprint {
|
206
|
+
-webkit-border-radius: 4px;
|
207
|
+
-moz-border-radius: 4px;
|
208
|
+
border-radius: 4px;
|
209
|
+
}
|
210
|
+
|
211
|
+
.output-format{
|
212
|
+
display: inline-block;
|
213
|
+
padding: 4px 6px;
|
214
|
+
font-weight: bold;
|
215
|
+
line-height: 14px;
|
216
|
+
color: #ffffff;
|
217
|
+
text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25);
|
218
|
+
white-space: nowrap;
|
219
|
+
vertical-align: baseline;
|
220
|
+
background-color: #999999;
|
221
|
+
-webkit-border-radius: 3px;
|
222
|
+
-moz-border-radius: 3px;
|
223
|
+
border-radius: 3px;
|
224
|
+
}
|
225
|
+
|
226
|
+
.output-format a{
|
227
|
+
text-decoration: none;
|
228
|
+
color: inherit;
|
229
|
+
}
|