From f3912a9eee4b5ee57ec728f4b06b50ab9a8c3eef Mon Sep 17 00:00:00 2001 From: Reinhard Pointner Date: Sat, 5 Nov 2011 00:47:53 +0000 Subject: [PATCH] + added scripting docs to website~~ --- website/base.css | 11 ++- website/code.css | 51 +++++++++- website/images/script.png | Bin 0 -> 12902 bytes website/script.html | 192 ++++++++++++++++++++++++++++++++++++++ 4 files changed, 250 insertions(+), 4 deletions(-) create mode 100644 website/images/script.png create mode 100644 website/script.html diff --git a/website/base.css b/website/base.css index c5be6b89..a1e90cde 100644 --- a/website/base.css +++ b/website/base.css @@ -25,6 +25,12 @@ h3 { margin-bottom: -8px; } +hr { + border-style: dashed; + border-width: 1px 0 0 0; + border-color: lightgray; +} + .section h2.reference { padding-top: 25px; } @@ -180,9 +186,8 @@ div.screencast:hover .play { margin-bottom: 20px; } -.section p { - margin-left: 10px; - margin-right: 0px; +.section p, .section .description { + margin: 16px 0 0 10px; } .section .quote { diff --git a/website/code.css b/website/code.css index 91964f47..d89de6a8 100644 --- a/website/code.css +++ b/website/code.css @@ -9,15 +9,26 @@ code { margin: 5px 0px; } +pre { + margin: 0px; +} + code .variable { color: #7f0055; font-weight: bold; } -code .method { +code .method, div.documentation pre .method { color: #0066cc; } +code .property, div.documentation pre .property { + color: #225577; + font-size: 11pt; + font-weight: bold; + font-family: monospace; +} + code .string, code .numeral, code .regex { color: #008800; } @@ -39,3 +50,41 @@ code .option { code .argument { color: #008800; } + + +div.documentation { + font-size: 11pt; + padding: 5px; + border: 1px solid #9EADC0; + background-color: #F8F8FF; + margin-bottom: 20px; +} + +div.documentation h4 { + margin: -5px -5px 5px -5px; + background-color: #DEE3E9; + border-bottom: 1px solid #9EADC0; + padding: 2px 5px; +} + +div.documentation pre { + font-size: 13pt; + margin-top: 5px; + margin-bottom: 5px; +} + +div.documentation dt { + margin-bottom: 3px; + color: #4E4E4E; + font-size: 10pt; + font-weight: bold; +} + +div.documentation .return { + color: #4C6B87; + font-size: 10pt; +} + +div.documentation .property { + color: #225577; +} diff --git a/website/images/script.png b/website/images/script.png new file mode 100644 index 0000000000000000000000000000000000000000..930fd87d8828744d1523f0e0a6834839e0158ee5 GIT binary patch literal 12902 zcmW+-1ymbN7Y*(Z+}$a~-Cc{j7N@vdad(GMyl8RPLLq3OK%lt0yGyY@-=DLaJxTWL zym@oqn>TlEV%1gUF;GcR0RRAoqJoSj^x6nL1CbG-?`Lpf|NQ{(A*HB|41EP4Tg5;> zqqr&OEkAeo5vjtM94hV&my!?rsf`v~sbqrjoOBxAt*yckrN+*5Y+* z-QfcOr~ryGlG?s`XMuL#=;ZzON&U3FOiThPbDocn1S9FDkWV&K%n~IRS)(~OO$aRK zho!#HS<=-TfP)(LG7&(DoLxl3Q+=JtvC2*K64Qr76ACjkGbPytVn6(o&X10&AtJOE z!B*BfHahcjCZf^W7c)h(G5>Y)!kM!Ldi}fbH)6@ z^^p|*V3=b%v5n27_oX4leW6&<6zT?m#Q5`t?50qqLvnzoI{+Qv_0}G1%;-iz1`h&^ zB*{u8jd*PrP%eV9U^rlil7?iWMy4Z$d*cbxVy{n-ac?c}k z+2U`QS;f-`X(Y4;1v2<4WU2(R)Eh-(M$faY**I`_K@c-qgaV{3L$OrJmi9?4;_^R0)hN^qHPD29Xcd&*1{*Y>qkb(?0Se)S1P zVx}9}xM2L;%fYBMf~{TDNV9RrofuDaJ+m&XrQo-=r$j6*R}!Ky0Yx3ZROgbvut&JBKGH9!~56%u-W6 zhw6WE89LMN)-Srha~+AyWC_fpnLgngDUq3m2*p-Q^h8diW}9vF5Kb*DM8CZa0FX_C zp2{4T1E25B*M7DVkx&fBv-iYgXA>tRCz~IS69d5Ozx=OqH(n5bs1+gtMBZO+^n0Dj zqoSi5T{gtV$H&b!FU?Qax(Jno61TR@MPA3b1$@rQk|;#uHeUAmzvbk(;yf1qc( zo&i0Qu%>>K)tGSe!s*iJDA7}+!or3E0-CTE zj6Ez97SIrdyvbH6ukoKbsRFYU>PL zUUF<-33!@BPaa4!;q`khn8ugLCxaNQv1vf9E%>Y7S0OaIUptkvZM7KPbX;*4{gT;@ zT2arOob-ExL;+@VEb-&d_h$nI4s|fp@Kxp8;83{3SuV)c zc28i(evShGU?7=rHZnz1IBJ}n zStc-cLzwSOD6N>)WS{%Gkeg3V6|qPW3kYEf@dlUxmIV(sa&ijVv_KUNoe#uOD1~Z} zIu8gna%9`U{I4i;3DDjrRlr!Oj~HVp@LPsd+UlJ<;b?c=q>0%RkM%T2q&zA{h6Wk} z{D1?%C)>B*X1pQaye?$sm{b>Eyrg2{!KRrlFJ1;96AFaTl-0(hGga6unv1j;qe}h( z?mi{0pFl4hy~tza)8!M{28+^a*Jt+;BNR8~=|E1@3-*5Tc;$YR5w3?Hea_X$ilzyj4!t^S6YPP_tX>+usH$-{Cj@p z{LhiUho?3+lA%zOXLfz^)6t16W}*W8`}fbdl!St!u7U>XAV}&vlM>%#Se$mMQf~hF z?k-({|NYW*>7)_*%-~DE)K#2$CcYf0m$ET_oY5*_K`@NS%~jX=&y%M4`>ftagrI}` zi^0uCO95f-@RPb<1Ztvpcy-;^N-xKwj8`iczDN|oFK*p;wJsAKdm+CjMZ!tfZyEGP zC(qa7t+--IU4Ej-CsPbef|2CLqH(r=*aGLu@Ua4_(1AlK6PSC$I^golwD?&>2NShp?w&zU48 z8e}5AK(w11HbF^bNe&`-Qa(rU;-dgGdY6vu$O4|MKdF8)v#{v*!YF1c z?(L<#xw$dR+j*P|YbU)2SSaRoIVaD~+&Y60H+#($NJ=~cIYz6ZiW#wcRRrY7zgKE&0WIfg#ZZVu`)o`x%~FEY*W0U)1ZRj>AY}23YT3+ zV1eIr{$@kXhlAD3tU&ZDjxeeHoTew?X{-8QQE$6Ku~`6iSS=;!s1TJQ^h_uj+ndg} zf0L~{yvhgLvu%uC;&^VA0Nopw$(KMXh z#>>RQSBSfjS|{n|7)r{dLkX1t{QZKLsxWAuUjvicOjlRtR}Y}OXrJ-T=T9|t3Ir>| zaSx{`m2q%!g*E=wAd1qM@u(rV_rsq#A$0F`ie0EPi7zOi;Nj!@d5oky^wcm2-?@&h zxi2mc;kHQsCUAe$Fig;ZG}cjJUkE{xVU}gd9(-I}M4)&57^{0ClHW^gDd2Za_w#2L zHfl7r5H_k*7lSGANc%}$}}p8VJfSOT91h#U?QqKHdqO0;bghKNeE z@^UPHmSaK+C@2@7)1Ph3yinmo@Z5hHu`?Cj^y=q%l;R`&tb+qU^LV54novXyB(Whp zh;7iqAK_G8?ZBeYzcG?i*FCt^Zu*D^k|!8$#f36Vl;KH|*O)VCJDW2I3wUaOKPlv| zUkMr#reAtzgDe^e9B4p@Z4=5-S_Gx=GBtGe#!K_kk$HzOO>pZ7K6{rs@Nzf=}yvUw^7=-4x=aJh&%um=)lcRi@KK?MpJQ zR5k($WFur00o1NfSb_&sVad62w~mHRM#jcpxM!H3EPJBBA6>p)P$qNQzn$z}y+tR9 zJoqxQ;;?VRrV=x$CK&>K%a9FGKggOg!iI)C=b>D+wdth!chWHcc9VmydQASdLEdF! zT)AQJLi31hkDJN03r{nwie@NNHqjJQ0uxgLX=EfLs8StkSgq0XU^6r<4wY-WA^CD)$?uGt2?zSfIknTdvQHw+&dx>cXMIe*Pa`9ypJoVXV%=_^0@qXuAj#J=?aTSPA5Qqbf zSR*4X121{|*dwV?drrq}J|iI^l_BzQ$F{V^_h;(nxc8`(#?mM6dYAoF1hIhn?%{tF%&4 znSbrYfX~|u<wOwL1@=x;gGPecCVS~pRtH(lhgZ`2 zV9f}0yS~cyuqBfkb9q}h2Z?17fDm-?5lSpAeP=NEwLRaD8(cTRFplfpo$8GK;Dejc zSr%`LJCF&+#p~@xpk&&fu#CAmli1zeT~P0l%Y~zivJu|LS{41ZP6U$)qpd7y%!Qa^XwG9-EFKpW4MUFQV!M_RCyLL|a> zoA>H6a>@?yXXGCb4-fmJ&Z~i#Es}Wfz`pavLxvCa4R5ksDwMG8JvbO|h&5-6k@F+= z2`c0vlRhMA8Hej0ucNbXwp}*N_`!a6F2R@kugSq1d|5vAQDa?qzn~4KADRAPRTRwXy)V2%t3kOeMDn+@3d3RE z5j@|zKuhKr%9J+#g@BAo*OC;;sNaHj9=l%>UIK_hXCNUk8?oNXZ+3S4@yp2|03h@)^4{pJB*mXpzW#*keCRS&DNzyBma^DVJAdo@O{dtSH8}DC z?MF}xCytYZhY``4$%Ot~E8>Z8eT3S*Bv4_W(+z;0$L*?`)zPpDYyS&4NYi|p-dJ>k zT61igJb%wrJkjJk*E&O99MQp~B)Nq0h6jGyV}ZyZ*}_baMyIjK9Kwq)MN} zJ7~$SN-B9H=9A=FT3gM$o-scl=jsy>MudjWdp6c`OThF~$Ar)+>(4ae*4BRf;vE0I zQx?@UaKI5>f)3B=pRRO;8y=WIzvS0Kw~{g2K)}-OKAg|ncwJXayolzNln_2>E64zK z%v`f1LlS0-K|IGO{EKta_hxIj0C%{U zl*aDwo2$m12zaYGF7Ps&m!o2ytxi%c%n8FFs+<+z+FjHvddS9c;6Sc8X7&9~#7^^T zhp+$>MvWWQ7ORA+ZcKXvtdy@rdNeZ3m(njeB2naa%`P*x{Z#1eb7#%k}cJd=q zoQj_g1zAd8i()AM?gMC4BqL}gWnj-jz})}l{G|UBY2!*pQlSF{NZ`(5c%sbJF=jd3 zmX>$RwRWceHvf3~?A-NlSU&0Oea;?m)3C}l=8RsM0p=4ai@3u*_urIUMPsFp)9EL+ zG)U7_>LVIs+hYl=*0w(iVr$GVy{nSuaO~#0D zhz7sG**l?8@3;jWLC*5eH=I09+NY79QHUsg4GFG;$!3d4y`RHapZd&gjJd*WJ@|PA z${BFK6?~FV$&ExIQ}_`&p0(X(*KfmA{ClrI=KVc5jxb66_8 zd$nDOl_l&u!%qIr#y*}K>0BW;`W|AeYa|EQ-?AzMKPzd5aiY$Ya-h>nYvYzHN*=}W z2Ej_mQp6~k5~<z08S zwvt!kk|Tv-H?0jc8zAe%(Ei~hiw>eP_%Z?m43lU(o0<IZs!}TeI5LF@ItV^7PChQU^O+a}3ZqWPl zAXc!1l(a-O&Lc*U2BuiSB)Bmt z!rdI;5&h(EXOP1ifr*@z>PR`z2aW^t?P|yJ zv!WTIkW$&P@lt%}K>7SI-6jlyahteXH}RLxvLiv*O=%}7OL*tbYv&DOmfww;I0k{JN z5s?OvMhD(7GqT!ta2^1k^7z;9-n^GoI-J1dfpKz6;&}!AsXr?@E=`B4xg7Ofj&KCM z#eX&v;BGLpY2W$mr5VPJxi(dFBE+KtSBBnM?sUM6x2u~mLKvS>f%im5VD))GSg=G< zi`0ZXPM_|cS0N=3Rwfn@wufcI@x2*Ztx4m+PU*yD6_Q6+;p-wwC5m-lIXPfEU&C-n zc4{%&8e_sX)bU3s#D^SE7Dm`Lgyjkby|8|*Z?V7;5Ma_OYKAA`mjrWTP{TK=jR%SH zIq`=dl>hCld-wzSJHYM<&e`_1Yy7RFeOluo1EOqeJAroO{VJOR9Rp+MK>VFJ35!y` zRWnR8hrZUF$ZXs~)CXs-noF-pZyRT)A$QQhzdl7`Bv;nXO%phNmUbF_+RWO(8lPRk z1K1?q23B~&h^e~WPLUB1rXwIczS7k7*zv+9l4WFKy~VVlECzYu-oO9T?)#M|N(g72 zxS4(JMF3}wNc5>X4Cw%c*<%HLV2-OHyiwX!bDLV} z!vFQlh?B>YEcxy9hk%%XzNV78z0?ek@(PJuR05xy$Gq@oTtdUmcxffPla8Nw9SYq} zlZk7a0VSWscv-Pwis>XW5EPmKl1;Gwtn%>9EEw5gTEk?Rltj^$Xm!hUFnxOqb#e{Z z-@C65%XD(#4$1D!w>x;j1x~4?G}zya5q20pfgmHuxOqmQa^8zSn1CZqclapqv6BlS zxJqg71Rxx3?3KrrmKFx^9A?>VkloWpP}?@xT1=c zC^A!vwsXBqP-i^`Gfao#rx+$@^8^jmgB+P&fJVy*mC~TQOJ_l*idE9pPBRBOIRh{C zu~Io>bV#k9cPN_BIDJ5etoUUcR-L3Hx(&chEcE_@D-w=y@ExY#h5H5@uvIbr5qZ5RY+io>YFt!nD2Y!r+EC$xNl zEQm8aP~K#gqBjfZS#xJ3EMPE0cQ}nrV%)k^27B@aO%&hYUS~hBZKyia$ z+u5Pf6WGvHNJ^+T#+j61kcIz7a(i^aw4B+W@O^(43&|Ju{&~Ih%b(x-qK6a?F52xK z4r}vri!A%5EaD`xQ>JXteY0sW?@Cuf4cK4O#)~VHHkV_n5|QUIxR1wCt(BLl!4Rm` zg^t)9#qMWKjBWADGwh3Ek!uMM#umWn)L`R4*qFgo8bECBaxXMSBU7FrrNdiM1q&hi zhk3uX*%!Xp>A@&=U6gDFwO+-6psS!Tg=z$YCR`VbN2aUwLg;Y`O` z?9Qu?3fLa@BsElQVIG)Ej9|)!XkFoVs)imK8GuZx#~8+tREUH6tu>x{x5WWH{U>`V z4ZOn~kVC*oDFPBACe~(iw0Qhlm-h}W<(u^B`mYt?g<{SAb&IU$yxhw5VxsW@RQz7Df_*2ZeP8gzy``K4A; zea!8)Hafj#Z7?TN$3uv+>-hL1-fGp$vC{v|J{6~xEP22wR;7xIg{Ncv6jcb7AU<-d zTjm!MIQ7-`>eMnFKmYJ{luj;rd?&ncIdT79LiYEfS%Q86x?I+ra$}m&g!!+dF6|Sr;PgkFZ^R>qj`8Qyf55A$9t)VbsLDpZ*Qg|QRucI_-s^2)%|Mjo-jG*RC zN)3niU9&Rt5>@n3J;p!G<>f2sc{N4#akyJyy7-PA$4wiRaJe6{@OR>mkRz>%RFPnQ z7$-jonah<_{8402;>#ehD!UpsDKa?{oouFueSJ@P{@bVL^^A*PaeZ4yZa*s;fo)_H zCo+9-b!wJa5|36UMc^Rszoq;~NZpp|4Z9M2XbQTt52@gcmBJ5n8RZn;*Lj9+_f1xP ze6|kHrltlY;kpp+q#;4>VSy9vw0H*Ach~X{f2LE|X^}&qv}i>Ys*YB34!;Kt(|4@) zk!SPdxV*%H=;y1mivXn8*XTGtSK}(p;(1pCirYb+v^RNYv#`Kzm`n`VMY)J5&!= z{WDi4qu9aP2vWs-3^%W^-|38!U{O+uVof#Z!5=B|cY;qJXbd~U9f)6SX}%p1_((3< z;_2(NSCA7!nAU;g8lr(|&-D#);I@>(1Crzh=`zCzF13tJX6s#AD)|y^HmVqFBJ8sz z9Sq$FVwGDD9q`?Jdv+T!_w(=rx&PR!?Hw+KPqB@iOrR7du(wYfvec+;y!r$}&S*-I zy@y!6&f9c9R%;=w$R~~OEc?`i_invFTr3gBUB4lQ*J)4~P3gG}2LnD7JOV+&TVfmySeR4QR+aUY zv`^f}_)|Y=&8VST?8+%g$43?M5=Y5er3i^%{HENc~ zO#1h=S$E-GzdMC$+j;g5HV z7ook8z5B~{pJW30$8~FF%JM!}t9OI({Ew$IM@#0jelQsW97LX(QYzU*6bjz%kOD3q zYm5*@{gN^E>SUA7L*Dwh`BYlCjvMxKFu6|`AZnDV3 z;$!Q@+u?e%tyI^~p91LlQVUE_TX=}+1i81Z*KcrTVO;z-Y+epe;1Jg0JrlPGu_%5I zpMCUQYh61u#EoL=T>3(Seo(GSB+3=t*Rxby*D`G5;u3u(X`V1J#iTtnIN0F+XLe$4 zmg9{uWDL+9LK0#2lMlZ@ab3;fHL16Q_U5BcS`B(?bqdbL^SU%|CSvb%*F~j?%?I>) z5<(rE#$Z~hoA5^8l?wKT21Tt;UszUd-gvq03P{}6SQFO-oZjHc>K%ZIgy)@Bh}n@ zo>^Qg9Mc|b*6h!biGB)#rn4z++@sRi^pc~aPGTq0l6^wK5@CP{=9ql9#o8T=3v;TV zBA#Qdx>5#1)14N`L1=ZA9zktGFW}r!C{zE@pQdG%Uwnmc+eLq|rWAvxl>U*FE~W`U zgA9bf$k{C?|M=x-G4Tfl`M~Jk$0pT=%2pV?Uw-&s>%W9E5%dTe5StrvNhxM44Dmvd zRw-bc@p~VF*+)X`fisqh!&DoIriQ*w0jI678?X(!QtCErobA&BgkYS%-#z$zey>wY zAj5ESvNxFxL>V~1Qn*B-b0A@t&ub*iS%G`}CBB@LPRn`Q%aJ&`C99rX_h_184ddXS z)9_m5U9+-$dPuM*2LjJdpW83XuoRVCbS^45nw}IzxsjIGu!sC^7{6k;-oh7775vcg zq??%G`VYVAMydN`--nvNs(a03!?gWEr<{@Eq3Q8}urBp19$awRM3x%gCPkD}HEi?4 z*~Py1bhIRTS)MI;;MV)I2sff^`Ew5y(4ioaCK9?k?X8SE?`#)V^-VyO;P?0uoy85y zGz#3T6@dEkNj8FpD`y$@(3o6qA%|lZhm)`_w@=_xxRef)CJH(CkBrB3@dEpugtNp6 zm0SR#xfgovguwG2>p)YfjJZvwLTo>mJA&_5dN$Y-lcYhu(6fy)^(yAXL?{UkPU7!5 zGlh^|h;S2&vW>;oy4z6UD>iLM(rX&)3j778G}y_b@tu8P&aT5*B(&|CnQe*nl#+K; zwZwYciDj0v^WoxqchV0>rWi)mH$Rb2t%E%AzqJC#z1eJMHPx;ENpEKQ#@B<{KYJ9QO8`lJNvl# zTSbLj^zsuGQ7+;3l^=eiAAV&Ari!Szj5kDLkSV%Oqk~(vEFFC}W(QGe1O|IQTjXG-%znet%nqZh;+xq@6$Uh2 z$x!_~`1r>_;%Gccs!#AGg-TJ%J0#O^f-F0+Y(fNJW5eQxDl24%{n&Vs@3&WGYtzoH zbfG*xnFq%K`yGoHge{x8AzC>tfap`TkdOgL!N4+0z&|V2W{zgTU@x&{j56KI3#@2$ zSPP$gjh?;wN4iLN@W*gipkfp|$(;xOtTEn${8P0cF)5^--Kg0{_xrCRjW2Prp3~s% zygxyYcd>fINy9!G_CbuC;@pVJVyDr(za&-UW9tTobXSFn+33ke3Q78&#;fOs<^~l= zxYKFbiF5w--0P5Dth{FgJl!%}UE;fF`(z{1M)d(>|4jiisGkvHik&j6FNj@CB=(&q z;M=sqCAFA&h9rdSEbO^{J?8t%*=V_03iBrT2t@;2hhkd=CScjvOV9+ zg2Ow`wJGMWTj}Y$?_pZo2l;Lzn|~nAYHy4C)LuMY#};i~Vp*Sx^!4FW$TdIUiQa|Ip5QLs)94pxxGo^qVkl?fV4`@Z8kmtjx%Z>|pf^>ulxHSV;^Gqw+67ZW z+Yh8BbLx4GjUFnmqt7TnP-?D@pe zW3G?wnPVZPLMpIcNc8>$$LPo6e9I*loEbMEE~_FPx)(_V-w;Eh90QA2JGEy5WGl@W zVSm`BbuR-gHWm^ZftL5eVD-O=aX#Lel^z}K*YO4i*|T1r&+J6_)N>=62LD=GYgBSX zi?DixOT%|DPp-2wvavOZG5Bi>>S=?$!dRQ`RazcQeQn&@5D}V4=L|$EyDcqZd0?v4 zCjkWFsgD)0J+ zL6GD^GAG}YN={y;XIG0G?_kFje2lDCFGZ)f?+P^KNmGea_o3go;v{nAjKl$BT@eSku}}P87G+wzgz|9ki6_(mN#=d?Ydo07dZhVpSm0p?JNqrxQ#=BVZI_sPfvb#aFmZ=@qvH+)g#0mQaFXS zYo2zgZFu&0v`yVw4GQCb(Czi?)K%!8KkUT|M^NdBS>u)4fjPL+@v&j4J;;C7(GtW< zYT*4lQVaf9&%nT7V@BM|!%AZdT@Zb4D(pxSsmZ{0H7wU8=+GTx&8+*TJZ_h5;LW3c z!NbEnP+4>W)$!#SEilBv!b^q}GeOt4IptSf7d_7fa7dV+z{jN7A+lEZpqdd(R0Br0 z)(Y^1uAgouwr3@F=m#gi{N1t)T{;a<6C_LYN>7qeZ5#&Pt(zw*H%WEGH+0tRVJ>AH5b47F;D_^kUlpp} zSUdnEUpN{9Q6)^BB!pz`x5nBLA$pojLfq|h%ExGg-#^5KK^64UYrMSI)y`;RS-kbLWWfYYe3FN+qo(Iv%Yo@XS-G$CPVISxH`xTe>>;C?JvKoSA z*$%IUG1AmzsKzA@JzGXY2C8V9uQ7mw2tv20%!r1YjGfD34AF21Z`O31ob@)LszB%n zm1)MvbpNpS!0A|g9~v53gz~#j>}sm2ssm1;Xvlf&w2rfi-Jg)dLevEkbgFf!$uMml zHuhMrG)Fqf-2GDtD{3Mqon;zdyYE*6u6)TF_0d&SR1o(3umyq@8Pfll_^jPwy}rJt zH;gzKZNje>#K4lD%H$7@!9&SsR$7uo8a&icE>I%J*h#j!t8t}>gI7YLCc(U-6{Go0 zJ2ym91vjUhI#Y?72)+N{rlfUFlnS$KHoZkv^Fy4)+gR_*n7H`OIJfkO!DbZ-I@DAv z0cKhtEKM9xw($#lWY~_wr&-NsCB<+H8OXcS(^tVyGa*#S94e^28(4*Eaz;i*ZLGQA zGOLJkyVIg*ihm1*FT0G1h>jk z;}tO>FvA`yodOg<{OzYpwze}MxmZ)x*nPpRi z8R{KZ2{LRr>5lT9@FS6_jAUqjiwcFR!H~n$QxVQjPW<<83g2InQ%)WmklWc88C-RK zc^}gS;g=ZSH0BRKiNCjdL;&3TbSWuyK_Q2g{_3Bn%m+boiF z96Q^3;jj}DN{YC(GR=QW?X8`f8On@q4y{u6JE;svZ#hymhf-*IaYX*l> z2n{>&VBx%Q76|ZlkK-tNxPEIdubwVRAz7h}3&8QJe2apa;eg893NS3#+y39l*Ku31 z8x^I><_)W!2>tnpE3b<|2lzb;y0|}>KWu4enLnlXb9{1KT{M~fS5@^V=)Soy@S(u} z+>b00r+9n5LrJ}TkXME?SAd5H9vsK3T2__IYfrBp#~w+6E>P2`Q^frV8uip9iC+yr z%W6Qi*uC%Xt5A(xavx3InuDk~MgJfd6e%CwCO9}a{$sCh@9(#FN7ENO+-Udr_o!0Xu;Qu=ICJ>? zd^~_9zKYb20J$*L#)Y~>*_iuuqn9#_%FNXj_@AJTzvl|Waj6L*m)`|qxN&~&Y#ewu zcMu6y{<|=w;Do(=9wyT#D6Q2}83Kk1CmY!VkCcNSE(fqEWt>leD~Y;O+$99?h{vD~ z8~tBjdEq6&Q5dAImz$E^JLDH&C}S;fKtxJ909E`J|7F6Y5Q%~2DEq2kc$`R&AC@R{?Y>g?ZFM zAus#wwiV|tTMG*dRA-b_8FOXhiD=4dqiyRjTD_uX6l2sd*CQ5zu7{|ZT0Sl=_gj#W zbEi*GP!MLPevCkOxSy`oOSe$$Nd@5zNcHZ4jNaTgdIA|Y+j`mpMxr#gMWD8%cMv(kuI$h|05)%)*mea!qO=lmeedmk zUwmGF=<)wOJbaq^?`)_JT>A~H184Si5EFP38xME^NHxfHxJ&28W~8I(=3n%H`|E?K*^d6aR?o}w@B9yl{NOyGyB-Q z`0pWXqDYgm5iZX|6}ho20_MaVrqhm81~2V#4)s}Vk-a5p^~;$z+_2w`M21xUV5F;| zg;h{>!+EC4<^pQ$O{}BPTj2w$G3P9ABNErLz69hN)C8_4kRqfF6XlN*U5fu@417I- zPHyp3(z`DRzIQ2YI08s{BW#3deonKB#)zd;@^^-GjjisfX?yQ*cCjGOrF7R9=zl^0 Nin6LQby8+w{{toJc`g6| literal 0 HcmV?d00001 diff --git a/website/script.html b/website/script.html new file mode 100644 index 00000000..1402d7ed --- /dev/null +++ b/website/script.html @@ -0,0 +1,192 @@ + + + + Script CLI + + + + + + + + + + + + + + +
+ + +
+ +

+ Script CLI + Scripting interface usage manual +

+
+ +
+
+ See Examples + Anything is possible +
+
+

About

+

+ FileBot makes scripting and automation as easy as it gets. Just script everything in Groovy + instead of bothering with cumbersome cmd and bash scripts. It's the same on all platforms and much more powerful. + The provided functions are the same as in the CLI and parameter usage + is also exactly the same. +

+

Examples

+

Running Scripts

+

+ filebot -script "path/to/script.groovy" args... + Execute a given Groovy script. Parameters defined on the cmdline when starting a script will serve as default parameters + while running that script. Find scripts for common tasks here. +

+ + +

Example Scripts

+ +
+
args.eachMediaFolder {
+	getSubtitles(folder:it)
+	rename(folder:it)
+	compute(file:it.listFiles().findAll{ it.isVideo() })
+}
Fetch subtitles, rename and compute checksums for all media folders in the file hierarchy.
+ +
+
['E:/tvshows'].eachMediaFolder{ rename(folder:it, db:'tvrage') }
+['E:/anime'].eachMediaFolder{ rename(folder:it, db:'anidb') }
+['E:/movies'].eachMediaFolder{ rename(folder:it, db:'opensubtitles') }
+
Run rename on different folder hierarchies using different episode/movie datasources.
+ +
+
args.getFiles().findAll{ it.isVideo() }
+.sort{ a, b -> a.name.compareTo(b.name) }
+.each{ println getMediaInfo(file:it, format:'{fn} [{vf} {vc} {af}]') }
+
Print media info for all video files using the given format pattern.
+ + +

+ Function Reference + source +

+ +
+

Rename media files

+ 
File[] rename(folder|file, query, format, db, lang, strict)
+
Match files with episode/movie data and rename according to given naming scheme.
+
+
Parameters:
+
folder - process media files in this folder
+
file - process these media files
+
query - force series/movie name, auto-detect if not set
+
format - episode/movie naming scheme
+
db - episode/movie database
+
lang - preferred language for episode/movie titles
+
strict - turn on/off strict matching
+
+
+ +
+

Fetch subtitles for media files

+ 
File[] getSubtitles(folder|file, query, lang, output, encoding)
+
Download subtitles for the given given files. Lookup subtitles via hash or filename as fallback.
+
+
Parameters:
+
folder - process media files in this folder
+
file - process these media files
+
query - series/movie name
+
lang - subtitle language
+
output - force output format (e.g. srt)
+
encoding - force output charset
+
+
+ +
+

File verification

+ 
boolean check(folder|file)
+
Check given sfv/md5/sha1 files.
+
+
Parameters:
+
folder - check the sfv/md5/sha1 files in this folder
+
file - check these sfv/md5/sha1
+
+
+ 
File compute(folder|file, output, encoding)
+
Compute sfv/md5/sha1 for the given files.
+
+
Parameters:
+
folder - compute checksums for files in this folder
+
file - compute checksums for these files
+
output - absolute or relative output file or just output format (sfv, md5 or sha1)
+
encoding - output charset, defaults to UTF-8
+
+
+ +
+

Other

+ 
String[] fetchEpisodeList(query, format, db, lang)
+
Fetch episode data for the given tv show and format episode names.
+
+
Parameters:
+
query - tv series name
+
format - episode naming scheme
+
db - episode database
+
lang - preferred language for episode titles
+
+
+ 
String getMediaInfo(file, format)
+
Get mediainfo as defined by the given format.
+
+
Parameters:
+
file - get info for this file
+
format - media naming scheme
+
+
+
+ +
+ + Hosted on sourceforge.net + | Creative Commons License: Attribution-NonCommercial-ShareAlike © 2011 +
+
+
+ +