From fd99dae289e3e4b3eaa8a34cfc326b27b4618c86 Mon Sep 17 00:00:00 2001 From: 7rans Date: Fri, 23 Oct 2009 21:03:21 -0400 Subject: [PATCH 01/27] Updated files. --- assets/images/logo.jpg | Bin 0 -> 29953 bytes example.html | 35 + example.xml | 13 + example.yaml | 14 + index.html | 188 +++ rdoc/DNote.html | 354 +++++ rdoc/DNote/Notes.html | 1137 +++++++++++++++++ rdoc/LICENSE.html | 121 ++ rdoc/README_rdoc.html | 160 +++ rdoc/Syckle.html | 159 +++ rdoc/Syckle/Plugins.html | 162 +++ rdoc/Syckle/Plugins/DNote.html | 490 +++++++ rdoc/created.rid | 1 + rdoc/images/alias.png | Bin 0 -> 764 bytes rdoc/images/attribute.png | Bin 0 -> 613 bytes rdoc/images/bug.png | Bin 0 -> 774 bytes rdoc/images/bullet_black.png | Bin 0 -> 211 bytes rdoc/images/bullet_toggle_minus.png | Bin 0 -> 207 bytes rdoc/images/bullet_toggle_plus.png | Bin 0 -> 209 bytes rdoc/images/class.png | Bin 0 -> 592 bytes rdoc/images/date.png | Bin 0 -> 626 bytes rdoc/images/file.png | Bin 0 -> 342 bytes rdoc/images/find.png | Bin 0 -> 659 bytes rdoc/images/loadingAnimation.gif | Bin 0 -> 5886 bytes rdoc/images/macFFBgHack.png | Bin 0 -> 207 bytes rdoc/images/method.png | Bin 0 -> 452 bytes rdoc/images/module.png | Bin 0 -> 853 bytes rdoc/images/page_green.png | Bin 0 -> 621 bytes rdoc/images/page_white_width.png | Bin 0 -> 309 bytes rdoc/images/plugin.png | Bin 0 -> 591 bytes rdoc/images/project.png | Bin 0 -> 909 bytes rdoc/images/ruby.png | Bin 0 -> 592 bytes rdoc/images/wrench.png | Bin 0 -> 610 bytes rdoc/images/wrench_orange.png | Bin 0 -> 584 bytes rdoc/images/zoom.png | Bin 0 -> 692 bytes rdoc/index.html | 397 ++++++ rdoc/js/darkfish.js | 116 ++ rdoc/js/github.css | 93 ++ rdoc/js/highlight.js | 1 + rdoc/js/jquery.js | 32 + rdoc/js/quicksearch.js | 114 ++ rdoc/js/thickbox.js | 10 + rdoc/lib/dnote/command_rb.html | 56 + rdoc/lib/dnote/notes_rb.html | 62 + rdoc/lib/dnote_rb.html | 54 + rdoc/plug/syckle/services/dnote_rb.html | 54 + rdoc/rdoc.css | 786 ++++++++++++ ri/DNote/Notes/cdesc-Notes.yaml | 104 ++ ri/DNote/Notes/counts-i.yaml | 11 + ri/DNote/Notes/display-i.yaml | 12 + ri/DNote/Notes/fu-i.yaml | 11 + ri/DNote/Notes/initialize_defaults-i.yaml | 11 + ri/DNote/Notes/labels%3d-i.yaml | 11 + ri/DNote/Notes/new-c.yaml | 11 + ri/DNote/Notes/noharm%3f-i.yaml | 11 + ri/DNote/Notes/notes-i.yaml | 11 + ri/DNote/Notes/organize-i.yaml | 12 + ri/DNote/Notes/parse-i.yaml | 12 + ri/DNote/Notes/to_html-i.yaml | 12 + ri/DNote/Notes/to_json-i.yaml | 11 + ri/DNote/Notes/to_markdown-i.yaml | 12 + ri/DNote/Notes/to_rdoc-i.yaml | 12 + ri/DNote/Notes/to_xml-i.yaml | 12 + ri/DNote/Notes/to_yaml-i.yaml | 11 + ri/DNote/Notes/verbose%3f-i.yaml | 11 + ri/DNote/Notes/write-i.yaml | 12 + ri/DNote/cdesc-DNote.yaml | 22 + ri/DNote/new-c.yaml | 10 + ri/DNote/run-c.yaml | 10 + ri/Syckle/Plugins/DNote/cdesc-DNote.yaml | 79 ++ ri/Syckle/Plugins/DNote/clean-i.yaml | 12 + ri/Syckle/Plugins/DNote/dnote-i.yaml | 11 + ri/Syckle/Plugins/DNote/document-i.yaml | 12 + .../Plugins/DNote/initialize_defaults-i.yaml | 11 + ri/Syckle/Plugins/DNote/output%3d-i.yaml | 14 + ri/Syckle/Plugins/DNote/reset-i.yaml | 12 + ri/Syckle/Plugins/cdesc-Plugins.yaml | 14 + ri/Syckle/cdesc-Syckle.yaml | 14 + ri/created.rid | 1 + 79 files changed, 5141 insertions(+) create mode 100644 assets/images/logo.jpg create mode 100644 example.html create mode 100644 example.xml create mode 100644 example.yaml create mode 100644 index.html create mode 100644 rdoc/DNote.html create mode 100644 rdoc/DNote/Notes.html create mode 100644 rdoc/LICENSE.html create mode 100644 rdoc/README_rdoc.html create mode 100644 rdoc/Syckle.html create mode 100644 rdoc/Syckle/Plugins.html create mode 100644 rdoc/Syckle/Plugins/DNote.html create mode 100644 rdoc/created.rid create mode 100644 rdoc/images/alias.png create mode 100644 rdoc/images/attribute.png create mode 100644 rdoc/images/bug.png create mode 100644 rdoc/images/bullet_black.png create mode 100644 rdoc/images/bullet_toggle_minus.png create mode 100644 rdoc/images/bullet_toggle_plus.png create mode 100644 rdoc/images/class.png create mode 100644 rdoc/images/date.png create mode 100644 rdoc/images/file.png create mode 100644 rdoc/images/find.png create mode 100644 rdoc/images/loadingAnimation.gif create mode 100644 rdoc/images/macFFBgHack.png create mode 100644 rdoc/images/method.png create mode 100644 rdoc/images/module.png create mode 100644 rdoc/images/page_green.png create mode 100644 rdoc/images/page_white_width.png create mode 100644 rdoc/images/plugin.png create mode 100644 rdoc/images/project.png create mode 100644 rdoc/images/ruby.png create mode 100644 rdoc/images/wrench.png create mode 100644 rdoc/images/wrench_orange.png create mode 100644 rdoc/images/zoom.png create mode 100644 rdoc/index.html create mode 100644 rdoc/js/darkfish.js create mode 100644 rdoc/js/github.css create mode 100644 rdoc/js/highlight.js create mode 100644 rdoc/js/jquery.js create mode 100644 rdoc/js/quicksearch.js create mode 100644 rdoc/js/thickbox.js create mode 100644 rdoc/lib/dnote/command_rb.html create mode 100644 rdoc/lib/dnote/notes_rb.html create mode 100644 rdoc/lib/dnote_rb.html create mode 100644 rdoc/plug/syckle/services/dnote_rb.html create mode 100644 rdoc/rdoc.css create mode 100644 ri/DNote/Notes/cdesc-Notes.yaml create mode 100644 ri/DNote/Notes/counts-i.yaml create mode 100644 ri/DNote/Notes/display-i.yaml create mode 100644 ri/DNote/Notes/fu-i.yaml create mode 100644 ri/DNote/Notes/initialize_defaults-i.yaml create mode 100644 ri/DNote/Notes/labels%3d-i.yaml create mode 100644 ri/DNote/Notes/new-c.yaml create mode 100644 ri/DNote/Notes/noharm%3f-i.yaml create mode 100644 ri/DNote/Notes/notes-i.yaml create mode 100644 ri/DNote/Notes/organize-i.yaml create mode 100644 ri/DNote/Notes/parse-i.yaml create mode 100644 ri/DNote/Notes/to_html-i.yaml create mode 100644 ri/DNote/Notes/to_json-i.yaml create mode 100644 ri/DNote/Notes/to_markdown-i.yaml create mode 100644 ri/DNote/Notes/to_rdoc-i.yaml create mode 100644 ri/DNote/Notes/to_xml-i.yaml create mode 100644 ri/DNote/Notes/to_yaml-i.yaml create mode 100644 ri/DNote/Notes/verbose%3f-i.yaml create mode 100644 ri/DNote/Notes/write-i.yaml create mode 100644 ri/DNote/cdesc-DNote.yaml create mode 100644 ri/DNote/new-c.yaml create mode 100644 ri/DNote/run-c.yaml create mode 100644 ri/Syckle/Plugins/DNote/cdesc-DNote.yaml create mode 100644 ri/Syckle/Plugins/DNote/clean-i.yaml create mode 100644 ri/Syckle/Plugins/DNote/dnote-i.yaml create mode 100644 ri/Syckle/Plugins/DNote/document-i.yaml create mode 100644 ri/Syckle/Plugins/DNote/initialize_defaults-i.yaml create mode 100644 ri/Syckle/Plugins/DNote/output%3d-i.yaml create mode 100644 ri/Syckle/Plugins/DNote/reset-i.yaml create mode 100644 ri/Syckle/Plugins/cdesc-Plugins.yaml create mode 100644 ri/Syckle/cdesc-Syckle.yaml create mode 100644 ri/created.rid diff --git a/assets/images/logo.jpg b/assets/images/logo.jpg new file mode 100644 index 0000000000000000000000000000000000000000..626f6f43e6dd4bf4fbeeab2309bb3966a12e7d5b GIT binary patch literal 29953 zcmbq)2Ut_hwrB#ON^dGPKxm;?CDb4#2`z+PM7s2jbcN7SdQ~Z*Nk_UgQK`~9ND~1; zihzJ1VBy98{O6qio_p?l?|x^8z4w&0)~s1GtIX`-^4;YJ01ZkVsSW@FfdB;l2e@1X zlB)$cIRF6K+5jj303ZdB0Oao{#>*^Tl6z{sZe@ z__>gM=Zk}%TzSiIXH&=Hb zSbzfGAH-q!^zUL(K0J`OodXP`s{SVkKBvIc%N{?x{~-2XI`+HfkDlSt!C?8{ zS=cQPR}XJ}d^hbC#pOl+wdfyUXr};sR})nyH+y#7nOer1f7qh_Ar+Px7~b|91o(J$yZU96db$z1%$iUi}y0 z{i6(qaPsl>@D5az7ya*L|2sB(ogDs$k^5cqm&Si*VI~-R9}ic*-y{EfIDTKE;=iBr zqW`V__n7=qX!`#^`fL3^kp78d=nmPG{=KmOu6=)-qj)gbEpK~k zUwc*jt%#pOGQwgK!s0g##HC=r|HK5vZo+=|`ClM^Gyl6t+r!SuA@JWLONjp!`7ef|QxdgtY4>opkxAXA#`3v)Z!v3#i zsjdBgm!_NBA4>6uOtiJ}dgkqP&)!bm+rtg~Tkkxry?yKr0zK^&_s4zf3GZdlt%O3RD>H{8EawDYj_!y6-CJjK5mS9}4U z@IO`XZ%v3f{QorZ7h=Ch?)O~!uR{96UjAA7kB0w{ocEvN`n!$)S2pbIZr;3Me^Uz2 zhLqI*&{ICJ=>O7S+1dVMxIO*6UH@IUm+zXCcQ#IPJV@)oPvhpkL%CZ-!lLD{7nQ%LPA1GL3xda<{ASP6&1tp2NeVD zAE2~;bU;j%r$t)?Y3>F%Z6nkM@rW0s;ach~Rgyg^yZj z2{^?G_2}SUAnTNZ@H%?T#N`5jf)I%39M6Cf;Nn@hG7inpKu$#PA18SExy{$^T@{t@ zZ5q;j>00%IvbnKZyRy}a4iiG*2Iu{c8^HB@&ilo%T;Uf)B21R(xHMvy&>=T^biJ-p zcnL35i5NRQw4QS&3v4P^OnE`>5L(QbiZbMUZLM6K?3$Q+vidb2t{`S{_@2$rIzj58 zB~KTY(KlU%)^n-?eQQq!i6#@+Spt-E+CzyHtla2YcV`^`Q@Ierk4SV)lr{psF`>9b zbj_4D{m6XW?fBo$1$DIDk#EgQx|zB5esg}d#@H#;q2ttl#JM@$R{)&tm9fQUe?Q?h zD6F^yxjjAi#CSG`Xp-_d?czi8;=)B1``QA%mgQG8ARIjyPTFOQ8Y2i>E#xm z{pM`{;}KO1{(-g{(B7nf$Vp?VlI>@U6fP5hUK~neNc%qHikyiod+py+MC6p z?kURJkRBb#kK?b5I5t~I2DhitJZeHYC}krkNXJN|C)KbXEi5cnaRN=|MI!~X4^AfnPtWvY z&4fFLo}8kRi$2=jZ<@-yk65u1J$b~Je_+(o_iMgaMkV}A@3taYf^bxEDvAtw60cPp zML^04N21A5sVb>B22w6(p_Xqtr0cVXO!M_UY{VOOTnk%WxB5*~UQdWB=Mtd5?8y*d zpQ!&Hi(a+=#7@AY_vhQ6-mPA~{v@lqv8-slGi`ntlI5Y%u^Pcf*a)%F&g(S z0cI=GuTtGF0h#RAS{{}2nM@nKH@19Bu9|eStejFnyF$G$0{2Edsveu_Ltusbtno-g z9Gn2hl1fts`vbj>{T=U8_2dojVD+5tH7uAlQ^Iuivw4~>0eyfdz>fW}$*xHId0EMS zV(%0sw}%LC`ZKQ^#p>Gs7?Yvuxe4p(o4Wp?Z-QkeWAZ%z%dsL`3p#+X;IQU7%d0v| zhp~Wj11E8TVQlsK11Lpi1;$8qd#Fc`r9+ZV-z_s;<*AWfIRpXDg%iU;?pzds)6NRd z!&**m2y^w*1z^?%TnkWXj%Z!%{^ zqihBcJ2mF|ny{b|w!5!O9FxwqO}58MM`Wfv;$frntY~)S?W3BM&HX_Ccar$(ou5iU z5=#wxd?}0TYS)pP;e4JDjt2*D0VJnH($2-WTdkJftR;z*JL6KI%X_)aBFxL8@Rp5I z*5)qJEH-Bq*E>dGHHaOu1uKHtO*vu&+(^jXxFDh8|E(%Oapjc%L7&+5&Jw$NR|pEX zcrEH%P}tVUYADH)0qs#yh@x!oBBjk+KNtx*Be*YSi@LMTd;RFFrk%hWO)5#C`@Y&I zF)nH|Uw}CJxffid!0J0eaK|rSgXTdLDet|*g$O|mT?XW{)sy)2lZE9vjM>O}bFj7@ zsInJE;GF^D?*Y(f?-3idKDXa`Ucw~4sP4Ihd@asU%u_n8Du)ZxJvky-Ot4nHJL0zO z^Z&HY5fR&IvBptf+-BNQ=I$$;Za2T%MM=7oJoC{;f}@k^K`lF0+h&`RGXX2g*XEdC z^)&B2JDjohPm-OhJq|ZoZ3I_$EuxI9ItEZ?l;J=W=FKe>NobHm@Zlvuv`jFq;NQy6 zClq4swiZH}U?w0N*K8h3%O`1>B7T4tbEOb{n2F^%Z{2yf|lC{*if-+n}J=c{>T}uZVjr>pMp$<0UFExInE^3@9~& z5XZ8|C|DKBH_?x%TBo>S9kTUfO<7ZiZDxt#?(DwaNhA5*8%w<{uK&SX&?`Ryg2{LR zOHU~M=4ikCtQZvW5;QWB<~JWHxkKO(q2@oCPh4A=xu4UDUMaWlQW!K*q0ZK0m?-Ml z?j~?T-I7Txx7q-HW3i(LqN$4^8v+mr|D%CqNpez|WigxmrTU${YfLwH7_ABOfuj&PylUNMH1Kgur9?~@b@a(7#~GO1u}ln0H2EAlZ?46c-UH!SxZy_8W+e$@$DO7Y2>WNcrN?b=svMYSJ8}__ss;D z5=Y~=gz}@|e0hVixEiX9{}z@u2t7Pl<4 zC+wCsTqQgcoM^|lmZojtBoYK)7t9dQ?8$s*Tsw(g(8xqH9zgY;6>0ki#@PrG@2`HJ zNiwc6TTTL_ik679nV#Ny!f3|q#!}IutCi6zK+in`$(IBf< zKn8G)|3>pqmUWK~L~STlwb&gm?b`GN8J>-sx#8mOeh9tmsbJx?M3$bjI|S5#_Y!f8lb0 zZR*(|Y|4qt8$V0wg;5uIIa7AeNPf-ypJ#;aDnz%s|J$WArW&b)BMI3+p%);6k z-O#=FPV1g#y!jwIpQwSt!t_K@`!?UB{nX-L56V>jWq6dkR#aOd`kdhoXTRmE%dC_Sf0(?;3~l!>c{#4^GZ#( z(giP5I{AS~e(5pWvsSahU_6GP@_%DBMtFP7>R z$)sFp#LVIKZ+8s%oIh^;n>Y-x2X`IUmqJUTLw=qWcBP8chGmgPY^F?h`&DTbgxf_|3W(ksdMtn0qorku4H5WGeS(nkXg#brz!I2O{nQInVv#S!4;Kw zgWT`RJ%p>oHx^ZpRj?Z}V;>P%10aoD^n3kM&tpQf2*2pHohFRYLOOW(n?Kf%*vjMC zx-+%U)M;`ZSSrrRY>{tO{J!O^h}B%Z<`8if<$ z^cYJY+0o+|tv;jb5I@DB?_1)XKdalY9HGsIKLx$OKlpC6@pZ+gSlb82GX7E-J^BiE zZg(*@3JWAy>vo)Lp$p-PmZA8PM4M4?l}XEb&^NNyOK?_rvWXrj;MUo+hTH(8;pR{Y zKK;hi&7lLBIx4zrwq=cdhl{K-=h{~y+&o{ zdSGBb?o5T`L*6@#{BZlJ)8PHnqx@p&X|sFxcM@#%es#5nxV$bMd8pP>ddou=2P~Um zTW(|twt2#ru4|Chv%no(se&!tP|9rmmDWDC;q#bpWApp``M|nQW#7pSp49XCgcV}X z7sPAvmf%OgX5n{tjFw-1zv4AoPgjTx?FX9MWiDx8QWp!5Hl_CwtAxdZat~)=6 z8s2;C_6`JgR=o=5-KBhxfS$0MU(FOMnQ3NMx5Gtb@SB-w=48z>63L1L@usGyu9q)j zxenZ6v(umGiR#ykvX~nk6|U^WPh*a4f<=<`3a!bUaOvglcd3eq{HwdFb3{5WP+*HC z?h3EhQdjsnAw-lI1A=&Kb!3{5L6oIg4B>5O%~Ctartuqz`%-TrXs$gRaAFdDYCB6k zeAASQzllUbZ&rZpR%D+sLriMQ6Ei*Vv(>V{FvJ~L8Qpv*%kjoc zn2KDu0P`6i|2H);!{#TdAWnfqE5Lmzjs8&4^*L7CeuQk@x1HiKBuTlNy*-*KPaO{`Ds5%LtR=M&JJ<3zqJLs?YOs3EL^E_tqNIv`=7eYbt1 z#&%B4y70dTvDo+pY_A*K3HL$@9T>AFNNKnNc(y?{+%A`1R`~?oD4-;LV(Yfvmf(H1 z5=U3y+dWY@LBE!E%Jt&fIk!`{zbH>Z28N3vqLC8tjgrK(`eqx8oz%W-7&g@I_}c@S z!e=HnqSm7ze#XUASP#3Uz`mmLxj%^k-OLo53;A#qUD^uwtCr)#kB+iGR2IuT1>GK< zU;B0ctI2KtU*__tr+fBujj~D4`wIK2n@-dq#a+n~0=Im@nQtxuda6eX<(q=i6AGpJ zd)}0xBLz{S!qUU{mtJCbP`Or3D*beEm z&y>j&LXJ?1L)G&tyU8It>!5`nf6rtxhux#r*v-e|Z>Ni$DYgk5VG9&j=XhsF*FJ(< zr)6Hi>e}id6(n)7-^K%*CHrq~^kUhXeahTFm6PsZf;mrkIGxd`WfX0W@Qe)kN!7JG<$cVcv8-V8m`9(?DsGLs)l zJW=!Lto3u)FZCJd$;Di5pd;&d;pPQ{5W+gx-NYG2)h{(fuCrh-3+HW$)j5K9a!$@u z&aK|eqfZ?!0iDYoEPkhZbLohd(RZn-jyFt{$iChUjxDM5@=3G+`8{^GY&9299@u7x zVVHuFRO?_cxI(7PuJov45|5ZKzko4i&~D1cM)b5mG_#wfcY4I}lZOf6JeGBQqY=4l zHT3nplP8ODq5VWrBM)brdvTRdgRxQNIiozLhL3UP7!*T>fEpAzTe7ir_Nwd^D}FuM zxbJ?p``E7Y)6RL`^LMa95Mm!p5{f*Sa!8 zBhu@}Va8Z~{>QxP{8#KkBf|}|Zh4Zu4U;}b0T1IlHQistw0dG_yc6 zxJqa;256+li7t#{;M32No9X=VX(j*r$t8fS+IlX0)w}&^X)YA?P^2?+;WH!cyb}~b zB6|ffVZ{TTAR|~8G71rhFo%HV%^#Hy#;N2AAON7^mZA)WWNQHgRM7PLk{8NqzR9i| zLD?iMBmH(-f@1f%5$$lU%xsOI=tlKS#Zy#LP?+A?V`+8OVu*?=)oKZ?3C@*Ym=_y4 z?w!l$1-%&@;o(6rF>CE2cthixxiQ|KF#wr1@vSwJ?IW#-T#`1qVOS&+e-HxOOE?F{Q~w5EI!G? z#Xu0^*M1Xlp+nb*o_OF`Wwp}wvRxc1YU@QUjm9%2EKvP z_KQNkhe-BRB@OX(7bOVc(w6WlS*-hLb}b~W|4Zo=3v*6L+a@TC6iZz)0c`vd5 zt^aoEds3?KkLEV_oXv?XlxIk0k^71u*U-fYv%55nwZ%e?c>{{9os1cYo_+~!Ybp(p zoIz9}@KNdw#Y(r-zziDyal^G?_!J_ zp3#q$0YBsN3ujwjIbdMCd;R`gHAP2rL#cq7J>>f5GTJguGK%ibRzeLRoT${ey;Hr2S{lqu?dDo8mRfYuF&QqGARD2h&8U@V=83Rj zIMhO^bl9sX%^M#|TU27O>1()PG63I};jdNQUMYQH(K({fH)<#j0>rsdtz{%`oU>#iNTd%-^eWzqe<1WG&V09WVO1-tJT^c zavzvHOzR#BXNc?)ISql9Z(1w3e7w1a&S}V71}zHPtD{-SJ|{4ITC|^Rrv91MlPRw{ zPC0Kg5o43GLo)Ex-&lg4mqx1?L}K8lS7o$52~%35-m{>jl&_j=mNjX43`HlYujaWR z_Sn=t>jvv#LH~UX3tYfX!EK_5rO8RZ&Bk?f*L=>{S(aFboZZCc&qkh}-G~z!ROfVE zL+INF`3o@j_k=q4TRt1y5bIZQr+=Ckv3uLL-*&v3Y3-W2`&6J^09${8ny#C08xQMi z$ql%DQIFirOF#tR31x%3f|F;~JP%)vGwDTedjj#q?6poO9hsbGoToA1!0?~ozPA1Z zhsM=9^`+*Q17OIY5!nni16B8ZNzh@~qyiHkZg{MmaSQ>R+Z z9SpkOM!#&T{;oE6%bTD4(A^E~be`KKq`che8vN650oPZoAkw<>^t^}+6}w|te_%qt zn5{D<6}Vwmv{EA9gfh7ELu_tLC~*vpLe^j|$8J(bg@Wt6wNzPqoFs52mt0M%Pgpo%d7WAOebrx{8t8QfjX! zP~;iPsmg4d(YZFkoA(kNpVauNg7WXDOCvq^0RFl6%|e~y8F{5m#XIj@0@xf0h2DDn zR1H1BwOPO%ZD%OJH(aRgsQxvfBthuEz8(-e&OZ4b4{b!E&bkKWCLQvc2I1AuWSb{IhuGyH7=K3AEl$uM1FlNG;4zCYPOW`32$wOCawoeo+qzpJ>PRiw1v^%n@nAp!D-?& zoy8$xW#pR}1L6~C$54?7cWZ60TTTzqZLP$*rOmKFa{#Stq9Nc@>7)1V*3eWy*UQat zcmbgd0Y%UwOBq6=$AtO}&uWZgVQ>o~_hFn8Bm? zB!Us*^-~pwQ96~hGtjLwh2WO2R)Z5~?UC6S{^KH-G@54%g%`LKuPz@b1rrMWVC||sl`P#cg z2R~f7?+(@DLd?BIZQnWV#%~Ak=N*cjDa~%a@2&d5_h!}CB5uVBojgu_{D>Yl04nYF z+NdcCq7>oGe$kN~`}k-si~DE;E{Lr=`4FNPwbnrTB2*zLc;SxqbUr~8)FJjF{u}9Q z&pt-)kyJJ}7j=J><~h0vbP`EZPZyb7QZ68iCWC2Hn4Q%-eSIoee8;>5uJjne-Qb=6 zT-1r5hu^n^)B^4#fXv`@=CS(l$neM2;?vKWq;>u1XTejmtYcCk3>KPYBrV~i(7}v- z0zs7z$`!(fN6v`W`>{1U`UVR$6i5Wgs zmJe5Qx|p#wyuLm=^_b8juJCa(e6Rf0W0FgNV?kx4dpeSJnD7ubef8qjlH4~XYXfvL zgQP6zvlRV_6vO8{lyOe~7>Ybf1PpApnkp=UJ7IH;?}16OoHP&s_z9537^v+4}*n~2zsCoc9Ub0VUXBGQn1d7XJ0 z6W>US9=0q}_usZ+VTls(kV&Kb*a+0r4b#)tPFZR&a|l(;G0WlgrQg)uQuK>aD^Us7 zLA@%bQF@Ty7SVs9@+O+L&#BXm=bAq~q-2DY;AiA$aUbTG$3ea3CY`jvlU|b(OTsna zqYv6ytYe{fnZAXkWtW5PJ%`g~i=fA@1_s3C(j-Xu`b)*tfM{mV`^laenFlR_U%5VF zm1Tx3PKyj>n7muY@pezhEz2CLa4SZ9m-PW*eV?n*RhN)KOApf_#d_WIWL&XeE0U|Q z+2Fq(uaIND;wWrLEbXRhqF}8S^5QJM`<37%%L^2M>m)jd{UeAYr1`5vkEPdz76QSVSzu0;4 zJMTsf9SijZeZ#bMEE-TQ?S{9ZO`JhOK<*wrTj`9c%$?~?*Ng44va?CpcS9cbdhA07 zzt6ey9SX}Q;-x~}VKiY9$==~DLv6A<-V9D$jFNJ*W(h?uU~WeV`l>gJcf#__lWoo7 zE7CiEja8RUCBwdbrus_j4irO7Z>7gB<{XbFddohcWITfKZ;Rc75m5UlamtSnm+UVv zkcCwjwHz$34n|<~$uWTuN54E&L-i-_%X_^C)IO+rI%H5WaFUC%xLY4Z%Vl4`(CRQ9 zFkvn@v)q2yac`4-Bo=M>bZ$iP&Th@JfWDJrTwXO0{(8>zX=8B#8!ElHt(^4|K>uvR z)zs$Hb9t{a*4&vH)DcC(GVMxtB$4-_sNh}U%TJ`e*LuaC$|JKlD`)jQ!^rP>ahm$( z!jrA`DgEpv8;W^Q$3MRoie8VYNG8eOQaoXN#Q4G!V_^M8oLTpNX{SDmt8GwTW%cpc zmtk_gS?Rg){xF=DN_`gl-Q5y+ zz{oQL;HL70Hi2<*8E~1S{JUZI;QKeQvWh@5rPFQIFJ)6Rs{UHkFQpCl_7S>m_wVk( zo%ly82KEW>eD^&Y2U8oeA9MT|51Bv1zUm9edN|d6rqG^MV^Sbf_QJ*@D_20jxChjg zzNo1enOLb$&-`d{V_SjzOG5xPb=#E!d%+(ScR)1t)Ay~lv-7Gw27xq2&wP+Ns0`Wf zLDw-P?@ppe!xcz1*HnFzymC zCN3>tp`qU4Aap1w*c3LB2-R~58OU~8t6w0MZ>z*UV?Y230;iQ-jTrYojDWO^DH?jd zELOoz*zBtpHSNFp7re&Uw(NrUNkPv1@^^4Q%xPA2g!^GaeW3fu-rFC>%JpX@J_i${9KzD;5JUsWsYo)pu#8Gh}9Yse)TTZtD^aOx3rRgt5Xcm_Xo z@_v5W@dW0xeXK-lR$Zk>#jj$i9I=*5`i=B#c0FlCzSR2N#<~ZmG5HNL1PYZ=am1%g z{sN7N#6i7_LC@%joceD^JX<)OxytlWSWZBG>Vx`PeACmY=2;Ctt)0LmW-<|JGR-oH z3^LGz8->rE&h>6R{rMnwhUnW}={A6|Q%5iJc9mA5PrA!X^_+%y;U$Jm&~;(HZ0_0Y zjr14H!%7~n?X=00Mrr4D#0ZpP|+0UPgb8lUhXbj`FgR!Z{z>}TowueMjWY2%yS1W3h6gS#u=zmEW`+=ES5|L{LKO-(I<2qIv8mjJhlK944ynC6dEdn8LwxK@+1 z_c-D>oUJM#K?#wG$AsG#Glo4?5oK)s56XW+$%(ja>WfxiefKLABpZ)p#4C(`HPQ0R zVd}W=)Cq<&4J6H*rFL6NLE)7B6^1Mh9N!DEt9denuQ2zgX~i`+JwGdM{@Qr!Fw+E6 z4-@2v@R>r&x>S9{Uvin9`w*}F(E0X|uo@!luk#?FQTgqiQ2b%B;;vZzifl}MGDZAi zZvMszWkN-@(0mh_R%2L3IT+07-UNE4Om1nfdVKJtukGzi>nc-D5P^g7qQvW$>>6q(+lnyp_|U22eT?}AYeqce8Y$sl?7 z3oJ~JweFZBVr}@KU0Sll~Sj+;P{(df7NEBUjn8f{tt8$T%Pm~ZAZ@w2wWiy$Pe`md^*JQ z(jB{t65s-ElCJ30U3{ZO)xB`oe!6Kum%KR6Qy6MHT;y@#fBe4Sy4!7iNAPKyLNP~< zzYp$hV=?Y#f;o(ENqzlw82o}>&$wXC)JqU)N~(uoNd<+Iyt1zO+MD=*CQ<|ealqna z9uu~!RE1lzZ)bEGFUoS)OJ1Mu$=lP26E}6r7uUe(rlvw}7j|A50=m@4@;_ zBNF#I+v6$qw*mauV7s(m2-nAgC~prUEC!;e=7d!bKq&vv-?RFUQoSzCvJ4ljD(5_sG@l0 zAZ{&yJRe5l_Lv}>*CK~5LX1qh1vf+ z3=%sOXzF2bBTWVDj+sn|55usL-=Y}yT|!Ed+z`6F>plIu)lOF_KDC7CE?_IMsTr++ zeO1z&7vsIbw`S3VuR}Mn-7_iWf=QBJCnH9J{MU$9e?Z?~cbxyR30c(xN>Z2u zn$qZ0+f12z9(9i%jp<7KQ1WbV$!B_m*>ccfrCfacCUraW9Z8R&>PCrQsWZP& z7qCn7b9iQeTWhNmks`OztacznoaAVtRn;_US6{_+rZ9H>aCoTMRDSQ;`iRMj0BYWy z{#-NSDaPE?D@&R^&e|>~Tv|}?RJwPa>2u5RuBMg*c73!(1sw@NrI%bILolcM626_) z=zkTPn7y!;<2>6BGJ93$nZ=Z@M0@@)0;o&*pi9M@m<)lz=IDKHNtWhj++K-JRQff( zTA9cmh@`UKx?x0yh>T`h)vN~c!eUCHIt8UP1@l~)(t?vB0d>Oi=DeikSi@(E?A*7v zBYa%^@}%DvmKG?-Un%?hDORd!rYGcVW#UgLP=z-~AB%0=`RehIhrrOC-iw{G%Ha%B z_PsFSaPROgjd(tpSvYnuwd_b%E9Aam*~^iQny$Q@au|_QwQnFBy;Y>J!X?1jFn)Dw z>@l$qrJ9P1 z5{e8f7gsnY@Fg62OA8zrVxRpWsvXiOL3}~!&p^ZBTB52|JQ^7^v7{>wJ`a3CY2R(e z`m#(yK6Gj=us?H}c6P-@U|i^0Zj3Jn`@RA5u_Jl)7 z^V>`CP3CKNv!htqkQ}TFF*f~_znW7nCorIB`*pS{QKKks(C~xbC7|uG+Up8AE_t%W zRV6c=PtWEc@ki>H1m?VwjQ&0OrMvn>7-fa@;IAC72IE_<(=OKZ+G*;Q6LFGXbpe*f;DsvKEJ zf>-Ra$w>ZVz!~+cg(u=wH}*sj@2Osarry48l1USA&0zO>K8n{sTKz#ZFG=Dhz@wU^ z@8?a=_<&o9`wQ0BJv-nWIkn7>VtsSoq8bxRK9=!PL}P(D3vbij^xc*_Oky-y&Au<_ zlSSF&7QO%2M(;e!{Lxsa1FM%kk99{uF^Asua6_@CF|VjfXwcf)G8f%WIDX5UOtrjW z4FK~etw@acatTOyPPu)R6b1ivboRm%Yt`V-G)l_MfoS)`s^=mXO)-j5YlfL#Jn&e) zUDE`aYiu7Q2g>9^WIoW~59ti0=wbeO0#;axVFPZB>#E?QlC`V+K}cV#Q_ZkBHD(LTs&7~XDu183HL>Mqx$XLb0S~7=EY`?iU(KZdG}IybqIq%=sp-~Cz=Gd>#c+b%Xh25h zhN{7uf9sl%u~8b3NA-9*DQ@Z$+SV*x3T5>`?im(_JsGY(5C4{5LM&mvSv4{E0M4LG zE%8Ie(`iiyc<*Sw*5eCZ`zD-3;+??5bY94S3i=c`rk}M?et+=n*K+=F!M*%Ls)WG( zJd3frE2}CnImY(Dh=&<`vYN!RANfD;if7%p=gZ*izvr&csLvj87W`pj*(>NQr3V;k zbw6FPXm^Q$rdwIJ8e&nEYrexWOky!_;H+?qwda9!tT0jnGR?wD>5g)g`^;S>KnJCI zGABhIpCj|ne=~WJON4htf73>|D(Q8Uul~w z<^9i&nu+?E#f0xj9=;{puhNsoN#z?e9}c!?0%N6%k$@LI=|^%CESf#oMI9h-MV&<| z4l4s=&Tw&ah*WULyi{hl(-mKGMaea5#x(HFoBOxCNrWA7LhJzJij z%a17{e>`5iknj;2#1PS?E<`WV+5vdacgf$->6m`=Lf0e(7+AC)}m`c$$TB7jVztSz1hvL zUUnVKQ0Aisb2-U|a6D=#G8$hV)yh#Y$kptCJebMT`Wt2ERE$LGLO7WPJeCF?myF2% z1h4FLtw4g(#_}H=g*d|Q#~hx1N#yq`g*1e^Z?q*dqz`@+Zdl;tVjzX&yR4v+^gif_ zHFRHSb`NGU>+oCDwzxq@0cH=Y=^7~_Nu-82ku<=AIsOYyBzzoOHig!mLyZ$CM?$E> zF0_fPQCd)Ld&;lpdLgy7#RVugcW3GF`CO}P+SSrmwx%1MKSu6GUNgcJ4e9=zF!Q-1 z;*B8e`H4UFX=1qn7hvnY6Nmo>^vq%4QLiPP?v!o`kv^enp}a5NHI+Rt=0=m;`?QB9 zBk+;^RQq!aAQKGd(a20Ysi?loWcL33mm2ZA4q@)@uI^^mPy^KLU}_2uj07WL9_X4Y zg^Gl%jL}OrIm)|6?_N&hz}4hJ4fw;4RtAqot2s5vppgY+|>f8j~&WcfesOg`(FGiX0rEl(6y4Im(5hI5kPoYf zt6H`Z=}OPIehCox>BuJ~dX+A1oo|o(6I`I(pZY8%eG6kl3WGm>ydah5N754t{eo!` zEEfDMp3Y!h^7&~^cA-h8vzMw}+K;Lrm zdrJkzSx|fXrbqy}TRW$=KtGu$T)^H5?VVX;yCCA~_StjRQ=WL-)Y|BE$-{de!?QE^ zGx*C{uZ&r+hzHf`Jn4kc%+{cP8bSfgQ4l8O5^2|M2Y@GkYrwZU11j>@?n zmt*2K@8gh$A@`^gsN2U&K=cRt4=!3aZg2|Pw--Mctf(zN-K93Y4ojMhV2xTR%eVVc z0d=SLDnQB|7)&2EFR3itsYk+DGe88vU-?k+YvO|5eO!%^7rkaZ&Z@(sIN}**_q#!3 z+CCu-wMNARp$7QX)Fw%c(n9Tm-V72IMmU3so_b3st3I*J`W0J)QdQpDh2{kx;KDoG zx8dX;d5r}?37FL2Q+5&^4J2-Er5Ls(fX2a^Jj8rKyTjR!m$pIil!{`@BOCSXUSzwb z6a9A$mG@}E2=w`y?HK7Ckg2z1$YMaLI0ya3aWXmv_;|hv1ZxB8OM^GGJ3-um5<2xE z!)M;Py(H2BrO8_+TAa|gHCD70!F}ZtvTw!f;uFU^j!#>Rgx#%YlcOkocb{6?*jfwH zsXv{GyW{w!StiFn#`A}137_yfnU`J_l+)I0kHBgNNN;E^eJ!ly^)cbM^V!rg3Bo!( zMf|>?E?@Kw26JB_NLZ+q%mUe@&IDoJ_xO?1-TpkEZLnX?G)dU^Uo)jVax4ONc~;jh z3>mL0q|>j{9*d(b3|46XY{$=!*OjNKCf9qEFGloqHDsHNd+#*C19*c4lGsQl!?($1 z0bl0Mzu*eH49J=4?|Okl!Q(zHuYh0Pi`2I_=XsgGH48h>#?2NLvQwxR&iE{ql3j#u z$;d3TeTgbde^;dIgt^}UZ?GkNz1P#=xO5b``8~eS#%*5r%(aAjfcx9IK`*Rcx1Pjv z78{Quj<+mL?|%y~6nOUzlKlzKrlFA`Fy*w(HShvMr-@_`W-aslw)(D>fOEH@o zD$S@XJ-KQQC5}qu7Iv&H`2VUow5{ww_K1DW1}RReh?s*;GjeMe%an7<-JDM!q2^jH zWIKr8iOT3nr)#@V+t(F3mIE6pqll*evMWebdP`aA+Dt93r-DNDv`k*(5FVBB&MLct zhRn@!}^d z)ZE@QbuqD78x5TpfCJ+T-Puu?bvs8XT<6lJpkuJXZL!{T3kEiD58Bn;V&DpE&$cGx zsBL)9a{UE{^p3q%+;s;-rR~uWs*ERf_N@YX>Dg?l(qs{GJ`y@97Rz*RhH3>#5aBH_ zNB{%P%O6#PLnqnRCCu&KZ2r|Ypv@aBjZnq)OiHAuSu zPTNp_QUmfsccC=$sP5~KhD4K2A=T~9U|pEW%2jApIk^)rdF&L@=slly({XVpeQQPr zkD0x0pAxcS@BpFnf%=ou0yZ_w&y;U$j{%s@J}7+hpe`di>heu9{p=3S)Vx3sU5F;PJAcd8*3;Z(G5{g1!jZ~P*5+ic;sxq{QZ zg#O;MW^HZ4`p?3yI*pm#!+tnG9RPb%i0*B_e9n_mKmh-LT`y>`Jr5*RZ# zfK<&FzE|EW<;kBLLbWH4&7%CBp_GRE8g4-RrgO4EF2yrzGd5|Y;!kHomj%<|6i6EV za|s#wMq|4jPy*t~r`t9*4AhRS1LO33$+TmA$nouJI}R_khBESSl9WVsTMSi?|G27W z8ChUnJc01>?{PwC7~dwmrc>4F@}q5@rpW>FgQF;7#8~SSZ3EDA z81=YXJ$s_Q|p?xC1e5kcNfua|v+E zJh`$Q5dnFKKS7{I6tT$Fo@?C!y&aK-quZ#v(8PkuaDEgn<*`Iq0gUFZX~js;C$*ak zEk4DSzHNmM%_l33M^mnxATI&wpMys;3Qk~M;SyyLB#4V$LnHPoXQXjh+7WX|MM~zk=fexLp5I$}>GYP(bey1U6Rsp# zLiDD*xlCWYU z;j`T^g%wFDrVH_oijbM_p#s062KZ9BKPY|$Sbzrz2X*HjM9Gu0whP#uX>p{Z^=oxv zp^07>+2`6sJvDM*YRMlL@z8kkr3(4TP=^X3p4L=UX=cSaC4X^$MJ#LL3`x{|{xcrq z7U8U`3xy(IdU6fBq*^(i<>_Nfsjd$=Wd6> zq0n-Dv&E4a>h7>s60KU^3YC{4&B@E3znDMrZty7I!0}j(-uYT(FW;eUdOPTo#eHUj z#X*&DB=X%pwOB}HalmIkq_MgCV$qx`;f5ItqYyu@40`qF5K0Q)X8}p-&O5f0+mp&HDrC1aBn<-O_i;$@fw32?Ixvv}d*@ z(K&KIc8v;$l!`%FKTw%d!Z*pn3#4cxtlIFQ4SI%4DN+^r(Kn75tNr*^=0+LDAOXyF z1NL_1A~kpon^~9PmO;@|4&ECLxqC~J1WiONn2s`pgq6oJvjuWo&nF{%D-}>ABAn(M zK|Iq_ph{{W_t;VI$ixgj2~_b5H)K2hHrQ6z?KNae)fQQm^0^~|{BQz!#yqVt7jiYR zA@NJi^@lR448{otK6hyYYT&mgTyp1|b2p~mDD4|ISJ#<8xfJhS%6hrSFq)AZ}5ZlB%ch>j&?%bI*|IEKxS?4|P zIs5Fr&)(1TykemzM>W?c$5s<#`hF3!Siu#(;Jonfd&dOA?g)YNk@3D(&r5uRsestP zuodX!N0-3eZa6}NRO_6+cVzhZIthUEM_%YXq#+W~BlWZaFHX)$XzuqW8=`+p$0Mm` z0%E@uzN5@-16cn6=6{}{Zc81}E`?1}R|?-KtqxZqM}|)9=wzbi1A#Mgd|4t^6Z6=q zK79XH5nqT*zV<~hxH2}VmN#Z?#&d}?M5_7Ky2iOo`8Rz)*#Vj!d8frC6ZE~{~zmj?Bd4DVReQt(DZYEb8 z1vi4NaZ~qY9{pwdZs7C*I^3E>Pc)c zGZO{-DN%9e8T_i)w&uE|GW|rs!}u}!8ziYbzl1xL>0%l@XuTW3hp&Z<+JdI6tk7v$ zLI}AEh$eHf$sm(otf&=M7;f;KaO1~z$e`NYYYQZ+HF<0(iF0lw|9LW)ZWx3> z(1}q3h5=nSmcGwW3HWi(>D{Tw!bm!PiU70tvnY;9_~m_N7*Bat&PKu0g(9&jPIw>C zK2D@Qz0@U}MvEJtVhcG@P7O#^B21`zn3LP)X*FXEz>BFxaQDTj(#|ys(L9VtkkV%0 zHU1O6y3f+w-=nBnk?m4|`_c4j{&u%U)t}Ugnw|xS_m0#_WyEuv&%JA2jSjycTjRGV zH`1urNG#9!xiTGU@V34=l2-+c&)?#c?!qH+}q{V-ISkJ~80iY)=4#(kY&owfcNwk-@4&j<~{G|g) zk%v0g(w>#&yi>kZR+yly|e5f)9+=a~riI|y)bDgm^t9zL*mVLfNdQe}gKt2z`*K2=q*=iYrRB3sZ^hH?KysG_I z-G)psrTS~um62egtPEB@RWi|;)%Kz~yX~zYF4<}8dqFrZAa$Wew0Ix8u#B(2+zCUxCGxLZv2#AYecp>z;NE`?V-uM^xH zQlfwjfz0XC^V9@CBz>E@#rq~M;J^tW>Bbl~X>zIYw!P$L4d&#n(;8+8?Z2TKOmcLH zhU%;CKAq9EwN^3w;O~@ZF3Dbid5eO=scwo}eWB725v!7!pOSi1L^z-f9tqd}6gdB2 zaF5l(!`C(zv0+4@x*{QZcZ`s*eJ5U)rtcl4=)l)yUwOEDRPHNW32TPGELp0B$9{6* z<7WvhZ-r+Mg3Ua{q|HnvX&v16U5ENzYxVxi948emt?DjX9arTqI7lA#X`yH9_=e+^ zdm)i^!oTELRGEO$m!S05lWeaHW(ked2jJjix&)(iaIOwvU7K1!L&^ki6T4M7-4mEc zY>Dy8X;>TfXU`aBH#UFqOJv3I)|DH)UFD{q(#j_76?gJ@?V+nlxTCFH3j^kt->vKY zKPlh;@)7SS;&-^DoANE2bYgl)x_~#k0SQ+cyI$VJY76O;IAU zw^R&cDFdd;%kPq1OHevT4c3qUJQVV^a-;fk#|0Mk0wjnnr6}__xg-=;I3v(4_CWNT z`a|r?jL@uuw4djbbe8<3uB$)ZQF@c!i3mqi4*7BJ8CDGNNT2!ya=9e4F(g_GO=bqBaviSnN53{2j zi<`-p7#%+2(9sV_X;C)y%zH7@Pu4x_8qyoqv-vEu!h5?fM6-hQqi~#x_>aE}9wb)5 z{*5_J#%7@ieKkZm8LZSZ@N-r^6JC_X?!H$|-iuDh_NuF6s9)`GnUxyz#!4hPhyrU& zw9$SkXO9AAW!Cw)IQ?C4<$~Sm57bDx;~q_d$T_%LL|D4U?$mCqzPssge~wT6j@ycZ zu+9}Y5DG!T_bEj<(&iAXb4L6lI4m0R*x{T6BAXEHjO z^mYna9wZA{f@Hjqv*d0gea%KQINxI>ezeb)hpg8CbsDKk=-JZ5QWZChEDpy4$B}g2 z>A78Spks90M1Px`5DOe~Gcbp7YI{`U;h+g13R}od4~{4~+|ZW;%DmJM7)4|{SRX-9(*Yqu4FpEW1 zz8~p%5+mBLTd?5^Qf6AHd>?S@lxBBinA>IZ_PDE6dV%9a*WFiAw40bv-_Z}`3}8)- zu~$y^`4p5ezCsrR{v^pWvrWI@kW%Vy?q1AuRSH%h*u;uSzhFkYp!Su^hD>2H6;Y7& zpGdUtxR@B+-~VE~e83WoDWR@F(d8*DkGS=F^jOX04lLE-d2Be#9l_)i@}<&s=feFk z*bfZ#<7|gujbFP@L-{^oLcS?*4>fFO9Vv%Gb~K{%ZG$Nv7l1%~;km=7?1I7^TnUkr za5cH}f+g&l%?5yPG&}0ji-iFULkz%zgrEaEx95D=}Qe; zwgRz`asR5i1rOlHI?5*>I{pCEFkhsy1{}qLcTS5s-G8Ed?5aOMlaaf}?j0N99#<+< zU^pI(HWuM;p;rD>hET3-$j_fVd$iv8Sx;~3o$8@wyzTRQL73_xD^!8T*SBKIQrkTtU#31khtCJz z=FN4G5qB~X(SdX4Q+8{FurynGHrsc!vTfiX7P`aVOxpX_)4Xy%8hbA;xSLw(I%BHi z!~)VPjw>(qNvHYRG8)}n8E`l)h&`QhYh+TbhgA zl&;qrP+wMm+MYt78=*Nh@<1GwYR5r$dN`ODaz}yZuEtOiGHJ}{<5iK6k(dFidbc~m z;#2YPo5OClZ%^XswM^leX=Fp?%U*Yn@T?j9zVRe-h zXxK=;2w8x|CxoY_?=8{1Cg+JV)D8&4;NQy+gDCN7;;8FgKi-=lJo1hM;~*OfgpzP! zy72|I=jS9$rYi06BFfZ6++ch~?GHe?Xx8PluGcJd8-}S#O-`UV{f<%z-4P@sKN!UV z7Sz75pPY~Dh*#ip2U4(M&WCUxblj-g@lQoLe@!mG_nCvCzbABKl7h^~<6BKxy9A(8 z?e0GsrtGU);qQ8LJlM94T)>11)m`+!h+s^?&SY|&p7w8+kjDS<(zzvAFsxo(dh5A zy1prQtwhG%M9N}WvNUcWuehY$l{-9OBpEPtS>A{6nBEBX9=;$GmUH^lqG;hpCvS9`EP$# z&A?vCQxt{2T;KsRsg$6QezcTkVov*%6%$na>uBKp2}34H#pzg>M-(TuHWfIU$+WqR zh4HOC#%^`E#M&2WLh;PQ@P<1jW$+C~FHsXg2gV^bE{;@jaZycX!k(I+tF!%_CE2tZO*pB+KtjRA zh^^|draDpZ)S3(%k)DBcOqL&l3pAg<-Lm-u@LKr3#j|QMhY5-hw5+)<`LJT*qncPj z`CRNv*a1R7CDgyLP)1N8OT3WEb#Jvzp}m z8g)P$UQm%-s>OvXaCKf6)F+fQ)5J-H#O%67pvm{MwXktGJU352Y2|N*#FFg#U{#%v zTuN0>M{k^w@-4ZBdhA6#ATaGb>?_C6YuCFJf>z;LVWaQ)%EGja@f;Et9OVzj$;bD5 z;Ag4s80xjEFlZy(>jQ6!UrE|byO%ssD$_!_rE8%zCRRlovHG<|+s5tMaQM+XN9P|W z#=~|9xzcg|7^56u>%9%8FW0iCURc!*{WDXSbdlbK$6+pJFaZOViiBTbG=se1)aOj0 zT}xQXMKoh1#<+eUp2Bg3&#?=&?oNR~V}wdI28AMlEO0Q3E?zcxTJS5x`%$#rPp+s! zTZ0+C%`ru#N{H8K!?Rm_3=V@DT zrsZ2ueR}=yVm|!Av=K?9>&GI+%QQBqt%E3#ViUF3{h*1?ti zMK<_HmG?A!aHu50FgnqUh56iR`Ht_h5QPHIJUU}STmmis*btcKHwFN2QiY8k5)$u6 zbKvPy_Ji|nwmOcL_Y`eM$zmQ)c-uT2l|F1TU$79L^?%j)spc{~dn14o-Ij3ErNi^- z38TnPV;e}@(F9lc8y^i>G|Qak=k%3&q|+7TxECd}(->y8O=-4cNg;NoA4vnN_Ma`H zMA-yOrQP6bg6KR6MzV!TE7ZWhlDP9M}zV;}Ae>8iM`rh+%mn43pjX$nlq8axX( z`f*&vUV+cN{yU5RBj8t9y5pVYAllx$Eo0ai$!{59a$n;qA9jqfLpm-@{MwEu!&}MM zO;HZyW2z!kD!Am(+PT)Qj<150ZwzCh^jocoA}nE5A?#p)hQ$*E#rKX8CD11 zhXl=Q`P{X#qFwr|p|*35n%VHZ+()Z7rGwDVAC#SFHLI!TvX`^e*~0lR z(Uu6f&V51)o<<%X=cgU0RA?f=sSVKqa=)SJT=9n2w1UmR({TvGhnRKmxmICa3PL%T zk1^xt#h0O$m*kGJbk0qoeoQGoDb)6lL^8 z>SH-ZX($z}8$<b0C4cz^5n?UOBKAjJ8KIiBzB=DSF>b-^!rDlLR!o(2ut`}&B)1nku< z7TuRc*l*6(?jGf`%4LX8AK90QDwW!iL{%cxrJg;5oM}}cr_AenOEW6uws& z-)7^>)2C{^Fnv;4$%0dHSHF0!qi}THOy#WnLk@mRN8f@ue8Lb%K z^2tq_NY))GZ2efFf2{0W|BnAhTpf1$*{?=pW&`e@x<1k=Z#~Xl-cl=MR#v-it@q=- zmJPWXTJ+KaEt{a&6JU^3!&v^VRCuyLXxBJV!S`CZ(JP^4CG=viQgDl@XC~(#zzN6E zX;kEbYekaRR$S0BXW)$ysYl;$HDuaoJ^reMUj6}dTT^*-J$~_e-qb{C-qh;!A;&nc ziV=OQ4|e^nMwV>uSV&a=GAO4tC!g`T_fI{p;>K;-LF17eJDpCZNUIM;9xnwNe&~I$ zJU2CT^%89Am1}3zq6@ubr!>M_(s6$SVLwIy=<~#nF`E_wOU`?WI`>wYh1_FX?HLBZ z`kKDHP6rIOgPKz~^SG^);55~>Nbi4v!wE%1X+nP`qrp-n)iV>AXbHu6lqZ48x z0K<`ucq*e>oOmwX*ZOdFdPd`o5BHTfLu{I)VA@pmo;#jwYsQ#WAtWElqu9FcYRCms zN%S+}VZXfM#)ZeIqw(8YzE-*llI0Tl&vAYei7i4#Pat_t#ZrA6FaRE^2kUU6J7sbX zlINtMO-&Vx)kj4K(ai-M@~_`HX9_vl6frHDZU}aVXwtNGeT3wHWv#)Xcc`@UC+L9v zPZTJ{5{+_CIM`yf+?dO#upmV&BfXG52s)F^O0DH99MRvffYjF)Lo9J9etXiEC0gLd zL=&i8D)C^a`3a;mKt+Eka0#HT)0+`!xY*2gy9s?4sdC;#9l^`DDlULj-9uoST6Edp zj9B!^1( z1xc^9GixXAplE@6v{!#c+_jQuv=~6xa7IObpZ`b-7N6#YL%Lz+4>nj8{iX%ue~Yz> zyr=#0=9a+;YS`W6bc<2+*Vf>~xQ(v#Sy7)kM)s59J++~HU+G|^H8S}R;Jvz4PO#6# z*M`4D){-jR`*i9}M!EJ2WmR6hoN6zRjO^`kP4Z@GTYKbDYLPhkQRqgB&w5fxuy_yp zMo*62k2@FNaHVW(xvC(B)J#op@mhNU+k7bZ3U926gf))yS{u>#;%*3=#wWYr)Tog3 z)wVN=?e!%}cnTq}%BOM6w^zBkD!hcLULuhW``{FKO-Q`#lMSW%;_6M1+G^R|UqA-uMAjnQnHvNs}Y7E11{`+XR~UOBA8a87rW3Tt5T+lpIY zrge*R(#_SR#IxZz0j3oT(^D51_CWKg-xld(sI3ByBI|t)u>3kHW+7D2XFgZHJ4=^x z?``N02EXPXgSnMHsim7)*B=l!#VAdIQF#Ere{c^$Fl_q8_cY=pTOU_#Vr_g8ZxNPZ z4NJBDkjb;FQZZBXA(MOWLpmdpoxz?bnvu1M_Gb8JyP2<-S(-CI=FxCus-I9~AvxaQ zLWsJVPn9L>`@j#lR)sQ_ujf7nT~Ft*3#FgP4~s*GW=!%}6Q?=?$TuTj2LHyA#vkrz zn$FYBZ3LYL|Xe{CyyD4wGAAhINTx;-PuxCbj0 z%L7U`WVWVa1qYu}ly_nQw&ML=`+QyWdH7k%Kmf6XwN8ErYvJC2&YEr@XnD) zWnP^w0V%e^19OKn9g}aFTB=CjgXE)W4D!H}McRu#4(6>9m`cZTK^C?<;8C<h?DUWCg=mK3IC{w(S2 zwOG4S_h&%D3BU;XeoQEfs;Uz|OnSx2bA-?6KldA#Z6%sbB zJ{0`jj8TG5m%(lMHh09w_4Kb{V{d+ujySP!ZK%7yz}$Kv*38+I??+3AbsRp-ZuewI zMqt`%y$Vr4Eg7)^5a5`6<9TMldDp$lz&;yt7th(yxDs6>*7g}u;GnleSeW;b;KFgd zv~iy^**f4Dy`iM4_(bB4sdP%cT+XAbikxx3MOT}(g&miHWK}KrF=1N0U#U>*%gHd5 z*C|5qZXOWQI?UyRixQ{bV6587bfc@aZ*5P*PZarmB1rzka1?$fV9RChS|XQBpPCQC z-WmOVR}ggp#ALT$3i1J9o6zw_xgyp>Ar5 zzWg$*16NxP#idN3GpL6G+&<-22<5@*s(b$ke*B5l9ov`8zh1lrj|c&a$QNNnb9ZBn zK};cQkv4xLAgI{lYzfQI$jY}A$#p+c=sU`*-b?u93m?rSlhz!j-}1dbZ}eCDS3zI& z+rJ3H2|F-R6)7g~0cu1wxgs;lF4b|YEz!NHe>%5O*Azdf{vc&Nj{LZbM9C)I09bLiqMx6 z)@Cu2ulS}v?`56x3ixD*-@s9$n_gHuf5auS7Dtp{bHYy5G*rARt{Sd;!~{{wxx^ym zr41(xPT4b6+8Tx{0P^i~<0KR(B6)Fde7%aZ9B)00*b=bL*Xv3K7Y%cC{z?*!;pp{@ zh;58^B)!=7GIH!PtZ!^B7TdIqDnnGhck1=v>sTF2EBYjWrW5?`eUetl20+^^cUE5Q z5F86o>}n323NYUZIeuyoUh}3{7+4zw0WtLJ$wud zkjpd`W4kdgHFH`?ch>l<6ABIk12f|i+18&*{sENTPmV^~WpqH|+Y~iCRlDVXVB{L@ zBa9B)ig`usNkA1-Ukl?-z#+N>Z=^=CM9ly))_QsU>J~8w_Qk;3;H0N$jj`1WR zxo(Tjx&nU=(*FVY!>O09yRbd87HP~&-);CAerp2db`Vqr_Twn^tWT587_a*gcMhVv zytH;%h}J7lav5q#wJM~S2Ye?QeJvRrD8m}PxJ*nK_v)>sJA@&T8lPbt{AMxm+hU6~ z!WLE@xWN0LPb}$=jT~PcxfImU8pr(Rmm#HAyT?}782`Rq#Mh?w?edojflm{>A!Sr5ou{Pqb?bc^Lck? zWhnkbKh~O0^wB4$_wW}@E8G}3+K}XTc9}NJ($)Mf9=>Q{oq?kDAy)hYs7IEZ7=1+@ zPewS2QawZI`JuG@TrpZfDEDPvl6x&RO~Z;AcsSw}kXr|+=OPQk&Wd_&Lsn;=os3Y6 z>uD+QS6zI<+Gp|j#7lO@_eHUn3!g^{56s+por%=N6qtIG(1nr#M`0CI(lN*&Tck zdu>bmuEG0@SF=*t_L34-9ft1bX~TzEX>w!&=AV4BQA&N|=Uq940SVS7Vb){$B zDB`Hg14{e>H2FdvMk)W=8zNt~@zRs7zcny^UkKYiVR6cuZ!qeR-cuJinQ(J|rqPR5 ztzn}+Z6nnlk z>@^xeCzD<1GjsHF-hdwYv^9+3E<$;-+qyGFt|}s3IyjhK4CS^s@O(Zs#9(?PlG`NF zh6iTe$TPc|i#W8F%VA1vp|Yt?=puR6JXD{*5{4OVZCa6FXG_N4B+r1UNjreHC(>bn zab84)YV{_&RX14?SDz>*(w+W=!`xxMP?dO@9)L3cCl;hx=r1SzFA$`Zm1l@9DRDQ} zn|$Wunf$x{!}DAETqT4bjbX{z*mVvr68kG)yFn({0xGLR>l*PH#x+zUGnQGC$HVVx z3xy#TSp3ur=d!LRDQ;(%lMbYNcJ_GhILr8~IU+uL9F*)L7H#1-oNI+X8(P!du|uUU zS->2Ah%t?;VEw`UeHX90N#!+xv`gR1OS4<-+wt*9gZk(v zwgLK7ljFI^@(a9F(ROZ*{bRER6+`z>9LNY!O$T}j;0~mR>Yih7pcJ#n=Dp5RIKP#n zo+ooSeKy2mdWdrV;9`@O!R5=)CEo2s|<&)ltusKp;uC@4YEn1l`{#0V)iEa>Etqk?c95IC{d4&r*!C)~mth zv#|Z8&^5SkLV3UA1$xrD9 ztq*m26<7b^hMS#Z94SyUO%aKRJUooMoW&FJCmTYTk zc0HGQQDBfLF3Rkv8cpLc*O(VgqcKJc18s6}#{aWb_a6xbSKfQ-N@DGg_&wyvKy zoOATAmxMoZh1a!m{PmC~Rjs@v4L_8oA4(5JsE-FFZeKQq~VqZC+mEEN|e5 zU@Iy|Mj*{V?{UCxo~Hcs_)qm}RO__yllP()9V|_Db6xvNsS$~M7RamfjY913iP^94 zHy^a7w_CZ|#F z3T(CL8hddFp!Vgh%pnQH!*!u$oTIeHQQ9jeC#?nQm}cIF)jjr1$BrQ{zWgsO=Wo&u z%Oqa>0j#(8r%cW&JPYWLU@Q?93It>Uf+%hQY0r}RUz$f-k@QTjExz4{T9F*xqd#-M z^5~De=iZfE3yL7j&mB<$oo*_4?gxQqStToqUA=qEiLn}GiIJ-69*H6(+s*+d#VXq7iJ)b^$V z!Z~~*)L~qAY(9dARkAFx<~6NVkqTv5;#1YD9~S*WiN6Og-T!}nglT15{tb+-8X<;a#fD&fqdTS)a6?i3N15gV3MDeoj^h9EHT(if0!XU54CfpAM{5R~z|8`pb zlLug8LzGrQ+22xTG?>GxU}FQN)RB znRqdis~n*$YvifYfF$vXcsdAnguDLl;o$#1VGc9uj{jh2)5P{Pf~7!n5Ik#y`H*U5 zg28k2OO*XJ6Z5r*U$M+<*o_s*1H!umin<-5*j22;jTE?W2Q>YMNc_8}Txp-;8H*O5 z4`GkSXnL@PBG`IK)_*t8|6G`V?B{>^1q@ + +<%= title %> + + + +
+

<%= title %>

+
+

TODO

+
    +
  1. lib/dnote/notes.rb

      +
    1. TODO: Add ability to read header notes. They oftern +have a outline format, rather then the single line. 19
    2. +
    3. TODO: Need good CSS file. 22
    4. +
    5. TODO: Need XSL? 24
    6. +
  2. +
  3. plug/syckle/services/dnote.rb

      +
    1. TODO: Should this service be part of the +site+ cycle? 18
    2. +
  4. +
+
+
+ + diff --git a/example.xml b/example.xml new file mode 100644 index 0000000..e0b9758 --- /dev/null +++ b/example.xml @@ -0,0 +1,13 @@ + + + +TODO: Add ability to read header notes. They oftern +have a outline format, rather then the single line. +TODO: Need good CSS file. +TODO: Need XSL? + + +TODO: Should this service be part of the +site+ cycle? + + + diff --git a/example.yaml b/example.yaml new file mode 100644 index 0000000..b329454 --- /dev/null +++ b/example.yaml @@ -0,0 +1,14 @@ +--- +TODO: + lib/dnote/notes.rb: + - - 19 + - |- + TODO: Add ability to read header notes. They oftern + have a outline format, rather then the single line. + - - 22 + - "TODO: Need good CSS file." + - - 24 + - "TODO: Need XSL?" + plug/syckle/services/dnote.rb: + - - 18 + - "TODO: Should this service be part of the +site+ cycle?" diff --git a/index.html b/index.html new file mode 100644 index 0000000..8f94208 --- /dev/null +++ b/index.html @@ -0,0 +1,188 @@ + + + D'Note + + + + + + + +
+
+
+

D'Note

+
+
+ +
+
+ +

Developer's take note! All those TODO: and FIXME: notes floating around your source code are rotting away. + They are trapped and in desparate need of your attention. No worries. D'Note is here to liberate them. + D'Note scans your source code for labeled comments, collects, collates and sorts them, and then + saves them in a format of your choosing.

+ + +

Note Structure

+ +

D'Note uses a commonly used pattern of "LABEL:". The colon helps D'Note separate developer notes + from other documentation. To be more specific, developer's notes in the source code must follow + these simple set of rules:

+ +

1) Notes start with a label puctuated with a colon and followed by the note text.

+ +
+  # LABEL: description ...
+  
+ +

2) Any note that requires more than one line must remain flush to the left + margin (the margin is set by the first line). This is done because RDoc will mistake + the note for a <pre> block if it is indented.

+ +
+  # LABEL: description ...
+  # continue ...
+  
+ +

3) An alternative to the last rule is to make the whole note a <pre> block, + by indenting it. Then the text layout is free-form.

+ +
+  # This is a description of something...
+  #
+  #   LABEL: description ...
+  #          continue ...
+  
+ +

4) All consecutive notes must be separated by at least one blank line.

+ +
+  # LABEL: description ...
+  # 
+  # LABEL: description ...
+  
+ +

Without the blank line the second note will be taken to be part of the first.

+ +

That's all there is to it. In future we plan to relax the last rule, and if we can + convince the developers of RDoc to recognize labels, we may eventually be able to relax + the flush rule too.

+ + +

Generating Notes

+ +

As you can see the commandline interface is quite straight-forward.

+ +
+  Usage: dnote [OPTIONS] path1 [path2 ...]
+   
+  OUTPUT FORMAT: (choose one)
+          --rdoc                       RDoc comment format
+          --markdown                   Markdown wiki format
+          --xml                        XML markup format
+          --html                       HTML markup format
+          --yaml                       YAML serialization format
+          --json                       JSON serialization format
+   
+  OTHER OPTIONS:
+          --label                      labels to collect
+      -t, --title [TITLE]              title to use in headers
+   
+  STANDARD OPTIONS:
+      -v, --verbose                    extra verbose output
+          --debug                      debug mode
+      -h, --help                       show this help information
+  
+ +

The default path is lib/ and the default format --rdoc. + Here is an example of DNote's current notes in RDoc format:

+ +
+  = Development Notes
+
+  == TODO
+
+  === file://lib/dnote/notes.rb
+
+  * TODO: Add ability to read header notes. They oftern
+  have a outline format, rather then the single line. (19)
+  * TODO: Need good CSS file. (22)
+  * TODO: Need XSL? (24)
+
+  === file://plug/syckle/services/dnote.rb
+
+  * TODO: Should this service be part of the +site+ cycle? (18)
+
+  (4 TODOs)
+  
+ +

As you can see by the command help a variety of formats are available, here are examples of the + XML, HTML and YAML + formats.

+ +

In the future the Notes class will model things a bit better (so the YAML output will improve), + and the parsing will be made more flexible. For instance, it would be nice if page-top outlined notes + could be parsed as well.

+ +
+
+ +
+ + + +

+ +

Copyright (c) 2009 Thomas Sawyer

+
+ + + + + diff --git a/rdoc/DNote.html b/rdoc/DNote.html new file mode 100644 index 0000000..a58db0f --- /dev/null +++ b/rdoc/DNote.html @@ -0,0 +1,354 @@ + + + + + + + + Module: DNote + + + + + + + + + + + + + + + +
+

+ +   + + D'Note  + DNote +

+
+ +
+
+ +
+

In Files

+ +
+ + + + +
+ +
+ + + + + + +
+

Namespace

+ +
+ + + + +
+

Methods

+ +
+ + + + +
+ +
+ + +
+

Files

+ +
+ + +
+

Class Index + [+]

+
+
+ Quicksearch + +
+
+ + + + +
+ + +
+ +
+ Generated with Razzle Dazzle Redfish

+ [Validate] +
+
+ +
+ +
+ +

DNote

+ + +

+require ‘reap/project/scm‘ +

+ +
+ + + +
+

Constants

+
+ +
VERSION
+ +
(Not documented)
+ + +
+
+ + + + + + + +
+

Public Class Methods

+ + +
+ + +
+ + new(*args) + click to toggle source + +
+ +
+ +

(Not documented)

+ + + +
+
+# File lib/dnote.rb, line 6
+  def self.new(*args)
+    Notes.new(*args)
+  end
+
+ +
+ + +
+ + +
+ + +
+ + run() + click to toggle source + +
+ +
+ +

(Not documented)

+ + + +
+
+# File lib/dnote/command.rb, line 7
+  def self.run
+    options = {}
+    format  = 'rdoc'
+
+    opts = OptionParser.new do |opt|
+
+      opt.banner = "Usage: dnote [OPTIONS] path1 [path2 ...]"
+
+      opt.separator(" ")
+      opt.separator("OUTPUT FORMAT: (choose one)")
+
+      opt.on("--rdoc", "RDoc comment format") do |format|
+        format = 'rdoc'
+      end
+
+      opt.on("--markdown", "Markdown wiki format") do |format|
+        format = 'markdown'
+      end
+
+      opt.on("--xml", "XML markup format") do |format|
+        format = 'xml'
+      end
+
+      opt.on("--html", "HTML markup format") do |format|
+        format = 'html'
+      end
+
+      opt.on("--yaml", "YAML serialization format") do |format|
+        format = 'yaml'
+      end
+
+      opt.on("--json", "JSON serialization format") do |format|
+        format = 'json'
+      end
+
+      opt.separator(" ")
+      opt.separator("OTHER OPTIONS:")
+
+      opt.on("--label", "labels to collect") do |lbl|
+        options[:labels] ||= []
+        options[:labels] << lbl
+      end
+
+      opt.on("--title", "-t [TITLE]", "title to use in headers") do |title|
+        options[:title] = title
+      end
+
+      #opt.on("--output", "-o [FILE]", "name of file to store output (w/o extension)") do |out|
+      #  options[:output] = out
+      #end
+
+      opt.separator(" ")
+      opt.separator("STANDARD OPTIONS:")
+
+      opt.on("--verbose", "-v", "extra verbose output") do
+        options[:verbose] = true
+      end
+
+      opt.on("--debug", "debug mode") do
+        $DEBUG = true
+      end
+
+      #opt.on("--quiet", "-q", "surpress non-essential output") do
+      #  options[:quiet] = true
+      #end
+
+      #opt.on("--noharm", "-n", "only pretend to write to disk") do
+      #  options[:noharm] = true
+      #end
+
+      #opt.on("--dryrun", "noharm and verbose modes combined") do
+      #  options[:verbose] = true
+      #  options[:noharm] = true
+      #end
+
+      #opt.on("--trace", "debug and verbose modes combined") do
+      #  $DEBUG = true
+      #  options[:verbose] = true
+      #end
+
+      opt.on_tail('--help', '-h', "show this help information") do
+        puts opt
+        exit
+      end
+
+    end
+
+    opts.parse!
+
+    paths = ARGV.dup
+    dnote = DNote.new(paths, options)
+    dnote.display(format)
+  end
+
+ +
+ + +
+ + +
+ + +
+ + +
+ +

Disabled; run with --debug to generate this.

+ +
+ + + diff --git a/rdoc/DNote/Notes.html b/rdoc/DNote/Notes.html new file mode 100644 index 0000000..ddca5f2 --- /dev/null +++ b/rdoc/DNote/Notes.html @@ -0,0 +1,1137 @@ + + + + + + + + Class: DNote::Notes + + + + + + + + + + + + + + + +
+

+ +   + + D'Note  + DNote::Notes +

+
+ +
+
+ +
+

In Files

+
+ +
+
+ + + + +
+ +
+ + + +
+

Parent

+
    + +
  • Object
  • + +
+
+ + + + + + + +
+

Methods

+ +
+ + + + +
+ +
+ + +
+

Files

+ +
+ + +
+

Class Index + [+]

+
+
+ Quicksearch + +
+
+ + + + +
+ + +
+ +
+ Generated with Razzle Dazzle Redfish

+ [Validate] +
+
+ +
+ +
+ + +

Developer Notes

+

+This class goes through you source files and compiles an list of any +labeled comments. Labels are single word prefixes to a comment ending in a +colon. +

+

+By default the labels supported are TODO, FIXME, OPTIMIZE and DEPRECATE. +

+

+Output is a set of files in XML and RDoc’s simple markup format. +

+
+  TODO: Add ability to read header notes. They oftern
+        have a outline format, rather then the single line.
+
+  TODO: Need good CSS file.
+
+  TODO: Need XSL?
+
+ +
+ + + +
+

Constants

+
+ +
DEFAULT_LABELS
+ +

+Default note labels to look for in source code. +

+ + +
HTML_CSS
+ +
(Not documented)
+ + +
+
+ + + + +
+

Attributes

+ + +
+ + + + +
+ title[RW] +
+ +
+ + + +
+
+ +
+ + + + +
+ verbose[RW] +
+ +
+ +

+Verbose +

+ +
+
+ +
+ + + + +
+ paths[RW] +
+ +
+ +

+Paths to search. +

+ +
+
+ +
+ + + + +
+ labels[RW] +
+ +
+ +

+Labels to document. Defaults are: TODO, FIXME, OPTIMIZE and DEPRECATE. +

+ +
+
+ +
+ + + + +
+

Public Class Methods

+ + +
+ + +
+ + new(paths, options={}) + click to toggle source + +
+ +
+ + + + + +
+
+# File lib/dnote/notes.rb, line 57
+    def initialize(paths, options={})
+      initialize_defaults
+
+      if paths.empty?
+        #if file = File.exist?('meta/loadpath')
+        #  paths = YAML.load(File.new(file)).to_list
+        #  paths = Array === paths ? paths : paths.split(/\s+/)
+        #elsif file = File.exist?('lib')
+        #  paths = ['lib']
+        #else
+          paths = ['**/*.rb']
+        #end
+      end
+
+      @paths = paths
+
+      options.each do |k, v|
+        __send__("#{k}=", v)
+      end
+
+      parse
+    end
+
+ +
+ + +
+ + +
+ +
+

Public Instance Methods

+ + +
+ + +
+ + counts() + click to toggle source + +
+ +
+ + + + + +
+
+# File lib/dnote/notes.rb, line 101
+    def counts
+      @counts
+    end
+
+ +
+ + +
+ + +
+ + +
+ + display(format) + click to toggle source + +
+ +
+ +

+Scans source code for developer notes and writes them to well organized +files. +

+ + + +
+
+# File lib/dnote/notes.rb, line 113
+    def display(format)
+      #paths    = self.paths
+      #output   = self.output
+
+      #parse
+
+      #paths  = paths.to_list
+
+      #labels = labels.split(',') if String === labels
+      #labels = [labels].flatten.compact
+
+      #records, counts = extract(labels, loadpath)
+      #records = organize(records)
+
+      #case format.to_s
+      #when 'rdoc', 'txt', 'text'
+      #  text = format_rd(records)
+      #else
+      #  text = format_xml(records)
+      #end
+
+      if notes.empty?
+        $stderr << "No #{labels.join(', ')} notes.\n"
+      else
+        #temp = templates.find{ |f| /#{format}$/ =~ f }
+        #erb  = ERB.new(File.read(temp))
+        #text = erb.result(binding)
+
+        text = __send__("to_#{format}")
+
+        #if output
+        #  #templates.each do |template|
+        #    #text = format_notes(notes, format)
+        #    file = write(txt, format)
+        #    #file = file #Pathname.new(file).relative_path_from(Pathname.pwd) #project.root
+        #    puts "Updated #{file}"
+        #  #end
+        #else
+          puts text
+        #end
+        $stderr << "\n(" + counts.map{|l,n| "#{n} #{l}s"}.join(', ') + ")\n"
+      end
+    end
+
+ +
+ + +
+ + +
+ + +
+ + fu() + click to toggle source + +
+ +
+ + + + + +
+
+# File lib/dnote/notes.rb, line 383
+    def fu
+      @fu ||= (
+        if noop? and verbose?
+          FileUtils::DryRun
+        elsif noop
+          FileUtils::Noop
+        elsif verbose
+          FileUtils::Verbose
+        else
+          FileUtils
+        end
+      )
+    end
+
+ +
+ + +
+ + +
+ + +
+ + initialize_defaults() + click to toggle source + +
+ +
+ + + + + +
+
+# File lib/dnote/notes.rb, line 81
+    def initialize_defaults
+      @paths    = ["lib"]
+      #@output   = DEFAULT_OUTPUT
+      @labels   = DEFAULT_LABELS
+      @title    = "Developer's Notes"
+      @format   = "rdoc"
+    end
+
+ +
+ + +
+ + +
+ + +
+ + labels=(labels) + click to toggle source + +
+ +
+ + + + + +
+
+# File lib/dnote/notes.rb, line 174
+    def labels=(labels)
+      @labels = (
+        case labels
+        when String
+          labels.split(/[:;,]/)
+        else
+          labels = [labels].flatten.compact.uniq
+        end
+      )
+    end
+
+ +
+ + +
+ + +
+ + +
+ + noharm?() + click to toggle source + +
+ +
+ + + + + +
+
+# File lib/dnote/notes.rb, line 90
+    def noharm?  ; @noharm  ; end
+
+ +
+ + +
+ + +
+ + +
+ + notes() + click to toggle source + +
+ +
+ + + + + +
+
+# File lib/dnote/notes.rb, line 96
+    def notes
+      @notes
+    end
+
+ +
+ + +
+ + +
+ + +
+ + organize(records) + click to toggle source + +
+ +
+ +

+Organize records in heirarchical form. +

+ + + +
+
+# File lib/dnote/notes.rb, line 244
+    def organize(records)
+      orecs = {}
+      records.each do |record|
+        label = record['label']
+        file  = record['file']
+        line  = record['line']
+        note  = record['note'].rstrip
+        orecs[label] ||= {}
+        orecs[label][file] ||= []
+        orecs[label][file] << [line, note]
+      end
+      orecs
+    end
+
+ +
+ + +
+ + +
+ + +
+ + parse() + click to toggle source + +
+ +
+ +

+Gather and count notes. This returns two elements, a hash in the form of +label=>notes and a counts hash. +

+ + + +
+
+# File lib/dnote/notes.rb, line 194
+    def parse
+      #
+      files = self.paths.map do |path|
+        if File.directory?(path)
+          Dir.glob(File.join(path, '**/*'))
+        else
+          Dir.glob(path)
+        end
+      end.flatten.uniq
+
+      #
+      records, counts = [], Hash.new(0)
+
+      # iterate through files extracting notes
+      files.each do |fname|
+        next unless File.file?(fname)
+        #next unless fname =~ /\.rb$/      # TODO should this be done?
+        File.open(fname) do |f|
+          line_no, save, text = 0, nil, nil
+          while line = f.gets
+            line_no += 1
+            labels.each do |label|
+              if line =~ /^\s*#\s*#{Regexp.escape(label)}[:]?\s*(.*?)$/
+                file = fname
+                text = ''
+                save = {'label'=>label,'file'=>file,'line'=>line_no,'note'=>text}
+                records << save
+                counts[label] += 1
+              end
+            end
+            if text
+              if line =~ /^\s*[#]{0,1}\s*$/ or line !~ /^\s*#/ or line =~ /^\s*#[+][+]/
+                text.strip!
+                text = nil
+                #records << save
+              else
+                text << line.gsub(/^\s*#\s*/,'')
+              end
+            end
+          end
+        end
+      end
+      # organize the notes
+      notes = organize(records)
+      #
+      @notes, @counts = notes, counts
+    end
+
+ +
+ + +
+ + +
+ + +
+ + to_html() + click to toggle source + +
+ +
+ +

+HTML format. +

+ + + +
+
+# File lib/dnote/notes.rb, line 323
+    def to_html
+      html = []
+      html << %[<html>]
+      html << %[<head>]
+      html << %[<title><%= title %></title>]
+      html << %[<style>]
+      html << HTML_CSS
+      html << %[</style>]
+      html << %[</head>]
+      html << %[<body>]
+      html << %[<div class="main">]
+      html << %[<h1><%= title %></h1>]
+      html << %[<div class="notes">]
+      notes.each do |label, per_file|
+        html << %[<h2>#{label}</h2>]
+        html << %[<ol class="set #{label.downcase}">]
+        per_file.each do |file, line_notes|
+          html << %[<li><h3><a href="#{file}">#{file}</a></h3><ol class="file" href="#{file}">]
+          line_notes.sort!{ |a,b| a[0] <=> b[0] }
+          line_notes.each do |line, note|
+            note = REXML::Text.normalize(note)
+            html << %[<li class="note #{label.downcase}" ref="#{line}">#{note} <sup>#{line}</sup></li>]
+          end
+          html << %[</ol></li>]
+        end
+        html << %[</ol>]
+      end
+      html << %[</div>]
+      html << %[</div>]
+      html << %[</boby>]
+      html << %[</html>]
+      html.join("\n")
+    end
+
+ +
+ + +
+ + +
+ + +
+ + to_json() + click to toggle source + +
+ +
+ + + + + +
+
+# File lib/dnote/notes.rb, line 364
+    def to_json
+      require 'json'
+      notes.to_json
+    end
+
+ +
+ + +
+ + +
+ + +
+ + to_markdown() + click to toggle source + +
+ +
+ +

+Format notes in RDoc format. +

+ + + +
+
+# File lib/dnote/notes.rb, line 283
+    def to_markdown
+      out = []
+      out << "# Development Notes"
+      notes.each do |label, per_file|
+        out << %[\n## #{label}]
+        per_file.each do |file, line_notes|
+          out << %[\n### file://#{file}\n]
+          line_notes.sort!{ |a,b| a[0] <=> b[0] }
+          line_notes.each do |line, note|
+            out << %[* #{note} (#{line})]
+          end
+        end
+      end
+      return out.join("\n")
+    end
+
+ +
+ + +
+ + +
+ + +
+ + to_rdoc() + click to toggle source + +
+ +
+ +

+Format notes in RDoc format. +

+ + + +
+
+# File lib/dnote/notes.rb, line 265
+    def to_rdoc
+      out = []
+      out << "= Development Notes"
+      notes.each do |label, per_file|
+        out << %[\n== #{label}]
+        per_file.each do |file, line_notes|
+          out << %[\n=== file://#{file}\n]
+          line_notes.sort!{ |a,b| a[0] <=> b[0] }
+          line_notes.each do |line, note|
+            out << %[* #{note} (#{line})]
+          end
+        end
+      end
+      return out.join("\n")
+    end
+
+ +
+ + +
+ + +
+ + +
+ + to_xml() + click to toggle source + +
+ +
+ +

+Format notes in XML format. +

+ + + +
+
+# File lib/dnote/notes.rb, line 301
+    def to_xml
+      xml = []
+      xml << "<notes>"
+      notes.each do |label, per_file|
+        xml << %[<set label="#{label}">]
+        per_file.each do |file, line_notes|
+          xml << %[<file src="#{file}">]
+          line_notes.sort!{ |a,b| a[0] <=> b[0] }
+          line_notes.each do |line, note|
+            note = REXML::Text.normalize(note)
+            xml << %[<note line="#{line}" type="#{label}">#{note}</note>]
+          end
+          xml << %[</file>]
+        end
+        xml << %[</set>]
+      end
+      xml << "</notes>"
+      return xml.join("\n")
+    end
+
+ +
+ + +
+ + +
+ + +
+ + to_yaml() + click to toggle source + +
+ +
+ + + + + +
+
+# File lib/dnote/notes.rb, line 358
+    def to_yaml
+      require 'yaml'
+      notes.to_yaml
+    end
+
+ +
+ + +
+ + +
+ + +
+ + verbose?() + click to toggle source + +
+ +
+ + + + + +
+
+# File lib/dnote/notes.rb, line 93
+    def verbose? ; @verbose ; end
+
+ +
+ + +
+ + +
+ + +
+ + write(text, format) + click to toggle source + +
+ +
+ +

+Save notes. +

+ + + +
+
+# File lib/dnote/notes.rb, line 371
+    def write(text, format)
+      if output.directory?
+        file = output + "notes.#{format}"
+      else
+        file = Pathname.new(output)
+      end
+      fu.mkdir_p(file.parent)
+      File.open(file, 'w') { |f| f << text } unless noharm?
+      file
+    end
+
+ +
+ + +
+ + +
+ + +
+ + +
+ +

Disabled; run with --debug to generate this.

+ +
+ + + diff --git a/rdoc/LICENSE.html b/rdoc/LICENSE.html new file mode 100644 index 0000000..ee3a9a6 --- /dev/null +++ b/rdoc/LICENSE.html @@ -0,0 +1,121 @@ + + + + + + + + File: LICENSE [D'Note] + + + + + + + + + + + + + +
+

+   + D'Note  + LICENSE +

+
+ +
+
+ + + +
+

Files

+ +
+ + +
+

Class Index + [+]

+
+
+ Quicksearch + +
+
+ + + +
+ + +
+ +
+ Generated with Razzle Dazzle Redfish

+ [Validate] +
+
+ +
+

+The MIT License +

+

+Copyright © 2009 Thomas Sawyer +

+

+Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and associated documentation files (the +“Software”), to deal in the Software without restriction, +including without limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to the +following conditions: +

+

+The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. +

+

+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN +NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, +DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE +USE OR OTHER DEALINGS IN THE SOFTWARE. +

+ +
+ + + + + diff --git a/rdoc/README_rdoc.html b/rdoc/README_rdoc.html new file mode 100644 index 0000000..84519ce --- /dev/null +++ b/rdoc/README_rdoc.html @@ -0,0 +1,160 @@ + + + + + + + + File: README.rdoc [D'Note] + + + + + + + + + + + + + +
+

+   + D'Note  + README.rdoc +

+
+ +
+
+ + + +
+

Files

+ +
+ + +
+

Class Index + [+]

+
+
+ Quicksearch + +
+
+ + + +
+ + +
+ +
+ Generated with Razzle Dazzle Redfish

+ [Validate] +
+
+ +
+

D’Note

+ +

DESCRIPTION

+

+Extract developement notes from source code and make some pretty RDoc +and/or HTML formatted files out of them. +

+

SYNOPSIS

+

+Developer notes it the source code must be formate as follows: +

+
+  # TYPE: description ...
+  #       ... cont ...
+
+

+All notes must be separated by a blank line. Eg. +

+
+  # TYPE: description ...
+  #
+  # TYPE: description ...
+
+

+Without the blank line the second note will be taken to be part of the +first. Any description that takes up more than one line must remain flush +to the left margin (if the first line is flush to the left margin too) b/c +RDoc will mistake of formatting the remaining lines as a pre block +it if is not. So… +

+
+  # TYPE: ... description ...
+  # continue ...
+
+

+Alternately the whole note can be a pre block by indenting them. +Then the layout if freed-up. +

+
+  # This is a description of something...
+  #
+  #   TYPE: description ...
+  #         continued ...
+
+

COPYRIGHTS

+

+(MIT License) +

+

+Copyright © 2006, 2009 Thomas Sawyer +

+

+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS +OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. +

+ +
+ + + + + diff --git a/rdoc/Syckle.html b/rdoc/Syckle.html new file mode 100644 index 0000000..7916205 --- /dev/null +++ b/rdoc/Syckle.html @@ -0,0 +1,159 @@ + + + + + + + + Module: Syckle + + + + + + + + + + + + + + + +
+

+ +   + + D'Note  + Syckle +

+
+ +
+
+ +
+

In Files

+
+
    + +
+
+
+ + + + +
+ +
+ + + + + + +
+

Namespace

+ +
+ + + + + + + +
+ +
+ + +
+

Files

+ +
+ + +
+

Class Index + [+]

+
+
+ Quicksearch + +
+
+ + + + +
+ + +
+ +
+ Generated with Razzle Dazzle Redfish

+ [Validate] +
+
+ +
+ +
+ +

Syckle

+ + + +
+ + + + + + + + + + +
+ + +
+ +

Disabled; run with --debug to generate this.

+ +
+ + + diff --git a/rdoc/Syckle/Plugins.html b/rdoc/Syckle/Plugins.html new file mode 100644 index 0000000..2e5433b --- /dev/null +++ b/rdoc/Syckle/Plugins.html @@ -0,0 +1,162 @@ + + + + + + + + Module: Syckle::Plugins + + + + + + + + + + + + + + + +
+

+ +   + + D'Note  + Syckle::Plugins +

+
+ +
+
+ +
+

In Files

+ +
+ + + + +
+ +
+ + + + + + +
+

Namespace

+ +
+ + + + + + + +
+ +
+ + +
+

Files

+ +
+ + +
+

Class Index + [+]

+
+
+ Quicksearch + +
+
+ + + + +
+ + +
+ +
+ Generated with Razzle Dazzle Redfish

+ [Validate] +
+
+ +
+ +
+ +

Plugins

+ + + +
+ + + + + + + + + + +
+ + +
+ +

Disabled; run with --debug to generate this.

+ +
+ + + diff --git a/rdoc/Syckle/Plugins/DNote.html b/rdoc/Syckle/Plugins/DNote.html new file mode 100644 index 0000000..f3480c3 --- /dev/null +++ b/rdoc/Syckle/Plugins/DNote.html @@ -0,0 +1,490 @@ + + + + + + + + Class: Syckle::Plugins::DNote + + + + + + + + + + + + + + + +
+

+ +   + + D'Note  + Syckle::Plugins::DNote +

+
+ +
+
+ +
+

In Files

+ +
+ + + + +
+ +
+ + + +
+

Parent

+
    + +
  • Service
  • + +
+
+ + + + + + + +
+

Methods

+ +
+ + + + +
+ +
+ + +
+

Files

+ +
+ + +
+

Class Index + [+]

+
+
+ Quicksearch + +
+
+ + + + +
+ + +
+ +
+ Generated with Razzle Dazzle Redfish

+ [Validate] +
+
+ +
+ +
+ + +

Developmer’s Notes Plugin

+

+This plugin goes through you source files and compiles an lit of any +labeled comments. Labels are single word prefixes to a comment ending in a +colon. For example, you might note somewhere in your code: +

+

+By default this label supports the TODO, FIXME, OPTIMIZE and DEPRECATE. +

+

+Output is a set of files in HTML, XML and RDoc’s simple markup +format. This plugin can run automatically if there is a notes/ +directory in the project’s log directory. +

+ +
+ + + +
+

Constants

+
+ +
DEFAULT_LABELS
+ +

+Default note labels to looked for in source code. +

+ + +
+
+ + + + +
+

Attributes

+ + +
+ + + + +
+ files[RW] +
+ +
+ +

+Paths to search. +

+ +
+
+ +
+ + + + +
+ labels[RW] +
+ +
+ +

+Labels to document. Defaults are: TODO, FIXME, OPTIMIZE and DEPRECATE. +

+ +
+
+ +
+ + + + +
+ output[RW] +
+ +
+ +

+Directory to save output. Defaults to standard log directory. +

+ +
+
+ +
+ + + + +
+

Public Instance Methods

+ + +
+ + +
+ + clean() + click to toggle source + +
+ +
+ +

+Remove notes directory. +

+ + + +
+
+# File plug/syckle/services/dnote.rb, line 79
+    def clean
+      dnote.clean
+    end
+
+ +
+ + +
+ + +
+ + +
+ + dnote() + click to toggle source + +
+ +
+ + + + + +
+
+# File plug/syckle/services/dnote.rb, line 61
+    def dnote
+      @dnote ||= ::DNote.new(files, :labels=>labels, :verbose=>verbose?)
+    end
+
+ +
+ + +
+ + +
+ + +
+ + document() + click to toggle source + +
+ +
+ +

+Generate notes documents. +

+ + + +
+
+# File plug/syckle/services/dnote.rb, line 66
+    def document
+      mkdir_p(output)
+      file = output + "index.html"
+      File.open(file, 'w'){ |f| f << dnote.to_html }
+      report "Updated #{file.to_s.sub(Dir.pwd+'/','')}"
+    end
+
+ +
+ + +
+ + +
+ + +
+ + output=(path) + click to toggle source + +
+ +
+ +
+ Formats (xml, html, rdoc).
+
+

+attr_accessor :formats +

+ + + +
+
+# File plug/syckle/services/dnote.rb, line 56
+    def output=(path)
+      @output = Pathname.new(path)
+    end
+
+ +
+ + +
+ + +
+ + +
+ + reset() + click to toggle source + +
+ +
+ +

+Mark notes documents as out-of-date. +

+ + + +
+
+# File plug/syckle/services/dnote.rb, line 74
+    def reset
+      dnote.reset
+    end
+
+ +
+ + +
+ + +
+ +
+

Private Instance Methods

+ + +
+ + +
+ + initialize_defaults() + click to toggle source + +
+ +
+ + + + + +
+
+# File plug/syckle/services/dnote.rb, line 86
+    def initialize_defaults
+      @files  = metadata.loadpath || 'lib'
+      @output = project.log + 'dnote'
+      @labels = DEFAULT_LABELS
+    end
+
+ +
+ + +
+ + +
+ + +
+ + +
+ +

Disabled; run with --debug to generate this.

+ +
+ + + diff --git a/rdoc/created.rid b/rdoc/created.rid new file mode 100644 index 0000000..4519d7b --- /dev/null +++ b/rdoc/created.rid @@ -0,0 +1 @@ +Fri, 23 Oct 2009 21:03:18 -0400 diff --git a/rdoc/images/alias.png b/rdoc/images/alias.png new file mode 100644 index 0000000000000000000000000000000000000000..9ebf013a23a56653655a736a7e149deb7365ea03 GIT binary patch literal 764 zcmV&SR3v>A``^efOSo-hEdApp;^Jd;9y!%1UfzX6Bh- z%-mbG|0Na{7Ruai_Y+DEb1s+b!*9k%Q!whMxjtZKA*?o;i1g&jy0@( zaU=-@d-h+o%gal6JRXEXA&L3`d2 z%jIxzZ~*p9O-;EJp_Ds0If38rM<5W8ic~K>FOK&2_p!CLg^i63OioVb6k$)zWHLx3 z5;!|M!}<9+#QSi1dRlbEcxPt^;cysUuU8@%3}RwpLRIGG<|IKnoyP6$Eh3SKw7a*r zSDXP=IYc&YZf;7@?fCe($^l9ORaJ3wbAx0uiC8QqRr$2t-Cfy8%XCI3B%pxJW>XdM zw~zPt_s}#A@pxQ5Ly)4szaMtH9lgE1SXx@b+S(fW`ub$fYPE8J7#bSNDzme*Ub07{ zQKV8SjEs!%0@v5ql8ggm!@$6Rbi^E8vBqpRM-}l+@5OSMrl+TWj*gC^qoV@>u{fQb zov5v?g~?>X@bEC&+uLPaQ&Ypn-y~^mZA}+f(&2EFH8eE%dU|@ENpN*_1-)L6_4Rc* zFuq@`IjX9vp1QiaK9ZojyZhnQURP99d=u;%37VRkpwsD4U0sd3x;hEQB&e^i|3QN0 z=H|Os1fRqaw!?#igLmS4HE!G3*ce(`TF}^5T)AZ%#@G{_P{NCN^P z(J0zvSn~SSm(Ur);-M~8^*;61*VRI`T1BN&LAhK;sZ>I-SVW;vfUfJv=ko^ugnc0x zhJodBxe>iyk3%w<%wC8holUJ4(iv>tL{`DQt zPOsyUbO_Cmc&*iHkqbm3ku`|GcC^OhF>jj9W*GkH;^g!iUVpib_h*=@udp4h(P+e*zL_~ZmJjh(y^BxULwq>9zXoYE8sq{#pN~U0C6!8vY)5N2 z9P*}mw}7X$O^qTtJef1ACWvJT9^wt-)Zh0r~j#0bT`f;-zv6 z^Tmw22!%rMcs!TaUX<-8s;X-B`+Xbo+_uWuFa z1yIPc?DTrQ7KvRhmt*TG|L=EYQ=LqFX;=Lp`4}jx6BE-@00000NkvXXu0mjf=s_29 literal 0 HcmV?d00001 diff --git a/rdoc/images/bug.png b/rdoc/images/bug.png new file mode 100644 index 0000000000000000000000000000000000000000..2d5fb90ec6ee08f53947e0266a87b03f75893446 GIT binary patch literal 774 zcmV+h1Nr=kP) zlgUq0Q544c8(ae&UR$8ps&snq6^bPY3v3xAmMW74Di$h~GCH6E3TaYs2#6A<7K*gC z777H71_Wa;(dfp+g-drPCSWu)#PInZi72LJ;o?i~$-U=y&UbQ89Dul3%3P+Axkzc* zbH-y;QF=hR{qLItf%ci2_&e5wNo0gnVatG?ul6Zw=o$I9Ljfn*ic3`U?>IfEim3g{ zujU&$-hy6wn;w(xme|zJm;lWJxtTFfM)q0`kX!Vu0+d${$}LCddK1<^htTe-fUYL3 zB`SdNsZD>RgvLj1<^@h6_+cDRK2Brcr2~>%$*5S)hyV33PV^teac3%|4lz@8p4?)5 z?t5o^?q+%^%)Yygo~I^U4VR!bTnWuE35hcWrfCDR3q+sxJ79e7Fg`&)RCqLA^2^y^ z0laVfadW90_Fz8Brm|r47sB^u1VgI>kanj)Z4`zMSfHlm8>CwXa$JVM`$2RrmZB-3 zN10m-!;BvH*Br3V8t`DH7m`jf#2upVDXl{5ff18_pzCPK1Zu$$CKKvd8FGeFf)+K<|x33pc7P&S#3GZT4mEw;nr(Ze*F z3&*?-4U-lm*#tber5 z%S_ceqB`b3ko6r~BbvDwdohTvP(3a(pq{x#T$yQsu#OKwEe}KuH^Mh@nxg_(Nw136 zq#a^3xNBke)In+!?qk3%4wB69{pF`Tzg`07*qoM6N<$ Eg55P&8UO$Q literal 0 HcmV?d00001 diff --git a/rdoc/images/bullet_black.png b/rdoc/images/bullet_black.png new file mode 100644 index 0000000000000000000000000000000000000000..57619706d10d9736b1849a83f2c5694fbe09c53b GIT binary patch literal 211 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!60wlNoGJgf6SkfJR9T^zbpD<_bdI{u9mbgZg z1m~xflqVLYGB~E>C#5QQ<|d}62BjvZR2H60wE-$h^>lFz(Kw&{<9vg>5sw~gS5O!4 zr|{HuUFIBKiQyL}eBJ-L{`UVT|6_O~L{G%N{Wbre{kQtZ_0LvEhC#5QQ<|d}62BjvZR2H60wE-$h^mK6y(Kw&{<9vg>(S^W+6Zii9 z|Nhthr~iNb*Z!}6uiN$Dz5neG3a-`baBX8yz1H+_;eX)`ni0%X8XBDc-`=Ph(Uan2 zYsR{H!kvIN--9isvHznRsC#5QQ<|d}62BjvZR2H60wE-$h_H=O!(Kw&{<9vg>(S^W+6Zii9 z|Nhthr~iNb*Z!}6uiN$Dz5neG3a-`baBX8yz4q@v|B?28{s)#N@CGn3@%_y|zAV9T z66e<&B4?b6oF&azg|C(V&1ZbI_D}pL`}(^FT2yXwG1Ph~$Q@h8mJYOz!PC{xWt~$( F699+YQR)By literal 0 HcmV?d00001 diff --git a/rdoc/images/class.png b/rdoc/images/class.png new file mode 100644 index 0000000000000000000000000000000000000000..f763a16880751445e3c4a8802a28d3cf8b5787c9 GIT binary patch literal 592 zcmV-W0k7R5;7c zlif>`Q5?tj7Yw@ZCMtTF^Q|ZedeJhM%QPCR*bs8V79p$QTo7e94yQNXRs-{0?hOn_-8n0AMO@u1Ts zNl8QzJs1#rz%RBt?ux>l+amAvh+J!{$lkaqv}+Erb-6j2xp>K4GLQnNB*W`hFg*?P z^AL@~(h~Z+wfcWEXHqV^Tq-#z$7Y#o0;yFxA!00F}F2dX# zjE$iOgT#G4*1TR6kB1Gnn@>$meCh2a>c5YuIvFn-R2W@>4@M*m@-|jiDV?b)bccgA zyPfsMM!rjy>+1O2)5Eg29Z_*2p&qGnmS!OH?vZ(4>QB01d>j%9n4QINxkyT(Dos?I zjaWF$*IQmh`SF-?xU%xMEfjq1=6qY*g&lgG_cXv$BGoIWyfO5 zp>pdV*O+y=&6@N2WWFo(%RtT`Q(H^6zn^a%epE~Kx^mEJ{c8`luC$nc*z9j|4Ms8aJK-la5OC%H;f`~O(q$Q#t2<^v$A>fbmv%e#dKTwK=Ku{5lS|}<-`a#7b zzTCOnnT>at)D}AMFuOZ5&%EqFN(lyumd$2ASF6=;nM~%2?gqc@U=#|4PqkX@EBo-9 z7pD#bO_RUa>*faM`8;MYfVi$JnB-zcBFc6gjl$d!bF98Q!!!(Z1_R~P?e!pt#6CHJ9S&n_n&@=9 z%GP;!@Co4c*at+6vNz7o(6en^Q1%qHrc;1)9IRaz-$@S$Z-qdC^ds3X0NvQH;KS)D z-dh&rW&@X;1cS(45z)J&BVt+tv&GMVJ%!EiW) zLBGZW)#Z+gl-Lih&?>X3SS-S#ujQ;9JRXmIB7X)8`d6ETj)D#Q2+$s|<_b7-B9Xvq zwNfqlEp%y3$uY`h{Y$(Gn5@}sqEsq95lpAkFO5dyBmP6^H-51G4J|rN2Ujt<`2YX_ M07*qoM6N<$fC#5QQ<|d}62BjvZR2H60wE-%6;pyTSA|c6o&@eC9QG)Hj&ExYL zO&oVL^)+cM^qd@ApywS>pwx0H@RDN}hq;7mU-SKczYQ-hnrr=;iDAQMZQ+*g=YOM= z!QlMQEn7FbaD->uKAYgo_j9)W&$$zS*W9}m(ey0q$&7l-XEWO0Y(9M=SnhLbwy;d>@~SY$Ku*0xPvIOQeV1x7u_z-2-X>_74(yfh7C znXL|3GZ+d2`3re2hs?MKP)IO9T&v~?D!=C@G6X*U1@h2}>2WE%HrrsjTfQsh6N9%SR25A5rkWp0g zzi;-6|3HJE;58sAyX1e@^d7EwiKQLb00%dp|5+t<{|l;G!D3eSuFDma zRCxr2MVY_`ELgLXqo}ssqp5E;*r|opZT~&|!~VN?1^mw`Yxp0VmiIp*r|Ey~#AW|W zTBd;IxVd?%*x1<_!3Ip2yP9Rn!u1aqt=siKx4a3At0%7dKV|u@|9wlg|7x7R;eT!K z{QuFp&Huxb3&AdAW?^~2z`(!^HUQ{cR*=op7H|BYU0VMi3A-|5H&#ol!zs_8lnTUg(&PtE($2Dhdk=&(F^R z|KGZGj(DV`tD_*NsU$2QNCCXqf9n(sfdh~LzJJdCa}5CGoUI+JZJBOCDz({abl~fE zw*5kfzVoR6cNi2r#C!ZEH0O;NW@rIh| zlqsqSSs9s#;sV;-@|>77A1W_O_DV`91Pq4Kz`Z(PaO&pn=GOMkuU$ROkc5GuVd!Y* zcn`UMYkYq7V07o@rsi~>-ziMLT zG+?a49zQWzia{TFcs{FKj#dh}e#z5@`O3omC>ELXboP2cR7WT?J@&ao#fn-I;sJ*F zD;=5p9?%y~V{F{q4^{|Zlt~d?*Ve!iWj&E%8@h^*gN$V29v5mAsN{O(ULD=kFMd^> zzLGLp)CZ#Qm6Q%3+`@kXtfre9GnE->Ai(oKKDoxtH@hRaB&C1e=IHR>I8;havNP_A z5Rq#nPVBdI5VpJ;S&et6>VVp>c?LwQ)tZWlq#H^i>)VP@16GREXU98`irCrvkEecY zkv~S7^T>M0*)Mb{LvE6`M77!t_ZXXI^`uU6W|L`YE-^~uca*s^)=F=9o*rxs>$qx+ zN_$rAd`ahYK2^cpF)HkQ1(Vq|Urh;b~<55D)DL$EUNo=p_A6VQ1A+M~) zfa$>U0O5Rbu4r3$+|O$+gUQaOR@{dPsf3U1Dln%z0(Y0xq^w4=AKW8UMLXPC9RL7* zZ3?i~&mg|kvE%&Q2{D=<{q^E0^^uNwISF-V^g!SN_6Pp zHm8=*qyzo0O&|aW=mQ}BV^c}pv_6$imk>cA#v4GgKI?F@S#sYw42|o9Jp1uLDt+Ls z2-H#~>q=LQWTF;nU7xJYKH2KCI4{O5B$T{{EgN}dE+rE|#F+n@O!gj|u;Xxe?Su03 z2tWqC_4M@)#<@OoQ{pg&@m`>d=YYXNQlKHoj2tjT2nB<`FCZcENCi2SLd5c#Iz{+w= zQMis*31e?RPgP7h#4AOzY&hE#R4n&Ii?x5Yq0)?J7KNcBj@XdX zlWZ;>n^k?`V`54w4oMu!H=JW%u_9}!!vS4^ZMC2#K+@g2!t)G5*y)(xiYlL_px35D zIhY0lK348EIpV!%r-=F;O(7xbv>oQP6>|(>Opp4COU-9M>Q6ub0PdDCFo(En#x&eN zGni{g@pt^Yi&Zk-WUSBg%!GQT&imw!)F&}=v0^+ zPAeQFDhtKVnUuxMHpDJZ^)IYcqn3l$E3tGu>6%O0JW{Qd&uUAT_CJz)Db-2{$Z4Cq zibD~-93PZJRMP~xt4_LEY#WADM=C$k2DOim8}|&T7PflIw)ySUdh%=c{&;)e+r`Hd z>F)2L5sYyl@Pwfv-Z+Q9(~d^Q%E@BrXlV!+zKk$1SUf5lN)jz7MS>v}FnGm>Qbf5( zWmQ8>Y4OMAhWe&Lk?b!b?Oi z7q@cwX@48D4*Plhd-GIrduvP}Ef)tlzfP@U!q&vPH#vyU*UZF+Z1UXs%zV%z6LOs+ zcaVxUJ2&!|`1z(BM}Lk=9HZd_-+C?1s|j(*3pM}K)5P_O^ZvgjpgCOOIH^P=rz zrnafS&0I?@i8t47Fuv>lf^b*BgG?Gr8}Rx=$^MeEIq58C~R;2W5b2+Z6DSOmY&y?jM>PP zmCH(!b;p5a z08~hSk!QD03@!sbLen@urU{Gbn>9K(ikm zl#3h~9C5N=ig9Rs_qtTd=#qk`!ZGs7NvnMZ+uzd@j(?Rvpko)yuH)l~lSKOGS)aBD z7_OmZBdg=SE=0lny&|8m4WGI#J|9BJ}fBGEjmh_+3QFV-yUQn(l{$5#`e$ znfciyaIqFV2bzbhDu?7{<$RLQFC=|ws^?CtX)4I8sO>-(eMb1ar-sUdK)fzgqvMk> zZ^Rh)#8kxW$|S;j1HHPvzPz`!bA(!5h*+9K{Bl4}FHo45&3%yp?rDAP3~x@+ME*8G z&}mIK2Y`4+qxB<9rNt@5hlZ)HG`HKZFPtZ(CdCW@wfOGs!rXe8 z-mBDPnj{HhE4Ayk=DMsy6c5sbcY=`3>S0gZ@AO)^Sd)t$p13pA3PJ#dmLDTD1s}Wz z02ItQF~53Ov+wZ2P`n_U4VAJGo_<)CMpqJ3n-|`KmS8^ z<6NCKAuP(yrPRXiqft#MxAk}%PIb2CItemH*OUB$_E1dAyieI6EigfeNusQvXT~9L zwllbU*O+j+W5Qti)3H?p?*D`9lDN^-b^Q#pv$U8g4>1bxARs=rK5^IfwL5Y4H4Pl{I}`^(PH1gYU{*wqe@3$h1OCneK4J4!&MRe zOI%s;fxPp5H9Bx6x{QqEsK*Hpw`q|yBo$$v_ZDvLxN=kn=g9|eG|t{-cBCa zWSp2ev%7lwBK@tsaE^R7fx&OwUGQ#^arcni@_`qa0+Ih<3e19Mf+3k%g+)@Z0>QL0 z!HU9+@@y$mUhU^$zNMt8xbj1@av;@3!U%#u{N{thykrE-duU`-05?CiI5){L zy%f8$xwgE)K0S*=93sE3FU*{+{yF$b=Jm0O!B_#^eoI(9dVeEu^GYSFGhk6VM2eP; zSzH6(dYAFYJ=IMG-RZ%6^E|!yINDStfqn3^nx(_a*MMt-QOJ6FngYP6Flzi8{}M1u z?#m8_6qlhH0|2mB*E(B$x{iH!qh!(v^CX*om>t8m-!J2T%OyrE@fg!+W!rCupnGfE zR%c(5_C1*?Q|=SfK?@c3?d{0gfIk6Qne%2NAR%5!D1e2lrEA=#=314|^y}mlbdU!h zPIxs%P{lm;bYgjBs1qyXxkN6UD66G>mRl#Xr4z~PvG$je@$TcPPQN{YiFfsV4Ahz{ z;nj44T{SOdcs1301%HU_N_w4#jyn9@;-ar3_x<_h`fhkmBj(Iby8UQuwZ@CP3EK}j zbXm^OyhBqkWQ~AeVy^iVB)4Wh)+=b5--vjbtrvx4823+e>fN%unKd+&T&~@;LSp8#I-|*I=U2LzE0($<|LW%XsA_XQ z3>6@ct56W8`Y2>d{!pjH=F?<22mf_ejVWx&mfsLml615hA!(-FDBnc-jDQv_NKXNy z(=8#eu15MT`JMYUW~~vr%z{`z9S|~|_VAY6Ov4M7#Wa(*O#3EWzRYv@&_zy|0i*@_46?BhYPPEpVGD|(a((4@b>fF)l-3jQvCcv z{o)yqMWo1gDTG1vWp=_AJoP5UPxA^qrdn6*;Qh%^sB8>DcX5d2bXh zu<5X$-n2+RVUy$k%$jmfMxgu4ZWTs$Oy{Q?tryu(5>W>)zs2)w zHL}wWPpTzwL2MM8=lkwHp3#jyMe3%J0Av0)*ixKl2lMvu@{j$n91n^pNe|jd``l0N z0RU<BSv#yWY}G&Kb9IUxK2(l z!4Sz=T3g)J1mqFu!`seMX@O}Bp}gyZ@I7GK*7vWYuax&DJ=8$){{tXS> z7+}lu)M-J126vy;?q&^}iM1!NCf1I@E@@H~O-PIlsM7kknVdsATr@pmBo(C~$G6gS z02;)2O@0&~`#fHDeC1eCZZs;s2N)@A;Z!v}6IRW@+w4GRSlrsuorBjfJ?y*o(0gj> zt+;DN~K1pX*UvM(B(Di$9F6+&eT z#bhNzlMA>q^N?j+@1IqnYvK};_)_77Ts{!elaGqJg{uwb(1mX6u=pkfLJYkfX+`v! zOm>eolNV>Nz$A&W8YqkN#cU|#i6j>Ox+Eu4*8Myq{Eq?u*kn+nT zQ@k8?r`Isov^UI2=T{#K~skC)fRP-aj zcrJyQmQ!u>p5&{_zp7xOM(Q%smb6M%g6o4s^>A8#L41?8Ox^e7CM$W~*3!e8F7P`S zK9!26tqJVBt`?fLxM^Gf`xAacdcbz&)u<6pKM?qA_ms76BOQWg0Le^W#?SMIT$jE7 zyw1!lG*$#k#iqZyl9~L_CjIwBb}$%9+e2Vw!1@$nfpvj1y2o4hJabo7^;(V}>++Tz z{|NtdydBeFpKnv*Vg9BTu3P)+)3J?9`*6t|c{b*k>-L!PvY`#5^i1^XCnxh zky})0T&rp6 zJFwUVv-;Dzt2_z1)}rtpHBQH#<-`N0%%UP1TF^VNx2@~Zh_4nbMMxj7zeHTrB&q)a Dl)1NK literal 0 HcmV?d00001 diff --git a/rdoc/images/macFFBgHack.png b/rdoc/images/macFFBgHack.png new file mode 100644 index 0000000000000000000000000000000000000000..c6473b324ee1dae1faaacc0826639833f551116c GIT binary patch literal 207 zcmeAS@N?(olHy`uVBq!ia0vp^k|4~%1|*NXY)uAIEX7WqAsj$Z!;#Vf4nJ za0`Jjl>Qs8<JF;+Fd5q0wCR k?u=~bH}2*0f`J3~k>FVdQ&MBb@0BAfpf&c&j literal 0 HcmV?d00001 diff --git a/rdoc/images/method.png b/rdoc/images/method.png new file mode 100644 index 0000000000000000000000000000000000000000..7851cf34c946e5667221e3478668503eb1cd733f GIT binary patch literal 452 zcmV;#0XzPQP)Pdwe5?6tW?r-ok|b$oDQj8FV%kZPq;(MWOV8?8;<)(iP}>hNMU> z7fbz%jjlr7h8uuoQ~J6}n}@Y@PdTk=)PxO{%7zmL?dchpZX*~n;I{!C>*(8cU;q(~ zAS%Po_@naEU!xidrBXD?;hN|x^%W|Ij)0y*r5vi|?W&Fub(NqJ@z0o=O5TQ^(M5v$(QKVE?W+9X! z*o}&~6c?_FreF)9NJB7b5Nbn{G0n4+%uJhR9(V5R|NFTpb|HgjefT!tIhLx@DR+N) zV+fHiR5Yt19}k|KnCsND{tH-`IMJ)3AE?OtyZ4>Un|6(d%h#JK`i&a7^xW9>`yBy` zS4SOHeOpC7$?hH5-#7Rswiue_8Ju*2N@$58=a#2OTA3png`w3v->gWif7t%e$ z$NLVS!tFT#8WL|Wa&K~+{%4P2cRfwesYV1_!F=3OaRVHl(>=`%&{x*s30c}#CNE@&;ItrAv!f!)Oy$Q9t$uS=(sD$-J{T*^(8Eez1E-l3}} zPrfHZ1`qsIFe&gipuL8-IZbo2Yg{lFGKs?ZZWcOaOdk*3`5T;$?AjbG1#`B510Er^h2)2r3Y{!8_2Gj=$KzuN5 zaErtW8W_Y2iJJjY)5pmTVJoPJYpanPOEuYHclM^C1F>${hFRpdi8a<2H|Xudf78bm(zwJ9`K%6I?q*Ua~ fW9JvIbn5*B+_J)rUMBs>00000NkvXXu0mjfH&TkY literal 0 HcmV?d00001 diff --git a/rdoc/images/page_green.png b/rdoc/images/page_green.png new file mode 100644 index 0000000000000000000000000000000000000000..de8e003f9fb8752c09e7f3655d5d8664b5c62fc3 GIT binary patch literal 621 zcmV-z0+RiSP)QqUjAtB;_Vvt6}AS_5YgM`Uqu`yva+H8^=4U$e4gHb}u zAQ2N{V3A%pO|?Pv?tb6z=jC}SiRa$G^v3q?*6XcYz$p|cq{uLj@#~Fi`J(>5{@&&N zy%T^+;>8cXx%|o77anP?&W1?1A(>-T49z9pyeCl@7YI+Si zKti7=B~``}TImz(G{0PnlQA3P#MAd}sorMjkP!50B7$nAkU^%#nl{Q9lW0@}9fE-> zN(q7tRuiC_T1r|BBtVBTlQ2+70$Rf;eF`Z;lx46Cpu-rEgb)EBKq(b^W8l<^We(`D z43?0=01z<3G6+UUv6`CsWCk6^93!#+<;ws7007{zS3k2k9-zZKFO~(k`>s0y006+1 zgF_jyIhsL-`FMf~JL~C=cV75(CrJ|q;MVO961G=O zm9d)YpJg5g(4i_HKL75eSE}mq$Y}r}hyVdcV~p>6a}oXr80q`oj%+s700000NkvXX Hu0mjfPs|!l literal 0 HcmV?d00001 diff --git a/rdoc/images/page_white_width.png b/rdoc/images/page_white_width.png new file mode 100644 index 0000000000000000000000000000000000000000..1eb880947ddf3e745c29e8d9dc90f09c7e6e323c GIT binary patch literal 309 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!60wlNoGJgf6SkfJR9T^zbpD<_bdI{u9mbgZg z1m~xflqVLYGB~E>C#5QQ<|d}62BjvZR2H60wE-$R?&;zfqH(@;q9b3Efq-lM(nr^( z=EYR73-9e)UYMWsXy%?aZsD68Yyv^2$~6QgEcljw%kx>O(f-gQ?@fOOx3A-0+Qw?O zRx~W)kn~Qe2d6f9nMG#g9Q04Mk==M~N!Dglvxk!fgVh#w@ZV$IY1+Xc`d{d2UcaP~ zfWp)_Ivqj}l2SPy^9ZWy6rG9Yx4v67_uA&&9|XA~5-#3)W3%em1peD8RWH^#O%XoM zxMPud%}GTj#~*+7JMxTd!`{^Q+>(D3*|@KV`*G2;{QnANOxu1$r2xIe;OXk;vd$@? F2>@zac~<}c literal 0 HcmV?d00001 diff --git a/rdoc/images/plugin.png b/rdoc/images/plugin.png new file mode 100644 index 0000000000000000000000000000000000000000..6187b15aec001b7080b51a5f944f07591f26cc15 GIT binary patch literal 591 zcmV-V0eEcNHZMNv|IbJ-M`( zKwWL~opzjJe^WpCmV9E;(0&ut2;4va_(#>M8)>9$R5viQnf(Nkh~VM$y>J(jqb$cj z+nL1Nm|mV)Gm|9MnHf*7Ja4OEAQz__^LRKOLEwqpiGV^^A*T=#&inGm-62Xs;dnSp zKj&H9T*boh2i)W+(n27l!C)>fq|L%VB1i ziC4p;NwV_}ZjW7$LRW#(_bKF#hp=!IqNO26Z*w2+LEwx{PVnZ&Sn}T;mtzb$;qA*nT@@+ zV5uQ@iXDTPoTbV#FRr~z04|PPh`wXTNoCm9*tG&?e3+fYl>K6+&3|Cc$KOpL`ER+_ dcRl5U#9zn6ZO}GFPx${!mO*MF0Q*y3eor|M>g=`Tqa@{Qvs?|NXDTr27B&{r~-?x|;p}{Pp+s`2X|j z?&y@Kj-9TT-Q(N*|NHs>_L`cS@bd4-$jGIorBrT8;Nak=r>FM!^;d6D*4Ea~*vfg3 zae8}6z(ra=Nnt@;bXC5|y6fxf^7rub_42s5xXaMV>gwuX zc~?hZKA57FVR%`fprFLb!qL{yowAb4%gbwiWRRqYqqCjO&CRU4r?$4Xm8grx#>VCA z(XxSZnR;*^w>_y6+8(8Sr@*TciZLR>h_*2=Q7vhnor_4f3y zysJ}cOUcv4vcIifa9G^j+@GwOtH7X*poM&ocFNkqyvMlS-rnu->$%CWpP!$wu(0gx z?6k?LwaKgY{qmu&o7vph^7-w<&cKn8kyma{nWL7)#l@MbkXUa}afWI1_4AjPm+kKC z_xbfrXG7T7*x%^dx5Kljx1wu;WL|Jq&DhBJ|Mc$i?1z|vo}QkGoPzoM_<@*u|NsAf zT~=uT0004WQchCrnG$Xm(9#Z}7=1lq>SfC8$bEuPJMe8CG%BBFRSfdW%gvL=J{v#@b; z3$Z%pFwB<@tP%C8^Q~+wTFlBUIi0~sI(eeqJpO1W3FmrdCRq^%SDplSu=*+1woDv) zZVXnX7Bg68`d1{SGc$1rn@cgsOsisHGmw}SS2!W0Y*9cPLwSrc8|U)ax!p??4J~^k zH5g1idO-F8)hp=m&Jhn{@Lu5JkPqSuck$-RwPpgH)+AQER3$8Rl2=-MwTL88z$SaP jUxB@vxO!s0lvq0e*keaJTe36J00000NkvXXu0mjfCq4Ek literal 0 HcmV?d00001 diff --git a/rdoc/images/ruby.png b/rdoc/images/ruby.png new file mode 100644 index 0000000000000000000000000000000000000000..f763a16880751445e3c4a8802a28d3cf8b5787c9 GIT binary patch literal 592 zcmV-W0k7R5;7c zlif>`Q5?tj7Yw@ZCMtTF^Q|ZedeJhM%QPCR*bs8V79p$QTo7e94yQNXRs-{0?hOn_-8n0AMO@u1Ts zNl8QzJs1#rz%RBt?ux>l+amAvh+J!{$lkaqv}+Erb-6j2xp>K4GLQnNB*W`hFg*?P z^AL@~(h~Z+wfcWEXHqV^Tq-#z$7Y#o0;yFxA!00F}F2dX# zjE$iOgT#G4*1TR6kB1Gnn@>$meCh2a>c5YuIvFn-R2W@>4@M*m@-|jiDV?b)bccgA zyPfsMM!rjy>+1O2)5Eg29Z_*2p&qGnmS!OH?vZ(4>QB01d>j%9n4QINxkyT(Dos?I zjaWF$*IQmh`SF-?xU%xMEfjq1=6qY*g&lgG_cXv$BGoIWyfO5 zp>pdV*O+y=&6@N2WWFo(%RtT`Q(H^6zn^a%epE~Kx^mEJ{c8`luC$nc*z9j|4Ms8aJK-la^jb z4`0v}DG1te)wmeb(>p90leRz?_mO+^JKy=v&2<29Od6?F%9%(c8los#f*@G`-%W&* z$)uBj2i@u-@SgX}gtyWPe6d*|w6h%R? zScK2#Yn%$sum0cy>90DmY*i{1XqpClEtktsRTZ)lCUe z<FogV^*tm>8*AlX za4oiR!&85LrobG57qUHUX#{>Vz(RHpB5|@>9O6N$jqB8>%($0wxE5R3)b>Y~xtCo$ zCgEk&A?_#IxHdN)9tqre^o{ho4{?hmPuf@^@I3-wncaRd%|~O3xbrKY=&TiwPYkJroM{;WUQTuMY8vpg}f4o)2%U3C;eEDoiEh?94d(rV57VIF#8VqzW$HrDC|#U`x@QDbgi zVl)t9GGz&YY#D?gc%>hISA+_EBpnXt#pnC`p6@xw0$8TCbULjhlgVx(kuc)%xbgqq zR5+DNDFRN0!y)7Gm}oT0i39}h4h928qY?Rho^UvPGJ#kuW|-Amtrn`Pmd&+bFo@sp z$LI4IQw7BG?|#2ewOS<<3VjL$0=lMY^m;wqZujv5kx1l%Sl;V&Iy4#$ip3&@LV2!7vhhN=PCz%^9v24`qb(+m4W?!q-&~=?ssf5GfnAmJKV;3bvpDm0(NhahZ=&^sqo6Odj6>)Dq_3p~4~ zvb`d3Mydwjt&Df^hVmLtI2x=U&h9(JVYX-!y~z3zi;1>=LY;o(bL$(Yf$lf)dMf0-u^0HrpTG Wk@)HE*94aU0000m+BBgry{~j2fHLegbHP( zrgXNbr0}2;^nywdjLjZe?uxtrd3D(pZH@fFFc0{BW_~jxoO1w7-VX;6vK@ROA$$R6 zEmo;Ht-Mj|>5jUy{bQ^V5@53LRI8AgLpUm|m+15sqcz@QtVSo|oz7ArM8?pIn+>gN z0b=4_b5O|4A*;Q+vc9Vqr~%3V155*NV~@gTz}KSUiKB-uJzjMZ>5%Q#n24H!V{ zTY(LLAE*NAHZ}C#wnj%Bw5OFIkRhkkAW#kDC3j9Wm0YXRaXlyyp>#mVfYG)eC;@ab zDb=T-BCAY4LI(Z@GOTr2V_A{pRwSmz+8Be>CjAw(=gnbVWAeguvZa93JmL(EDxv1m z0OP4q=fpAK1Mq!C2`OkEn37o;m#wF#(t(8Pu#S?2f#x<~4EO{@fmm`p9veD6RZ_jp z@Au4};q&`XuKEYgIiB4((kgxOs#YdqJw0fY>9^K_agEu5+$#k;w#%I2N>n_?)YIqu z`tq&#_^p?-%K*U0^}|7+9U(&k0?s;=r=uCZ%)H9_edH8wK}gB(nUB1FFk+2Ol%BXV zHoFY`D~2x|2 + + + + + + + D'Note + + + + + + + + + + + + + + + + + + +
+

+   + D'Note +

+
+ +
+
+ + + +
+

Files

+ +
+ + +
+

Class Index + [+]

+
+
+ Quicksearch + +
+
+ + + +
+ + +
+

Method Index

+ +
+ + + +
+ + +
+ Generated with Razzle Dazzle Redfish

+ [Validate] +
+
+ + + + +
+

D’Note

+ +

DESCRIPTION

+

+Extract developement notes from source code and make some pretty RDoc +and/or HTML formatted files out of them. +

+

SYNOPSIS

+

+Developer notes it the source code must be formate as follows: +

+
+  # TYPE: description ...
+  #       ... cont ...
+
+

+All notes must be separated by a blank line. Eg. +

+
+  # TYPE: description ...
+  #
+  # TYPE: description ...
+
+

+Without the blank line the second note will be taken to be part of the +first. Any description that takes up more than one line must remain flush +to the left margin (if the first line is flush to the left margin too) b/c +RDoc will mistake of formatting the remaining lines as a pre block +it if is not. So… +

+
+  # TYPE: ... description ...
+  # continue ...
+
+

+Alternately the whole note can be a pre block by indenting them. +Then the layout if freed-up. +

+
+  # This is a description of something...
+  #
+  #   TYPE: description ...
+  #         continued ...
+
+

COPYRIGHTS

+

+(MIT License) +

+

+Copyright © 2006, 2009 Thomas Sawyer +

+

+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS +OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. +

+ +
+ + + + + diff --git a/rdoc/js/darkfish.js b/rdoc/js/darkfish.js new file mode 100644 index 0000000..43528fd --- /dev/null +++ b/rdoc/js/darkfish.js @@ -0,0 +1,116 @@ +/** + * + * Darkfish Page Functions + * $Id: darkfish.js 53 2009-01-07 02:52:03Z deveiant $ + * + * Author: Michael Granger + * + */ + +/* Provide console simulation for firebug-less environments */ +if (!("console" in window) || !("firebug" in console)) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml", + "group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"]; + + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +}; + + +/** + * Unwrap the first element that matches the given @expr@ from the targets and return them. + */ +$.fn.unwrap = function( expr ) { + return this.each( function() { + $(this).parents( expr ).eq( 0 ).after( this ).remove(); + }); +}; + + +function showSource( e ) { + var target = e.target; + var codeSections = $(target). + parents('.method-detail'). + find('.method-source-code'); + + $(target). + parents('.method-detail'). + find('.method-source-code'). + slideToggle(); +}; + +function hookSourceViews() { + $('.method-description,.method-heading').click( showSource ); +}; + +function toggleDebuggingSection() { + $('.debugging-section').slideToggle(); +}; + +function hookDebuggingToggle() { + $('#debugging-toggle img').click( toggleDebuggingSection ); +}; + +function hookQuickSearch() { + $('.quicksearch-field').each( function() { + var searchElems = $(this).parents('.section').find( 'li' ); + var toggle = $(this).parents('.section').find('h3 .search-toggle'); + // console.debug( "Toggle is: %o", toggle ); + var qsbox = $(this).parents('form').get( 0 ); + + $(this).quicksearch( this, searchElems, { + noSearchResultsIndicator: 'no-class-search-results', + focusOnLoad: false + }); + $(toggle).click( function() { + // console.debug( "Toggling qsbox: %o", qsbox ); + $(qsbox).toggle(); + }); + }); +}; + +function highlightTarget( anchor ) { + console.debug( "Highlighting target '%s'.", anchor ); + + $("a[name=" + anchor + "]").each( function() { + if ( !$(this).parent().parent().hasClass('target-section') ) { + console.debug( "Wrapping the target-section" ); + $('div.method-detail').unwrap( 'div.target-section' ); + $(this).parent().wrap( '
' ); + } else { + console.debug( "Already wrapped." ); + } + }); +}; + +function highlightLocationTarget() { + console.debug( "Location hash: %s", window.location.hash ); + if ( ! window.location.hash || window.location.hash.length == 0 ) return; + + var anchor = window.location.hash.substring(1); + console.debug( "Found anchor: %s; matching %s", anchor, "a[name=" + anchor + "]" ); + + highlightTarget( anchor ); +}; + +function highlightClickTarget( event ) { + console.debug( "Highlighting click target for event %o", event.target ); + try { + var anchor = $(event.target).attr( 'href' ).substring(1); + console.debug( "Found target anchor: %s", anchor ); + highlightTarget( anchor ); + } catch ( err ) { + console.error( "Exception while highlighting: %o", err ); + }; +}; + + +$(document).ready( function() { + hookSourceViews(); + hookDebuggingToggle(); + hookQuickSearch(); + highlightLocationTarget(); + + $('ul.link-list a').bind( "click", highlightClickTarget ); +}); diff --git a/rdoc/js/github.css b/rdoc/js/github.css new file mode 100644 index 0000000..73326cd --- /dev/null +++ b/rdoc/js/github.css @@ -0,0 +1,93 @@ +/* github.com style (c) Vasily Polovnyov */ + +/* NOTE: This has been included in the rdoc.css stylesheet + rather then have it's own file simply b/c I have not + figured out how to utilize my own generator to be able + to copy additional files. + */ + +pre code { + display: block; + color: #000; + background: #f8f8ff +} + +code .comment, .template_comment, .diff .header, .javadoc { + color: #998; + font-style: italic +} + +code .keyword, .css .rule .keyword, .winutils, .javascript .title, .lisp .title, .subst { + color: #000; + font-weight: bold +} + +code .number, .hexcolor { + color: #40a070 +} + +code .string, .attribute .value, .phpdoc { + color: #d14 +} + +code .title, .id { + color: #900; + font-weight: bold +} + +code .javascript .title, .lisp .title, .subst { + font-weight: normal +} + +code .class .title { + color: #458; + font-weight: bold +} + +code .tag, .css .keyword, .html .keyword, .tag .title, .django .tag .keyword { + color: #000080; + font-weight: normal +} + +code .attribute, .variable, .instancevar, .lisp .body { + color: #008080 +} + +code .regexp { + color: #009926 +} + +code .class { + color: #458; + font-weight: bold +} + +code .symbol, .lisp .keyword { + color: #990073 +} + +code .builtin, .built_in, .lisp .title { + color: #0086b3 +} + +code .preprocessor, .pi, .doctype, .shebang, .cdata { + color: #999; + font-weight: bold +} + +code .deletion { + background: #fdd +} + +code .addition { + background: #dfd +} + +code .diff .change { + background: #0086b3 +} + +code .chunk { + color: #aaa +} + diff --git a/rdoc/js/highlight.js b/rdoc/js/highlight.js new file mode 100644 index 0000000..f3fa32d --- /dev/null +++ b/rdoc/js/highlight.js @@ -0,0 +1 @@ +var hljs=new function(){var p={};var a={};function n(c){return c.replace(/&/gm,"&").replace(//gm,">")}function k(s,r){if(!s){return false}for(var c=0;c'+n(N[0])+""}else{Q+=n(N[0])}T=S.lR.lastIndex;N=S.lR.exec(P)}Q+=n(P.substr(T,P.length-T));return Q}function M(r,O){if(O.subLanguage&&a[O.subLanguage]){var N=g(O.subLanguage,r);u+=N.keyword_count;C+=N.r;return N.value}else{return G(r,O)}}function J(O,r){var N=O.nM?"":'';if(O.rB){c+=N;O.buffer=""}else{if(O.eB){c+=n(r)+N;O.buffer=""}else{c+=N;O.buffer=r}}D[D.length]=O}function F(R,N,S){var T=D[D.length-1];if(S){c+=M(T.buffer+R,T);return false}var O=A(N,T);if(O){c+=M(T.buffer+R,T);J(O,N);C+=O.r;return O.rB}var r=x(D.length-1,N);if(r){var Q=T.nM?"":"";if(T.rE){c+=M(T.buffer+R,T)+Q}else{if(T.eE){c+=M(T.buffer+R,T)+Q+n(N)}else{c+=M(T.buffer+R+N,T)+Q}}while(r>1){Q=D[D.length-2].nM?"":"";c+=Q;r--;D.length--}D.length--;D[D.length-1].buffer="";if(T.starts){for(var P=0;P1){throw"Illegal"}return{r:C,keyword_count:u,value:c}}catch(H){if(H=="Illegal"){return{r:0,keyword_count:0,value:n(E)}}else{throw H}}}function h(s){var r="";for(var c=0;c"}function B(C){return""}while(z.length||A.length){var w=v().splice(0,1)[0];x+=n(y.substr(s,w.offset-s));s=w.offset;if(w.event=="start"){x+=t(w.node);u.push(w.node)}else{if(w.event=="stop"){var r=u.length;do{r--;var c=u[r];x+=B(c)}while(c!=w.node);u.splice(r,1);while(rD){D=c;var B=t.value;v=E}}}if(B){if(C){B=B.replace(/^(\t+)/gm,function(r,I,H,G){return I.replace(/\t/g,C)})}var x=y.className;if(!x.match(v)){x+=" "+v}var s=d(y);if(s.length){var u=document.createElement("pre");u.innerHTML=B;B=m(s,d(u),F)}var A=document.createElement("div");A.innerHTML='
'+B+"
";var w=y.parentNode.parentNode;w.replaceChild(A.firstChild,y.parentNode)}}function e(s,r,c){var t="m"+(s.cI?"i":"")+(c?"g":"");return new RegExp(r,t)}function j(){for(var r in p){if(!p.hasOwnProperty(r)){continue}var s=p[r];for(var c=0;c|>=|>>|>>=|>>>|>>>=|\\?|\\[|\\{|\\(|\\^|\\^=|\\||\\|=|\\|\\||~";this.ASM={cN:"string",b:"'",e:"'",i:"\\n",c:["escape"],r:0};this.QSM={cN:"string",b:'"',e:'"',i:"\\n",c:["escape"],r:0};this.BE={cN:"escape",b:"\\\\.",e:"^",nM:true,r:0};this.CLCM={cN:"comment",b:"//",e:"$",r:0};this.CBLCLM={cN:"comment",b:"/\\*",e:"\\*/"};this.HCM={cN:"comment",b:"#",e:"$"};this.CNM={cN:"number",b:this.CNR,e:"^",r:0}}();var initHighlightingOnLoad=hljs.initHighlightingOnLoad;hljs.LANGUAGES.cs={dM:{l:[hljs.UIR],c:["comment","string","number"],k:{"abstract":1,as:1,base:1,bool:1,"break":1,"byte":1,"case":1,"catch":1,"char":1,checked:1,"class":1,"const":1,"continue":1,decimal:1,"default":1,delegate:1,"do":1,"do":1,"double":1,"else":1,"enum":1,event:1,explicit:1,extern:1,"false":1,"finally":1,fixed:1,"float":1,"for":1,foreach:1,"goto":1,"if":1,implicit:1,"in":1,"int":1,"interface":1,internal:1,is:1,lock:1,"long":1,namespace:1,"new":1,"null":1,object:1,operator:1,out:1,override:1,params:1,"private":1,"protected":1,"public":1,readonly:1,ref:1,"return":1,sbyte:1,sealed:1,"short":1,sizeof:1,stackalloc:1,"static":1,string:1,struct:1,"switch":1,"this":1,"throw":1,"true":1,"try":1,"typeof":1,uint:1,ulong:1,unchecked:1,unsafe:1,ushort:1,using:1,virtual:1,"volatile":1,"void":1,"while":1,ascending:1,descending:1,from:1,get:1,group:1,into:1,join:1,let:1,orderby:1,partial:1,select:1,set:1,value:1,"var":1,where:1,yield:1}},m:[{cN:"comment",b:"///",e:"$",rB:true,c:["xmlDocTag"]},{cN:"xmlDocTag",b:"///|",e:"^"},{cN:"xmlDocTag",b:""},{cN:"string",b:'@"',e:'"',c:["quoteQuote"]},{cN:"quoteQuote",b:'""',e:"^"},hljs.CLCM,hljs.CBLCLM,hljs.ASM,hljs.QSM,hljs.BE,hljs.CNM]};hljs.LANGUAGES.cpp=function(){var a={keyword:{"false":1,"int":1,"float":1,"while":1,"private":1,"char":1,"catch":1,"export":1,virtual:1,operator:2,sizeof:2,dynamic_cast:2,typedef:2,const_cast:2,"const":1,struct:1,"for":1,static_cast:2,union:1,namespace:1,unsigned:1,"long":1,"throw":1,"volatile":2,"static":1,"protected":1,bool:1,template:1,mutable:1,"if":1,"public":1,friend:2,"do":1,"return":1,"goto":1,auto:1,"void":2,"enum":1,"else":1,"break":1,"new":1,extern:1,using:1,"true":1,"class":1,asm:1,"case":1,typeid:1,"short":1,reinterpret_cast:2,"default":1,"double":1,register:1,explicit:1,signed:1,typename:1,"try":1,"this":1,"switch":1,"continue":1,wchar_t:1,inline:1,"delete":1},built_in:{std:1,string:1,cin:1,cout:1,cerr:1,clog:1,stringstream:1,istringstream:1,ostringstream:1,auto_ptr:1,deque:1,list:1,queue:1,stack:1,vector:1,map:1,set:1,bitset:1,multiset:1,multimap:1}};return{dM:{l:[hljs.UIR],i:"",c:["stl_container"],l:[hljs.UIR],k:a,r:10}]}}();hljs.LANGUAGES.diff={cI:true,dM:{c:["chunk","header","addition","deletion","change"]},m:[{cN:"chunk",b:"^\\@\\@ +\\-\\d+,\\d+ +\\+\\d+,\\d+ +\\@\\@$",e:"^",r:10},{cN:"chunk",b:"^\\*\\*\\* +\\d+,\\d+ +\\*\\*\\*\\*$",e:"^",r:10},{cN:"chunk",b:"^\\-\\-\\- +\\d+,\\d+ +\\-\\-\\-\\-$",e:"^",r:10},{cN:"header",b:"Index: ",e:"$"},{cN:"header",b:"=====",e:"=====$"},{cN:"header",b:"^\\-\\-\\-",e:"$"},{cN:"header",b:"^\\*{3} ",e:"$"},{cN:"header",b:"^\\+\\+\\+",e:"$"},{cN:"header",b:"\\*{5}",e:"\\*{5}$"},{cN:"addition",b:"^\\+",e:"$"},{cN:"deletion",b:"^\\-",e:"$"},{cN:"change",b:"^\\!",e:"$"}]};hljs.XML_COMMENT={cN:"comment",b:""};hljs.XML_ATTR={cN:"attribute",b:"\\s[a-zA-Z\\:-]+=",e:"^",c:["value"]};hljs.XML_VALUE_QUOT={cN:"value",b:'"',e:'"'};hljs.XML_VALUE_APOS={cN:"value",b:"'",e:"'"};hljs.LANGUAGES.xml={dM:{c:["pi","comment","cdata","tag"]},cI:true,m:[{cN:"pi",b:"<\\?",e:"\\?>",r:10},hljs.XML_COMMENT,{cN:"cdata",b:"<\\!\\[CDATA\\[",e:"\\]\\]>"},{cN:"tag",b:"",c:["title","tag_internal"],r:1.5},{cN:"title",b:"[A-Za-z:_][A-Za-z0-9\\._:-]+",e:"^",r:0},{cN:"tag_internal",b:"^",eW:true,nM:true,c:["attribute"],r:0,i:"[\\+\\.]"},hljs.XML_ATTR,hljs.XML_VALUE_QUOT,hljs.XML_VALUE_APOS]};hljs.HTML_TAGS={code:1,kbd:1,font:1,noscript:1,style:1,img:1,title:1,menu:1,tt:1,tr:1,param:1,li:1,tfoot:1,th:1,input:1,td:1,dl:1,blockquote:1,fieldset:1,big:1,dd:1,abbr:1,optgroup:1,dt:1,button:1,isindex:1,p:1,small:1,div:1,dir:1,em:1,frame:1,meta:1,sub:1,bdo:1,label:1,acronym:1,sup:1,body:1,xml:1,basefont:1,base:1,br:1,address:1,strong:1,legend:1,ol:1,script:1,caption:1,s:1,col:1,h2:1,h3:1,h1:1,h6:1,h4:1,h5:1,table:1,select:1,noframes:1,span:1,area:1,dfn:1,strike:1,cite:1,thead:1,head:1,option:1,form:1,hr:1,"var":1,link:1,b:1,colgroup:1,ul:1,applet:1,del:1,iframe:1,pre:1,frameset:1,ins:1,tbody:1,html:1,samp:1,map:1,object:1,a:1,xmlns:1,center:1,textarea:1,i:1,q:1,u:1};hljs.HTML_DOCTYPE={cN:"doctype",b:"",r:10};hljs.HTML_ATTR={cN:"attribute",b:"\\s[a-zA-Z\\:-]+=",e:"^",c:["value"]};hljs.HTML_SHORT_ATTR={cN:"attribute",b:" [a-zA-Z]+",e:"^"};hljs.HTML_VALUE={cN:"value",b:"[a-zA-Z0-9]+",e:"^"};hljs.LANGUAGES.html={dM:{c:["tag","comment","doctype","vbscript"]},cI:true,m:[hljs.XML_COMMENT,hljs.HTML_DOCTYPE,{cN:"tag",l:[hljs.IR],k:hljs.HTML_TAGS,b:"",c:["attribute"],i:"[\\+\\.]",starts:"css"},{cN:"tag",l:[hljs.IR],k:hljs.HTML_TAGS,b:"",c:["attribute"],i:"[\\+\\.]",starts:"javascript"},{cN:"tag",l:[hljs.IR],k:hljs.HTML_TAGS,b:"<[A-Za-z/]",e:">",c:["attribute"],i:"[\\+\\.]"},{cN:"css",e:"",rE:true,subLanguage:"css"},{cN:"javascript",e:"<\/script>",rE:true,subLanguage:"javascript"},hljs.HTML_ATTR,hljs.HTML_SHORT_ATTR,hljs.XML_VALUE_QUOT,hljs.XML_VALUE_APOS,hljs.HTML_VALUE,{cN:"vbscript",b:"<%",e:"%>",subLanguage:"vbscript"}]};hljs.LANGUAGES.css={dM:{c:["at_rule","id","class","attr_selector","pseudo","rules","comment"],k:hljs.HTML_TAGS,l:[hljs.IR],i:"="},cI:true,m:[{cN:"at_rule",b:"@",e:"[{;]",eE:true,l:[hljs.IR],k:{"import":1,page:1,media:1,charset:1,"font-face":1},c:["function","string","number","pseudo"]},{cN:"id",b:"\\#[A-Za-z0-9_-]+",e:"^"},{cN:"class",b:"\\.[A-Za-z0-9_-]+",e:"^",r:0},{cN:"attr_selector",b:"\\[",e:"\\]",i:"$"},{cN:"pseudo",b:":(:)?[a-zA-Z0-9\\_\\-\\+\\(\\)\\\"\\']+",e:"^"},{cN:"rules",b:"{",e:"}",c:["rule","comment"],i:"[^\\s]"},{cN:"rule",b:"[A-Z\\_\\.\\-]+\\s*:",e:";",eW:true,l:["[A-Za-z-]+"],k:{"play-during":1,"counter-reset":1,"counter-increment":1,"min-height":1,quotes:1,"border-top":1,pitch:1,font:1,pause:1,"list-style-image":1,"border-width":1,cue:1,"outline-width":1,"border-left":1,elevation:1,richness:1,"speech-rate":1,"border-bottom":1,"border-spacing":1,background:1,"list-style-type":1,"text-align":1,"page-break-inside":1,orphans:1,"page-break-before":1,"text-transform":1,"line-height":1,"padding-left":1,"font-size":1,right:1,"word-spacing":1,"padding-top":1,"outline-style":1,bottom:1,content:1,"border-right-style":1,"padding-right":1,"border-left-style":1,"voice-family":1,"background-color":1,"border-bottom-color":1,"outline-color":1,"unicode-bidi":1,"max-width":1,"font-family":1,"caption-side":1,"border-right-width":1,"pause-before":1,"border-top-style":1,color:1,"border-collapse":1,"border-bottom-width":1,"float":1,height:1,"max-height":1,"margin-right":1,"border-top-width":1,speak:1,"speak-header":1,top:1,"cue-before":1,"min-width":1,width:1,"font-variant":1,"border-top-color":1,"background-position":1,"empty-cells":1,direction:1,"border-right":1,visibility:1,padding:1,"border-style":1,"background-attachment":1,overflow:1,"border-bottom-style":1,cursor:1,margin:1,display:1,"border-left-width":1,"letter-spacing":1,"vertical-align":1,clip:1,"border-color":1,"list-style":1,"padding-bottom":1,"pause-after":1,"speak-numeral":1,"margin-left":1,widows:1,border:1,"font-style":1,"border-left-color":1,"pitch-range":1,"background-repeat":1,"table-layout":1,"margin-bottom":1,"speak-punctuation":1,"font-weight":1,"border-right-color":1,"page-break-after":1,position:1,"white-space":1,"text-indent":1,"background-image":1,volume:1,stress:1,outline:1,clear:1,"z-index":1,"text-decoration":1,"margin-top":1,azimuth:1,"cue-after":1,left:1,"list-style-position":1},c:["value"]},hljs.CBLCLM,{cN:"value",b:"^",eW:true,eE:true,c:["function","number","hexcolor","string"]},{cN:"number",b:hljs.NR,e:"^"},{cN:"hexcolor",b:"\\#[0-9A-F]+",e:"^"},{cN:"function",b:hljs.IR+"\\(",e:"\\)",c:["params"]},{cN:"params",b:"^",eW:true,eE:true,c:["number","string"]},hljs.ASM,hljs.QSM]};hljs.LANGUAGES.ini={cI:true,dM:{c:["comment","title","setting"],i:"[^\\s]"},m:[{cN:"comment",b:";",e:"$"},{cN:"title",b:"\\[",e:"\\]"},{cN:"setting",b:"^[a-z0-9_\\[\\]]+[ \\t]*=[ \\t]*",e:"$",c:["value"]},{cN:"value",b:"^",eW:true,c:["string","number"],l:[hljs.IR],k:{on:1,off:1,"true":1,"false":1,yes:1,no:1}},hljs.QSM,hljs.BE,{cN:"number",b:"\\d+",e:"^"}]};hljs.LANGUAGES.javascript={dM:{l:[hljs.UIR],c:["string","comment","number","regexp_container","function"],k:{keyword:{"in":1,"if":1,"for":1,"while":1,"finally":1,"var":1,"new":1,"function":1,"do":1,"return":1,"void":1,"else":1,"break":1,"catch":1,"instanceof":1,"with":1,"throw":1,"case":1,"default":1,"try":1,"this":1,"switch":1,"continue":1,"typeof":1,"delete":1},literal:{"true":1,"false":1,"null":1}}},m:[hljs.CLCM,hljs.CBLCLM,hljs.CNM,hljs.ASM,hljs.QSM,hljs.BE,{cN:"regexp_container",b:"("+hljs.RSR+"|case|return|throw)\\s*",e:"^",nM:true,l:[hljs.IR],k:{"return":1,"throw":1,"case":1},c:["comment","regexp"],r:0},{cN:"regexp",b:"/.*?[^\\\\/]/[gim]*",e:"^"},{cN:"function",b:"\\bfunction\\b",e:"{",l:[hljs.UIR],k:{"function":1},c:["title","params"]},{cN:"title",b:"[A-Za-z$_][0-9A-Za-z$_]*",e:"^"},{cN:"params",b:"\\(",e:"\\)",c:["string","comment"]}]};hljs.LANGUAGES.ruby=function(){var a="[a-zA-Z_][a-zA-Z0-9_]*(\\!|\\?)?";var b=["comment","string","char","class","function","module_name","symbol","number","variable","regexp_container"];var c={keyword:{and:1,"false":1,then:1,defined:1,module:1,"in":1,"return":1,redo:1,"if":1,BEGIN:1,retry:1,end:1,"for":1,"true":1,self:1,when:1,next:1,until:1,"do":1,begin:1,unless:1,END:1,rescue:1,nil:1,"else":1,"break":1,undef:1,not:1,"super":1,"class":1,"case":1,require:1,yield:1,alias:1,"while":1,ensure:1,elsif:1,or:1,def:1},keymethods:{__id__:1,__send__:1,abort:1,abs:1,"all?":1,allocate:1,ancestors:1,"any?":1,arity:1,assoc:1,at:1,at_exit:1,autoload:1,"autoload?":1,"between?":1,binding:1,binmode:1,"block_given?":1,call:1,callcc:1,caller:1,capitalize:1,"capitalize!":1,casecmp:1,"catch":1,ceil:1,center:1,chomp:1,"chomp!":1,chop:1,"chop!":1,chr:1,"class":1,class_eval:1,"class_variable_defined?":1,class_variables:1,clear:1,clone:1,close:1,close_read:1,close_write:1,"closed?":1,coerce:1,collect:1,"collect!":1,compact:1,"compact!":1,concat:1,"const_defined?":1,const_get:1,const_missing:1,const_set:1,constants:1,count:1,crypt:1,"default":1,default_proc:1,"delete":1,"delete!":1,delete_at:1,delete_if:1,detect:1,display:1,div:1,divmod:1,downcase:1,"downcase!":1,downto:1,dump:1,dup:1,each:1,each_byte:1,each_index:1,each_key:1,each_line:1,each_pair:1,each_value:1,each_with_index:1,"empty?":1,entries:1,eof:1,"eof?":1,"eql?":1,"equal?":1,"eval":1,exec:1,exit:1,"exit!":1,extend:1,fail:1,fcntl:1,fetch:1,fileno:1,fill:1,find:1,find_all:1,first:1,flatten:1,"flatten!":1,floor:1,flush:1,for_fd:1,foreach:1,fork:1,format:1,freeze:1,"frozen?":1,fsync:1,getc:1,gets:1,global_variables:1,grep:1,gsub:1,"gsub!":1,"has_key?":1,"has_value?":1,hash:1,hex:1,id:1,"include?":1,included_modules:1,index:1,indexes:1,indices:1,induced_from:1,inject:1,insert:1,inspect:1,instance_eval:1,instance_method:1,instance_methods:1,"instance_of?":1,"instance_variable_defined?":1,instance_variable_get:1,instance_variable_set:1,instance_variables:1,"integer?":1,intern:1,invert:1,ioctl:1,"is_a?":1,isatty:1,"iterator?":1,join:1,"key?":1,keys:1,"kind_of?":1,lambda:1,last:1,length:1,lineno:1,ljust:1,load:1,local_variables:1,loop:1,lstrip:1,"lstrip!":1,map:1,"map!":1,match:1,max:1,"member?":1,merge:1,"merge!":1,method:1,"method_defined?":1,method_missing:1,methods:1,min:1,module_eval:1,modulo:1,name:1,nesting:1,"new":1,next:1,"next!":1,"nil?":1,nitems:1,"nonzero?":1,object_id:1,oct:1,open:1,pack:1,partition:1,pid:1,pipe:1,pop:1,popen:1,pos:1,prec:1,prec_f:1,prec_i:1,print:1,printf:1,private_class_method:1,private_instance_methods:1,"private_method_defined?":1,private_methods:1,proc:1,protected_instance_methods:1,"protected_method_defined?":1,protected_methods:1,public_class_method:1,public_instance_methods:1,"public_method_defined?":1,public_methods:1,push:1,putc:1,puts:1,quo:1,raise:1,rand:1,rassoc:1,read:1,read_nonblock:1,readchar:1,readline:1,readlines:1,readpartial:1,rehash:1,reject:1,"reject!":1,remainder:1,reopen:1,replace:1,require:1,"respond_to?":1,reverse:1,"reverse!":1,reverse_each:1,rewind:1,rindex:1,rjust:1,round:1,rstrip:1,"rstrip!":1,scan:1,seek:1,select:1,send:1,set_trace_func:1,shift:1,singleton_method_added:1,singleton_methods:1,size:1,sleep:1,slice:1,"slice!":1,sort:1,"sort!":1,sort_by:1,split:1,sprintf:1,squeeze:1,"squeeze!":1,srand:1,stat:1,step:1,store:1,strip:1,"strip!":1,sub:1,"sub!":1,succ:1,"succ!":1,sum:1,superclass:1,swapcase:1,"swapcase!":1,sync:1,syscall:1,sysopen:1,sysread:1,sysseek:1,system:1,syswrite:1,taint:1,"tainted?":1,tell:1,test:1,"throw":1,times:1,to_a:1,to_ary:1,to_f:1,to_hash:1,to_i:1,to_int:1,to_io:1,to_proc:1,to_s:1,to_str:1,to_sym:1,tr:1,"tr!":1,tr_s:1,"tr_s!":1,trace_var:1,transpose:1,trap:1,truncate:1,"tty?":1,type:1,ungetc:1,uniq:1,"uniq!":1,unpack:1,unshift:1,untaint:1,untrace_var:1,upcase:1,"upcase!":1,update:1,upto:1,"value?":1,values:1,values_at:1,warn:1,write:1,write_nonblock:1,"zero?":1,zip:1}};return{dM:{l:[a],c:b,k:c},m:[hljs.HCM,{cN:"comment",b:"^\\=begin",e:"^\\=end",r:10},{cN:"comment",b:"^__END__",e:"\\n$"},{cN:"params",b:"\\(",e:"\\)",l:[a],k:c,c:b},{cN:"function",b:"\\bdef\\b",e:"$|;",l:[a],k:c,c:["title","params","comment"]},{cN:"class",b:"\\b(class|module)\\b",e:"$",l:[hljs.UIR],k:c,c:["title","inheritance","comment"],k:{"class":1,module:1}},{cN:"title",b:"[A-Za-z_]\\w*(::\\w+)*(\\?|\\!)?",e:"^",r:0},{cN:"inheritance",b:"<\\s*",e:"^",c:["parent"]},{cN:"parent",b:"("+hljs.IR+"::)?"+hljs.IR,e:"^"},{cN:"number",b:"(\\b0[0-7_]+)|(\\b0x[0-9a-fA-F_]+)|(\\b[1-9][0-9_]*(\\.[0-9_]+)?)|[0_]\\b",e:"^",r:0},{cN:"number",b:"\\?\\w",e:"^"},{cN:"string",b:"'",e:"'",c:["escape","subst"],r:0},{cN:"string",b:'"',e:'"',c:["escape","subst"],r:0},{cN:"string",b:"%[qw]?\\(",e:"\\)",c:["escape","subst"],r:10},{cN:"string",b:"%[qw]?\\[",e:"\\]",c:["escape","subst"],r:10},{cN:"string",b:"%[qw]?{",e:"}",c:["escape","subst"],r:10},{cN:"string",b:"%[qw]?<",e:">",c:["escape","subst"],r:10},{cN:"string",b:"%[qw]?/",e:"/",c:["escape","subst"],r:10},{cN:"string",b:"%[qw]?%",e:"%",c:["escape","subst"],r:10},{cN:"string",b:"%[qw]?-",e:"-",c:["escape","subst"],r:10},{cN:"string",b:"%[qw]?\\|",e:"\\|",c:["escape","subst"],r:10},{cN:"module_name",b:":{2}"+a,e:"^",nM:true},{cN:"symbol",b:":"+a,e:"^"},{cN:"symbol",b:":",e:"^",c:["string"]},hljs.BE,{cN:"subst",b:"#\\{",e:"}",l:[a],k:c,c:b},{cN:"regexp_container",b:"("+hljs.RSR+")\\s*",e:"^",nM:true,c:["comment","regexp"],r:0},{cN:"regexp",b:"/",e:"/[a-z]*",i:"\\n",c:["escape"]},{cN:"variable",b:"(\\$\\W)|((\\$|\\@\\@?)(\\w+))",e:"^"}]}}();hljs.LANGUAGES.sql={cI:true,dM:{l:[hljs.IR],c:["string","number","comment"],k:{keyword:{all:1,partial:1,global:1,month:1,current_timestamp:1,using:1,go:1,revoke:1,smallint:1,indicator:1,"end-exec":1,disconnect:1,zone:1,"with":1,character:1,assertion:1,to:1,add:1,current_user:1,usage:1,input:1,local:1,alter:1,match:1,collate:1,real:1,then:1,rollback:1,get:1,read:1,timestamp:1,session_user:1,not:1,integer:1,bit:1,unique:1,day:1,minute:1,desc:1,insert:1,execute:1,like:1,ilike:2,level:1,decimal:1,drop:1,"continue":1,isolation:1,found:1,where:1,constraints:1,domain:1,right:1,national:1,some:1,module:1,transaction:1,relative:1,second:1,connect:1,escape:1,close:1,system_user:1,"for":1,deferred:1,section:1,cast:1,current:1,sqlstate:1,allocate:1,intersect:1,deallocate:1,numeric:1,"public":1,preserve:1,full:1,"goto":1,initially:1,asc:1,no:1,key:1,output:1,collation:1,group:1,by:1,union:1,session:1,both:1,last:1,language:1,constraint:1,column:1,of:1,space:1,foreign:1,deferrable:1,prior:1,connection:1,unknown:1,action:1,commit:1,view:1,or:1,first:1,into:1,"float":1,year:1,primary:1,cascaded:1,except:1,restrict:1,set:1,references:1,names:1,table:1,outer:1,open:1,select:1,size:1,are:1,rows:1,from:1,prepare:1,distinct:1,leading:1,create:1,only:1,next:1,inner:1,authorization:1,schema:1,corresponding:1,option:1,declare:1,precision:1,immediate:1,"else":1,timezone_minute:1,external:1,varying:1,translation:1,"true":1,"case":1,exception:1,join:1,hour:1,"default":1,"double":1,scroll:1,value:1,cursor:1,descriptor:1,values:1,dec:1,fetch:1,procedure:1,"delete":1,and:1,"false":1,"int":1,is:1,describe:1,"char":1,as:1,at:1,"in":1,varchar:1,"null":1,trailing:1,any:1,absolute:1,current_time:1,end:1,grant:1,privileges:1,when:1,cross:1,check:1,write:1,current_date:1,pad:1,begin:1,temporary:1,exec:1,time:1,update:1,catalog:1,user:1,sql:1,date:1,on:1,identity:1,timezone_hour:1,natural:1,whenever:1,interval:1,work:1,order:1,cascade:1,diagnostics:1,nchar:1,having:1,left:1},aggregate:{count:1,sum:1,min:1,max:1,avg:1}}},m:[hljs.CNM,hljs.CBLCLM,{cN:"comment",b:"--",e:"$"},{cN:"string",b:"'",e:"'",c:["escape","squote"],r:0},{cN:"squote",b:"''",e:"^",nM:true},{cN:"string",b:'"',e:'"',c:["escape","dquote"],r:0},{cN:"dquote",b:'""',e:"^",nM:true},{cN:"string",b:"`",e:"`",c:["escape"]},hljs.BE]};hljs.LANGUAGES.java={dM:{l:[hljs.UIR],c:["javadoc","comment","string","class","number","annotation"],k:{"false":1,"synchronized":1,"int":1,"abstract":1,"float":1,"private":1,"char":1,"interface":1,"boolean":1,"static":1,"null":1,"if":1,"const":1,"for":1,"true":1,"while":1,"long":1,"throw":1,strictfp:1,"finally":1,"protected":1,"extends":1,"import":1,"native":1,"final":1,"implements":1,"return":1,"void":1,"enum":1,"else":1,"break":1,"transient":1,"new":1,"catch":1,"instanceof":1,"byte":1,"super":1,"class":1,"volatile":1,"case":1,assert:1,"short":1,"package":1,"default":1,"double":1,"public":1,"try":1,"this":1,"switch":1,"continue":1,"throws":1}},m:[{cN:"class",l:[hljs.UIR],b:"(class |interface )",e:"{",i:":",k:{"class":1,"interface":1},c:["inheritance","title"]},{cN:"inheritance",b:"(implements|extends)",e:"^",nM:true,l:[hljs.IR],k:{"extends":1,"implements":1},r:10},{cN:"title",b:hljs.UIR,e:"^"},{cN:"params",b:"\\(",e:"\\)",c:["string","annotation"]},hljs.CNM,hljs.ASM,hljs.QSM,hljs.BE,hljs.CLCM,{cN:"javadoc",b:"/\\*\\*",e:"\\*/",c:["javadoctag"],r:10},{cN:"javadoctag",b:"@[A-Za-z]+",e:"^"},hljs.CBLCLM,{cN:"annotation",b:"@[A-Za-z]+",e:"^"}]};hljs.LANGUAGES.bash=function(){var a={"true":1,"false":1};return{dM:{l:[hljs.IR],c:["string","shebang","comment","number","test_condition","string","variable"],k:{keyword:{"if":1,then:1,"else":1,fi:1,"for":1,"break":1,"continue":1,"while":1,"in":1,"do":1,done:1,echo:1,exit:1,"return":1,set:1,declare:1},literal:a}},cI:false,m:[{cN:"shebang",b:"(#!\\/bin\\/bash)|(#!\\/bin\\/sh)",e:"^",r:10},hljs.HCM,{cN:"test_condition",b:"\\[ ",e:" \\]",c:["string","variable","number"],l:[hljs.IR],k:{literal:a},r:0},{cN:"test_condition",b:"\\[\\[ ",e:" \\]\\]",c:["string","variable","number"],l:[hljs.IR],k:{literal:a}},{cN:"variable",b:"\\$([a-zA-Z0-9_]+)\\b",e:"^"},{cN:"variable",b:"\\$\\{(([^}])|(\\\\}))+\\}",e:"^",c:["number"]},{cN:"string",b:'"',e:'"',i:"\\n",c:["escape","variable"],r:0},{cN:"string",b:'"',e:'"',i:"\\n",c:["escape","variable"],r:0},hljs.BE,hljs.CNM,{cN:"comment",b:"\\/\\/",e:"$",i:"."}]}}(); \ No newline at end of file diff --git a/rdoc/js/jquery.js b/rdoc/js/jquery.js new file mode 100644 index 0000000..afe9e74 --- /dev/null +++ b/rdoc/js/jquery.js @@ -0,0 +1,32 @@ +/* + * jQuery 1.2.6 - New Wave Javascript + * + * Copyright (c) 2008 John Resig (jquery.com) + * Dual licensed under the MIT (MIT-LICENSE.txt) + * and GPL (GPL-LICENSE.txt) licenses. + * + * $Date: 2008-09-25 09:50:52 -0700 (Thu, 25 Sep 2008) $ + * $Rev: 38 $ + */ +(function(){var _jQuery=window.jQuery,_$=window.$;var jQuery=window.jQuery=window.$=function(selector,context){return new jQuery.fn.init(selector,context);};var quickExpr=/^[^<]*(<(.|\s)+>)[^>]*$|^#(\w+)$/,isSimple=/^.[^:#\[\.]*$/,undefined;jQuery.fn=jQuery.prototype={init:function(selector,context){selector=selector||document;if(selector.nodeType){this[0]=selector;this.length=1;return this;}if(typeof selector=="string"){var match=quickExpr.exec(selector);if(match&&(match[1]||!context)){if(match[1])selector=jQuery.clean([match[1]],context);else{var elem=document.getElementById(match[3]);if(elem){if(elem.id!=match[3])return jQuery().find(selector);return jQuery(elem);}selector=[];}}else +return jQuery(context).find(selector);}else if(jQuery.isFunction(selector))return jQuery(document)[jQuery.fn.ready?"ready":"load"](selector);return this.setArray(jQuery.makeArray(selector));},jquery:"1.2.6",size:function(){return this.length;},length:0,get:function(num){return num==undefined?jQuery.makeArray(this):this[num];},pushStack:function(elems){var ret=jQuery(elems);ret.prevObject=this;return ret;},setArray:function(elems){this.length=0;Array.prototype.push.apply(this,elems);return this;},each:function(callback,args){return jQuery.each(this,callback,args);},index:function(elem){var ret=-1;return jQuery.inArray(elem&&elem.jquery?elem[0]:elem,this);},attr:function(name,value,type){var options=name;if(name.constructor==String)if(value===undefined)return this[0]&&jQuery[type||"attr"](this[0],name);else{options={};options[name]=value;}return this.each(function(i){for(name in options)jQuery.attr(type?this.style:this,name,jQuery.prop(this,options[name],type,i,name));});},css:function(key,value){if((key=='width'||key=='height')&&parseFloat(value)<0)value=undefined;return this.attr(key,value,"curCSS");},text:function(text){if(typeof text!="object"&&text!=null)return this.empty().append((this[0]&&this[0].ownerDocument||document).createTextNode(text));var ret="";jQuery.each(text||this,function(){jQuery.each(this.childNodes,function(){if(this.nodeType!=8)ret+=this.nodeType!=1?this.nodeValue:jQuery.fn.text([this]);});});return ret;},wrapAll:function(html){if(this[0])jQuery(html,this[0].ownerDocument).clone().insertBefore(this[0]).map(function(){var elem=this;while(elem.firstChild)elem=elem.firstChild;return elem;}).append(this);return this;},wrapInner:function(html){return this.each(function(){jQuery(this).contents().wrapAll(html);});},wrap:function(html){return this.each(function(){jQuery(this).wrapAll(html);});},append:function(){return this.domManip(arguments,true,false,function(elem){if(this.nodeType==1)this.appendChild(elem);});},prepend:function(){return this.domManip(arguments,true,true,function(elem){if(this.nodeType==1)this.insertBefore(elem,this.firstChild);});},before:function(){return this.domManip(arguments,false,false,function(elem){this.parentNode.insertBefore(elem,this);});},after:function(){return this.domManip(arguments,false,true,function(elem){this.parentNode.insertBefore(elem,this.nextSibling);});},end:function(){return this.prevObject||jQuery([]);},find:function(selector){var elems=jQuery.map(this,function(elem){return jQuery.find(selector,elem);});return this.pushStack(/[^+>] [^+>]/.test(selector)||selector.indexOf("..")>-1?jQuery.unique(elems):elems);},clone:function(events){var ret=this.map(function(){if(jQuery.browser.msie&&!jQuery.isXMLDoc(this)){var clone=this.cloneNode(true),container=document.createElement("div");container.appendChild(clone);return jQuery.clean([container.innerHTML])[0];}else +return this.cloneNode(true);});var clone=ret.find("*").andSelf().each(function(){if(this[expando]!=undefined)this[expando]=null;});if(events===true)this.find("*").andSelf().each(function(i){if(this.nodeType==3)return;var events=jQuery.data(this,"events");for(var type in events)for(var handler in events[type])jQuery.event.add(clone[i],type,events[type][handler],events[type][handler].data);});return ret;},filter:function(selector){return this.pushStack(jQuery.isFunction(selector)&&jQuery.grep(this,function(elem,i){return selector.call(elem,i);})||jQuery.multiFilter(selector,this));},not:function(selector){if(selector.constructor==String)if(isSimple.test(selector))return this.pushStack(jQuery.multiFilter(selector,this,true));else +selector=jQuery.multiFilter(selector,this);var isArrayLike=selector.length&&selector[selector.length-1]!==undefined&&!selector.nodeType;return this.filter(function(){return isArrayLike?jQuery.inArray(this,selector)<0:this!=selector;});},add:function(selector){return this.pushStack(jQuery.unique(jQuery.merge(this.get(),typeof selector=='string'?jQuery(selector):jQuery.makeArray(selector))));},is:function(selector){return!!selector&&jQuery.multiFilter(selector,this).length>0;},hasClass:function(selector){return this.is("."+selector);},val:function(value){if(value==undefined){if(this.length){var elem=this[0];if(jQuery.nodeName(elem,"select")){var index=elem.selectedIndex,values=[],options=elem.options,one=elem.type=="select-one";if(index<0)return null;for(var i=one?index:0,max=one?index+1:options.length;i=0||jQuery.inArray(this.name,value)>=0);else if(jQuery.nodeName(this,"select")){var values=jQuery.makeArray(value);jQuery("option",this).each(function(){this.selected=(jQuery.inArray(this.value,values)>=0||jQuery.inArray(this.text,values)>=0);});if(!values.length)this.selectedIndex=-1;}else +this.value=value;});},html:function(value){return value==undefined?(this[0]?this[0].innerHTML:null):this.empty().append(value);},replaceWith:function(value){return this.after(value).remove();},eq:function(i){return this.slice(i,i+1);},slice:function(){return this.pushStack(Array.prototype.slice.apply(this,arguments));},map:function(callback){return this.pushStack(jQuery.map(this,function(elem,i){return callback.call(elem,i,elem);}));},andSelf:function(){return this.add(this.prevObject);},data:function(key,value){var parts=key.split(".");parts[1]=parts[1]?"."+parts[1]:"";if(value===undefined){var data=this.triggerHandler("getData"+parts[1]+"!",[parts[0]]);if(data===undefined&&this.length)data=jQuery.data(this[0],key);return data===undefined&&parts[1]?this.data(parts[0]):data;}else +return this.trigger("setData"+parts[1]+"!",[parts[0],value]).each(function(){jQuery.data(this,key,value);});},removeData:function(key){return this.each(function(){jQuery.removeData(this,key);});},domManip:function(args,table,reverse,callback){var clone=this.length>1,elems;return this.each(function(){if(!elems){elems=jQuery.clean(args,this.ownerDocument);if(reverse)elems.reverse();}var obj=this;if(table&&jQuery.nodeName(this,"table")&&jQuery.nodeName(elems[0],"tr"))obj=this.getElementsByTagName("tbody")[0]||this.appendChild(this.ownerDocument.createElement("tbody"));var scripts=jQuery([]);jQuery.each(elems,function(){var elem=clone?jQuery(this).clone(true)[0]:this;if(jQuery.nodeName(elem,"script"))scripts=scripts.add(elem);else{if(elem.nodeType==1)scripts=scripts.add(jQuery("script",elem).remove());callback.call(obj,elem);}});scripts.each(evalScript);});}};jQuery.fn.init.prototype=jQuery.fn;function evalScript(i,elem){if(elem.src)jQuery.ajax({url:elem.src,async:false,dataType:"script"});else +jQuery.globalEval(elem.text||elem.textContent||elem.innerHTML||"");if(elem.parentNode)elem.parentNode.removeChild(elem);}function now(){return+new Date;}jQuery.extend=jQuery.fn.extend=function(){var target=arguments[0]||{},i=1,length=arguments.length,deep=false,options;if(target.constructor==Boolean){deep=target;target=arguments[1]||{};i=2;}if(typeof target!="object"&&typeof target!="function")target={};if(length==i){target=this;--i;}for(;i-1;}},swap:function(elem,options,callback){var old={};for(var name in options){old[name]=elem.style[name];elem.style[name]=options[name];}callback.call(elem);for(var name in options)elem.style[name]=old[name];},css:function(elem,name,force){if(name=="width"||name=="height"){var val,props={position:"absolute",visibility:"hidden",display:"block"},which=name=="width"?["Left","Right"]:["Top","Bottom"];function getWH(){val=name=="width"?elem.offsetWidth:elem.offsetHeight;var padding=0,border=0;jQuery.each(which,function(){padding+=parseFloat(jQuery.curCSS(elem,"padding"+this,true))||0;border+=parseFloat(jQuery.curCSS(elem,"border"+this+"Width",true))||0;});val-=Math.round(padding+border);}if(jQuery(elem).is(":visible"))getWH();else +jQuery.swap(elem,props,getWH);return Math.max(0,val);}return jQuery.curCSS(elem,name,force);},curCSS:function(elem,name,force){var ret,style=elem.style;function color(elem){if(!jQuery.browser.safari)return false;var ret=defaultView.getComputedStyle(elem,null);return!ret||ret.getPropertyValue("color")=="";}if(name=="opacity"&&jQuery.browser.msie){ret=jQuery.attr(style,"opacity");return ret==""?"1":ret;}if(jQuery.browser.opera&&name=="display"){var save=style.outline;style.outline="0 solid black";style.outline=save;}if(name.match(/float/i))name=styleFloat;if(!force&&style&&style[name])ret=style[name];else if(defaultView.getComputedStyle){if(name.match(/float/i))name="float";name=name.replace(/([A-Z])/g,"-$1").toLowerCase();var computedStyle=defaultView.getComputedStyle(elem,null);if(computedStyle&&!color(elem))ret=computedStyle.getPropertyValue(name);else{var swap=[],stack=[],a=elem,i=0;for(;a&&color(a);a=a.parentNode)stack.unshift(a);for(;i]*?)\/>/g,function(all,front,tag){return tag.match(/^(abbr|br|col|img|input|link|meta|param|hr|area|embed)$/i)?all:front+">";});var tags=jQuery.trim(elem).toLowerCase(),div=context.createElement("div");var wrap=!tags.indexOf("",""]||!tags.indexOf("",""]||tags.match(/^<(thead|tbody|tfoot|colg|cap)/)&&[1,"","
"]||!tags.indexOf("",""]||(!tags.indexOf("",""]||!tags.indexOf("",""]||jQuery.browser.msie&&[1,"div
","
"]||[0,"",""];div.innerHTML=wrap[1]+elem+wrap[2];while(wrap[0]--)div=div.lastChild;if(jQuery.browser.msie){var tbody=!tags.indexOf(""&&tags.indexOf("=0;--j)if(jQuery.nodeName(tbody[j],"tbody")&&!tbody[j].childNodes.length)tbody[j].parentNode.removeChild(tbody[j]);if(/^\s/.test(elem))div.insertBefore(context.createTextNode(elem.match(/^\s*/)[0]),div.firstChild);}elem=jQuery.makeArray(div.childNodes);}if(elem.length===0&&(!jQuery.nodeName(elem,"form")&&!jQuery.nodeName(elem,"select")))return;if(elem[0]==undefined||jQuery.nodeName(elem,"form")||elem.options)ret.push(elem);else +ret=jQuery.merge(ret,elem);});return ret;},attr:function(elem,name,value){if(!elem||elem.nodeType==3||elem.nodeType==8)return undefined;var notxml=!jQuery.isXMLDoc(elem),set=value!==undefined,msie=jQuery.browser.msie;name=notxml&&jQuery.props[name]||name;if(elem.tagName){var special=/href|src|style/.test(name);if(name=="selected"&&jQuery.browser.safari)elem.parentNode.selectedIndex;if(name in elem&¬xml&&!special){if(set){if(name=="type"&&jQuery.nodeName(elem,"input")&&elem.parentNode)throw"type property can't be changed";elem[name]=value;}if(jQuery.nodeName(elem,"form")&&elem.getAttributeNode(name))return elem.getAttributeNode(name).nodeValue;return elem[name];}if(msie&¬xml&&name=="style")return jQuery.attr(elem.style,"cssText",value);if(set)elem.setAttribute(name,""+value);var attr=msie&¬xml&&special?elem.getAttribute(name,2):elem.getAttribute(name);return attr===null?undefined:attr;}if(msie&&name=="opacity"){if(set){elem.zoom=1;elem.filter=(elem.filter||"").replace(/alpha\([^)]*\)/,"")+(parseInt(value)+''=="NaN"?"":"alpha(opacity="+value*100+")");}return elem.filter&&elem.filter.indexOf("opacity=")>=0?(parseFloat(elem.filter.match(/opacity=([^)]*)/)[1])/100)+'':"";}name=name.replace(/-([a-z])/ig,function(all,letter){return letter.toUpperCase();});if(set)elem[name]=value;return elem[name];},trim:function(text){return(text||"").replace(/^\s+|\s+$/g,"");},makeArray:function(array){var ret=[];if(array!=null){var i=array.length;if(i==null||array.split||array.setInterval||array.call)ret[0]=array;else +while(i)ret[--i]=array[i];}return ret;},inArray:function(elem,array){for(var i=0,length=array.length;i*",this).remove();while(this.firstChild)this.removeChild(this.firstChild);}},function(name,fn){jQuery.fn[name]=function(){return this.each(fn,arguments);};});jQuery.each(["Height","Width"],function(i,name){var type=name.toLowerCase();jQuery.fn[type]=function(size){return this[0]==window?jQuery.browser.opera&&document.body["client"+name]||jQuery.browser.safari&&window["inner"+name]||document.compatMode=="CSS1Compat"&&document.documentElement["client"+name]||document.body["client"+name]:this[0]==document?Math.max(Math.max(document.body["scroll"+name],document.documentElement["scroll"+name]),Math.max(document.body["offset"+name],document.documentElement["offset"+name])):size==undefined?(this.length?jQuery.css(this[0],type):null):this.css(type,size.constructor==String?size:size+"px");};});function num(elem,prop){return elem[0]&&parseInt(jQuery.curCSS(elem[0],prop,true),10)||0;}var chars=jQuery.browser.safari&&parseInt(jQuery.browser.version)<417?"(?:[\\w*_-]|\\\\.)":"(?:[\\w\u0128-\uFFFF*_-]|\\\\.)",quickChild=new RegExp("^>\\s*("+chars+"+)"),quickID=new RegExp("^("+chars+"+)(#)("+chars+"+)"),quickClass=new RegExp("^([#.]?)("+chars+"*)");jQuery.extend({expr:{"":function(a,i,m){return m[2]=="*"||jQuery.nodeName(a,m[2]);},"#":function(a,i,m){return a.getAttribute("id")==m[2];},":":{lt:function(a,i,m){return im[3]-0;},nth:function(a,i,m){return m[3]-0==i;},eq:function(a,i,m){return m[3]-0==i;},first:function(a,i){return i==0;},last:function(a,i,m,r){return i==r.length-1;},even:function(a,i){return i%2==0;},odd:function(a,i){return i%2;},"first-child":function(a){return a.parentNode.getElementsByTagName("*")[0]==a;},"last-child":function(a){return jQuery.nth(a.parentNode.lastChild,1,"previousSibling")==a;},"only-child":function(a){return!jQuery.nth(a.parentNode.lastChild,2,"previousSibling");},parent:function(a){return a.firstChild;},empty:function(a){return!a.firstChild;},contains:function(a,i,m){return(a.textContent||a.innerText||jQuery(a).text()||"").indexOf(m[3])>=0;},visible:function(a){return"hidden"!=a.type&&jQuery.css(a,"display")!="none"&&jQuery.css(a,"visibility")!="hidden";},hidden:function(a){return"hidden"==a.type||jQuery.css(a,"display")=="none"||jQuery.css(a,"visibility")=="hidden";},enabled:function(a){return!a.disabled;},disabled:function(a){return a.disabled;},checked:function(a){return a.checked;},selected:function(a){return a.selected||jQuery.attr(a,"selected");},text:function(a){return"text"==a.type;},radio:function(a){return"radio"==a.type;},checkbox:function(a){return"checkbox"==a.type;},file:function(a){return"file"==a.type;},password:function(a){return"password"==a.type;},submit:function(a){return"submit"==a.type;},image:function(a){return"image"==a.type;},reset:function(a){return"reset"==a.type;},button:function(a){return"button"==a.type||jQuery.nodeName(a,"button");},input:function(a){return/input|select|textarea|button/i.test(a.nodeName);},has:function(a,i,m){return jQuery.find(m[3],a).length;},header:function(a){return/h\d/i.test(a.nodeName);},animated:function(a){return jQuery.grep(jQuery.timers,function(fn){return a==fn.elem;}).length;}}},parse:[/^(\[) *@?([\w-]+) *([!*$^~=]*) *('?"?)(.*?)\4 *\]/,/^(:)([\w-]+)\("?'?(.*?(\(.*?\))?[^(]*?)"?'?\)/,new RegExp("^([:.#]*)("+chars+"+)")],multiFilter:function(expr,elems,not){var old,cur=[];while(expr&&expr!=old){old=expr;var f=jQuery.filter(expr,elems,not);expr=f.t.replace(/^\s*,\s*/,"");cur=not?elems=f.r:jQuery.merge(cur,f.r);}return cur;},find:function(t,context){if(typeof t!="string")return[t];if(context&&context.nodeType!=1&&context.nodeType!=9)return[];context=context||document;var ret=[context],done=[],last,nodeName;while(t&&last!=t){var r=[];last=t;t=jQuery.trim(t);var foundToken=false,re=quickChild,m=re.exec(t);if(m){nodeName=m[1].toUpperCase();for(var i=0;ret[i];i++)for(var c=ret[i].firstChild;c;c=c.nextSibling)if(c.nodeType==1&&(nodeName=="*"||c.nodeName.toUpperCase()==nodeName))r.push(c);ret=r;t=t.replace(re,"");if(t.indexOf(" ")==0)continue;foundToken=true;}else{re=/^([>+~])\s*(\w*)/i;if((m=re.exec(t))!=null){r=[];var merge={};nodeName=m[2].toUpperCase();m=m[1];for(var j=0,rl=ret.length;j=0;if(!not&&pass||not&&!pass)tmp.push(r[i]);}return tmp;},filter:function(t,r,not){var last;while(t&&t!=last){last=t;var p=jQuery.parse,m;for(var i=0;p[i];i++){m=p[i].exec(t);if(m){t=t.substring(m[0].length);m[2]=m[2].replace(/\\/g,"");break;}}if(!m)break;if(m[1]==":"&&m[2]=="not")r=isSimple.test(m[3])?jQuery.filter(m[3],r,true).r:jQuery(r).not(m[3]);else if(m[1]==".")r=jQuery.classFilter(r,m[2],not);else if(m[1]=="["){var tmp=[],type=m[3];for(var i=0,rl=r.length;i=0)^not)tmp.push(a);}r=tmp;}else if(m[1]==":"&&m[2]=="nth-child"){var merge={},tmp=[],test=/(-?)(\d*)n((?:\+|-)?\d*)/.exec(m[3]=="even"&&"2n"||m[3]=="odd"&&"2n+1"||!/\D/.test(m[3])&&"0n+"+m[3]||m[3]),first=(test[1]+(test[2]||1))-0,last=test[3]-0;for(var i=0,rl=r.length;i=0)add=true;if(add^not)tmp.push(node);}r=tmp;}else{var fn=jQuery.expr[m[1]];if(typeof fn=="object")fn=fn[m[2]];if(typeof fn=="string")fn=eval("false||function(a,i){return "+fn+";}");r=jQuery.grep(r,function(elem,i){return fn(elem,i,m,r);},not);}}return{r:r,t:t};},dir:function(elem,dir){var matched=[],cur=elem[dir];while(cur&&cur!=document){if(cur.nodeType==1)matched.push(cur);cur=cur[dir];}return matched;},nth:function(cur,result,dir,elem){result=result||1;var num=0;for(;cur;cur=cur[dir])if(cur.nodeType==1&&++num==result)break;return cur;},sibling:function(n,elem){var r=[];for(;n;n=n.nextSibling){if(n.nodeType==1&&n!=elem)r.push(n);}return r;}});jQuery.event={add:function(elem,types,handler,data){if(elem.nodeType==3||elem.nodeType==8)return;if(jQuery.browser.msie&&elem.setInterval)elem=window;if(!handler.guid)handler.guid=this.guid++;if(data!=undefined){var fn=handler;handler=this.proxy(fn,function(){return fn.apply(this,arguments);});handler.data=data;}var events=jQuery.data(elem,"events")||jQuery.data(elem,"events",{}),handle=jQuery.data(elem,"handle")||jQuery.data(elem,"handle",function(){if(typeof jQuery!="undefined"&&!jQuery.event.triggered)return jQuery.event.handle.apply(arguments.callee.elem,arguments);});handle.elem=elem;jQuery.each(types.split(/\s+/),function(index,type){var parts=type.split(".");type=parts[0];handler.type=parts[1];var handlers=events[type];if(!handlers){handlers=events[type]={};if(!jQuery.event.special[type]||jQuery.event.special[type].setup.call(elem)===false){if(elem.addEventListener)elem.addEventListener(type,handle,false);else if(elem.attachEvent)elem.attachEvent("on"+type,handle);}}handlers[handler.guid]=handler;jQuery.event.global[type]=true;});elem=null;},guid:1,global:{},remove:function(elem,types,handler){if(elem.nodeType==3||elem.nodeType==8)return;var events=jQuery.data(elem,"events"),ret,index;if(events){if(types==undefined||(typeof types=="string"&&types.charAt(0)=="."))for(var type in events)this.remove(elem,type+(types||""));else{if(types.type){handler=types.handler;types=types.type;}jQuery.each(types.split(/\s+/),function(index,type){var parts=type.split(".");type=parts[0];if(events[type]){if(handler)delete events[type][handler.guid];else +for(handler in events[type])if(!parts[1]||events[type][handler].type==parts[1])delete events[type][handler];for(ret in events[type])break;if(!ret){if(!jQuery.event.special[type]||jQuery.event.special[type].teardown.call(elem)===false){if(elem.removeEventListener)elem.removeEventListener(type,jQuery.data(elem,"handle"),false);else if(elem.detachEvent)elem.detachEvent("on"+type,jQuery.data(elem,"handle"));}ret=null;delete events[type];}}});}for(ret in events)break;if(!ret){var handle=jQuery.data(elem,"handle");if(handle)handle.elem=null;jQuery.removeData(elem,"events");jQuery.removeData(elem,"handle");}}},trigger:function(type,data,elem,donative,extra){data=jQuery.makeArray(data);if(type.indexOf("!")>=0){type=type.slice(0,-1);var exclusive=true;}if(!elem){if(this.global[type])jQuery("*").add([window,document]).trigger(type,data);}else{if(elem.nodeType==3||elem.nodeType==8)return undefined;var val,ret,fn=jQuery.isFunction(elem[type]||null),event=!data[0]||!data[0].preventDefault;if(event){data.unshift({type:type,target:elem,preventDefault:function(){},stopPropagation:function(){},timeStamp:now()});data[0][expando]=true;}data[0].type=type;if(exclusive)data[0].exclusive=true;var handle=jQuery.data(elem,"handle");if(handle)val=handle.apply(elem,data);if((!fn||(jQuery.nodeName(elem,'a')&&type=="click"))&&elem["on"+type]&&elem["on"+type].apply(elem,data)===false)val=false;if(event)data.shift();if(extra&&jQuery.isFunction(extra)){ret=extra.apply(elem,val==null?data:data.concat(val));if(ret!==undefined)val=ret;}if(fn&&donative!==false&&val!==false&&!(jQuery.nodeName(elem,'a')&&type=="click")){this.triggered=true;try{elem[type]();}catch(e){}}this.triggered=false;}return val;},handle:function(event){var val,ret,namespace,all,handlers;event=arguments[0]=jQuery.event.fix(event||window.event);namespace=event.type.split(".");event.type=namespace[0];namespace=namespace[1];all=!namespace&&!event.exclusive;handlers=(jQuery.data(this,"events")||{})[event.type];for(var j in handlers){var handler=handlers[j];if(all||handler.type==namespace){event.handler=handler;event.data=handler.data;ret=handler.apply(this,arguments);if(val!==false)val=ret;if(ret===false){event.preventDefault();event.stopPropagation();}}}return val;},fix:function(event){if(event[expando]==true)return event;var originalEvent=event;event={originalEvent:originalEvent};var props="altKey attrChange attrName bubbles button cancelable charCode clientX clientY ctrlKey currentTarget data detail eventPhase fromElement handler keyCode metaKey newValue originalTarget pageX pageY prevValue relatedNode relatedTarget screenX screenY shiftKey srcElement target timeStamp toElement type view wheelDelta which".split(" ");for(var i=props.length;i;i--)event[props[i]]=originalEvent[props[i]];event[expando]=true;event.preventDefault=function(){if(originalEvent.preventDefault)originalEvent.preventDefault();originalEvent.returnValue=false;};event.stopPropagation=function(){if(originalEvent.stopPropagation)originalEvent.stopPropagation();originalEvent.cancelBubble=true;};event.timeStamp=event.timeStamp||now();if(!event.target)event.target=event.srcElement||document;if(event.target.nodeType==3)event.target=event.target.parentNode;if(!event.relatedTarget&&event.fromElement)event.relatedTarget=event.fromElement==event.target?event.toElement:event.fromElement;if(event.pageX==null&&event.clientX!=null){var doc=document.documentElement,body=document.body;event.pageX=event.clientX+(doc&&doc.scrollLeft||body&&body.scrollLeft||0)-(doc.clientLeft||0);event.pageY=event.clientY+(doc&&doc.scrollTop||body&&body.scrollTop||0)-(doc.clientTop||0);}if(!event.which&&((event.charCode||event.charCode===0)?event.charCode:event.keyCode))event.which=event.charCode||event.keyCode;if(!event.metaKey&&event.ctrlKey)event.metaKey=event.ctrlKey;if(!event.which&&event.button)event.which=(event.button&1?1:(event.button&2?3:(event.button&4?2:0)));return event;},proxy:function(fn,proxy){proxy.guid=fn.guid=fn.guid||proxy.guid||this.guid++;return proxy;},special:{ready:{setup:function(){bindReady();return;},teardown:function(){return;}},mouseenter:{setup:function(){if(jQuery.browser.msie)return false;jQuery(this).bind("mouseover",jQuery.event.special.mouseenter.handler);return true;},teardown:function(){if(jQuery.browser.msie)return false;jQuery(this).unbind("mouseover",jQuery.event.special.mouseenter.handler);return true;},handler:function(event){if(withinElement(event,this))return true;event.type="mouseenter";return jQuery.event.handle.apply(this,arguments);}},mouseleave:{setup:function(){if(jQuery.browser.msie)return false;jQuery(this).bind("mouseout",jQuery.event.special.mouseleave.handler);return true;},teardown:function(){if(jQuery.browser.msie)return false;jQuery(this).unbind("mouseout",jQuery.event.special.mouseleave.handler);return true;},handler:function(event){if(withinElement(event,this))return true;event.type="mouseleave";return jQuery.event.handle.apply(this,arguments);}}}};jQuery.fn.extend({bind:function(type,data,fn){return type=="unload"?this.one(type,data,fn):this.each(function(){jQuery.event.add(this,type,fn||data,fn&&data);});},one:function(type,data,fn){var one=jQuery.event.proxy(fn||data,function(event){jQuery(this).unbind(event,one);return(fn||data).apply(this,arguments);});return this.each(function(){jQuery.event.add(this,type,one,fn&&data);});},unbind:function(type,fn){return this.each(function(){jQuery.event.remove(this,type,fn);});},trigger:function(type,data,fn){return this.each(function(){jQuery.event.trigger(type,data,this,true,fn);});},triggerHandler:function(type,data,fn){return this[0]&&jQuery.event.trigger(type,data,this[0],false,fn);},toggle:function(fn){var args=arguments,i=1;while(i=0){var selector=url.slice(off,url.length);url=url.slice(0,off);}callback=callback||function(){};var type="GET";if(params)if(jQuery.isFunction(params)){callback=params;params=null;}else{params=jQuery.param(params);type="POST";}var self=this;jQuery.ajax({url:url,type:type,dataType:"html",data:params,complete:function(res,status){if(status=="success"||status=="notmodified")self.html(selector?jQuery("
").append(res.responseText.replace(//g,"")).find(selector):res.responseText);self.each(callback,[res.responseText,status,res]);}});return this;},serialize:function(){return jQuery.param(this.serializeArray());},serializeArray:function(){return this.map(function(){return jQuery.nodeName(this,"form")?jQuery.makeArray(this.elements):this;}).filter(function(){return this.name&&!this.disabled&&(this.checked||/select|textarea/i.test(this.nodeName)||/text|hidden|password/i.test(this.type));}).map(function(i,elem){var val=jQuery(this).val();return val==null?null:val.constructor==Array?jQuery.map(val,function(val,i){return{name:elem.name,value:val};}):{name:elem.name,value:val};}).get();}});jQuery.each("ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","),function(i,o){jQuery.fn[o]=function(f){return this.bind(o,f);};});var jsc=now();jQuery.extend({get:function(url,data,callback,type){if(jQuery.isFunction(data)){callback=data;data=null;}return jQuery.ajax({type:"GET",url:url,data:data,success:callback,dataType:type});},getScript:function(url,callback){return jQuery.get(url,null,callback,"script");},getJSON:function(url,data,callback){return jQuery.get(url,data,callback,"json");},post:function(url,data,callback,type){if(jQuery.isFunction(data)){callback=data;data={};}return jQuery.ajax({type:"POST",url:url,data:data,success:callback,dataType:type});},ajaxSetup:function(settings){jQuery.extend(jQuery.ajaxSettings,settings);},ajaxSettings:{url:location.href,global:true,type:"GET",timeout:0,contentType:"application/x-www-form-urlencoded",processData:true,async:true,data:null,username:null,password:null,accepts:{xml:"application/xml, text/xml",html:"text/html",script:"text/javascript, application/javascript",json:"application/json, text/javascript",text:"text/plain",_default:"*/*"}},lastModified:{},ajax:function(s){s=jQuery.extend(true,s,jQuery.extend(true,{},jQuery.ajaxSettings,s));var jsonp,jsre=/=\?(&|$)/g,status,data,type=s.type.toUpperCase();if(s.data&&s.processData&&typeof s.data!="string")s.data=jQuery.param(s.data);if(s.dataType=="jsonp"){if(type=="GET"){if(!s.url.match(jsre))s.url+=(s.url.match(/\?/)?"&":"?")+(s.jsonp||"callback")+"=?";}else if(!s.data||!s.data.match(jsre))s.data=(s.data?s.data+"&":"")+(s.jsonp||"callback")+"=?";s.dataType="json";}if(s.dataType=="json"&&(s.data&&s.data.match(jsre)||s.url.match(jsre))){jsonp="jsonp"+jsc++;if(s.data)s.data=(s.data+"").replace(jsre,"="+jsonp+"$1");s.url=s.url.replace(jsre,"="+jsonp+"$1");s.dataType="script";window[jsonp]=function(tmp){data=tmp;success();complete();window[jsonp]=undefined;try{delete window[jsonp];}catch(e){}if(head)head.removeChild(script);};}if(s.dataType=="script"&&s.cache==null)s.cache=false;if(s.cache===false&&type=="GET"){var ts=now();var ret=s.url.replace(/(\?|&)_=.*?(&|$)/,"$1_="+ts+"$2");s.url=ret+((ret==s.url)?(s.url.match(/\?/)?"&":"?")+"_="+ts:"");}if(s.data&&type=="GET"){s.url+=(s.url.match(/\?/)?"&":"?")+s.data;s.data=null;}if(s.global&&!jQuery.active++)jQuery.event.trigger("ajaxStart");var remote=/^(?:\w+:)?\/\/([^\/?#]+)/;if(s.dataType=="script"&&type=="GET"&&remote.test(s.url)&&remote.exec(s.url)[1]!=location.host){var head=document.getElementsByTagName("head")[0];var script=document.createElement("script");script.src=s.url;if(s.scriptCharset)script.charset=s.scriptCharset;if(!jsonp){var done=false;script.onload=script.onreadystatechange=function(){if(!done&&(!this.readyState||this.readyState=="loaded"||this.readyState=="complete")){done=true;success();complete();head.removeChild(script);}};}head.appendChild(script);return undefined;}var requestDone=false;var xhr=window.ActiveXObject?new ActiveXObject("Microsoft.XMLHTTP"):new XMLHttpRequest();if(s.username)xhr.open(type,s.url,s.async,s.username,s.password);else +xhr.open(type,s.url,s.async);try{if(s.data)xhr.setRequestHeader("Content-Type",s.contentType);if(s.ifModified)xhr.setRequestHeader("If-Modified-Since",jQuery.lastModified[s.url]||"Thu, 01 Jan 1970 00:00:00 GMT");xhr.setRequestHeader("X-Requested-With","XMLHttpRequest");xhr.setRequestHeader("Accept",s.dataType&&s.accepts[s.dataType]?s.accepts[s.dataType]+", */*":s.accepts._default);}catch(e){}if(s.beforeSend&&s.beforeSend(xhr,s)===false){s.global&&jQuery.active--;xhr.abort();return false;}if(s.global)jQuery.event.trigger("ajaxSend",[xhr,s]);var onreadystatechange=function(isTimeout){if(!requestDone&&xhr&&(xhr.readyState==4||isTimeout=="timeout")){requestDone=true;if(ival){clearInterval(ival);ival=null;}status=isTimeout=="timeout"&&"timeout"||!jQuery.httpSuccess(xhr)&&"error"||s.ifModified&&jQuery.httpNotModified(xhr,s.url)&&"notmodified"||"success";if(status=="success"){try{data=jQuery.httpData(xhr,s.dataType,s.dataFilter);}catch(e){status="parsererror";}}if(status=="success"){var modRes;try{modRes=xhr.getResponseHeader("Last-Modified");}catch(e){}if(s.ifModified&&modRes)jQuery.lastModified[s.url]=modRes;if(!jsonp)success();}else +jQuery.handleError(s,xhr,status);complete();if(s.async)xhr=null;}};if(s.async){var ival=setInterval(onreadystatechange,13);if(s.timeout>0)setTimeout(function(){if(xhr){xhr.abort();if(!requestDone)onreadystatechange("timeout");}},s.timeout);}try{xhr.send(s.data);}catch(e){jQuery.handleError(s,xhr,null,e);}if(!s.async)onreadystatechange();function success(){if(s.success)s.success(data,status);if(s.global)jQuery.event.trigger("ajaxSuccess",[xhr,s]);}function complete(){if(s.complete)s.complete(xhr,status);if(s.global)jQuery.event.trigger("ajaxComplete",[xhr,s]);if(s.global&&!--jQuery.active)jQuery.event.trigger("ajaxStop");}return xhr;},handleError:function(s,xhr,status,e){if(s.error)s.error(xhr,status,e);if(s.global)jQuery.event.trigger("ajaxError",[xhr,s,e]);},active:0,httpSuccess:function(xhr){try{return!xhr.status&&location.protocol=="file:"||(xhr.status>=200&&xhr.status<300)||xhr.status==304||xhr.status==1223||jQuery.browser.safari&&xhr.status==undefined;}catch(e){}return false;},httpNotModified:function(xhr,url){try{var xhrRes=xhr.getResponseHeader("Last-Modified");return xhr.status==304||xhrRes==jQuery.lastModified[url]||jQuery.browser.safari&&xhr.status==undefined;}catch(e){}return false;},httpData:function(xhr,type,filter){var ct=xhr.getResponseHeader("content-type"),xml=type=="xml"||!type&&ct&&ct.indexOf("xml")>=0,data=xml?xhr.responseXML:xhr.responseText;if(xml&&data.documentElement.tagName=="parsererror")throw"parsererror";if(filter)data=filter(data,type);if(type=="script")jQuery.globalEval(data);if(type=="json")data=eval("("+data+")");return data;},param:function(a){var s=[];if(a.constructor==Array||a.jquery)jQuery.each(a,function(){s.push(encodeURIComponent(this.name)+"="+encodeURIComponent(this.value));});else +for(var j in a)if(a[j]&&a[j].constructor==Array)jQuery.each(a[j],function(){s.push(encodeURIComponent(j)+"="+encodeURIComponent(this));});else +s.push(encodeURIComponent(j)+"="+encodeURIComponent(jQuery.isFunction(a[j])?a[j]():a[j]));return s.join("&").replace(/%20/g,"+");}});jQuery.fn.extend({show:function(speed,callback){return speed?this.animate({height:"show",width:"show",opacity:"show"},speed,callback):this.filter(":hidden").each(function(){this.style.display=this.oldblock||"";if(jQuery.css(this,"display")=="none"){var elem=jQuery("<"+this.tagName+" />").appendTo("body");this.style.display=elem.css("display");if(this.style.display=="none")this.style.display="block";elem.remove();}}).end();},hide:function(speed,callback){return speed?this.animate({height:"hide",width:"hide",opacity:"hide"},speed,callback):this.filter(":visible").each(function(){this.oldblock=this.oldblock||jQuery.css(this,"display");this.style.display="none";}).end();},_toggle:jQuery.fn.toggle,toggle:function(fn,fn2){return jQuery.isFunction(fn)&&jQuery.isFunction(fn2)?this._toggle.apply(this,arguments):fn?this.animate({height:"toggle",width:"toggle",opacity:"toggle"},fn,fn2):this.each(function(){jQuery(this)[jQuery(this).is(":hidden")?"show":"hide"]();});},slideDown:function(speed,callback){return this.animate({height:"show"},speed,callback);},slideUp:function(speed,callback){return this.animate({height:"hide"},speed,callback);},slideToggle:function(speed,callback){return this.animate({height:"toggle"},speed,callback);},fadeIn:function(speed,callback){return this.animate({opacity:"show"},speed,callback);},fadeOut:function(speed,callback){return this.animate({opacity:"hide"},speed,callback);},fadeTo:function(speed,to,callback){return this.animate({opacity:to},speed,callback);},animate:function(prop,speed,easing,callback){var optall=jQuery.speed(speed,easing,callback);return this[optall.queue===false?"each":"queue"](function(){if(this.nodeType!=1)return false;var opt=jQuery.extend({},optall),p,hidden=jQuery(this).is(":hidden"),self=this;for(p in prop){if(prop[p]=="hide"&&hidden||prop[p]=="show"&&!hidden)return opt.complete.call(this);if(p=="height"||p=="width"){opt.display=jQuery.css(this,"display");opt.overflow=this.style.overflow;}}if(opt.overflow!=null)this.style.overflow="hidden";opt.curAnim=jQuery.extend({},prop);jQuery.each(prop,function(name,val){var e=new jQuery.fx(self,opt,name);if(/toggle|show|hide/.test(val))e[val=="toggle"?hidden?"show":"hide":val](prop);else{var parts=val.toString().match(/^([+-]=)?([\d+-.]+)(.*)$/),start=e.cur(true)||0;if(parts){var end=parseFloat(parts[2]),unit=parts[3]||"px";if(unit!="px"){self.style[name]=(end||1)+unit;start=((end||1)/e.cur(true))*start;self.style[name]=start+unit;}if(parts[1])end=((parts[1]=="-="?-1:1)*end)+start;e.custom(start,end,unit);}else +e.custom(start,val,"");}});return true;});},queue:function(type,fn){if(jQuery.isFunction(type)||(type&&type.constructor==Array)){fn=type;type="fx";}if(!type||(typeof type=="string"&&!fn))return queue(this[0],type);return this.each(function(){if(fn.constructor==Array)queue(this,type,fn);else{queue(this,type).push(fn);if(queue(this,type).length==1)fn.call(this);}});},stop:function(clearQueue,gotoEnd){var timers=jQuery.timers;if(clearQueue)this.queue([]);this.each(function(){for(var i=timers.length-1;i>=0;i--)if(timers[i].elem==this){if(gotoEnd)timers[i](true);timers.splice(i,1);}});if(!gotoEnd)this.dequeue();return this;}});var queue=function(elem,type,array){if(elem){type=type||"fx";var q=jQuery.data(elem,type+"queue");if(!q||array)q=jQuery.data(elem,type+"queue",jQuery.makeArray(array));}return q;};jQuery.fn.dequeue=function(type){type=type||"fx";return this.each(function(){var q=queue(this,type);q.shift();if(q.length)q[0].call(this);});};jQuery.extend({speed:function(speed,easing,fn){var opt=speed&&speed.constructor==Object?speed:{complete:fn||!fn&&easing||jQuery.isFunction(speed)&&speed,duration:speed,easing:fn&&easing||easing&&easing.constructor!=Function&&easing};opt.duration=(opt.duration&&opt.duration.constructor==Number?opt.duration:jQuery.fx.speeds[opt.duration])||jQuery.fx.speeds.def;opt.old=opt.complete;opt.complete=function(){if(opt.queue!==false)jQuery(this).dequeue();if(jQuery.isFunction(opt.old))opt.old.call(this);};return opt;},easing:{linear:function(p,n,firstNum,diff){return firstNum+diff*p;},swing:function(p,n,firstNum,diff){return((-Math.cos(p*Math.PI)/2)+0.5)*diff+firstNum;}},timers:[],timerId:null,fx:function(elem,options,prop){this.options=options;this.elem=elem;this.prop=prop;if(!options.orig)options.orig={};}});jQuery.fx.prototype={update:function(){if(this.options.step)this.options.step.call(this.elem,this.now,this);(jQuery.fx.step[this.prop]||jQuery.fx.step._default)(this);if(this.prop=="height"||this.prop=="width")this.elem.style.display="block";},cur:function(force){if(this.elem[this.prop]!=null&&this.elem.style[this.prop]==null)return this.elem[this.prop];var r=parseFloat(jQuery.css(this.elem,this.prop,force));return r&&r>-10000?r:parseFloat(jQuery.curCSS(this.elem,this.prop))||0;},custom:function(from,to,unit){this.startTime=now();this.start=from;this.end=to;this.unit=unit||this.unit||"px";this.now=this.start;this.pos=this.state=0;this.update();var self=this;function t(gotoEnd){return self.step(gotoEnd);}t.elem=this.elem;jQuery.timers.push(t);if(jQuery.timerId==null){jQuery.timerId=setInterval(function(){var timers=jQuery.timers;for(var i=0;ithis.options.duration+this.startTime){this.now=this.end;this.pos=this.state=1;this.update();this.options.curAnim[this.prop]=true;var done=true;for(var i in this.options.curAnim)if(this.options.curAnim[i]!==true)done=false;if(done){if(this.options.display!=null){this.elem.style.overflow=this.options.overflow;this.elem.style.display=this.options.display;if(jQuery.css(this.elem,"display")=="none")this.elem.style.display="block";}if(this.options.hide)this.elem.style.display="none";if(this.options.hide||this.options.show)for(var p in this.options.curAnim)jQuery.attr(this.elem.style,p,this.options.orig[p]);}if(done)this.options.complete.call(this.elem);return false;}else{var n=t-this.startTime;this.state=n/this.options.duration;this.pos=jQuery.easing[this.options.easing||(jQuery.easing.swing?"swing":"linear")](this.state,n,0,1,this.options.duration);this.now=this.start+((this.end-this.start)*this.pos);this.update();}return true;}};jQuery.extend(jQuery.fx,{speeds:{slow:600,fast:200,def:400},step:{scrollLeft:function(fx){fx.elem.scrollLeft=fx.now;},scrollTop:function(fx){fx.elem.scrollTop=fx.now;},opacity:function(fx){jQuery.attr(fx.elem.style,"opacity",fx.now);},_default:function(fx){fx.elem.style[fx.prop]=fx.now+fx.unit;}}});jQuery.fn.offset=function(){var left=0,top=0,elem=this[0],results;if(elem)with(jQuery.browser){var parent=elem.parentNode,offsetChild=elem,offsetParent=elem.offsetParent,doc=elem.ownerDocument,safari2=safari&&parseInt(version)<522&&!/adobeair/i.test(userAgent),css=jQuery.curCSS,fixed=css(elem,"position")=="fixed";if(elem.getBoundingClientRect){var box=elem.getBoundingClientRect();add(box.left+Math.max(doc.documentElement.scrollLeft,doc.body.scrollLeft),box.top+Math.max(doc.documentElement.scrollTop,doc.body.scrollTop));add(-doc.documentElement.clientLeft,-doc.documentElement.clientTop);}else{add(elem.offsetLeft,elem.offsetTop);while(offsetParent){add(offsetParent.offsetLeft,offsetParent.offsetTop);if(mozilla&&!/^t(able|d|h)$/i.test(offsetParent.tagName)||safari&&!safari2)border(offsetParent);if(!fixed&&css(offsetParent,"position")=="fixed")fixed=true;offsetChild=/^body$/i.test(offsetParent.tagName)?offsetChild:offsetParent;offsetParent=offsetParent.offsetParent;}while(parent&&parent.tagName&&!/^body|html$/i.test(parent.tagName)){if(!/^inline|table.*$/i.test(css(parent,"display")))add(-parent.scrollLeft,-parent.scrollTop);if(mozilla&&css(parent,"overflow")!="visible")border(parent);parent=parent.parentNode;}if((safari2&&(fixed||css(offsetChild,"position")=="absolute"))||(mozilla&&css(offsetChild,"position")!="absolute"))add(-doc.body.offsetLeft,-doc.body.offsetTop);if(fixed)add(Math.max(doc.documentElement.scrollLeft,doc.body.scrollLeft),Math.max(doc.documentElement.scrollTop,doc.body.scrollTop));}results={top:top,left:left};}function border(elem){add(jQuery.curCSS(elem,"borderLeftWidth",true),jQuery.curCSS(elem,"borderTopWidth",true));}function add(l,t){left+=parseInt(l,10)||0;top+=parseInt(t,10)||0;}return results;};jQuery.fn.extend({position:function(){var left=0,top=0,results;if(this[0]){var offsetParent=this.offsetParent(),offset=this.offset(),parentOffset=/^body|html$/i.test(offsetParent[0].tagName)?{top:0,left:0}:offsetParent.offset();offset.top-=num(this,'marginTop');offset.left-=num(this,'marginLeft');parentOffset.top+=num(offsetParent,'borderTopWidth');parentOffset.left+=num(offsetParent,'borderLeftWidth');results={top:offset.top-parentOffset.top,left:offset.left-parentOffset.left};}return results;},offsetParent:function(){var offsetParent=this[0].offsetParent;while(offsetParent&&(!/^body|html$/i.test(offsetParent.tagName)&&jQuery.css(offsetParent,'position')=='static'))offsetParent=offsetParent.offsetParent;return jQuery(offsetParent);}});jQuery.each(['Left','Top'],function(i,name){var method='scroll'+name;jQuery.fn[method]=function(val){if(!this[0])return;return val!=undefined?this.each(function(){this==window||this==document?window.scrollTo(!i?val:jQuery(window).scrollLeft(),i?val:jQuery(window).scrollTop()):this[method]=val;}):this[0]==window||this[0]==document?self[i?'pageYOffset':'pageXOffset']||jQuery.boxModel&&document.documentElement[method]||document.body[method]:this[0][method];};});jQuery.each(["Height","Width"],function(i,name){var tl=i?"Left":"Top",br=i?"Right":"Bottom";jQuery.fn["inner"+name]=function(){return this[name.toLowerCase()]()+num(this,"padding"+tl)+num(this,"padding"+br);};jQuery.fn["outer"+name]=function(margin){return this["inner"+name]()+num(this,"border"+tl+"Width")+num(this,"border"+br+"Width")+(margin?num(this,"margin"+tl)+num(this,"margin"+br):0);};});})(); \ No newline at end of file diff --git a/rdoc/js/quicksearch.js b/rdoc/js/quicksearch.js new file mode 100644 index 0000000..332772a --- /dev/null +++ b/rdoc/js/quicksearch.js @@ -0,0 +1,114 @@ +/** + * + * JQuery QuickSearch - Hook up a form field to hide non-matching elements. + * $Id: quicksearch.js 53 2009-01-07 02:52:03Z deveiant $ + * + * Author: Michael Granger + * + */ +jQuery.fn.quicksearch = function( target, searchElems, options ) { + // console.debug( "Quicksearch fn" ); + + var settings = { + delay: 250, + clearButton: false, + highlightMatches: false, + focusOnLoad: false, + noSearchResultsIndicator: null + }; + if ( options ) $.extend( settings, options ); + + return jQuery(this).each( function() { + // console.debug( "Creating a new quicksearch on %o for %o", this, searchElems ); + new jQuery.quicksearch( this, searchElems, settings ); + }); +}; + + +jQuery.quicksearch = function( searchBox, searchElems, settings ) { + var timeout; + var boxdiv = $(searchBox).parents('div').eq(0); + + function init() { + setupKeyEventHandlers(); + focusOnLoad(); + }; + + function setupKeyEventHandlers() { + // console.debug( "Hooking up the 'keypress' event to %o", searchBox ); + $(searchBox). + unbind( 'keyup' ). + keyup( function(e) { return onSearchKey( e.keyCode ); }); + $(searchBox). + unbind( 'keypress' ). + keypress( function(e) { + switch( e.which ) { + // Execute the search on Enter, Tab, or Newline + case 9: + case 13: + case 10: + clearTimeout( timeout ); + e.preventDefault(); + doQuickSearch(); + break; + + // Allow backspace + case 8: + return true; + break; + + // Only allow valid search characters + default: + return validQSChar( e.charCode ); + } + }); + }; + + function focusOnLoad() { + if ( !settings.focusOnLoad ) return false; + $(searchBox).focus(); + }; + + function onSearchKey ( code ) { + clearTimeout( timeout ); + // console.debug( "...scheduling search." ); + timeout = setTimeout( doQuickSearch, settings.delay ); + }; + + function validQSChar( code ) { + var c = String.fromCharCode( code ); + return ( + (c == ':') || + (c >= 'a' && c <= 'z') || + (c >= 'A' && c <= 'Z') + ); + }; + + function doQuickSearch() { + var searchText = searchBox.value; + var pat = new RegExp( searchText, "im" ); + var shownCount = 0; + + if ( settings.noSearchResultsIndicator ) { + $('#' + settings.noSearchResultsIndicator).hide(); + } + + // All elements start out hidden + $(searchElems).each( function(index) { + var str = $(this).text(); + + if ( pat.test(str) ) { + shownCount += 1; + $(this).fadeIn(); + } else { + $(this).hide(); + } + }); + + if ( shownCount == 0 && settings.noSearchResultsIndicator ) { + $('#' + settings.noSearchResultsIndicator).slideDown(); + } + }; + + init(); +}; diff --git a/rdoc/js/thickbox.js b/rdoc/js/thickbox.js new file mode 100644 index 0000000..3a3fdae --- /dev/null +++ b/rdoc/js/thickbox.js @@ -0,0 +1,10 @@ +/* + * Thickbox 3 - One Box To Rule Them All. + * By Cody Lindley (http://www.codylindley.com) + * Copyright (c) 2007 cody lindley + * Licensed under the MIT License: http://www.opensource.org/licenses/mit-license.php +*/ + +var tb_pathToImage = "../images/loadingAnimation.gif"; + +eval(function(p,a,c,k,e,r){e=function(c){return(c35?String.fromCharCode(c+29):c.toString(36))};if(!''.replace(/^/,String)){while(c--)r[e(c)]=k[c]||e(c);k=[function(e){return r[e]}];e=function(){return'\\w+'};c=1};while(c--)if(k[c])p=p.replace(new RegExp('\\b'+e(c)+'\\b','g'),k[c]);return p}('$(o).2S(9(){1u(\'a.18, 3n.18, 3i.18\');1w=1p 1t();1w.L=2H});9 1u(b){$(b).s(9(){6 t=X.Q||X.1v||M;6 a=X.u||X.23;6 g=X.1N||P;19(t,a,g);X.2E();H P})}9 19(d,f,g){3m{3(2t o.v.J.2i==="2g"){$("v","11").r({A:"28%",z:"28%"});$("11").r("22","2Z");3(o.1Y("1F")===M){$("v").q("<4 5=\'B\'><4 5=\'8\'>");$("#B").s(G)}}n{3(o.1Y("B")===M){$("v").q("<4 5=\'B\'><4 5=\'8\'>");$("#B").s(G)}}3(1K()){$("#B").1J("2B")}n{$("#B").1J("2z")}3(d===M){d=""}$("v").q("<4 5=\'K\'><1I L=\'"+1w.L+"\' />");$(\'#K\').2y();6 h;3(f.O("?")!==-1){h=f.3l(0,f.O("?"))}n{h=f}6 i=/\\.2s$|\\.2q$|\\.2m$|\\.2l$|\\.2k$/;6 j=h.1C().2h(i);3(j==\'.2s\'||j==\'.2q\'||j==\'.2m\'||j==\'.2l\'||j==\'.2k\'){1D="";1G="";14="";1z="";1x="";R="";1n="";1r=P;3(g){E=$("a[@1N="+g+"]").36();25(D=0;((D&1d;&1d;2T &2R;"}n{1D=E[D].Q;1G=E[D].u;14="<1e 5=\'1U\'>&1d;&1d;&2O; 2N"}}n{1r=1b;1n="1t "+(D+1)+" 2L "+(E.1c)}}}S=1p 1t();S.1g=9(){S.1g=M;6 a=2x();6 x=a[0]-1M;6 y=a[1]-1M;6 b=S.z;6 c=S.A;3(b>x){c=c*(x/b);b=x;3(c>y){b=b*(y/c);c=y}}n 3(c>y){b=b*(y/c);c=y;3(b>x){c=c*(x/b);b=x}}13=b+30;1a=c+2G;$("#8").q("<1I 5=\'2F\' L=\'"+f+"\' z=\'"+b+"\' A=\'"+c+"\' 23=\'"+d+"\'/>"+"<4 5=\'2D\'>"+d+"<4 5=\'2C\'>"+1n+14+R+"<4 5=\'2A\'>1l 1k 1j 1s");$("#Z").s(G);3(!(14==="")){9 12(){3($(o).N("s",12)){$(o).N("s",12)}$("#8").C();$("v").q("<4 5=\'8\'>");19(1D,1G,g);H P}$("#1U").s(12)}3(!(R==="")){9 1i(){$("#8").C();$("v").q("<4 5=\'8\'>");19(1z,1x,g);H P}$("#1X").s(1i)}o.1h=9(e){3(e==M){I=2w.2v}n{I=e.2u}3(I==27){G()}n 3(I==3k){3(!(R=="")){o.1h="";1i()}}n 3(I==3j){3(!(14=="")){o.1h="";12()}}};16();$("#K").C();$("#1L").s(G);$("#8").r({Y:"T"})};S.L=f}n{6 l=f.2r(/^[^\\?]+\\??/,\'\');6 m=2p(l);13=(m[\'z\']*1)+30||3h;1a=(m[\'A\']*1)+3g||3f;W=13-30;V=1a-3e;3(f.O(\'2j\')!=-1){1E=f.1B(\'3d\');$("#15").C();3(m[\'1A\']!="1b"){$("#8").q("<4 5=\'2f\'><4 5=\'1H\'>"+d+"<4 5=\'2e\'>1l 1k 1j 1s ")}n{$("#B").N();$("#8").q(" ")}}n{3($("#8").r("Y")!="T"){3(m[\'1A\']!="1b"){$("#8").q("<4 5=\'2f\'><4 5=\'1H\'>"+d+"<4 5=\'2e\'>1l 1k 1j 1s<4 5=\'F\' J=\'z:"+W+"p;A:"+V+"p\'>")}n{$("#B").N();$("#8").q("<4 5=\'F\' 3c=\'3b\' J=\'z:"+W+"p;A:"+V+"p;\'>")}}n{$("#F")[0].J.z=W+"p";$("#F")[0].J.A=V+"p";$("#F")[0].3a=0;$("#1H").11(d)}}$("#Z").s(G);3(f.O(\'37\')!=-1){$("#F").q($(\'#\'+m[\'26\']).1T());$("#8").24(9(){$(\'#\'+m[\'26\']).q($("#F").1T())});16();$("#K").C();$("#8").r({Y:"T"})}n 3(f.O(\'2j\')!=-1){16();3($.1q.35){$("#K").C();$("#8").r({Y:"T"})}}n{$("#F").34(f+="&1y="+(1p 33().32()),9(){16();$("#K").C();1u("#F a.18");$("#8").r({Y:"T"})})}}3(!m[\'1A\']){o.21=9(e){3(e==M){I=2w.2v}n{I=e.2u}3(I==27){G()}}}}31(e){}}9 1m(){$("#K").C();$("#8").r({Y:"T"})}9 G(){$("#2Y").N("s");$("#Z").N("s");$("#8").2X("2W",9(){$(\'#8,#B,#1F\').2V("24").N().C()});$("#K").C();3(2t o.v.J.2i=="2g"){$("v","11").r({A:"1Z",z:"1Z"});$("11").r("22","")}o.1h="";o.21="";H P}9 16(){$("#8").r({2U:\'-\'+20((13/2),10)+\'p\',z:13+\'p\'});3(!(1V.1q.2Q&&1V.1q.2P<7)){$("#8").r({38:\'-\'+20((1a/2),10)+\'p\'})}}9 2p(a){6 b={};3(!a){H b}6 c=a.1B(/[;&]/);25(6 i=0;i + + + + + + + File: command.rb [D'Note] + + + + + + + + + + + + + +
+
+
Last Modified
+
Fri Oct 23 21:01:39 -0400 2009
+ + +
Requires
+
+
    + +
  • optparse
  • + +
  • dnote
  • + +
+
+ + + +
+
+ +
+ +
+

Description

+ +
+ +
+ + + + diff --git a/rdoc/lib/dnote/notes_rb.html b/rdoc/lib/dnote/notes_rb.html new file mode 100644 index 0000000..ffc5d65 --- /dev/null +++ b/rdoc/lib/dnote/notes_rb.html @@ -0,0 +1,62 @@ + + + + + + + + File: notes.rb [D'Note] + + + + + + + + + + + + + +
+
+
Last Modified
+
Fri Oct 23 21:00:14 -0400 2009
+ + +
Requires
+
+
    + +
  • rexml/text
  • + +
  • pathname
  • + +
  • erb
  • + +
  • yaml
  • + +
  • json
  • + +
+
+ + + +
+
+ +
+ +
+

Description

+ +
+ +
+ + + + diff --git a/rdoc/lib/dnote_rb.html b/rdoc/lib/dnote_rb.html new file mode 100644 index 0000000..1e266d9 --- /dev/null +++ b/rdoc/lib/dnote_rb.html @@ -0,0 +1,54 @@ + + + + + + + + File: dnote.rb [D'Note] + + + + + + + + + + + + + +
+
+
Last Modified
+
Fri Oct 09 21:13:37 -0400 2009
+ + +
Requires
+
+
    + +
  • dnote/notes
  • + +
+
+ + + +
+
+ +
+ +
+

Description

+ +
+ +
+ + + + diff --git a/rdoc/plug/syckle/services/dnote_rb.html b/rdoc/plug/syckle/services/dnote_rb.html new file mode 100644 index 0000000..adc5e4a --- /dev/null +++ b/rdoc/plug/syckle/services/dnote_rb.html @@ -0,0 +1,54 @@ + + + + + + + + File: dnote.rb [D'Note] + + + + + + + + + + + + + +
+
+
Last Modified
+
Fri Oct 23 20:59:23 -0400 2009
+ + +
Requires
+
+
    + +
  • dnote
  • + +
+
+ + + +
+
+ +
+ +
+

Description

+ +
+ +
+ + + + diff --git a/rdoc/rdoc.css b/rdoc/rdoc.css new file mode 100644 index 0000000..fcc6976 --- /dev/null +++ b/rdoc/rdoc.css @@ -0,0 +1,786 @@ +/* + * "Darkfish" Rdoc CSS + * $Id: rdoc.css 54 2009-01-27 01:09:48Z deveiant $ + * + * Author: Michael Granger + * + */ + +/* Base Red is: color: #FF226C; */ + +*{ padding: 0; margin: 0; } + +body { + background: #efefef; + font: 14px "Helvetica Neue", Helvetica, Tahoma, sans-serif; + padding: 15px 40px; +} + +/* +body.class, body.module, body.file { + margin-left: 40px; +} +*/ + +body.file-popup { + font-size: 90%; + margin-left: 0; +} + +h1 { + font-size: 300%; + text-shadow: rgba(135,145,135,0.65) 2px 2px 3px; + color: #FF226C; +} + +h2,h3,h4 { margin-top: 1.5em; } + +a { + color: #FF226C; + text-decoration: none; +} + +a:hover { + border-bottom: 1px dotted #FF226C; +} + +pre { + padding: 0.5em 0; + border: 1px solid #ccc; +} + +p { + margin: 1em 0; +} + +ul { + margin-left: 20px; +} + + +.head { + width: auto; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + border: 0px solid #aaa; + padding: 0 10px; + margin: 0 8px 5px 8px; +} + +.head h1 { + color: #FF226C; + color: #666; + font-weight: bold; + font-size: 18px; +} + +.head h1 a { + color: #FF226C; + font-weight: bold; +} + +/* @group Generic Classes */ + +.initially-hidden { + display: none; +} + +.quicksearch-field { + width: 98%; + background: #ddd; + border: 1px solid #aaa; + height: 1.5em; + -webkit-border-radius: 4px; +} +.quicksearch-field:focus { + background: #f1edba; +} + +.missing-docs { + font-size: 120%; + background: white url(images/wrench_orange.png) no-repeat 4px center; + color: #ccc; + line-height: 2em; + border: 0px solid #d00; + opacity: 1; + padding-left: 20px; + text-indent: 24px; + letter-spacing: 3px; + font-weight: bold; + -webkit-border-radius: 5px; + -moz-border-radius: 5px; +} + +.target-section { + border: 2px solid #dcce90; + border-left-width: 8px; + padding: 0 1em; + background: #fff3c2; +} + +/* @end */ + + +/* @group Index Page, Standalone file pages */ + +/* +body.indexpage { + margin: 1em 3em; +} +*/ + +/* +body.indexpage p, +body.indexpage div, +body.file p { + margin: 1em 0; +} +*/ + +#metadata ul { + font-size: 14px; +} + +#metadata ul a { + font-size: 14px; +} + +/* +.indexpage ul, +.file #documentation ul { + line-height: 160%; + list-style: none; +} +*/ + +#metadata ul { + list-style: none; + margin-left: 0; +} + +/* +.indexpage ul a, +.file #documentation ul a { + font-size: 16px; +} +*/ + +#metadata li { + padding-left: 20px; + background: url(images/bullet_black.png) no-repeat left 4px; + color: #666; +} + +#metadata li.method { + padding-left: 20px; + background: url(images/method.png) no-repeat left 2px; +} + +#metadata li.module { + padding-left: 20px; + background: url(images/module.png) no-repeat left 2px; +} + +#metadata li.class { + padding-left: 20px; + background: url(images/class.png) no-repeat left 2px; +} + +#metadata li.file { + padding-left: 20px; + background: url(images/file.png) no-repeat left 2px; +} + +/* @end */ + +/* @group Top-Level Structure */ + +#metadata { + float: left; + width: 320px; + margin-top: 10px; +} + +#documentation { + margin: 0 1em 5em 360px; + min-width: 340px; +} + +/* +.file #metadata { + margin: 0.8em; +} +*/ + +#validator-badges { + clear: both; + text-align: left; + margin: 1em 1em 2em; + font-weight: bold; + font-size: 80%; +} + +/* @end */ + +/* @group Metadata Section */ + +#metadata .section { + background-color: #dedede; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + border: 1px solid #aaa; + margin: 0 8px 16px; + font-size: 90%; + overflow: hidden; +} + +#metadata h3.section-header { + margin: 0; + padding: 2px 8px; + background: #ccc; + color: #666; + -moz-border-radius-topleft: 4px; + -moz-border-radius-topright: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + border-bottom: 1px solid #aaa; +} + +#metadata ul, +#metadata dl, +#metadata p { + padding: 8px; + list-style: none; +} + +#file-metadata ul { + padding-left: 28px; + list-style-image: url(images/page_green.png); +} + +dl.svninfo { + color: #666; + margin: 0; +} +dl.svninfo dt { + font-weight: bold; +} + +ul.link-list li { + white-space: nowrap; +} + +ul.link-list .type { + font-size: 8px; + text-transform: uppercase; + color: white; + background: #969696; + padding: 2px 4px; + -webkit-border-radius: 5px; +} + +/* @end */ + + +/* @group Project Metadata Section */ +#project-metadata { + margin-top: 0em; +} + +/* +.file #project-metadata { + margin-top: 0em; +} +*/ + +#project-metadata .section { + border: 1px solid #aaa; +} +#project-metadata h3.section-header { + border-bottom: 1px solid #aaa; + position: relative; +} +#project-metadata h3.section-header .search-toggle { + position: absolute; + right: 5px; +} + + +#project-metadata form { + color: #777; + background: #ccc; + padding: 8px 8px 16px; + border-bottom: 1px solid #bbb; +} +#project-metadata fieldset { + border: 0; +} + +#no-class-search-results { + margin: 0 auto 1em; + text-align: center; + font-size: 14px; + font-weight: bold; + color: #aaa; +} + +/* @end */ + + +/* @group Documentation Section */ +#description { + font-size: 100%; + color: #333; +} + +#description p { + margin: 1em 0.4em; +} + +#description ul { + margin-left: 2em; +} +#description ul li { + line-height: 1.4em; +} + +#description dl, +#documentation dl { + margin: 8px 1.5em; + border: 1px solid #ccc; +} +#description dl { + font-size: 14px; +} + +#description dt, +#documentation dt { + padding: 2px 4px; + font-weight: bold; + background: #ddd; +} +#description dd, +#documentation dd { + padding: 2px 12px; +} +#description dd + dt, +#documentation dd + dt { + margin-top: 0.7em; +} + +#documentation .section { + font-size: 90%; +} +#documentation h3.section-header { + margin-top: 2em; + padding: 0.75em 0.5em; + background-color: #dedede; + color: #333; + font-size: 150%; + border: 1px solid #bbb; + -moz-border-radius: 3px; + -webkit-border-radius: 3px; +} + +#constants-list > dl, +#attributes-list > dl { + margin: 1em 0 2em; + border: 0; +} +#constants-list > dl dt, +#attributes-list > dl dt { + padding-left: 0; + font-weight: bold; + font-family: Monaco, "Andale Mono"; + background: inherit; +} +#constants-list > dl dt a, +#attributes-list > dl dt a { + color: inherit; +} +#constants-list > dl dd, +#attributes-list > dl dd { + margin: 0 0 1em 0; + padding: 0; + color: #666; +} + +/* @group Method Details */ + +#documentation .method-source-code { + display: none; +} + +#documentation .method-detail { + margin: 0.5em 0; + padding: 0.5em 0; + cursor: pointer; +} +#documentation .method-detail:hover { + background-color: #f1edba; +} +#documentation .method-alias { + font-style: oblique; +} +#documentation .method-heading { + position: relative; + padding: 2px 4px 0 20px; + font-size: 125%; + font-weight: bold; + color: #333; + background: url(images/method.png) no-repeat left bottom; +} +#documentation .method-heading a { + color: inherit; +} +#documentation .method-click-advice { + position: absolute; + top: 2px; + right: 5px; + font-size: 10px; + color: #9b9877; + visibility: hidden; + padding-right: 20px; + line-height: 20px; + background: url(images/zoom.png) no-repeat right top; +} +#documentation .method-detail:hover .method-click-advice { + visibility: visible; +} + +#documentation .method-alias .method-heading { + color: #666; + background: url(images/alias.png) no-repeat left bottom; +} + +#documentation .method-description, +#documentation .aliases { + margin: 0 20px; + line-height: 1.2em; + color: #666; +} +#documentation .aliases { + padding-top: 4px; + font-style: italic; + cursor: default; +} +#documentation .method-description p { + padding: 0; +} +#documentation .method-description p + p { + margin-bottom: 0.5em; +} + +#documentation .attribute-method-heading { + background: url(images/attribute.png) no-repeat left bottom; +} +#documentation #attribute-method-details .method-detail:hover { + background-color: transparent; + cursor: default; +} +#documentation .attribute-access-type { + font-size: 60%; + text-transform: uppercase; + vertical-align: super; + padding: 0 2px; +} +/* @end */ + +/* @end */ + + + +/* @group Source Code */ + +a.source-toggle { + font-size: 90%; +} + +a.source-toggle img { +} + +div.method-source-code { + background: #262626; + background: #F6F6F6; + color: #2f2f2f; + margin: 1em; + padding: 0.5em; + border: 1px dashed #999; + overflow: hidden; +} + +div.method-source-code pre { + background: inherit; + padding: 0; + color: #222; + overflow: hidden; +} + +/* @group Ruby keyword styles */ + +.standalone-code { background: #221111; color: #22dead; overflow: hidden; } + +.ruby-constant { color: #7fffd4; background: transparent; } +.ruby-keyword { color: #00ffff; background: transparent; } +.ruby-ivar { color: #eedd82; background: transparent; } +.ruby-operator { color: #00ffee; background: transparent; } +.ruby-identifier { color: #ffdead; background: transparent; } +.ruby-node { color: #ffa07a; background: transparent; } +.ruby-comment { color: #b22222; background: transparent; font-weight: bold;} +.ruby-regexp { color: #ffa07a; background: transparent; } +.ruby-value { color: #7fffd4; background: transparent; } + +.ruby-constant { color: #70004d; background: transparent; } +.ruby-keyword { color: #000000; background: transparent; font-weight: bold;} +.ruby-ivar { color: #11448e; background: transparent; } +.ruby-operator { color: #ff0022; background: transparent; } +.ruby-identifier { color: #00413d; background: transparent; } +.ruby-node { color: #001f71; background: transparent; } +.ruby-comment { color: #bbbbbb; background: transparent; } +.ruby-regexp { color: #001f71; background: transparent; } +.ruby-value { color: #70004d; background: transparent; } + +/* @end */ +/* @end */ + + +/* @group File Popup Contents */ + +.file #metadata, +.file-popup #metadata { +} + +.file-popup dl { + font-size: 80%; + padding: 0.75em; + background-color: #dedede; + color: #333; + border: 1px solid #bbb; + -moz-border-radius: 3px; + -webkit-border-radius: 3px; +} +.file dt { + font-weight: bold; + padding-left: 22px; + line-height: 20px; + background: url(images/page_white_width.png) no-repeat left top; +} +.file dt.modified-date { + background: url(images/date.png) no-repeat left top; +} +.file dt.requires { + background: url(images/plugin.png) no-repeat left top; +} +.file dt.scs-url { + background: url(images/wrench.png) no-repeat left top; +} + +.file dl dd { + margin: 0 0 1em 0; +} +.file #metadata dl dd ul { + list-style: circle; + margin-left: 20px; + padding-top: 0; +} +.file #metadata dl dd ul li { +} + + +.file h2 { + margin-top: 2em; + padding: 0.75em 0.5em; + background-color: #dedede; + color: #333; + font-size: 120%; + border: 1px solid #bbb; + -moz-border-radius: 3px; + -webkit-border-radius: 3px; +} + +/* @end */ + + + + +/* @group ThickBox Styles */ +#TB_window { + font: 12px Arial, Helvetica, sans-serif; + color: #333333; +} + +#TB_secondLine { + font: 10px Arial, Helvetica, sans-serif; + color:#666666; +} + +#TB_window a:link {color: #666666;} +#TB_window a:visited {color: #666666;} +#TB_window a:hover {color: #000;} +#TB_window a:active {color: #666666;} +#TB_window a:focus{color: #666666;} + +#TB_overlay { + position: fixed; + z-index:100; + top: 0px; + left: 0px; + height:100%; + width:100%; +} + +.TB_overlayMacFFBGHack {background: url(images/macFFBgHack.png) repeat;} +.TB_overlayBG { + background-color:#000; + filter:alpha(opacity=75); + -moz-opacity: 0.75; + opacity: 0.75; +} + +* html #TB_overlay { /* ie6 hack */ + position: absolute; + height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px'); +} + +#TB_window { + position: fixed; + background: #ffffff; + z-index: 102; + color:#000000; + display:none; + border: 4px solid #525252; + text-align:left; + top:50%; + left:50%; +} + +* html #TB_window { /* ie6 hack */ +position: absolute; +margin-top: expression(0 - parseInt(this.offsetHeight / 2) + (TBWindowMargin = document.documentElement && document.documentElement.scrollTop || document.body.scrollTop) + 'px'); +} + +#TB_window img#TB_Image { + display:block; + margin: 15px 0 0 15px; + border-right: 1px solid #ccc; + border-bottom: 1px solid #ccc; + border-top: 1px solid #666; + border-left: 1px solid #666; +} + +#TB_caption{ + height:25px; + padding:7px 30px 10px 25px; + float:left; +} + +#TB_closeWindow{ + height:25px; + padding:11px 25px 10px 0; + float:right; +} + +#TB_closeAjaxWindow{ + padding:7px 10px 5px 0; + margin-bottom:1px; + text-align:right; + float:right; +} + +#TB_ajaxWindowTitle{ + float:left; + padding:7px 0 5px 10px; + margin-bottom:1px; + font-size: 22px; +} + +#TB_title{ + background-color: #FF226C; + color: #dedede; + height:40px; +} +#TB_title a { + color: white !important; + border-bottom: 1px dotted #dedede; +} + +#TB_ajaxContent{ + clear:both; + padding:2px 15px 15px 15px; + overflow:auto; + text-align:left; + line-height:1.4em; +} + +#TB_ajaxContent.TB_modal{ + padding:15px; +} + +#TB_ajaxContent p{ + padding:5px 0px 5px 0px; +} + +#TB_load{ + position: fixed; + display:none; + height:13px; + width:208px; + z-index:103; + top: 50%; + left: 50%; + margin: -6px 0 0 -104px; /* -height/2 0 0 -width/2 */ +} + +* html #TB_load { /* ie6 hack */ +position: absolute; +margin-top: expression(0 - parseInt(this.offsetHeight / 2) + (TBWindowMargin = document.documentElement && document.documentElement.scrollTop || document.body.scrollTop) + 'px'); +} + +#TB_HideSelect{ + z-index:99; + position:fixed; + top: 0; + left: 0; + background-color:#fff; + border:none; + filter:alpha(opacity=0); + -moz-opacity: 0; + opacity: 0; + height:100%; + width:100%; +} + +* html #TB_HideSelect { /* ie6 hack */ + position: absolute; + height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px'); +} + +#TB_iframeContent{ + clear:both; + border:none; + margin-bottom:-1px; + margin-top:1px; + _margin-bottom:1px; +} + +/* @end */ + +/* @group Debugging Section */ + +#debugging-toggle { + text-align: center; +} +#debugging-toggle img { + cursor: pointer; +} + +#rdoc-debugging-section-dump { + display: none; + margin: 0 2em 2em; + background: #ccc; + border: 1px solid #999; +} + + + +/* @end */ diff --git a/ri/DNote/Notes/cdesc-Notes.yaml b/ri/DNote/Notes/cdesc-Notes.yaml new file mode 100644 index 0000000..dbb0d2c --- /dev/null +++ b/ri/DNote/Notes/cdesc-Notes.yaml @@ -0,0 +1,104 @@ +--- !ruby/object:RDoc::RI::ClassDescription +attributes: +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: "Labels to document. Defaults are: TODO, FIXME, OPTIMIZE and DEPRECATE." + name: labels + rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Paths to search. + name: paths + rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: [] + + name: title + rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Verbose + name: verbose + rw: RW +class_methods: +- !ruby/object:RDoc::RI::MethodSummary + name: new +comment: +- !ruby/struct:RDoc::Markup::Flow::H + level: 1 + text: Developer Notes +- !ruby/struct:RDoc::Markup::Flow::P + body: This class goes through you source files and compiles an list of any labeled comments. Labels are single word prefixes to a comment ending in a colon. +- !ruby/struct:RDoc::Markup::Flow::P + body: By default the labels supported are TODO, FIXME, OPTIMIZE and DEPRECATE. +- !ruby/struct:RDoc::Markup::Flow::P + body: Output is a set of files in XML and RDoc's simple markup format. +- !ruby/struct:RDoc::Markup::Flow::VERB + body: " TODO: Add ability to read header notes. They oftern\n have a outline format, rather then the single line.\n\n TODO: Need good CSS file.\n\n TODO: Need XSL?\n" +- !ruby/struct:RDoc::Markup::Flow::RULE + width: +- !ruby/struct:RDoc::Markup::Flow::H + level: 1 + text: Developer Notes +- !ruby/struct:RDoc::Markup::Flow::P + body: This class goes through you source files and compiles an list of any labeled comments. Labels are single word prefixes to a comment ending in a colon. +- !ruby/struct:RDoc::Markup::Flow::P + body: By default the labels supported are TODO, FIXME, OPTIMIZE and DEPRECATE. +- !ruby/struct:RDoc::Markup::Flow::P + body: Output is a set of files in XML and RDoc's simple markup format. +- !ruby/struct:RDoc::Markup::Flow::VERB + body: " TODO: Add ability to read header notes. They oftern\n have a outline format, rather then the single line.\n\n TODO: Need good CSS file.\n\n TODO: Need XSL?\n" +constants: +- !ruby/object:RDoc::RI::Constant + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Default note labels to look for in source code. + name: DEFAULT_LABELS + value: "['TODO', 'FIXME', 'OPTIMIZE', 'DEPRECATE']" +- !ruby/object:RDoc::RI::Constant + comment: + name: HTML_CSS + value: "<<-HERE body { margin: 0; padding: 0; } .main { width: 800px; margin: 0 auto; border: 1px solid #ccc; padding: 0 20px 20px 20px; } h1 { margin: 25px 0; } h2,h3,h4 { margin: 5px 0; padding: 0; color: 880044; } h3 { color: 004488; } h4 { color: 888844; } ul { margin: 0; padding: 0; text-align: left; } li { margin: 0; padding: 0; text-align: left; } HERE" +full_name: DNote::Notes +includes: [] + +instance_methods: +- !ruby/object:RDoc::RI::MethodSummary + name: counts +- !ruby/object:RDoc::RI::MethodSummary + name: display +- !ruby/object:RDoc::RI::MethodSummary + name: fu +- !ruby/object:RDoc::RI::MethodSummary + name: initialize_defaults +- !ruby/object:RDoc::RI::MethodSummary + name: labels= +- !ruby/object:RDoc::RI::MethodSummary + name: noharm? +- !ruby/object:RDoc::RI::MethodSummary + name: notes +- !ruby/object:RDoc::RI::MethodSummary + name: organize +- !ruby/object:RDoc::RI::MethodSummary + name: parse +- !ruby/object:RDoc::RI::MethodSummary + name: to_html +- !ruby/object:RDoc::RI::MethodSummary + name: to_json +- !ruby/object:RDoc::RI::MethodSummary + name: to_markdown +- !ruby/object:RDoc::RI::MethodSummary + name: to_rdoc +- !ruby/object:RDoc::RI::MethodSummary + name: to_xml +- !ruby/object:RDoc::RI::MethodSummary + name: to_yaml +- !ruby/object:RDoc::RI::MethodSummary + name: verbose? +- !ruby/object:RDoc::RI::MethodSummary + name: write +name: Notes +superclass: Object diff --git a/ri/DNote/Notes/counts-i.yaml b/ri/DNote/Notes/counts-i.yaml new file mode 100644 index 0000000..ef9150c --- /dev/null +++ b/ri/DNote/Notes/counts-i.yaml @@ -0,0 +1,11 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: [] + +full_name: DNote::Notes#counts +is_singleton: false +name: counts +params: () +visibility: public diff --git a/ri/DNote/Notes/display-i.yaml b/ri/DNote/Notes/display-i.yaml new file mode 100644 index 0000000..a77ee75 --- /dev/null +++ b/ri/DNote/Notes/display-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Scans source code for developer notes and writes them to well organized files. +full_name: DNote::Notes#display +is_singleton: false +name: display +params: (format) +visibility: public diff --git a/ri/DNote/Notes/fu-i.yaml b/ri/DNote/Notes/fu-i.yaml new file mode 100644 index 0000000..478dd74 --- /dev/null +++ b/ri/DNote/Notes/fu-i.yaml @@ -0,0 +1,11 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: [] + +full_name: DNote::Notes#fu +is_singleton: false +name: fu +params: () +visibility: public diff --git a/ri/DNote/Notes/initialize_defaults-i.yaml b/ri/DNote/Notes/initialize_defaults-i.yaml new file mode 100644 index 0000000..d2362d9 --- /dev/null +++ b/ri/DNote/Notes/initialize_defaults-i.yaml @@ -0,0 +1,11 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: [] + +full_name: DNote::Notes#initialize_defaults +is_singleton: false +name: initialize_defaults +params: () +visibility: public diff --git a/ri/DNote/Notes/labels%3d-i.yaml b/ri/DNote/Notes/labels%3d-i.yaml new file mode 100644 index 0000000..628fa3e --- /dev/null +++ b/ri/DNote/Notes/labels%3d-i.yaml @@ -0,0 +1,11 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: [] + +full_name: DNote::Notes#labels= +is_singleton: false +name: labels= +params: (labels) +visibility: public diff --git a/ri/DNote/Notes/new-c.yaml b/ri/DNote/Notes/new-c.yaml new file mode 100644 index 0000000..6096cdd --- /dev/null +++ b/ri/DNote/Notes/new-c.yaml @@ -0,0 +1,11 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: [] + +full_name: DNote::Notes::new +is_singleton: true +name: new +params: (paths, options={}) +visibility: public diff --git a/ri/DNote/Notes/noharm%3f-i.yaml b/ri/DNote/Notes/noharm%3f-i.yaml new file mode 100644 index 0000000..eae62d9 --- /dev/null +++ b/ri/DNote/Notes/noharm%3f-i.yaml @@ -0,0 +1,11 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: [] + +full_name: DNote::Notes#noharm? +is_singleton: false +name: noharm? +params: () +visibility: public diff --git a/ri/DNote/Notes/notes-i.yaml b/ri/DNote/Notes/notes-i.yaml new file mode 100644 index 0000000..e056b55 --- /dev/null +++ b/ri/DNote/Notes/notes-i.yaml @@ -0,0 +1,11 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: [] + +full_name: DNote::Notes#notes +is_singleton: false +name: notes +params: () +visibility: public diff --git a/ri/DNote/Notes/organize-i.yaml b/ri/DNote/Notes/organize-i.yaml new file mode 100644 index 0000000..b37a7fe --- /dev/null +++ b/ri/DNote/Notes/organize-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Organize records in heirarchical form. +full_name: DNote::Notes#organize +is_singleton: false +name: organize +params: (records) +visibility: public diff --git a/ri/DNote/Notes/parse-i.yaml b/ri/DNote/Notes/parse-i.yaml new file mode 100644 index 0000000..3c5548b --- /dev/null +++ b/ri/DNote/Notes/parse-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Gather and count notes. This returns two elements, a hash in the form of label=>notes and a counts hash. +full_name: DNote::Notes#parse +is_singleton: false +name: parse +params: () +visibility: public diff --git a/ri/DNote/Notes/to_html-i.yaml b/ri/DNote/Notes/to_html-i.yaml new file mode 100644 index 0000000..ebedeac --- /dev/null +++ b/ri/DNote/Notes/to_html-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: HTML format. +full_name: DNote::Notes#to_html +is_singleton: false +name: to_html +params: () +visibility: public diff --git a/ri/DNote/Notes/to_json-i.yaml b/ri/DNote/Notes/to_json-i.yaml new file mode 100644 index 0000000..3119c70 --- /dev/null +++ b/ri/DNote/Notes/to_json-i.yaml @@ -0,0 +1,11 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: [] + +full_name: DNote::Notes#to_json +is_singleton: false +name: to_json +params: () +visibility: public diff --git a/ri/DNote/Notes/to_markdown-i.yaml b/ri/DNote/Notes/to_markdown-i.yaml new file mode 100644 index 0000000..1248ee1 --- /dev/null +++ b/ri/DNote/Notes/to_markdown-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Format notes in RDoc format. +full_name: DNote::Notes#to_markdown +is_singleton: false +name: to_markdown +params: () +visibility: public diff --git a/ri/DNote/Notes/to_rdoc-i.yaml b/ri/DNote/Notes/to_rdoc-i.yaml new file mode 100644 index 0000000..e35dbb6 --- /dev/null +++ b/ri/DNote/Notes/to_rdoc-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Format notes in RDoc format. +full_name: DNote::Notes#to_rdoc +is_singleton: false +name: to_rdoc +params: () +visibility: public diff --git a/ri/DNote/Notes/to_xml-i.yaml b/ri/DNote/Notes/to_xml-i.yaml new file mode 100644 index 0000000..0e992cd --- /dev/null +++ b/ri/DNote/Notes/to_xml-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Format notes in XML format. +full_name: DNote::Notes#to_xml +is_singleton: false +name: to_xml +params: () +visibility: public diff --git a/ri/DNote/Notes/to_yaml-i.yaml b/ri/DNote/Notes/to_yaml-i.yaml new file mode 100644 index 0000000..3433d37 --- /dev/null +++ b/ri/DNote/Notes/to_yaml-i.yaml @@ -0,0 +1,11 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: [] + +full_name: DNote::Notes#to_yaml +is_singleton: false +name: to_yaml +params: () +visibility: public diff --git a/ri/DNote/Notes/verbose%3f-i.yaml b/ri/DNote/Notes/verbose%3f-i.yaml new file mode 100644 index 0000000..3bd41e4 --- /dev/null +++ b/ri/DNote/Notes/verbose%3f-i.yaml @@ -0,0 +1,11 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: [] + +full_name: DNote::Notes#verbose? +is_singleton: false +name: verbose? +params: () +visibility: public diff --git a/ri/DNote/Notes/write-i.yaml b/ri/DNote/Notes/write-i.yaml new file mode 100644 index 0000000..042e948 --- /dev/null +++ b/ri/DNote/Notes/write-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Save notes. +full_name: DNote::Notes#write +is_singleton: false +name: write +params: (text, format) +visibility: public diff --git a/ri/DNote/cdesc-DNote.yaml b/ri/DNote/cdesc-DNote.yaml new file mode 100644 index 0000000..e099190 --- /dev/null +++ b/ri/DNote/cdesc-DNote.yaml @@ -0,0 +1,22 @@ +--- !ruby/object:RDoc::RI::ModuleDescription +attributes: [] + +class_methods: +- !ruby/object:RDoc::RI::MethodSummary + name: new +- !ruby/object:RDoc::RI::MethodSummary + name: run +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: require 'reap/project/scm' +constants: +- !ruby/object:RDoc::RI::Constant + comment: + name: VERSION + value: "\"0.9\"" +full_name: DNote +includes: [] + +instance_methods: [] + +name: DNote diff --git a/ri/DNote/new-c.yaml b/ri/DNote/new-c.yaml new file mode 100644 index 0000000..12d6ff3 --- /dev/null +++ b/ri/DNote/new-c.yaml @@ -0,0 +1,10 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +full_name: DNote::new +is_singleton: true +name: new +params: (*args) +visibility: public diff --git a/ri/DNote/run-c.yaml b/ri/DNote/run-c.yaml new file mode 100644 index 0000000..b5b39b5 --- /dev/null +++ b/ri/DNote/run-c.yaml @@ -0,0 +1,10 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +full_name: DNote::run +is_singleton: true +name: run +params: () +visibility: public diff --git a/ri/Syckle/Plugins/DNote/cdesc-DNote.yaml b/ri/Syckle/Plugins/DNote/cdesc-DNote.yaml new file mode 100644 index 0000000..3ac45fc --- /dev/null +++ b/ri/Syckle/Plugins/DNote/cdesc-DNote.yaml @@ -0,0 +1,79 @@ +--- !ruby/object:RDoc::RI::ClassDescription +attributes: +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Paths to search. + name: files + rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: "Labels to document. Defaults are: TODO, FIXME, OPTIMIZE and DEPRECATE." + name: labels + rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Directory to save output. Defaults to standard log directory. + name: output + rw: RW +class_methods: [] + +comment: +- !ruby/struct:RDoc::Markup::Flow::H + level: 1 + text: Developmer's Notes Plugin +- !ruby/struct:RDoc::Markup::Flow::P + body: "This plugin goes through you source files and compiles an lit of any labeled comments. Labels are single word prefixes to a comment ending in a colon. For example, you might note somewhere in your code:" +- !ruby/struct:RDoc::Markup::Flow::P + body: By default this label supports the TODO, FIXME, OPTIMIZE and DEPRECATE. +- !ruby/struct:RDoc::Markup::Flow::P + body: Output is a set of files in HTML, XML and RDoc's simple markup format. This plugin can run automatically if there is a notes/ directory in the project's log directory. +- !ruby/struct:RDoc::Markup::Flow::RULE + width: +- !ruby/struct:RDoc::Markup::Flow::H + level: 1 + text: Developmer's Notes Plugin +- !ruby/struct:RDoc::Markup::Flow::P + body: "This plugin goes through you source files and compiles an lit of any labeled comments. Labels are single word prefixes to a comment ending in a colon. For example, you might note somewhere in your code:" +- !ruby/struct:RDoc::Markup::Flow::P + body: By default this label supports the TODO, FIXME, OPTIMIZE and DEPRECATE. +- !ruby/struct:RDoc::Markup::Flow::P + body: Output is a set of files in HTML, XML and RDoc's simple markup format. This plugin can run automatically if there is a notes/ directory in the project's log directory. +- !ruby/struct:RDoc::Markup::Flow::RULE + width: +- !ruby/struct:RDoc::Markup::Flow::H + level: 1 + text: Developmer's Notes Plugin +- !ruby/struct:RDoc::Markup::Flow::P + body: "This plugin goes through you source files and compiles an lit of any labeled comments. Labels are single word prefixes to a comment ending in a colon. For example, you might note somewhere in your code:" +- !ruby/struct:RDoc::Markup::Flow::P + body: By default this label supports the TODO, FIXME, OPTIMIZE and DEPRECATE. +- !ruby/struct:RDoc::Markup::Flow::P + body: Output is a set of files in HTML, XML and RDoc's simple markup format. This plugin can run automatically if there is a notes/ directory in the project's log directory. +constants: +- !ruby/object:RDoc::RI::Constant + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Default note labels to looked for in source code. + name: DEFAULT_LABELS + value: "['TODO', 'FIXME', 'OPTIMIZE', 'DEPRECATE']" +full_name: Syckle::Plugins::DNote +includes: [] + +instance_methods: +- !ruby/object:RDoc::RI::MethodSummary + name: clean +- !ruby/object:RDoc::RI::MethodSummary + name: dnote +- !ruby/object:RDoc::RI::MethodSummary + name: document +- !ruby/object:RDoc::RI::MethodSummary + name: initialize_defaults +- !ruby/object:RDoc::RI::MethodSummary + name: output= +- !ruby/object:RDoc::RI::MethodSummary + name: reset +name: DNote +superclass: Service diff --git a/ri/Syckle/Plugins/DNote/clean-i.yaml b/ri/Syckle/Plugins/DNote/clean-i.yaml new file mode 100644 index 0000000..d362b8f --- /dev/null +++ b/ri/Syckle/Plugins/DNote/clean-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Remove notes directory. +full_name: Syckle::Plugins::DNote#clean +is_singleton: false +name: clean +params: () +visibility: public diff --git a/ri/Syckle/Plugins/DNote/dnote-i.yaml b/ri/Syckle/Plugins/DNote/dnote-i.yaml new file mode 100644 index 0000000..30d594d --- /dev/null +++ b/ri/Syckle/Plugins/DNote/dnote-i.yaml @@ -0,0 +1,11 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: [] + +full_name: Syckle::Plugins::DNote#dnote +is_singleton: false +name: dnote +params: () +visibility: public diff --git a/ri/Syckle/Plugins/DNote/document-i.yaml b/ri/Syckle/Plugins/DNote/document-i.yaml new file mode 100644 index 0000000..5153243 --- /dev/null +++ b/ri/Syckle/Plugins/DNote/document-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Generate notes documents. +full_name: Syckle::Plugins::DNote#document +is_singleton: false +name: document +params: () +visibility: public diff --git a/ri/Syckle/Plugins/DNote/initialize_defaults-i.yaml b/ri/Syckle/Plugins/DNote/initialize_defaults-i.yaml new file mode 100644 index 0000000..ac0df93 --- /dev/null +++ b/ri/Syckle/Plugins/DNote/initialize_defaults-i.yaml @@ -0,0 +1,11 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: [] + +full_name: Syckle::Plugins::DNote#initialize_defaults +is_singleton: false +name: initialize_defaults +params: () +visibility: private diff --git a/ri/Syckle/Plugins/DNote/output%3d-i.yaml b/ri/Syckle/Plugins/DNote/output%3d-i.yaml new file mode 100644 index 0000000..d2ba05f --- /dev/null +++ b/ri/Syckle/Plugins/DNote/output%3d-i.yaml @@ -0,0 +1,14 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::VERB + body: " Formats (xml, html, rdoc).\n" +- !ruby/struct:RDoc::Markup::Flow::P + body: attr_accessor :formats +full_name: Syckle::Plugins::DNote#output= +is_singleton: false +name: output= +params: (path) +visibility: public diff --git a/ri/Syckle/Plugins/DNote/reset-i.yaml b/ri/Syckle/Plugins/DNote/reset-i.yaml new file mode 100644 index 0000000..d43f092 --- /dev/null +++ b/ri/Syckle/Plugins/DNote/reset-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Mark notes documents as out-of-date. +full_name: Syckle::Plugins::DNote#reset +is_singleton: false +name: reset +params: () +visibility: public diff --git a/ri/Syckle/Plugins/cdesc-Plugins.yaml b/ri/Syckle/Plugins/cdesc-Plugins.yaml new file mode 100644 index 0000000..afe9576 --- /dev/null +++ b/ri/Syckle/Plugins/cdesc-Plugins.yaml @@ -0,0 +1,14 @@ +--- !ruby/object:RDoc::RI::ModuleDescription +attributes: [] + +class_methods: [] + +comment: +constants: [] + +full_name: Syckle::Plugins +includes: [] + +instance_methods: [] + +name: Plugins diff --git a/ri/Syckle/cdesc-Syckle.yaml b/ri/Syckle/cdesc-Syckle.yaml new file mode 100644 index 0000000..093189b --- /dev/null +++ b/ri/Syckle/cdesc-Syckle.yaml @@ -0,0 +1,14 @@ +--- !ruby/object:RDoc::RI::ModuleDescription +attributes: [] + +class_methods: [] + +comment: +constants: [] + +full_name: Syckle +includes: [] + +instance_methods: [] + +name: Syckle diff --git a/ri/created.rid b/ri/created.rid new file mode 100644 index 0000000..a76c3bc --- /dev/null +++ b/ri/created.rid @@ -0,0 +1 @@ +Fri, 23 Oct 2009 21:03:17 -0400 From 775e2ae1f692afbd32251e7b978d1a57e5e6229c Mon Sep 17 00:00:00 2001 From: 7rans Date: Sat, 24 Oct 2009 01:05:46 -0400 Subject: [PATCH 02/27] Updated files. --- rdoc/DNote.html | 26 +- rdoc/DNote/Notes.html | 356 ++++----- rdoc/DNote/Site.html | 673 ++++++++++++++++++ rdoc/LICENSE.html | 10 +- rdoc/README_rdoc.html | 79 +- rdoc/Syckle.html | 10 +- rdoc/Syckle/Plugins.html | 10 +- rdoc/Syckle/Plugins/DNote.html | 102 +-- rdoc/created.rid | 2 +- rdoc/index.html | 251 ++++--- rdoc/lib/dnote/command_rb.html | 2 +- rdoc/lib/dnote/notes_rb.html | 2 +- rdoc/lib/dnote/site_rb.html | 54 ++ rdoc/plug/syckle/services/dnote_rb.html | 4 +- ri/DNote/Notes/cdesc-Notes.yaml | 18 +- ri/DNote/Notes/to-i.yaml | 11 + ri/DNote/Notes/to_html_list-i.yaml | 11 + ri/DNote/Site/__DIR__-i.yaml | 10 + ri/DNote/Site/cdesc-Site.yaml | 67 ++ ri/DNote/Site/clean-i.yaml | 12 + .../noharm%3f-i.yaml => Site/document-i.yaml} | 4 +- ri/DNote/{Notes => Site}/fu-i.yaml | 2 +- ri/DNote/Site/initialize_defaults-i.yaml | 11 + ri/DNote/Site/new-c.yaml | 10 + ri/DNote/Site/output%3d-i.yaml | 11 + ri/DNote/Site/reset-i.yaml | 12 + .../templates-i.yaml} | 4 +- ri/DNote/{Notes => Site}/write-i.yaml | 6 +- ri/DNote/cdesc-DNote.yaml | 2 - ri/Syckle/Plugins/DNote/cdesc-DNote.yaml | 8 +- .../Plugins/DNote/initialize_defaults-i.yaml | 5 +- ri/Syckle/Plugins/DNote/output%3d-i.yaml | 7 +- ri/created.rid | 2 +- 33 files changed, 1349 insertions(+), 445 deletions(-) create mode 100644 rdoc/DNote/Site.html create mode 100644 rdoc/lib/dnote/site_rb.html create mode 100644 ri/DNote/Notes/to-i.yaml create mode 100644 ri/DNote/Notes/to_html_list-i.yaml create mode 100644 ri/DNote/Site/__DIR__-i.yaml create mode 100644 ri/DNote/Site/cdesc-Site.yaml create mode 100644 ri/DNote/Site/clean-i.yaml rename ri/DNote/{Notes/noharm%3f-i.yaml => Site/document-i.yaml} (74%) rename ri/DNote/{Notes => Site}/fu-i.yaml (84%) create mode 100644 ri/DNote/Site/initialize_defaults-i.yaml create mode 100644 ri/DNote/Site/new-c.yaml create mode 100644 ri/DNote/Site/output%3d-i.yaml create mode 100644 ri/DNote/Site/reset-i.yaml rename ri/DNote/{Notes/verbose%3f-i.yaml => Site/templates-i.yaml} (73%) rename ri/DNote/{Notes => Site}/write-i.yaml (68%) diff --git a/rdoc/DNote.html b/rdoc/DNote.html index a58db0f..c8e436b 100644 --- a/rdoc/DNote.html +++ b/rdoc/DNote.html @@ -46,6 +46,9 @@

In Files

  • lib/dnote/command.rb
  • +
  • lib/dnote/site.rb
  • +
  • lib/dnote/notes.rb
  • @@ -71,6 +74,8 @@

    Namespace

  • DNote::Notes
  • +
  • DNote::Site
  • +
    @@ -124,16 +129,18 @@

    Class Index @@ -154,10 +161,7 @@

    Class Index

    DNote

    -

    -require ‘reap/project/scm‘ -

    - + @@ -291,9 +295,9 @@

    Public Class Methods

    opt.separator(" ") opt.separator("STANDARD OPTIONS:") - opt.on("--verbose", "-v", "extra verbose output") do - options[:verbose] = true - end + #opt.on("--verbose", "-v", "extra verbose output") do + # options[:verbose] = true + #end opt.on("--debug", "debug mode") do $DEBUG = true diff --git a/rdoc/DNote/Notes.html b/rdoc/DNote/Notes.html index ddca5f2..c9fa733 100644 --- a/rdoc/DNote/Notes.html +++ b/rdoc/DNote/Notes.html @@ -75,41 +75,37 @@

    Parent

    Methods

    @@ -150,16 +146,18 @@

    Class Index @@ -246,25 +244,6 @@

    Attributes

    -
    - - - - -
    - verbose[RW] -
    - -
    - -

    -Verbose -

    - -
    -
    -
    @@ -313,7 +292,7 @@

    Public Class Methods

    - +
    @@ -332,27 +311,13 @@

    Public Class Methods

    -# File lib/dnote/notes.rb, line 57
    +# File lib/dnote/notes.rb, line 40
         def initialize(paths, options={})
           initialize_defaults
    -
    -      if paths.empty?
    -        #if file = File.exist?('meta/loadpath')
    -        #  paths = YAML.load(File.new(file)).to_list
    -        #  paths = Array === paths ? paths : paths.split(/\s+/)
    -        #elsif file = File.exist?('lib')
    -        #  paths = ['lib']
    -        #else
    -          paths = ['**/*.rb']
    -        #end
    -      end
    -
    -      @paths = paths
    -
           options.each do |k, v|
             __send__("#{k}=", v)
           end
    -
    +      #@paths = ['**/*.rb'] if @paths.empty?
           parse
         end
    @@ -370,7 +335,7 @@

    Public Instance Methods

    - +
    @@ -389,7 +354,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 101
    +# File lib/dnote/notes.rb, line 63
         def counts
           @counts
         end
    @@ -402,7 +367,7 @@

    Public Instance Methods

    - +
    @@ -424,7 +389,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 113
    +# File lib/dnote/notes.rb, line 70
         def display(format)
           #paths    = self.paths
           #output   = self.output
    @@ -476,50 +441,8 @@ 

    Public Instance Methods

    -
    - - -
    - - fu() - click to toggle source - -
    - -
    - - - - - -
    -
    -# File lib/dnote/notes.rb, line 383
    -    def fu
    -      @fu ||= (
    -        if noop? and verbose?
    -          FileUtils::DryRun
    -        elsif noop
    -          FileUtils::Noop
    -        elsif verbose
    -          FileUtils::Verbose
    -        else
    -          FileUtils
    -        end
    -      )
    -    end
    -
    - -
    - - -
    - -
    - +
    @@ -538,11 +461,10 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 81
    +# File lib/dnote/notes.rb, line 50
         def initialize_defaults
    -      @paths    = ["lib"]
    -      #@output   = DEFAULT_OUTPUT
           @labels   = DEFAULT_LABELS
    +      @paths    = ["**/*.rb"]
           @title    = "Developer's Notes"
           @format   = "rdoc"
         end
    @@ -555,7 +477,7 @@

    Public Instance Methods

    - +
    @@ -574,7 +496,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 174
    +# File lib/dnote/notes.rb, line 115
         def labels=(labels)
           @labels = (
             case labels
    @@ -593,38 +515,8 @@ 

    Public Instance Methods

    -
    - - -
    - - noharm?() - click to toggle source - -
    - -
    - - - - - -
    -
    -# File lib/dnote/notes.rb, line 90
    -    def noharm?  ; @noharm  ; end
    -
    - -
    - - -
    - -
    - +
    @@ -643,7 +535,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 96
    +# File lib/dnote/notes.rb, line 58
         def notes
           @notes
         end
    @@ -656,7 +548,7 @@

    Public Instance Methods

    - +
    @@ -677,7 +569,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 244
    +# File lib/dnote/notes.rb, line 177
         def organize(records)
           orecs = {}
           records.each do |record|
    @@ -700,7 +592,7 @@ 

    Public Instance Methods

    - +
    @@ -722,9 +614,8 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 194
    +# File lib/dnote/notes.rb, line 128
         def parse
    -      #
           files = self.paths.map do |path|
             if File.directory?(path)
               Dir.glob(File.join(path, '**/*'))
    @@ -778,8 +669,40 @@ 

    Public Instance Methods

    +
    + + +
    + + to(format) + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/dnote/notes.rb, line 192
    +    def to(format)
    +      __send__("to_#{format}")
    +    end
    +
    + +
    + + +
    + +
    - +
    @@ -800,7 +723,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 323
    +# File lib/dnote/notes.rb, line 256
         def to_html
           html = []
           html << %[<html>]
    @@ -813,6 +736,43 @@ 

    Public Instance Methods

    html << %[<body>] html << %[<div class="main">] html << %[<h1><%= title %></h1>] + html << to_html_list + html << %[</div>] + html << %[</boby>] + html << %[</html>] + html.join("\n") + end
    +
    + +
    + + +
    + + +
    + + +
    + + to_html_list() + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/dnote/notes.rb, line 276
    +    def to_html_list
    +      html = []
           html << %[<div class="notes">]
           notes.each do |label, per_file|
             html << %[<h2>#{label}</h2>]
    @@ -829,9 +789,6 @@ 

    Public Instance Methods

    html << %[</ol>] end html << %[</div>] - html << %[</div>] - html << %[</boby>] - html << %[</html>] html.join("\n") end
    @@ -843,7 +800,7 @@

    Public Instance Methods

    - +
    @@ -862,7 +819,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 364
    +# File lib/dnote/notes.rb, line 304
         def to_json
           require 'json'
           notes.to_json
    @@ -876,7 +833,7 @@ 

    Public Instance Methods

    - +
    @@ -897,7 +854,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 283
    +# File lib/dnote/notes.rb, line 216
         def to_markdown
           out = []
           out << "# Development Notes"
    @@ -922,7 +879,7 @@ 

    Public Instance Methods

    - +
    @@ -943,7 +900,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 265
    +# File lib/dnote/notes.rb, line 198
         def to_rdoc
           out = []
           out << "= Development Notes"
    @@ -968,7 +925,7 @@ 

    Public Instance Methods

    - +
    @@ -989,7 +946,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 301
    +# File lib/dnote/notes.rb, line 234
         def to_xml
           xml = []
           xml << "<notes>"
    @@ -1018,7 +975,7 @@ 

    Public Instance Methods

    - +
    @@ -1037,7 +994,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 358
    +# File lib/dnote/notes.rb, line 298
         def to_yaml
           require 'yaml'
           notes.to_yaml
    @@ -1050,77 +1007,6 @@ 

    Public Instance Methods

    -
    - - -
    - - verbose?() - click to toggle source - -
    - -
    - - - - - -
    -
    -# File lib/dnote/notes.rb, line 93
    -    def verbose? ; @verbose ; end
    -
    - -
    - - -
    - - -
    - - -
    - - write(text, format) - click to toggle source - -
    - -
    - -

    -Save notes. -

    - - - -
    -
    -# File lib/dnote/notes.rb, line 371
    -    def write(text, format)
    -      if output.directory?
    -        file = output + "notes.#{format}"
    -      else
    -        file = Pathname.new(output)
    -      end
    -      fu.mkdir_p(file.parent)
    -      File.open(file, 'w') { |f| f << text } unless noharm?
    -      file
    -    end
    -
    - -
    - - -
    - -
    diff --git a/rdoc/DNote/Site.html b/rdoc/DNote/Site.html new file mode 100644 index 0000000..f4f435c --- /dev/null +++ b/rdoc/DNote/Site.html @@ -0,0 +1,673 @@ + + + + + + + + Class: DNote::Site + + + + + + + + + + + + + + + +
    +

    + +   + + D'Note  + DNote::Site +

    +
    + +
    +
    + +
    +

    In Files

    +
    + +
    +
    + + + + +
    + +
    + + + +
    +

    Parent

    +
      + +
    • Object
    • + +
    +
    + + + + + + + +
    +

    Methods

    + +
    + + + + +
    + +
    + + +
    +

    Files

    + +
    + + +
    +

    Class Index + [+]

    +
    +
    + Quicksearch + +
    +
    + + + + +
    + + +
    + +
    + Generated with Razzle Dazzle Redfish

    + [Validate] +
    +
    + +
    + +
    + +

    Site

    + + +

    +Site class is used to build a “pretty” +output set. The template files are saved to the output directory. +Additional formats can be saved the the directory as well. +

    + +
    + + + +
    +

    Constants

    +
    + +
    DEFAULT_OUTPUT
    + +

    +Default output directory is dnote/. +

    + + +
    +
    + + + + +
    +

    Attributes

    + + +
    + + + + +
    + title[RW] +
    + +
    + +

    +Title to use in any headers. +

    + +
    +
    + +
    + + + + +
    + output[RW] +
    + +
    + +

    +Directory to save output. +

    + +
    +
    + +
    + + + + +
    + formats[RW] +
    + +
    + +

    +Additional Formats to supply besided the html (xml, rdoc, markdown, etc.) +

    + +
    +
    + +
    + + +
    + notes[R] +
    + +
    + +

    +Notes object. +

    + +
    +
    + +
    + + + + +
    +

    Public Class Methods

    + + +
    + + +
    + + new(paths, options) + click to toggle source + +
    + +
    + +

    (Not documented)

    + + + +
    +
    +# File lib/dnote/site.rb, line 27
    +    def initialize(paths, options)
    +      self.title   = options[:title]
    +
    +      self.output  = options.delete(:output)
    +      self.formats = options.delete(:formats)
    +
    +      @notes = Notes.new(paths, options)
    +    end
    +
    + +
    + + +
    + + +
    + +
    +

    Public Instance Methods

    + + +
    + + +
    + + __DIR__() + click to toggle source + +
    + +
    + +

    (Not documented)

    + + + +
    +
    +# File lib/dnote/site.rb, line 102
    +    def __DIR__
    +      File.dirname(__FILE__)
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + clean() + click to toggle source + +
    + +
    + +

    +Remove output directory. +

    + + + +
    +
    +# File lib/dnote/site.rb, line 80
    +    def clean
    +      if File.directory?(output)
    +        fu.rm_r(output)
    +        puts "removed #{output}"
    +      end
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + document() + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/dnote/site.rb, line 50
    +    def document
    +      fu.mkdir_p(output)
    +
    +      # copy the whole template directory over
    +      fu.cp_r("#{__DIR__}/template/", "#{output}/")
    +
    +      # (re)write the erb templates
    +      templates.each do |temp|
    +        erb  = ERB.new(File.read(temp))
    +        text = erb.result(binding)
    +        file = File.basename(temp)
    +        write(file, text)
    +      end
    +
    +      # produce requested additional formats
    +      formats.each do |format|
    +        text = notes.to(format)
    +        write("notes.#{format}", text)
    +      end
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + fu() + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/dnote/site.rb, line 107
    +    def fu
    +      @fu ||= (
    +        if $NOOP and $DEBUG
    +          FileUtils::DryRun
    +        elsif $NOOP
    +          FileUtils::Noop
    +        elsif $DEBUG
    +          FileUtils::Verbose
    +        else
    +          FileUtils
    +        end
    +      )
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + initialize_defaults() + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/dnote/site.rb, line 37
    +    def initialize_defaults
    +      @output   = DEFAULT_OUTPUT
    +      @title    = "Development Notes"
    +      @formats  = []
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + output=(path) + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/dnote/site.rb, line 44
    +    def output=(path)
    +      raise "output cannot be root" if File.expand_path(path) == "/"
    +      @output = Pathname.new(path)
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + reset() + click to toggle source + +
    + +
    + +

    +Reset output directory, marking it as out-of-date. +

    + + + +
    +
    +# File lib/dnote/site.rb, line 72
    +    def reset
    +      if File.directory?(output)
    +        File.utime(0,0,output) unless $NOOP
    +        puts "marked #{output}"
    +      end
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + templates() + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/dnote/site.rb, line 88
    +    def templates
    +      @templates ||= (
    +        Dir[File.join(File.dirname(__FILE__), 'template/*')].select{ |f| File.file?(f) }
    +      )
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + write(fname, text) + click to toggle source + +
    + +
    + +

    +Save file to output. +

    + + + +
    +
    +# File lib/dnote/site.rb, line 96
    +    def write(fname, text)
    +      file = output + fname
    +      fu.mkdir_p(file.parent)
    +      File.open(file, 'w') { |f| f << text } unless $NOOP
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + +
    + +

    Disabled; run with --debug to generate this.

    + +
    + + + diff --git a/rdoc/LICENSE.html b/rdoc/LICENSE.html index ee3a9a6..85d67b4 100644 --- a/rdoc/LICENSE.html +++ b/rdoc/LICENSE.html @@ -60,16 +60,18 @@

    Class Index

    diff --git a/rdoc/README_rdoc.html b/rdoc/README_rdoc.html index 84519ce..f45a8c8 100644 --- a/rdoc/README_rdoc.html +++ b/rdoc/README_rdoc.html @@ -60,16 +60,18 @@

    Class Index

    @@ -86,54 +88,79 @@

    Class Index

    D’Note

    DESCRIPTION

    -Extract developement notes from source code and make some pretty RDoc -and/or HTML formatted files out of them. +Extract developement notes from source code and generate some nice output +formats for them.

    SYNOPSIS

    -Developer notes it the source code must be formate as follows: +Developer notes it the source code must be formatted as follows:

    -  # TYPE: description ...
    -  #       ... cont ...
    +  # LABEL: description ...
     

    -All notes must be separated by a blank line. Eg. +Any description that takes up more than one line must remain flush to the +left margin (if the first line is flush to the left margin too) b/c RDoc +will mistake of formatting the remaining lines as a pre block it +if is not. So…

    -  # TYPE: description ...
    -  #
    -  # TYPE: description ...
    +  # LABEL: ... description ...
    +  # continue ...
     

    -Without the blank line the second note will be taken to be part of the -first. Any description that takes up more than one line must remain flush -to the left margin (if the first line is flush to the left margin too) b/c -RDoc will mistake of formatting the remaining lines as a pre block -it if is not. So… +All consecutive notes must be separated by a blank lines.

    -  # TYPE: ... description ...
    -  # continue ...
    +  # LABEL: description ...
    +  #
    +  # LABEL: description ...
     

    -Alternately the whole note can be a pre block by indenting them. -Then the layout if freed-up. +Without the blank line the second note will be taken to be part of the +first. +

    +

    +Alternately the whole note can be made a pre block by indention. +Then the layout if freed-form.

       # This is a description of something...
       #
    -  #   TYPE: description ...
    -  #         continued ...
    +  #   LABEL: description ...
    +  #          continued ...
    +
    +

    +With properly formatted notes, we then use the dnote command line +tool. +

    +
    +  $ dnote
    +
    +

    +And lo! Pretty output. See dnote --help for more options. +

    +

    INSTALLATION

    +

    +The usual RubyGem’s command: +

    +
    +  $ sudo gem install dnote
     

    COPYRIGHTS

    diff --git a/rdoc/Syckle.html b/rdoc/Syckle.html index 7916205..61105ac 100644 --- a/rdoc/Syckle.html +++ b/rdoc/Syckle.html @@ -104,16 +104,18 @@

    Class Index

    diff --git a/rdoc/Syckle/Plugins.html b/rdoc/Syckle/Plugins.html index 2e5433b..8946f04 100644 --- a/rdoc/Syckle/Plugins.html +++ b/rdoc/Syckle/Plugins.html @@ -107,16 +107,18 @@

    Class Index

    diff --git a/rdoc/Syckle/Plugins/DNote.html b/rdoc/Syckle/Plugins/DNote.html index f3480c3..e10ace9 100644 --- a/rdoc/Syckle/Plugins/DNote.html +++ b/rdoc/Syckle/Plugins/DNote.html @@ -75,17 +75,17 @@

    Parent

    Methods

    @@ -126,16 +126,18 @@

    Class Index

    @@ -245,7 +247,27 @@

    Attributes

    -Directory to save output. Defaults to standard log directory. +Directory to save output. Defaults to dnote/ under project log +directory. +

    + +
    +
    + +
    + + + + +
    + formats[RW] +
    + +
    + +

    +Formats (xml, html, rdoc).

    @@ -261,7 +283,7 @@

    Public Instance Methods

    - +
    @@ -282,9 +304,9 @@

    Public Instance Methods

    -# File plug/syckle/services/dnote.rb, line 79
    +# File plug/syckle/services/dnote.rb, line 83
         def clean
    -      dnote.clean
    +      #dnote.clean
         end
    @@ -295,7 +317,7 @@

    Public Instance Methods

    - +
    @@ -314,9 +336,9 @@

    Public Instance Methods

    -# File plug/syckle/services/dnote.rb, line 61
    +# File plug/syckle/services/dnote.rb, line 63
         def dnote
    -      @dnote ||= ::DNote.new(files, :labels=>labels, :verbose=>verbose?)
    +      @dnote ||= ::DNote::Site.new(files, :labels=>labels, :formats=>formats, :output=>output)
         end
    @@ -327,7 +349,7 @@

    Public Instance Methods

    - +
    @@ -348,12 +370,14 @@

    Public Instance Methods

    -# File plug/syckle/services/dnote.rb, line 66
    +# File plug/syckle/services/dnote.rb, line 68
         def document
    -      mkdir_p(output)
    -      file = output + "index.html"
    -      File.open(file, 'w'){ |f| f << dnote.to_html }
    -      report "Updated #{file.to_s.sub(Dir.pwd+'/','')}"
    +      $NOOP = noop?  # TODO:
    +      dnote.document
    +      #mkdir_p(output)
    +      #file = output + "index.html"
    +      #File.open(file, 'w'){ |f| f << dnote.to_html }
    +      report "Updated #{output.to_s.sub(Dir.pwd+'/','')}"
         end
    @@ -364,7 +388,7 @@

    Public Instance Methods

    - +
    @@ -376,19 +400,14 @@

    Public Instance Methods

    -
    - Formats (xml, html, rdoc).
    -
    -

    -attr_accessor :formats -

    +
    -# File plug/syckle/services/dnote.rb, line 56
    +# File plug/syckle/services/dnote.rb, line 58
         def output=(path)
           @output = Pathname.new(path)
         end
    @@ -401,7 +420,7 @@

    Public Instance Methods

    - +
    @@ -422,9 +441,9 @@

    Public Instance Methods

    -# File plug/syckle/services/dnote.rb, line 74
    +# File plug/syckle/services/dnote.rb, line 78
         def reset
    -      dnote.reset
    +      #dnote.reset
         end
    @@ -441,7 +460,7 @@

    Private Instance Methods

    - +
    @@ -453,18 +472,21 @@

    Private Instance Methods

    - +

    +TODO: maybe files default of */.rb is better? +

    -# File plug/syckle/services/dnote.rb, line 86
    +# File plug/syckle/services/dnote.rb, line 90
         def initialize_defaults
    -      @files  = metadata.loadpath || 'lib'
    -      @output = project.log + 'dnote'
    -      @labels = DEFAULT_LABELS
    +      @files   = metadata.loadpath || 'lib'
    +      @output  = project.log + 'dnote'
    +      @formats = []
    +      @labels  = DEFAULT_LABELS
         end
    diff --git a/rdoc/created.rid b/rdoc/created.rid index 4519d7b..0c5e1d3 100644 --- a/rdoc/created.rid +++ b/rdoc/created.rid @@ -1 +1 @@ -Fri, 23 Oct 2009 21:03:18 -0400 +Sat, 24 Oct 2009 01:05:41 -0400 diff --git a/rdoc/index.html b/rdoc/index.html index 7246337..fb0191e 100644 --- a/rdoc/index.html +++ b/rdoc/index.html @@ -70,16 +70,18 @@

    Class Index

    @@ -89,14 +91,19 @@

    Class Index

    Method Index

    @@ -249,72 +291,90 @@

    Files

    Classes/Modules

    Methods

    --> @@ -323,54 +383,79 @@

    Methods

    D’Note

    DESCRIPTION

    -Extract developement notes from source code and make some pretty RDoc -and/or HTML formatted files out of them. +Extract developement notes from source code and generate some nice output +formats for them.

    SYNOPSIS

    -Developer notes it the source code must be formate as follows: +Developer notes it the source code must be formatted as follows:

    -  # TYPE: description ...
    -  #       ... cont ...
    +  # LABEL: description ...
     

    -All notes must be separated by a blank line. Eg. +Any description that takes up more than one line must remain flush to the +left margin (if the first line is flush to the left margin too) b/c RDoc +will mistake of formatting the remaining lines as a pre block it +if is not. So…

    -  # TYPE: description ...
    -  #
    -  # TYPE: description ...
    +  # LABEL: ... description ...
    +  # continue ...
     

    -Without the blank line the second note will be taken to be part of the -first. Any description that takes up more than one line must remain flush -to the left margin (if the first line is flush to the left margin too) b/c -RDoc will mistake of formatting the remaining lines as a pre block -it if is not. So… +All consecutive notes must be separated by a blank lines.

    -  # TYPE: ... description ...
    -  # continue ...
    +  # LABEL: description ...
    +  #
    +  # LABEL: description ...
     

    -Alternately the whole note can be a pre block by indenting them. -Then the layout if freed-up. +Without the blank line the second note will be taken to be part of the +first. +

    +

    +Alternately the whole note can be made a pre block by indention. +Then the layout if freed-form.

       # This is a description of something...
       #
    -  #   TYPE: description ...
    -  #         continued ...
    +  #   LABEL: description ...
    +  #          continued ...
    +
    +

    +With properly formatted notes, we then use the dnote command line +tool. +

    +
    +  $ dnote
    +
    +

    +And lo! Pretty output. See dnote --help for more options. +

    +

    INSTALLATION

    +

    +The usual RubyGem’s command: +

    +
    +  $ sudo gem install dnote
     

    COPYRIGHTS

    diff --git a/rdoc/lib/dnote/command_rb.html b/rdoc/lib/dnote/command_rb.html index 273b807..c0acaa5 100644 --- a/rdoc/lib/dnote/command_rb.html +++ b/rdoc/lib/dnote/command_rb.html @@ -23,7 +23,7 @@

    Last Modified
    -
    Fri Oct 23 21:01:39 -0400 2009
    +
    Sat Oct 24 00:22:34 -0400 2009
    Requires
    diff --git a/rdoc/lib/dnote/notes_rb.html b/rdoc/lib/dnote/notes_rb.html index ffc5d65..d86ee90 100644 --- a/rdoc/lib/dnote/notes_rb.html +++ b/rdoc/lib/dnote/notes_rb.html @@ -23,7 +23,7 @@
    Last Modified
    -
    Fri Oct 23 21:00:14 -0400 2009
    +
    Sat Oct 24 00:48:57 -0400 2009
    Requires
    diff --git a/rdoc/lib/dnote/site_rb.html b/rdoc/lib/dnote/site_rb.html new file mode 100644 index 0000000..d8f0a58 --- /dev/null +++ b/rdoc/lib/dnote/site_rb.html @@ -0,0 +1,54 @@ + + + + + + + + File: site.rb [D'Note] + + + + + + + + + + + + + +
    +
    +
    Last Modified
    +
    Sat Oct 24 00:52:53 -0400 2009
    + + +
    Requires
    +
    +
      + +
    • dnote/notes
    • + +
    +
    + + + +
    +
    + +
    + +
    +

    Description

    + +
    + +
    + + + + diff --git a/rdoc/plug/syckle/services/dnote_rb.html b/rdoc/plug/syckle/services/dnote_rb.html index adc5e4a..9a09f56 100644 --- a/rdoc/plug/syckle/services/dnote_rb.html +++ b/rdoc/plug/syckle/services/dnote_rb.html @@ -23,14 +23,14 @@
    Last Modified
    -
    Fri Oct 23 20:59:23 -0400 2009
    +
    Sat Oct 24 00:50:46 -0400 2009
    Requires
      -
    • dnote
    • +
    • dnote/site
    diff --git a/ri/DNote/Notes/cdesc-Notes.yaml b/ri/DNote/Notes/cdesc-Notes.yaml index dbb0d2c..b50f57d 100644 --- a/ri/DNote/Notes/cdesc-Notes.yaml +++ b/ri/DNote/Notes/cdesc-Notes.yaml @@ -17,12 +17,6 @@ attributes: name: title rw: RW -- !ruby/object:RDoc::RI::Attribute - comment: - - !ruby/struct:RDoc::Markup::Flow::P - body: Verbose - name: verbose - rw: RW class_methods: - !ruby/object:RDoc::RI::MethodSummary name: new @@ -70,22 +64,22 @@ instance_methods: name: counts - !ruby/object:RDoc::RI::MethodSummary name: display -- !ruby/object:RDoc::RI::MethodSummary - name: fu - !ruby/object:RDoc::RI::MethodSummary name: initialize_defaults - !ruby/object:RDoc::RI::MethodSummary name: labels= -- !ruby/object:RDoc::RI::MethodSummary - name: noharm? - !ruby/object:RDoc::RI::MethodSummary name: notes - !ruby/object:RDoc::RI::MethodSummary name: organize - !ruby/object:RDoc::RI::MethodSummary name: parse +- !ruby/object:RDoc::RI::MethodSummary + name: to - !ruby/object:RDoc::RI::MethodSummary name: to_html +- !ruby/object:RDoc::RI::MethodSummary + name: to_html_list - !ruby/object:RDoc::RI::MethodSummary name: to_json - !ruby/object:RDoc::RI::MethodSummary @@ -96,9 +90,5 @@ instance_methods: name: to_xml - !ruby/object:RDoc::RI::MethodSummary name: to_yaml -- !ruby/object:RDoc::RI::MethodSummary - name: verbose? -- !ruby/object:RDoc::RI::MethodSummary - name: write name: Notes superclass: Object diff --git a/ri/DNote/Notes/to-i.yaml b/ri/DNote/Notes/to-i.yaml new file mode 100644 index 0000000..3a15262 --- /dev/null +++ b/ri/DNote/Notes/to-i.yaml @@ -0,0 +1,11 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: [] + +full_name: DNote::Notes#to +is_singleton: false +name: to +params: (format) +visibility: public diff --git a/ri/DNote/Notes/to_html_list-i.yaml b/ri/DNote/Notes/to_html_list-i.yaml new file mode 100644 index 0000000..3a5a116 --- /dev/null +++ b/ri/DNote/Notes/to_html_list-i.yaml @@ -0,0 +1,11 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: [] + +full_name: DNote::Notes#to_html_list +is_singleton: false +name: to_html_list +params: () +visibility: public diff --git a/ri/DNote/Site/__DIR__-i.yaml b/ri/DNote/Site/__DIR__-i.yaml new file mode 100644 index 0000000..37c3ba0 --- /dev/null +++ b/ri/DNote/Site/__DIR__-i.yaml @@ -0,0 +1,10 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +full_name: DNote::Site#__DIR__ +is_singleton: false +name: __DIR__ +params: () +visibility: public diff --git a/ri/DNote/Site/cdesc-Site.yaml b/ri/DNote/Site/cdesc-Site.yaml new file mode 100644 index 0000000..1aec754 --- /dev/null +++ b/ri/DNote/Site/cdesc-Site.yaml @@ -0,0 +1,67 @@ +--- !ruby/object:RDoc::RI::ClassDescription +attributes: +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Additional Formats to supply besided the html (xml, rdoc, markdown, etc.) + name: formats + rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Notes object. + name: notes + rw: R +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Directory to save output. + name: output + rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Title to use in any headers. + name: title + rw: RW +class_methods: +- !ruby/object:RDoc::RI::MethodSummary + name: new +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Site class is used to build a "pretty" output set. The template files are saved to the output directory. Additional formats can be saved the the directory as well. +- !ruby/struct:RDoc::Markup::Flow::RULE + width: +- !ruby/struct:RDoc::Markup::Flow::P + body: Site class is used to build a "pretty" output set. The template files are saved to the output directory. Additional formats can be saved the the directory as well. +constants: +- !ruby/object:RDoc::RI::Constant + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Default output directory is dnote/. + name: DEFAULT_OUTPUT + value: Pathname.new('dnote') +full_name: DNote::Site +includes: [] + +instance_methods: +- !ruby/object:RDoc::RI::MethodSummary + name: __DIR__ +- !ruby/object:RDoc::RI::MethodSummary + name: clean +- !ruby/object:RDoc::RI::MethodSummary + name: document +- !ruby/object:RDoc::RI::MethodSummary + name: fu +- !ruby/object:RDoc::RI::MethodSummary + name: initialize_defaults +- !ruby/object:RDoc::RI::MethodSummary + name: output= +- !ruby/object:RDoc::RI::MethodSummary + name: reset +- !ruby/object:RDoc::RI::MethodSummary + name: templates +- !ruby/object:RDoc::RI::MethodSummary + name: write +name: Site +superclass: Object diff --git a/ri/DNote/Site/clean-i.yaml b/ri/DNote/Site/clean-i.yaml new file mode 100644 index 0000000..58fff51 --- /dev/null +++ b/ri/DNote/Site/clean-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Remove output directory. +full_name: DNote::Site#clean +is_singleton: false +name: clean +params: () +visibility: public diff --git a/ri/DNote/Notes/noharm%3f-i.yaml b/ri/DNote/Site/document-i.yaml similarity index 74% rename from ri/DNote/Notes/noharm%3f-i.yaml rename to ri/DNote/Site/document-i.yaml index eae62d9..7ac9e16 100644 --- a/ri/DNote/Notes/noharm%3f-i.yaml +++ b/ri/DNote/Site/document-i.yaml @@ -4,8 +4,8 @@ aliases: [] block_params: comment: [] -full_name: DNote::Notes#noharm? +full_name: DNote::Site#document is_singleton: false -name: noharm? +name: document params: () visibility: public diff --git a/ri/DNote/Notes/fu-i.yaml b/ri/DNote/Site/fu-i.yaml similarity index 84% rename from ri/DNote/Notes/fu-i.yaml rename to ri/DNote/Site/fu-i.yaml index 478dd74..c788335 100644 --- a/ri/DNote/Notes/fu-i.yaml +++ b/ri/DNote/Site/fu-i.yaml @@ -4,7 +4,7 @@ aliases: [] block_params: comment: [] -full_name: DNote::Notes#fu +full_name: DNote::Site#fu is_singleton: false name: fu params: () diff --git a/ri/DNote/Site/initialize_defaults-i.yaml b/ri/DNote/Site/initialize_defaults-i.yaml new file mode 100644 index 0000000..9ed3c0f --- /dev/null +++ b/ri/DNote/Site/initialize_defaults-i.yaml @@ -0,0 +1,11 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: [] + +full_name: DNote::Site#initialize_defaults +is_singleton: false +name: initialize_defaults +params: () +visibility: public diff --git a/ri/DNote/Site/new-c.yaml b/ri/DNote/Site/new-c.yaml new file mode 100644 index 0000000..73c4fc5 --- /dev/null +++ b/ri/DNote/Site/new-c.yaml @@ -0,0 +1,10 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +full_name: DNote::Site::new +is_singleton: true +name: new +params: (paths, options) +visibility: public diff --git a/ri/DNote/Site/output%3d-i.yaml b/ri/DNote/Site/output%3d-i.yaml new file mode 100644 index 0000000..731ff79 --- /dev/null +++ b/ri/DNote/Site/output%3d-i.yaml @@ -0,0 +1,11 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: [] + +full_name: DNote::Site#output= +is_singleton: false +name: output= +params: (path) +visibility: public diff --git a/ri/DNote/Site/reset-i.yaml b/ri/DNote/Site/reset-i.yaml new file mode 100644 index 0000000..fc4fb29 --- /dev/null +++ b/ri/DNote/Site/reset-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Reset output directory, marking it as out-of-date. +full_name: DNote::Site#reset +is_singleton: false +name: reset +params: () +visibility: public diff --git a/ri/DNote/Notes/verbose%3f-i.yaml b/ri/DNote/Site/templates-i.yaml similarity index 73% rename from ri/DNote/Notes/verbose%3f-i.yaml rename to ri/DNote/Site/templates-i.yaml index 3bd41e4..8a2b7e5 100644 --- a/ri/DNote/Notes/verbose%3f-i.yaml +++ b/ri/DNote/Site/templates-i.yaml @@ -4,8 +4,8 @@ aliases: [] block_params: comment: [] -full_name: DNote::Notes#verbose? +full_name: DNote::Site#templates is_singleton: false -name: verbose? +name: templates params: () visibility: public diff --git a/ri/DNote/Notes/write-i.yaml b/ri/DNote/Site/write-i.yaml similarity index 68% rename from ri/DNote/Notes/write-i.yaml rename to ri/DNote/Site/write-i.yaml index 042e948..62fc879 100644 --- a/ri/DNote/Notes/write-i.yaml +++ b/ri/DNote/Site/write-i.yaml @@ -4,9 +4,9 @@ aliases: [] block_params: comment: - !ruby/struct:RDoc::Markup::Flow::P - body: Save notes. -full_name: DNote::Notes#write + body: Save file to output. +full_name: DNote::Site#write is_singleton: false name: write -params: (text, format) +params: (fname, text) visibility: public diff --git a/ri/DNote/cdesc-DNote.yaml b/ri/DNote/cdesc-DNote.yaml index e099190..c86bdc6 100644 --- a/ri/DNote/cdesc-DNote.yaml +++ b/ri/DNote/cdesc-DNote.yaml @@ -7,8 +7,6 @@ class_methods: - !ruby/object:RDoc::RI::MethodSummary name: run comment: -- !ruby/struct:RDoc::Markup::Flow::P - body: require 'reap/project/scm' constants: - !ruby/object:RDoc::RI::Constant comment: diff --git a/ri/Syckle/Plugins/DNote/cdesc-DNote.yaml b/ri/Syckle/Plugins/DNote/cdesc-DNote.yaml index 3ac45fc..bfccd0a 100644 --- a/ri/Syckle/Plugins/DNote/cdesc-DNote.yaml +++ b/ri/Syckle/Plugins/DNote/cdesc-DNote.yaml @@ -6,6 +6,12 @@ attributes: body: Paths to search. name: files rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Formats (xml, html, rdoc). + name: formats + rw: RW - !ruby/object:RDoc::RI::Attribute comment: - !ruby/struct:RDoc::Markup::Flow::P @@ -15,7 +21,7 @@ attributes: - !ruby/object:RDoc::RI::Attribute comment: - !ruby/struct:RDoc::Markup::Flow::P - body: Directory to save output. Defaults to standard log directory. + body: Directory to save output. Defaults to dnote/ under project log directory. name: output rw: RW class_methods: [] diff --git a/ri/Syckle/Plugins/DNote/initialize_defaults-i.yaml b/ri/Syckle/Plugins/DNote/initialize_defaults-i.yaml index ac0df93..15bf197 100644 --- a/ri/Syckle/Plugins/DNote/initialize_defaults-i.yaml +++ b/ri/Syckle/Plugins/DNote/initialize_defaults-i.yaml @@ -2,8 +2,9 @@ aliases: [] block_params: -comment: [] - +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: "TODO: maybe files default of */.rb is better?" full_name: Syckle::Plugins::DNote#initialize_defaults is_singleton: false name: initialize_defaults diff --git a/ri/Syckle/Plugins/DNote/output%3d-i.yaml b/ri/Syckle/Plugins/DNote/output%3d-i.yaml index d2ba05f..a3a406f 100644 --- a/ri/Syckle/Plugins/DNote/output%3d-i.yaml +++ b/ri/Syckle/Plugins/DNote/output%3d-i.yaml @@ -2,11 +2,8 @@ aliases: [] block_params: -comment: -- !ruby/struct:RDoc::Markup::Flow::VERB - body: " Formats (xml, html, rdoc).\n" -- !ruby/struct:RDoc::Markup::Flow::P - body: attr_accessor :formats +comment: [] + full_name: Syckle::Plugins::DNote#output= is_singleton: false name: output= diff --git a/ri/created.rid b/ri/created.rid index a76c3bc..13dbb3c 100644 --- a/ri/created.rid +++ b/ri/created.rid @@ -1 +1 @@ -Fri, 23 Oct 2009 21:03:17 -0400 +Sat, 24 Oct 2009 00:53:01 -0400 From 133076800d6d3fb444f16c10bef7d7266cc32967 Mon Sep 17 00:00:00 2001 From: 7rans Date: Sat, 24 Oct 2009 01:06:25 -0400 Subject: [PATCH 03/27] Updated files. From a67ef55a695852acd5474ef3e79a7478e0617b7b Mon Sep 17 00:00:00 2001 From: 7rans Date: Sat, 24 Oct 2009 01:07:03 -0400 Subject: [PATCH 04/27] Updated files. From 7d3d38850391b9fa8126fd69ec1bee5223ba7c65 Mon Sep 17 00:00:00 2001 From: 7rans Date: Sun, 25 Oct 2009 09:13:06 -0400 Subject: [PATCH 05/27] Updated files. --- index.html | 46 +++-- rdoc/DNote/Notes.html | 238 +++++++++++++++++++------- rdoc/README_rdoc.html | 88 +++++++--- rdoc/Syckle/Plugins/DNote.html | 24 +-- rdoc/created.rid | 2 +- rdoc/index.html | 219 ++++++++++++++++-------- rdoc/lib/dnote/notes_rb.html | 2 +- rdoc/lib/dnote_rb.html | 2 +- ri/DNote/Notes/cdesc-Notes.yaml | 6 + ri/DNote/Notes/files-i.yaml | 11 ++ ri/DNote/Notes/match_arbitrary-i.yaml | 11 ++ ri/DNote/Notes/match_common-i.yaml | 11 ++ ri/created.rid | 2 +- 13 files changed, 461 insertions(+), 201 deletions(-) create mode 100644 ri/DNote/Notes/files-i.yaml create mode 100644 ri/DNote/Notes/match_arbitrary-i.yaml create mode 100644 ri/DNote/Notes/match_common-i.yaml diff --git a/index.html b/index.html index 8f94208..fa5e68d 100644 --- a/index.html +++ b/index.html @@ -55,24 +55,32 @@

    D'Note

    Developer's take note! All those TODO: and FIXME: notes floating around your source code are rotting away. - They are trapped and in desparate need of your attention. No worries. D'Note is here to liberate them. - D'Note scans your source code for labeled comments, collects, collates and sorts them, and then - saves them in a format of your choosing.

    + They are trapped and in desparate need of your attention.

    + +

    Not to fret. D'Note can help you liberate them. D'Note scans source code for labeled comments, collects, + collates and sorts them, and then returns them in a format of your choosing.

    Note Structure

    -

    D'Note uses a commonly used pattern of "LABEL:". The colon helps D'Note separate developer notes - from other documentation. To be more specific, developer's notes in the source code must follow - these simple set of rules:

    +

    D'Note scans for the common noting pattern used by develepors of many laguages of an all-caps label + followed bt a colon. To be more specific, for D'Note to recogznie a note, it needs ot follow this + simple set of rules:

    -

    1) Notes start with a label puctuated with a colon and followed by the note text.

    +

    1) Notes start with an all-caps label puctuated with a colon, followed by the note's text.

       # LABEL: description ...
       
    -

    2) Any note that requires more than one line must remain flush to the left +

    2) Specially designated notes can omit the colon. By default these are TODO, + FIXME and OPTIMIZE. Eg.

    + +
    +  # TODO description ...
    +  
    + +

    3) Any note that requires more than one line must remain flush to the left margin (the margin is set by the first line). This is done because RDoc will mistake the note for a <pre> block if it is indented.

    @@ -81,8 +89,8 @@

    Note Structure

    # continue ...
    -

    3) An alternative to the last rule is to make the whole note a <pre> block, - by indenting it. Then the text layout is free-form.

    +

    3) An alternative to the limitation of the last rule is to indent the whole note, making it + a <pre> block. Then the text layout is free-form.

       # This is a description of something...
    @@ -91,19 +99,8 @@ 

    Note Structure

    # continue ...
    -

    4) All consecutive notes must be separated by at least one blank line.

    - -
    -  # LABEL: description ...
    -  # 
    -  # LABEL: description ...
    -  
    - -

    Without the blank line the second note will be taken to be part of the first.

    - -

    That's all there is to it. In future we plan to relax the last rule, and if we can - convince the developers of RDoc to recognize labels, we may eventually be able to relax - the flush rule too.

    +

    That's all there is to it, if I can convince the developers of RDoc to add recognize labels, + we may eventually be able to relax the flush rule, which would be very nice.

    Generating Notes

    @@ -131,7 +128,7 @@

    Generating Notes

    -h, --help show this help information
    -

    The default path is lib/ and the default format --rdoc. +

    The default path is **/*.rb and the default format --rdoc. Here is an example of DNote's current notes in RDoc format:

    @@ -182,7 +179,6 @@ 

    Generating Notes

    Copyright (c) 2009 Thomas Sawyer

    - diff --git a/rdoc/DNote/Notes.html b/rdoc/DNote/Notes.html index c9fa733..cc60e0c 100644 --- a/rdoc/DNote/Notes.html +++ b/rdoc/DNote/Notes.html @@ -81,31 +81,37 @@

    Methods

  • #display
  • +
  • #files
  • +
  • #initialize_defaults
  • -
  • #labels=
  • +
  • #labels=
  • + +
  • #match_arbitrary
  • + +
  • #match_common
  • #notes
  • -
  • #organize
  • +
  • #organize
  • -
  • #parse
  • +
  • #parse
  • -
  • #to
  • +
  • #to
  • -
  • #to_html
  • +
  • #to_html
  • -
  • #to_html_list
  • +
  • #to_html_list
  • -
  • #to_json
  • +
  • #to_json
  • -
  • #to_markdown
  • +
  • #to_markdown
  • -
  • #to_rdoc
  • +
  • #to_rdoc
  • -
  • #to_xml
  • +
  • #to_xml
  • -
  • #to_yaml
  • +
  • #to_yaml
  • @@ -441,6 +447,46 @@

    Public Instance Methods

    +
    + + +
    + + files() + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/dnote/notes.rb, line 165
    +    def files
    +      @files ||= (
    +        self.paths.map do |path|
    +          if File.directory?(path)
    +            Dir.glob(File.join(path, '**/*'))
    +          else
    +            Dir.glob(path)
    +          end
    +        end.flatten.uniq
    +      )
    +    end
    +
    + +
    + + +
    + +
    @@ -477,7 +523,7 @@

    Public Instance Methods

    - +
    @@ -515,6 +561,84 @@

    Public Instance Methods

    +
    + + +
    + + match_arbitrary(line, lineno, file) + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/dnote/notes.rb, line 190
    +    def match_arbitrary(line, lineno, file)
    +      rec = nil
    +      labels.each do |label|
    +        if md = /^\s*#\s*([A-Z]+)[:]\s*(.*?)$/.match(line)
    +          label, text = md[1], md[2]
    +          rec = {'label'=>label,'file'=>file,'line'=>lineno,'note'=>text}
    +        end
    +      end
    +      return rec
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + match_common(line, lineno, file) + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/dnote/notes.rb, line 178
    +    def match_common(line, lineno, file)
    +      rec = nil
    +      labels.each do |label|
    +        if md = /^\s*#\s*#{Regexp.escape(label)}[:]?\s*(.*?)$/.match(line)
    +          text = md[1]
    +          rec = {'label'=>label,'file'=>file,'line'=>lineno,'note'=>text}
    +        end
    +      end
    +      return rec
    +    end
    +
    + +
    + + +
    + +
    @@ -548,7 +672,7 @@

    Public Instance Methods

    - +
    @@ -569,7 +693,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 177
    +# File lib/dnote/notes.rb, line 203
         def organize(records)
           orecs = {}
           records.each do |record|
    @@ -592,7 +716,7 @@ 

    Public Instance Methods

    - +
    @@ -614,43 +738,31 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 128
    +# File lib/dnote/notes.rb, line 129
         def parse
    -      files = self.paths.map do |path|
    -        if File.directory?(path)
    -          Dir.glob(File.join(path, '**/*'))
    -        else
    -          Dir.glob(path)
    -        end
    -      end.flatten.uniq
    -
    -      #
           records, counts = [], Hash.new(0)
    -
    -      # iterate through files extracting notes
           files.each do |fname|
             next unless File.file?(fname)
    -        #next unless fname =~ /\.rb$/      # TODO should this be done?
    +        #next unless fname =~ /\.rb$/      # TODO: should this be done?
             File.open(fname) do |f|
    -          line_no, save, text = 0, nil, nil
    +          lineno, save, text = 0, nil, nil
               while line = f.gets
    -            line_no += 1
    -            labels.each do |label|
    -              if line =~ /^\s*#\s*#{Regexp.escape(label)}[:]?\s*(.*?)$/
    -                file = fname
    -                text = ''
    -                save = {'label'=>label,'file'=>file,'line'=>line_no,'note'=>text}
    -                records << save
    -                counts[label] += 1
    -              end
    -            end
    -            if text
    -              if line =~ /^\s*[#]{0,1}\s*$/ or line !~ /^\s*#/ or line =~ /^\s*#[+][+]/
    -                text.strip!
    -                text = nil
    -                #records << save
    -              else
    -                text << line.gsub(/^\s*#\s*/,'')
    +            lineno += 1
    +            save = match_common(line, lineno, fname) || match_arbitrary(line, lineno, fname)
    +            if save
    +              #file = fname
    +              text = save['note']
    +              #save = {'label'=>label,'file'=>file,'line'=>line_no,'note'=>text}
    +              records << save
    +              counts[save['label']] += 1
    +            else
    +              if text
    +                if line =~ /^\s*[#]{0,1}\s*$/ or line !~ /^\s*#/ or line =~ /^\s*#[+][+]/
    +                  text.strip!
    +                  text = nil
    +                else
    +                  text << ' ' << line.gsub(/^\s*#\s*/,'')
    +                end
                   end
                 end
               end
    @@ -670,7 +782,7 @@ 

    Public Instance Methods

    - +
    @@ -689,7 +801,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 192
    +# File lib/dnote/notes.rb, line 218
         def to(format)
           __send__("to_#{format}")
         end
    @@ -702,7 +814,7 @@

    Public Instance Methods

    - +
    @@ -723,7 +835,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 256
    +# File lib/dnote/notes.rb, line 282
         def to_html
           html = []
           html << %[<html>]
    @@ -751,7 +863,7 @@ 

    Public Instance Methods

    - +
    @@ -770,7 +882,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 276
    +# File lib/dnote/notes.rb, line 302
         def to_html_list
           html = []
           html << %[<div class="notes">]
    @@ -800,7 +912,7 @@ 

    Public Instance Methods

    - +
    @@ -819,9 +931,9 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 304
    +# File lib/dnote/notes.rb, line 330
         def to_json
    -      require 'json'
    +      require 'json'  # TODO: fallback to json_pure
           notes.to_json
         end
    @@ -833,7 +945,7 @@

    Public Instance Methods

    - +
    @@ -854,7 +966,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 216
    +# File lib/dnote/notes.rb, line 242
         def to_markdown
           out = []
           out << "# Development Notes"
    @@ -879,7 +991,7 @@ 

    Public Instance Methods

    - +
    @@ -900,7 +1012,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 198
    +# File lib/dnote/notes.rb, line 224
         def to_rdoc
           out = []
           out << "= Development Notes"
    @@ -925,7 +1037,7 @@ 

    Public Instance Methods

    - +
    @@ -946,7 +1058,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 234
    +# File lib/dnote/notes.rb, line 260
         def to_xml
           xml = []
           xml << "<notes>"
    @@ -975,7 +1087,7 @@ 

    Public Instance Methods

    - +
    @@ -994,7 +1106,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 298
    +# File lib/dnote/notes.rb, line 324
         def to_yaml
           require 'yaml'
           notes.to_yaml
    diff --git a/rdoc/README_rdoc.html b/rdoc/README_rdoc.html
    index f45a8c8..efe8b2b 100644
    --- a/rdoc/README_rdoc.html
    +++ b/rdoc/README_rdoc.html
    @@ -107,54 +107,100 @@ 

    DESCRIPTION

    formats for them.

    SYNOPSIS

    +

    Note Structure

    -Developer notes it the source code must be formatted as follows: +D’Note scans for the common noting pattern used by develepors of many +laguages of an all-caps label followed bt a colon. To be more specific, for +D’Note to recogznie a note, it needs ot follow this simple set of +rules: +

    +

    +1) Notes start with an all-caps label puctuated with a colon, followed by +the note’s text.

       # LABEL: description ...
     

    -Any description that takes up more than one line must remain flush to the -left margin (if the first line is flush to the left margin too) b/c RDoc -will mistake of formatting the remaining lines as a pre block it -if is not. So… +2) Specially designated notes can omit the colon. By default these are +TODO, FIXME and OPTIMIZE.

    -  # LABEL: ... description ...
    -  # continue ...
    +  # TODO description ...
     

    -All consecutive notes must be separated by a blank lines. +3) Any note that requires more than one line must remain flush to the left +margin (the margin is set by the first line). This is done because RDoc +will mistake the note for a &lt;pre&gt; block if it is +indented.

       # LABEL: description ...
    -  #
    -  # LABEL: description ...
    +  # continue ...
     

    -Without the blank line the second note will be taken to be part of the -first. -

    -

    -Alternately the whole note can be made a pre block by indention. -Then the layout if freed-form. +4) An alternative to the limitation of the last rule is to indent the whole +note, making it a &lt;pre&gt; block. Then the text layout +is free-form.

       # This is a description of something...
       #
       #   LABEL: description ...
    -  #          continued ...
    +  #          continue ...
     

    -With properly formatted notes, we then use the dnote command line -tool. +That’s all there is to it, if I can convince the developers of RDoc +to add recognize labels, we may eventually be able to relax the flush rule, +which would be very nice. +

    +

    Generating Notes

    +

    +As you can see the commandline interface is quite straight-forward.

    -  $ dnote
    +  Usage: dnote [OPTIONS] path1 [path2 ...]
    +
    +  OUTPUT FORMAT: (choose one)
    +          --rdoc                       RDoc comment format
    +          --markdown                   Markdown wiki format
    +          --xml                        XML markup format
    +          --html                       HTML markup format
    +          --yaml                       YAML serialization format
    +          --json                       JSON serialization format
    +
    +  OTHER OPTIONS:
    +          --label                      labels to collect
    +      -t, --title [TITLE]              title to use in headers
    +
    +  STANDARD OPTIONS:
    +      -v, --verbose                    extra verbose output
    +          --debug                      debug mode
    +      -h, --help                       show this help information
     

    -And lo! Pretty output. See dnote --help for more options. +The default path is */.rb and the default format +--rdoc. Here is an example of DNote’s current notes in RDoc +format:

    +
    +  = Development Notes
    +
    +  == TODO
    +
    +  === file://lib/dnote/notes.rb
    +
    +  * TODO: Add ability to read header notes. They oftern
    +  have a outline format, rather then the single line. (19)
    +  * TODO: Need good CSS file. (22)
    +  * TODO: Need XSL? (24)
    +
    +  === file://plug/syckle/services/dnote.rb
    +
    +  * TODO: Should this service be part of the +site+ cycle? (18)
    +
    +  (4 TODOs)
    +

    INSTALLATION

    The usual RubyGem’s command: diff --git a/rdoc/Syckle/Plugins/DNote.html b/rdoc/Syckle/Plugins/DNote.html index e10ace9..f8c6489 100644 --- a/rdoc/Syckle/Plugins/DNote.html +++ b/rdoc/Syckle/Plugins/DNote.html @@ -75,17 +75,17 @@

    Parent

    Methods

    @@ -283,7 +283,7 @@

    Public Instance Methods

    - +
    @@ -317,7 +317,7 @@

    Public Instance Methods

    - +
    @@ -349,7 +349,7 @@

    Public Instance Methods

    - +
    @@ -388,7 +388,7 @@

    Public Instance Methods

    - +
    @@ -420,7 +420,7 @@

    Public Instance Methods

    - +
    @@ -460,7 +460,7 @@

    Private Instance Methods

    - +
    diff --git a/rdoc/created.rid b/rdoc/created.rid index 0c5e1d3..6ee3a1e 100644 --- a/rdoc/created.rid +++ b/rdoc/created.rid @@ -1 +1 @@ -Sat, 24 Oct 2009 01:05:41 -0400 +Sun, 25 Oct 2009 09:12:54 -0400 diff --git a/rdoc/index.html b/rdoc/index.html index fb0191e..69c5e70 100644 --- a/rdoc/index.html +++ b/rdoc/index.html @@ -92,8 +92,8 @@

    Method Index

    • -  DNote - ::new +  DNote::Site + ::new
    • @@ -102,8 +102,8 @@

      Method Index

    • -  DNote::Site - ::new +  DNote + ::new
    • @@ -117,13 +117,13 @@

      Method Index

    • -  DNote::Site - #clean +  Syckle::Plugins::DNote + #clean
    • -  Syckle::Plugins::DNote - #clean +  DNote::Site + #clean
    • @@ -138,17 +138,22 @@

      Method Index

    •  Syckle::Plugins::DNote - #dnote + #dnote +
    • + +
    • +  DNote::Site + #document
    •  Syckle::Plugins::DNote - #document + #document
    • -  DNote::Site - #document +  DNote::Notes + #files
    • @@ -157,13 +162,13 @@

      Method Index

    • -  Syckle::Plugins::DNote - #initialize_defaults +  DNote::Site + #initialize_defaults
    • -  DNote::Site - #initialize_defaults +  Syckle::Plugins::DNote + #initialize_defaults
    • @@ -173,7 +178,17 @@

      Method Index

    •  DNote::Notes - #labels= + #labels= +
    • + +
    • +  DNote::Notes + #match_arbitrary +
    • + +
    • +  DNote::Notes + #match_common
    • @@ -183,12 +198,12 @@

      Method Index

    •  DNote::Notes - #organize + #organize
    •  Syckle::Plugins::DNote - #output= + #output=
    • @@ -198,17 +213,17 @@

      Method Index

    •  DNote::Notes - #parse + #parse
    • -  Syckle::Plugins::DNote - #reset +  DNote::Site + #reset
    • -  DNote::Site - #reset +  Syckle::Plugins::DNote + #reset
    • @@ -218,42 +233,42 @@

      Method Index

    •  DNote::Notes - #to + #to
    •  DNote::Notes - #to_html + #to_html
    •  DNote::Notes - #to_html_list + #to_html_list
    •  DNote::Notes - #to_json + #to_json
    •  DNote::Notes - #to_markdown + #to_markdown
    •  DNote::Notes - #to_rdoc + #to_rdoc
    •  DNote::Notes - #to_xml + #to_xml
    •  DNote::Notes - #to_yaml + #to_yaml
    • @@ -308,71 +323,77 @@

      Classes/Modules

      Methods

        -
      • ::new — DNote
      • +
      • ::new — DNote::Site
      • ::new — DNote::Notes
      • -
      • ::new — DNote::Site
      • +
      • ::new — DNote
      • ::run — DNote
      • #__DIR__ — DNote::Site
      • -
      • #clean — DNote::Site
      • +
      • #clean — Syckle::Plugins::DNote
      • -
      • #clean — Syckle::Plugins::DNote
      • +
      • #clean — DNote::Site
      • #counts — DNote::Notes
      • #display — DNote::Notes
      • -
      • #dnote — Syckle::Plugins::DNote
      • - -
      • #document — Syckle::Plugins::DNote
      • +
      • #dnote — Syckle::Plugins::DNote
      • #document — DNote::Site
      • -
      • #fu — DNote::Site
      • +
      • #document — Syckle::Plugins::DNote
      • + +
      • #files — DNote::Notes
      • -
      • #initialize_defaults — Syckle::Plugins::DNote
      • +
      • #fu — DNote::Site
      • #initialize_defaults — DNote::Site
      • +
      • #initialize_defaults — Syckle::Plugins::DNote
      • +
      • #initialize_defaults — DNote::Notes
      • -
      • #labels= — DNote::Notes
      • +
      • #labels= — DNote::Notes
      • + +
      • #match_arbitrary — DNote::Notes
      • + +
      • #match_common — DNote::Notes
      • #notes — DNote::Notes
      • -
      • #organize — DNote::Notes
      • +
      • #organize — DNote::Notes
      • -
      • #output= — Syckle::Plugins::DNote
      • +
      • #output= — Syckle::Plugins::DNote
      • #output= — DNote::Site
      • -
      • #parse — DNote::Notes
      • - -
      • #reset — Syckle::Plugins::DNote
      • +
      • #parse — DNote::Notes
      • #reset — DNote::Site
      • +
      • #reset — Syckle::Plugins::DNote
      • +
      • #templates — DNote::Site
      • -
      • #to — DNote::Notes
      • +
      • #to — DNote::Notes
      • -
      • #to_html — DNote::Notes
      • +
      • #to_html — DNote::Notes
      • -
      • #to_html_list — DNote::Notes
      • +
      • #to_html_list — DNote::Notes
      • -
      • #to_json — DNote::Notes
      • +
      • #to_json — DNote::Notes
      • -
      • #to_markdown — DNote::Notes
      • +
      • #to_markdown — DNote::Notes
      • -
      • #to_rdoc — DNote::Notes
      • +
      • #to_rdoc — DNote::Notes
      • -
      • #to_xml — DNote::Notes
      • +
      • #to_xml — DNote::Notes
      • -
      • #to_yaml — DNote::Notes
      • +
      • #to_yaml — DNote::Notes
      • #write — DNote::Site
      • @@ -402,54 +423,100 @@

        DESCRIPTION

        formats for them.

        SYNOPSIS

        +

        Note Structure

        +

        +D’Note scans for the common noting pattern used by develepors of many +laguages of an all-caps label followed bt a colon. To be more specific, for +D’Note to recogznie a note, it needs ot follow this simple set of +rules: +

        -Developer notes it the source code must be formatted as follows: +1) Notes start with an all-caps label puctuated with a colon, followed by +the note’s text.

           # LABEL: description ...
         

        -Any description that takes up more than one line must remain flush to the -left margin (if the first line is flush to the left margin too) b/c RDoc -will mistake of formatting the remaining lines as a pre block it -if is not. So… +2) Specially designated notes can omit the colon. By default these are +TODO, FIXME and OPTIMIZE.

        -  # LABEL: ... description ...
        -  # continue ...
        +  # TODO description ...
         

        -All consecutive notes must be separated by a blank lines. +3) Any note that requires more than one line must remain flush to the left +margin (the margin is set by the first line). This is done because RDoc +will mistake the note for a &lt;pre&gt; block if it is +indented.

           # LABEL: description ...
        -  #
        -  # LABEL: description ...
        +  # continue ...
         

        -Without the blank line the second note will be taken to be part of the -first. -

        -

        -Alternately the whole note can be made a pre block by indention. -Then the layout if freed-form. +4) An alternative to the limitation of the last rule is to indent the whole +note, making it a &lt;pre&gt; block. Then the text layout +is free-form.

           # This is a description of something...
           #
           #   LABEL: description ...
        -  #          continued ...
        +  #          continue ...
         

        -With properly formatted notes, we then use the dnote command line -tool. +That’s all there is to it, if I can convince the developers of RDoc +to add recognize labels, we may eventually be able to relax the flush rule, +which would be very nice. +

        +

        Generating Notes

        +

        +As you can see the commandline interface is quite straight-forward.

        -  $ dnote
        +  Usage: dnote [OPTIONS] path1 [path2 ...]
        +
        +  OUTPUT FORMAT: (choose one)
        +          --rdoc                       RDoc comment format
        +          --markdown                   Markdown wiki format
        +          --xml                        XML markup format
        +          --html                       HTML markup format
        +          --yaml                       YAML serialization format
        +          --json                       JSON serialization format
        +
        +  OTHER OPTIONS:
        +          --label                      labels to collect
        +      -t, --title [TITLE]              title to use in headers
        +
        +  STANDARD OPTIONS:
        +      -v, --verbose                    extra verbose output
        +          --debug                      debug mode
        +      -h, --help                       show this help information
         

        -And lo! Pretty output. See dnote --help for more options. +The default path is */.rb and the default format +--rdoc. Here is an example of DNote’s current notes in RDoc +format:

        +
        +  = Development Notes
        +
        +  == TODO
        +
        +  === file://lib/dnote/notes.rb
        +
        +  * TODO: Add ability to read header notes. They oftern
        +  have a outline format, rather then the single line. (19)
        +  * TODO: Need good CSS file. (22)
        +  * TODO: Need XSL? (24)
        +
        +  === file://plug/syckle/services/dnote.rb
        +
        +  * TODO: Should this service be part of the +site+ cycle? (18)
        +
        +  (4 TODOs)
        +

        INSTALLATION

        The usual RubyGem’s command: diff --git a/rdoc/lib/dnote/notes_rb.html b/rdoc/lib/dnote/notes_rb.html index d86ee90..a942bdd 100644 --- a/rdoc/lib/dnote/notes_rb.html +++ b/rdoc/lib/dnote/notes_rb.html @@ -23,7 +23,7 @@

        Last Modified
        -
        Sat Oct 24 00:48:57 -0400 2009
        +
        Sun Oct 25 09:11:52 -0400 2009
        Requires
        diff --git a/rdoc/lib/dnote_rb.html b/rdoc/lib/dnote_rb.html index 1e266d9..73f312b 100644 --- a/rdoc/lib/dnote_rb.html +++ b/rdoc/lib/dnote_rb.html @@ -23,7 +23,7 @@
        Last Modified
        -
        Fri Oct 09 21:13:37 -0400 2009
        +
        Sun Oct 25 07:57:37 -0400 2009
        Requires
        diff --git a/ri/DNote/Notes/cdesc-Notes.yaml b/ri/DNote/Notes/cdesc-Notes.yaml index b50f57d..69c3c9a 100644 --- a/ri/DNote/Notes/cdesc-Notes.yaml +++ b/ri/DNote/Notes/cdesc-Notes.yaml @@ -64,10 +64,16 @@ instance_methods: name: counts - !ruby/object:RDoc::RI::MethodSummary name: display +- !ruby/object:RDoc::RI::MethodSummary + name: files - !ruby/object:RDoc::RI::MethodSummary name: initialize_defaults - !ruby/object:RDoc::RI::MethodSummary name: labels= +- !ruby/object:RDoc::RI::MethodSummary + name: match_arbitrary +- !ruby/object:RDoc::RI::MethodSummary + name: match_common - !ruby/object:RDoc::RI::MethodSummary name: notes - !ruby/object:RDoc::RI::MethodSummary diff --git a/ri/DNote/Notes/files-i.yaml b/ri/DNote/Notes/files-i.yaml new file mode 100644 index 0000000..b48e3d3 --- /dev/null +++ b/ri/DNote/Notes/files-i.yaml @@ -0,0 +1,11 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: [] + +full_name: DNote::Notes#files +is_singleton: false +name: files +params: () +visibility: public diff --git a/ri/DNote/Notes/match_arbitrary-i.yaml b/ri/DNote/Notes/match_arbitrary-i.yaml new file mode 100644 index 0000000..e0788b7 --- /dev/null +++ b/ri/DNote/Notes/match_arbitrary-i.yaml @@ -0,0 +1,11 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: [] + +full_name: DNote::Notes#match_arbitrary +is_singleton: false +name: match_arbitrary +params: (line, lineno, file) +visibility: public diff --git a/ri/DNote/Notes/match_common-i.yaml b/ri/DNote/Notes/match_common-i.yaml new file mode 100644 index 0000000..aacfc03 --- /dev/null +++ b/ri/DNote/Notes/match_common-i.yaml @@ -0,0 +1,11 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: [] + +full_name: DNote::Notes#match_common +is_singleton: false +name: match_common +params: (line, lineno, file) +visibility: public diff --git a/ri/created.rid b/ri/created.rid index 13dbb3c..062b8fe 100644 --- a/ri/created.rid +++ b/ri/created.rid @@ -1 +1 @@ -Sat, 24 Oct 2009 00:53:01 -0400 +Sun, 25 Oct 2009 09:12:52 -0400 From 8c011ad5ebd6a517b0890070e21afc0234ed17b5 Mon Sep 17 00:00:00 2001 From: 7rans Date: Sun, 25 Oct 2009 09:17:12 -0400 Subject: [PATCH 06/27] Updated files. From 59dfcdc4e3a72a3e704df00d55320e8f37a34d2b Mon Sep 17 00:00:00 2001 From: 7rans Date: Sun, 25 Oct 2009 09:17:51 -0400 Subject: [PATCH 07/27] Updated files. --- rdoc/DNote/Notes.html | 16 ++++++------ rdoc/DNote/Site.html | 8 +++--- rdoc/Syckle/Plugins/DNote.html | 24 ++++++++--------- rdoc/created.rid | 2 +- rdoc/index.html | 48 +++++++++++++++++----------------- rdoc/lib/dnote/notes_rb.html | 2 +- ri/created.rid | 2 +- 7 files changed, 51 insertions(+), 51 deletions(-) diff --git a/rdoc/DNote/Notes.html b/rdoc/DNote/Notes.html index cc60e0c..e5a3d8b 100644 --- a/rdoc/DNote/Notes.html +++ b/rdoc/DNote/Notes.html @@ -75,17 +75,17 @@

        Parent

        Methods

    -

    The default path is **/*.rb and the default format --rdoc. +

    The default path is **/*.rb and the default format --gnu. Here is an example of DNote's current notes in RDoc format:

    
    From 4e41b9c695e385821641ab5787c1b1b1c5bfaa11 Mon Sep 17 00:00:00 2001
    From: 7rans 
    Date: Sat, 6 Feb 2010 15:01:33 -0500
    Subject: [PATCH 11/27] Updated files.
    
    ---
     index.html                                  |  2 +-
     rdoc/classes/DNote.html                     |  4 +-
     rdoc/classes/DNote/Format.html              | 34 ++++-----
     rdoc/classes/DNote/Format/ErbScope.html     | 10 +--
     rdoc/classes/DNote/Notes.html               | 42 +++++------
     rdoc/classes/DNote/Site.html                |  2 +-
     rdoc/classes/Syckle.html                    |  2 +-
     rdoc/classes/Syckle/Plugins.html            |  2 +-
     rdoc/classes/Syckle/Plugins/DNote.html      |  2 +-
     rdoc/created.rid                            |  2 +-
     rdoc/files/LICENSE.html                     | 44 +++++------
     rdoc/files/README_rdoc.html                 | 44 +++++------
     rdoc/files/lib/dnote/command_rb.html        | 46 +++++------
     rdoc/files/lib/dnote/format_rb.html         | 44 +++++------
     rdoc/files/lib/dnote/notes_rb.html          | 44 +++++------
     rdoc/files/lib/dnote/site_rb.html           | 44 +++++------
     rdoc/files/lib/dnote_rb.html                | 44 +++++------
     rdoc/files/lib/plugins/syckle/dnote_rb.html | 44 +++++------
     rdoc/index.html                             | 84 ++++++++++-----------
     ri/created.rid                              |  2 +-
     20 files changed, 271 insertions(+), 271 deletions(-)
    
    diff --git a/index.html b/index.html
    index 78f79c7..2a3c55a 100644
    --- a/index.html
    +++ b/index.html
    @@ -125,7 +125,7 @@ 

    Generating Notes

    OTHER OPTIONS: --label labels to collect --title [TITLE] title to use in headers - -o, --output [PATH] name of file (w/o extension) or directory + -o, --output [PATH] name of file or directory STANDARD OPTIONS: --debug debug mode diff --git a/rdoc/classes/DNote.html b/rdoc/classes/DNote.html index c3d8c95..f8bdbcd 100644 --- a/rdoc/classes/DNote.html +++ b/rdoc/classes/DNote.html @@ -39,7 +39,7 @@

      - Dnote  + D'Note  DNote

    @@ -318,7 +318,7 @@

    Public Class Methods

    options[:title] = title end - opt.on("--output", "-o [PATH]", "name of file (w/o extension) or directory") do |path| + opt.on("--output", "-o [PATH]", "name of file or directory") do |path| options[:output] = path end diff --git a/rdoc/classes/DNote/Format.html b/rdoc/classes/DNote/Format.html index 234c07a..a8ee9ca 100644 --- a/rdoc/classes/DNote/Format.html +++ b/rdoc/classes/DNote/Format.html @@ -39,7 +39,7 @@

      - Dnote  + D'Note  DNote::Format

    @@ -104,12 +104,12 @@

    Methods

  • - #debug? + #debug?
  • - #dryrun? + #dryrun?
  • @@ -119,7 +119,7 @@

    Methods

  • - #fu + #fu
  • @@ -139,12 +139,12 @@

    Methods

  • - #render_gnu + #render_gnu
  • - #render_html + #render_html
  • @@ -164,7 +164,7 @@

    Methods

  • - #render_rdoc + #render_rdoc
  • @@ -174,12 +174,12 @@

    Methods

  • - #render_xml + #render_xml
  • - #render_xoxo + #render_xoxo
  • @@ -519,7 +519,7 @@

    Public Instance Methods

    - +
    @@ -555,7 +555,7 @@

    Public Instance Methods

    - +
    @@ -690,7 +690,7 @@

    Public Instance Methods

    - +
    @@ -759,7 +759,7 @@

    Public Instance Methods

    - +
    @@ -793,7 +793,7 @@

    Public Instance Methods

    - +
    @@ -867,7 +867,7 @@

    Private Instance Methods

    - +
    @@ -899,7 +899,7 @@

    Private Instance Methods

    - +
    @@ -964,7 +964,7 @@

    Private Instance Methods

    - +
    diff --git a/rdoc/classes/DNote/Format/ErbScope.html b/rdoc/classes/DNote/Format/ErbScope.html index 030f605..e7c6bd5 100644 --- a/rdoc/classes/DNote/Format/ErbScope.html +++ b/rdoc/classes/DNote/Format/ErbScope.html @@ -39,7 +39,7 @@

      - Dnote  + D'Note  DNote::Format::ErbScope

    @@ -95,12 +95,12 @@

    Methods

  • - #h + #h
  • - #method_missing + #method_missing
  • @@ -239,7 +239,7 @@

    Public Instance Methods

    - +
    @@ -271,7 +271,7 @@

    Public Instance Methods

    - +
    diff --git a/rdoc/classes/DNote/Notes.html b/rdoc/classes/DNote/Notes.html index a4f936a..51b1eb6 100644 --- a/rdoc/classes/DNote/Notes.html +++ b/rdoc/classes/DNote/Notes.html @@ -39,7 +39,7 @@

      - Dnote  + D'Note  DNote::Notes

    @@ -90,22 +90,22 @@

    Methods

  • - ::new + ::new
  • - #counts + #counts
  • - #each + #each
  • - #empty? + #empty?
  • @@ -115,32 +115,32 @@

    Methods

  • - #labels= + #labels=
  • - #match_arbitrary + #match_arbitrary
  • - #match_common + #match_common
  • - #notes + #notes
  • - #organize + #organize
  • - #parse + #parse
  • @@ -343,7 +343,7 @@

    Public Class Methods

    - +
    @@ -383,7 +383,7 @@

    Public Instance Methods

    - +
    @@ -415,7 +415,7 @@

    Public Instance Methods

    - +
    @@ -447,7 +447,7 @@

    Public Instance Methods

    - +
    @@ -519,7 +519,7 @@

    Public Instance Methods

    - +
    @@ -558,7 +558,7 @@

    Public Instance Methods

    - +
    @@ -597,7 +597,7 @@

    Public Instance Methods

    - +
    @@ -636,7 +636,7 @@

    Public Instance Methods

    - +
    @@ -668,7 +668,7 @@

    Public Instance Methods

    - +
    @@ -712,7 +712,7 @@

    Public Instance Methods

    - +
    diff --git a/rdoc/classes/DNote/Site.html b/rdoc/classes/DNote/Site.html index e48832c..3a4f739 100644 --- a/rdoc/classes/DNote/Site.html +++ b/rdoc/classes/DNote/Site.html @@ -39,7 +39,7 @@

      - Dnote  + D'Note  DNote::Site

    diff --git a/rdoc/classes/Syckle.html b/rdoc/classes/Syckle.html index 166097a..d138d7d 100644 --- a/rdoc/classes/Syckle.html +++ b/rdoc/classes/Syckle.html @@ -39,7 +39,7 @@

      - Dnote  + D'Note  Syckle

    diff --git a/rdoc/classes/Syckle/Plugins.html b/rdoc/classes/Syckle/Plugins.html index 2c1f280..bb99f4e 100644 --- a/rdoc/classes/Syckle/Plugins.html +++ b/rdoc/classes/Syckle/Plugins.html @@ -39,7 +39,7 @@

      - Dnote  + D'Note  Syckle::Plugins

    diff --git a/rdoc/classes/Syckle/Plugins/DNote.html b/rdoc/classes/Syckle/Plugins/DNote.html index e085b21..be610ac 100644 --- a/rdoc/classes/Syckle/Plugins/DNote.html +++ b/rdoc/classes/Syckle/Plugins/DNote.html @@ -39,7 +39,7 @@

      - Dnote  + D'Note  Syckle::Plugins::DNote

    diff --git a/rdoc/created.rid b/rdoc/created.rid index 16f28fb..f8205d0 100644 --- a/rdoc/created.rid +++ b/rdoc/created.rid @@ -1 +1 @@ -Sat, 06 Feb 2010 14:31:47 -0500 +Sat, 06 Feb 2010 15:00:07 -0500 diff --git a/rdoc/files/LICENSE.html b/rdoc/files/LICENSE.html index 18df423..315c4d4 100644 --- a/rdoc/files/LICENSE.html +++ b/rdoc/files/LICENSE.html @@ -5,7 +5,7 @@ - File: LICENSE [Dnote] + File: LICENSE [D'Note] @@ -36,7 +36,7 @@

      - Dnote  + D'Note  LICENSE

    @@ -130,7 +130,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -160,13 +160,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -184,19 +184,19 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -214,7 +214,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -226,7 +226,7 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • @@ -244,37 +244,37 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • DNote::Notes - #organize + #organize
  • @@ -292,7 +292,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • @@ -322,13 +322,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -352,7 +352,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -364,13 +364,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • diff --git a/rdoc/files/README_rdoc.html b/rdoc/files/README_rdoc.html index 3e55aa1..e6bcd03 100644 --- a/rdoc/files/README_rdoc.html +++ b/rdoc/files/README_rdoc.html @@ -5,7 +5,7 @@ - File: README.rdoc [Dnote] + File: README.rdoc [D'Note] @@ -36,7 +36,7 @@

      - Dnote  + D'Note  README.rdoc

    @@ -130,7 +130,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -160,13 +160,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -184,19 +184,19 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -214,7 +214,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -226,7 +226,7 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • @@ -244,37 +244,37 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • DNote::Notes - #organize + #organize
  • @@ -292,7 +292,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • @@ -322,13 +322,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -352,7 +352,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -364,13 +364,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • diff --git a/rdoc/files/lib/dnote/command_rb.html b/rdoc/files/lib/dnote/command_rb.html index 410a000..376c7d8 100644 --- a/rdoc/files/lib/dnote/command_rb.html +++ b/rdoc/files/lib/dnote/command_rb.html @@ -5,7 +5,7 @@ - File: command.rb [Dnote] + File: command.rb [D'Note] @@ -36,7 +36,7 @@

      - Dnote  + D'Note  command.rb

    @@ -46,7 +46,7 @@

    File Stats

    Last Modified
    -
    Sat Feb 06 14:03:05 -0500 2010
    +
    Sat Feb 06 14:59:51 -0500 2010
    Requires
    @@ -143,7 +143,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -173,13 +173,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -197,19 +197,19 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -227,7 +227,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -239,7 +239,7 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • @@ -257,37 +257,37 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • DNote::Notes - #organize + #organize
  • @@ -305,7 +305,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • @@ -335,13 +335,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -365,7 +365,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -377,13 +377,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • diff --git a/rdoc/files/lib/dnote/format_rb.html b/rdoc/files/lib/dnote/format_rb.html index f0ddba7..6b83ae1 100644 --- a/rdoc/files/lib/dnote/format_rb.html +++ b/rdoc/files/lib/dnote/format_rb.html @@ -5,7 +5,7 @@ - File: format.rb [Dnote] + File: format.rb [D'Note] @@ -36,7 +36,7 @@

      - Dnote  + D'Note  format.rb

    @@ -143,7 +143,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -173,13 +173,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -197,19 +197,19 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -227,7 +227,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -239,7 +239,7 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • @@ -257,37 +257,37 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • DNote::Notes - #organize + #organize
  • @@ -305,7 +305,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • @@ -335,13 +335,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -365,7 +365,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -377,13 +377,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • diff --git a/rdoc/files/lib/dnote/notes_rb.html b/rdoc/files/lib/dnote/notes_rb.html index 4f3f1c9..01f3865 100644 --- a/rdoc/files/lib/dnote/notes_rb.html +++ b/rdoc/files/lib/dnote/notes_rb.html @@ -5,7 +5,7 @@ - File: notes.rb [Dnote] + File: notes.rb [D'Note] @@ -36,7 +36,7 @@

      - Dnote  + D'Note  notes.rb

    @@ -149,7 +149,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -179,13 +179,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -203,19 +203,19 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -233,7 +233,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -245,7 +245,7 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • @@ -263,37 +263,37 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • DNote::Notes - #organize + #organize
  • @@ -311,7 +311,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • @@ -341,13 +341,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -371,7 +371,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -383,13 +383,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • diff --git a/rdoc/files/lib/dnote/site_rb.html b/rdoc/files/lib/dnote/site_rb.html index 96b783d..859391d 100644 --- a/rdoc/files/lib/dnote/site_rb.html +++ b/rdoc/files/lib/dnote/site_rb.html @@ -5,7 +5,7 @@ - File: site.rb [Dnote] + File: site.rb [D'Note] @@ -36,7 +36,7 @@

      - Dnote  + D'Note  site.rb

    @@ -139,7 +139,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -169,13 +169,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -193,19 +193,19 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -223,7 +223,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -235,7 +235,7 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • @@ -253,37 +253,37 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • DNote::Notes - #organize + #organize
  • @@ -301,7 +301,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • @@ -331,13 +331,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -361,7 +361,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -373,13 +373,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • diff --git a/rdoc/files/lib/dnote_rb.html b/rdoc/files/lib/dnote_rb.html index 8f52a43..925f73d 100644 --- a/rdoc/files/lib/dnote_rb.html +++ b/rdoc/files/lib/dnote_rb.html @@ -5,7 +5,7 @@ - File: dnote.rb [Dnote] + File: dnote.rb [D'Note] @@ -36,7 +36,7 @@

      - Dnote  + D'Note  dnote.rb

    @@ -139,7 +139,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -169,13 +169,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -193,19 +193,19 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -223,7 +223,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -235,7 +235,7 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • @@ -253,37 +253,37 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • DNote::Notes - #organize + #organize
  • @@ -301,7 +301,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • @@ -331,13 +331,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -361,7 +361,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -373,13 +373,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • diff --git a/rdoc/files/lib/plugins/syckle/dnote_rb.html b/rdoc/files/lib/plugins/syckle/dnote_rb.html index 8c1fbbd..40255d7 100644 --- a/rdoc/files/lib/plugins/syckle/dnote_rb.html +++ b/rdoc/files/lib/plugins/syckle/dnote_rb.html @@ -5,7 +5,7 @@ - File: dnote.rb [Dnote] + File: dnote.rb [D'Note] @@ -36,7 +36,7 @@

      - Dnote  + D'Note  dnote.rb

    @@ -141,7 +141,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -171,13 +171,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -195,19 +195,19 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -225,7 +225,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -237,7 +237,7 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • @@ -255,37 +255,37 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • DNote::Notes - #organize + #organize
  • @@ -303,7 +303,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • @@ -333,13 +333,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -363,7 +363,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -375,13 +375,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • diff --git a/rdoc/index.html b/rdoc/index.html index 14eccb5..23a54b9 100644 --- a/rdoc/index.html +++ b/rdoc/index.html @@ -5,7 +5,7 @@ - Dnote + D'Note @@ -36,7 +36,7 @@

      - Dnote + D'Note

    @@ -117,7 +117,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -147,13 +147,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -171,19 +171,19 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -201,7 +201,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -213,7 +213,7 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • @@ -231,37 +231,37 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • DNote::Notes - #organize + #organize
  • @@ -279,7 +279,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • @@ -309,13 +309,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -339,7 +339,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -351,13 +351,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • @@ -480,7 +480,7 @@

    Methods

  • ::new — DNote::Format
  • -
  • ::new — DNote::Notes
  • +
  • ::new — DNote::Notes
  • ::new — DNote::Format::ErbScope
  • @@ -494,51 +494,51 @@

    Methods

  • #clean — DNote::Site
  • -
  • #counts — DNote::Notes
  • +
  • #counts — DNote::Notes
  • -
  • #debug? — DNote::Format
  • +
  • #debug? — DNote::Format
  • #document — DNote::Site
  • #document — Syckle::Plugins::DNote
  • -
  • #dryrun? — DNote::Format
  • +
  • #dryrun? — DNote::Format
  • -
  • #each — DNote::Notes
  • +
  • #each — DNote::Notes
  • -
  • #empty? — DNote::Notes
  • +
  • #empty? — DNote::Notes
  • #erb — DNote::Format
  • #files — DNote::Notes
  • -
  • #fu — DNote::Format
  • +
  • #fu — DNote::Format
  • #fu — DNote
  • -
  • #h — DNote::Format::ErbScope
  • +
  • #h — DNote::Format::ErbScope
  • #initialize_defaults — DNote::Site
  • #initialize_defaults — Syckle::Plugins::DNote
  • -
  • #labels= — DNote::Notes
  • +
  • #labels= — DNote::Notes
  • -
  • #match_arbitrary — DNote::Notes
  • +
  • #match_arbitrary — DNote::Notes
  • -
  • #match_common — DNote::Notes
  • +
  • #match_common — DNote::Notes
  • -
  • #method_missing — DNote::Format::ErbScope
  • +
  • #method_missing — DNote::Format::ErbScope
  • -
  • #notes — DNote::Notes
  • +
  • #notes — DNote::Notes
  • -
  • #organize — DNote::Notes
  • +
  • #organize — DNote::Notes
  • #output= — DNote::Site
  • #output= — Syckle::Plugins::DNote
  • -
  • #parse — DNote::Notes
  • +
  • #parse — DNote::Notes
  • #publish — DNote::Format
  • @@ -548,9 +548,9 @@

    Methods

  • #render_custom — DNote::Format
  • -
  • #render_gnu — DNote::Format
  • +
  • #render_gnu — DNote::Format
  • -
  • #render_html — DNote::Format
  • +
  • #render_html — DNote::Format
  • #render_index — DNote::Format
  • @@ -558,13 +558,13 @@

    Methods

  • #render_markdown — DNote::Format
  • -
  • #render_rdoc — DNote::Format
  • +
  • #render_rdoc — DNote::Format
  • #render_soap — DNote::Format
  • -
  • #render_xml — DNote::Format
  • +
  • #render_xml — DNote::Format
  • -
  • #render_xoxo — DNote::Format
  • +
  • #render_xoxo — DNote::Format
  • #render_yaml — DNote::Format
  • diff --git a/ri/created.rid b/ri/created.rid index af8e64a..5e377b7 100644 --- a/ri/created.rid +++ b/ri/created.rid @@ -1 +1 @@ -Sat, 06 Feb 2010 14:48:54 -0500 +Sat, 06 Feb 2010 15:00:05 -0500 From 895c3e6ebcf0cfe874dec5013f504fb08deda394 Mon Sep 17 00:00:00 2001 From: 7rans Date: Sat, 6 Feb 2010 15:08:56 -0500 Subject: [PATCH 12/27] Updated files. --- index.html | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/index.html b/index.html index 2a3c55a..3657577 100644 --- a/index.html +++ b/index.html @@ -54,12 +54,12 @@

    D'Note

    -

    Developer's take note! All those TODO: and FIXME: notes floating around your source code are rotting away. - They are trapped and in desparate need of your attention.

    - -

    Not to fret. D'Note can help you liberate them. D'Note scans source code for labeled comments, collects, - collates and sorts them, and then returns them in a format of your choosing.

    +

    Developer's take note! All those "TODO" and "FIXME" notes floating around + your source code are rotting away. They are trapped and in desparate need of your attention.

    +

    But not to fret! D'Note will help you liberate them. D'Note will scan your + source code for labeled comments, collect, collate and sort them, and then return them to you in a + format of your choosing. Wunderbar!

    Note Structure

    From fba1aa56ec095c0039f25248a75e468795ddb026 Mon Sep 17 00:00:00 2001 From: 7rans Date: Sat, 6 Feb 2010 15:12:05 -0500 Subject: [PATCH 13/27] Updated files. --- index.html | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/index.html b/index.html index 3657577..15ef931 100644 --- a/index.html +++ b/index.html @@ -133,6 +133,10 @@

    Generating Notes

    -h, --help show this help information
    +

    As you can see by the command help a variety of formats are available, here are examples of the + XML, HTML and YAML + formats.

    +

    The default path is **/*.rb and the default format --gnu. Here is an example of DNote's current notes in RDoc format:

    @@ -155,10 +159,6 @@

    Generating Notes

    (4 TODOs)
    -

    As you can see by the command help a variety of formats are available, here are examples of the - XML, HTML and YAML - formats.

    -

    In the future the Notes class will model things a bit better (so the YAML output will improve), and the parsing will be made more flexible. For instance, it would be nice if page-top outlined notes could be parsed as well.

    From eb944d8e1fe0e3d7e9389bd172c757c42b47a966 Mon Sep 17 00:00:00 2001 From: 7rans Date: Sun, 7 Feb 2010 11:08:19 -0500 Subject: [PATCH 14/27] Updated files. --- rdoc/classes/DNote/Format.html | 30 ++++----- rdoc/classes/DNote/Format/ErbScope.html | 4 +- rdoc/classes/DNote/Notes.html | 36 +++++------ rdoc/created.rid | 2 +- rdoc/files/LICENSE.html | 34 +++++------ rdoc/files/README_rdoc.html | 34 +++++------ rdoc/files/lib/dnote/command_rb.html | 34 +++++------ rdoc/files/lib/dnote/format_rb.html | 36 +++++------ rdoc/files/lib/dnote/notes_rb.html | 36 +++++------ rdoc/files/lib/dnote/site_rb.html | 34 +++++------ rdoc/files/lib/dnote_rb.html | 36 +++++------ rdoc/files/lib/plugins/syckle/dnote_rb.html | 34 +++++------ rdoc/index.html | 68 ++++++++++----------- ri/DNote/cdesc-DNote.yaml | 2 +- ri/created.rid | 2 +- 15 files changed, 211 insertions(+), 211 deletions(-) diff --git a/rdoc/classes/DNote/Format.html b/rdoc/classes/DNote/Format.html index a8ee9ca..624b71e 100644 --- a/rdoc/classes/DNote/Format.html +++ b/rdoc/classes/DNote/Format.html @@ -104,7 +104,7 @@

    Methods

  • - #debug? + #debug?
  • @@ -119,7 +119,7 @@

    Methods

  • - #fu + #fu
  • @@ -139,12 +139,12 @@

    Methods

  • - #render_gnu + #render_gnu
  • - #render_html + #render_html
  • @@ -164,7 +164,7 @@

    Methods

  • - #render_rdoc + #render_rdoc
  • @@ -174,12 +174,12 @@

    Methods

  • - #render_xml + #render_xml
  • - #render_xoxo + #render_xoxo
  • @@ -519,7 +519,7 @@

    Public Instance Methods

    - +
    @@ -555,7 +555,7 @@

    Public Instance Methods

    - +
    @@ -690,7 +690,7 @@

    Public Instance Methods

    - +
    @@ -759,7 +759,7 @@

    Public Instance Methods

    - +
    @@ -793,7 +793,7 @@

    Public Instance Methods

    - +
    @@ -867,7 +867,7 @@

    Private Instance Methods

    - +
    @@ -964,7 +964,7 @@

    Private Instance Methods

    - +
    @@ -1032,7 +1032,7 @@

    Private Instance Methods

    else puts(result) end - $stderr << "\n(" + notes.counts.map{|l,n| "#{n} #{l}s"}.join(', ') + ")\n" + $stderr << "(" + notes.counts.map{|l,n| "#{n} #{l}s"}.join(', ') + ")\n" end
    diff --git a/rdoc/classes/DNote/Format/ErbScope.html b/rdoc/classes/DNote/Format/ErbScope.html index e7c6bd5..5dbb78b 100644 --- a/rdoc/classes/DNote/Format/ErbScope.html +++ b/rdoc/classes/DNote/Format/ErbScope.html @@ -90,7 +90,7 @@

    Methods

  • - ::new + ::new
  • @@ -201,7 +201,7 @@

    Public Class Methods

    - +
    diff --git a/rdoc/classes/DNote/Notes.html b/rdoc/classes/DNote/Notes.html index 51b1eb6..f393719 100644 --- a/rdoc/classes/DNote/Notes.html +++ b/rdoc/classes/DNote/Notes.html @@ -90,22 +90,22 @@

    Methods

  • - ::new + ::new
  • - #counts + #counts
  • - #each + #each
  • - #empty? + #empty?
  • @@ -115,22 +115,22 @@

    Methods

  • - #labels= + #labels=
  • - #match_arbitrary + #match_arbitrary
  • - #match_common + #match_common
  • - #notes + #notes
  • @@ -140,7 +140,7 @@

    Methods

  • - #parse + #parse
  • @@ -343,7 +343,7 @@

    Public Class Methods

    - +
    @@ -383,7 +383,7 @@

    Public Instance Methods

    - +
    @@ -415,7 +415,7 @@

    Public Instance Methods

    - +
    @@ -447,7 +447,7 @@

    Public Instance Methods

    - +
    @@ -519,7 +519,7 @@

    Public Instance Methods

    - +
    @@ -558,7 +558,7 @@

    Public Instance Methods

    - +
    @@ -597,7 +597,7 @@

    Public Instance Methods

    - +
    @@ -636,7 +636,7 @@

    Public Instance Methods

    - +
    @@ -712,7 +712,7 @@

    Public Instance Methods

    - +
    diff --git a/rdoc/created.rid b/rdoc/created.rid index f8205d0..51e6769 100644 --- a/rdoc/created.rid +++ b/rdoc/created.rid @@ -1 +1 @@ -Sat, 06 Feb 2010 15:00:07 -0500 +Sun, 07 Feb 2010 11:08:00 -0500 diff --git a/rdoc/files/LICENSE.html b/rdoc/files/LICENSE.html index 315c4d4..540d92e 100644 --- a/rdoc/files/LICENSE.html +++ b/rdoc/files/LICENSE.html @@ -124,13 +124,13 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • DNote::Notes - ::new + ::new
  • @@ -160,13 +160,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -190,13 +190,13 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -214,7 +214,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -244,19 +244,19 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • @@ -268,7 +268,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -292,7 +292,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • @@ -322,13 +322,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -352,7 +352,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -364,13 +364,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • diff --git a/rdoc/files/README_rdoc.html b/rdoc/files/README_rdoc.html index e6bcd03..0a9b1a7 100644 --- a/rdoc/files/README_rdoc.html +++ b/rdoc/files/README_rdoc.html @@ -124,13 +124,13 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • DNote::Notes - ::new + ::new
  • @@ -160,13 +160,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -190,13 +190,13 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -214,7 +214,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -244,19 +244,19 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • @@ -268,7 +268,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -292,7 +292,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • @@ -322,13 +322,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -352,7 +352,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -364,13 +364,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • diff --git a/rdoc/files/lib/dnote/command_rb.html b/rdoc/files/lib/dnote/command_rb.html index 376c7d8..74c86f8 100644 --- a/rdoc/files/lib/dnote/command_rb.html +++ b/rdoc/files/lib/dnote/command_rb.html @@ -137,13 +137,13 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • DNote::Notes - ::new + ::new
  • @@ -173,13 +173,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -203,13 +203,13 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -227,7 +227,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -257,19 +257,19 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • @@ -281,7 +281,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -305,7 +305,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • @@ -335,13 +335,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -365,7 +365,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -377,13 +377,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • diff --git a/rdoc/files/lib/dnote/format_rb.html b/rdoc/files/lib/dnote/format_rb.html index 6b83ae1..cb9cb6b 100644 --- a/rdoc/files/lib/dnote/format_rb.html +++ b/rdoc/files/lib/dnote/format_rb.html @@ -46,7 +46,7 @@

    File Stats

    Last Modified
    -
    Sat Feb 06 14:22:36 -0500 2010
    +
    Sat Feb 06 17:45:43 -0500 2010
    Requires
    @@ -137,13 +137,13 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • DNote::Notes - ::new + ::new
  • @@ -173,13 +173,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -203,13 +203,13 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -227,7 +227,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -257,19 +257,19 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • @@ -281,7 +281,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -305,7 +305,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • @@ -335,13 +335,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -365,7 +365,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -377,13 +377,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • diff --git a/rdoc/files/lib/dnote/notes_rb.html b/rdoc/files/lib/dnote/notes_rb.html index 01f3865..4f5a0cc 100644 --- a/rdoc/files/lib/dnote/notes_rb.html +++ b/rdoc/files/lib/dnote/notes_rb.html @@ -46,7 +46,7 @@

    File Stats

    Last Modified
    -
    Sat Feb 06 14:14:16 -0500 2010
    +
    Sun Feb 07 11:04:53 -0500 2010
    Requires
    @@ -143,13 +143,13 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • DNote::Notes - ::new + ::new
  • @@ -179,13 +179,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -209,13 +209,13 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -233,7 +233,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -263,19 +263,19 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • @@ -287,7 +287,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -311,7 +311,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • @@ -341,13 +341,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -371,7 +371,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -383,13 +383,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • diff --git a/rdoc/files/lib/dnote/site_rb.html b/rdoc/files/lib/dnote/site_rb.html index 859391d..d03e0ba 100644 --- a/rdoc/files/lib/dnote/site_rb.html +++ b/rdoc/files/lib/dnote/site_rb.html @@ -133,13 +133,13 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • DNote::Notes - ::new + ::new
  • @@ -169,13 +169,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -199,13 +199,13 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -223,7 +223,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -253,19 +253,19 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • @@ -277,7 +277,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -301,7 +301,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • @@ -331,13 +331,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -361,7 +361,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -373,13 +373,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • diff --git a/rdoc/files/lib/dnote_rb.html b/rdoc/files/lib/dnote_rb.html index 925f73d..4ca000b 100644 --- a/rdoc/files/lib/dnote_rb.html +++ b/rdoc/files/lib/dnote_rb.html @@ -46,7 +46,7 @@

    File Stats

    Last Modified
    -
    Sat Feb 06 13:02:33 -0500 2010
    +
    Sun Feb 07 11:07:06 -0500 2010
    Requires
    @@ -133,13 +133,13 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • DNote::Notes - ::new + ::new
  • @@ -169,13 +169,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -199,13 +199,13 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -223,7 +223,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -253,19 +253,19 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • @@ -277,7 +277,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -301,7 +301,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • @@ -331,13 +331,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -361,7 +361,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -373,13 +373,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • diff --git a/rdoc/files/lib/plugins/syckle/dnote_rb.html b/rdoc/files/lib/plugins/syckle/dnote_rb.html index 40255d7..a4c1f14 100644 --- a/rdoc/files/lib/plugins/syckle/dnote_rb.html +++ b/rdoc/files/lib/plugins/syckle/dnote_rb.html @@ -135,13 +135,13 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • DNote::Notes - ::new + ::new
  • @@ -171,13 +171,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -201,13 +201,13 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -225,7 +225,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -255,19 +255,19 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • @@ -279,7 +279,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -303,7 +303,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • @@ -333,13 +333,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -363,7 +363,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -375,13 +375,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • diff --git a/rdoc/index.html b/rdoc/index.html index 23a54b9..192de32 100644 --- a/rdoc/index.html +++ b/rdoc/index.html @@ -111,13 +111,13 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • DNote::Notes - ::new + ::new
  • @@ -147,13 +147,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -177,13 +177,13 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -201,7 +201,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -231,19 +231,19 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • @@ -255,7 +255,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -279,7 +279,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • @@ -309,13 +309,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -339,7 +339,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -351,13 +351,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • @@ -480,9 +480,9 @@

    Methods

  • ::new — DNote::Format
  • -
  • ::new — DNote::Notes
  • +
  • ::new — DNote::Notes
  • -
  • ::new — DNote::Format::ErbScope
  • +
  • ::new — DNote::Format::ErbScope
  • ::new — DNote::Site
  • @@ -494,9 +494,9 @@

    Methods

  • #clean — DNote::Site
  • -
  • #counts — DNote::Notes
  • +
  • #counts — DNote::Notes
  • -
  • #debug? — DNote::Format
  • +
  • #debug? — DNote::Format
  • #document — DNote::Site
  • @@ -504,15 +504,15 @@

    Methods

  • #dryrun? — DNote::Format
  • -
  • #each — DNote::Notes
  • +
  • #each — DNote::Notes
  • -
  • #empty? — DNote::Notes
  • +
  • #empty? — DNote::Notes
  • #erb — DNote::Format
  • #files — DNote::Notes
  • -
  • #fu — DNote::Format
  • +
  • #fu — DNote::Format
  • #fu — DNote
  • @@ -522,15 +522,15 @@

    Methods

  • #initialize_defaults — Syckle::Plugins::DNote
  • -
  • #labels= — DNote::Notes
  • +
  • #labels= — DNote::Notes
  • -
  • #match_arbitrary — DNote::Notes
  • +
  • #match_arbitrary — DNote::Notes
  • -
  • #match_common — DNote::Notes
  • +
  • #match_common — DNote::Notes
  • #method_missing — DNote::Format::ErbScope
  • -
  • #notes — DNote::Notes
  • +
  • #notes — DNote::Notes
  • #organize — DNote::Notes
  • @@ -538,7 +538,7 @@

    Methods

  • #output= — Syckle::Plugins::DNote
  • -
  • #parse — DNote::Notes
  • +
  • #parse — DNote::Notes
  • #publish — DNote::Format
  • @@ -548,9 +548,9 @@

    Methods

  • #render_custom — DNote::Format
  • -
  • #render_gnu — DNote::Format
  • +
  • #render_gnu — DNote::Format
  • -
  • #render_html — DNote::Format
  • +
  • #render_html — DNote::Format
  • #render_index — DNote::Format
  • @@ -558,13 +558,13 @@

    Methods

  • #render_markdown — DNote::Format
  • -
  • #render_rdoc — DNote::Format
  • +
  • #render_rdoc — DNote::Format
  • #render_soap — DNote::Format
  • -
  • #render_xml — DNote::Format
  • +
  • #render_xml — DNote::Format
  • -
  • #render_xoxo — DNote::Format
  • +
  • #render_xoxo — DNote::Format
  • #render_yaml — DNote::Format
  • diff --git a/ri/DNote/cdesc-DNote.yaml b/ri/DNote/cdesc-DNote.yaml index 9f334a7..9724964 100644 --- a/ri/DNote/cdesc-DNote.yaml +++ b/ri/DNote/cdesc-DNote.yaml @@ -9,7 +9,7 @@ constants: - !ruby/object:RDoc::RI::Constant comment: name: VERSION - value: "\"1.1\"" + value: "\"1.1.1\"" full_name: DNote includes: [] diff --git a/ri/created.rid b/ri/created.rid index 5e377b7..43a16aa 100644 --- a/ri/created.rid +++ b/ri/created.rid @@ -1 +1 @@ -Sat, 06 Feb 2010 15:00:05 -0500 +Sun, 07 Feb 2010 11:07:56 -0500 From 7a63f10ce66eb830349f87880e00f75faac882a5 Mon Sep 17 00:00:00 2001 From: 7rans Date: Sun, 7 Feb 2010 11:37:50 -0500 Subject: [PATCH 15/27] Updated files. --- rdoc/classes/DNote.html | 4 + rdoc/classes/DNote/Format.html | 70 +-- rdoc/classes/DNote/Format/ErbScope.html | 20 +- rdoc/classes/DNote/Notes.html | 72 +-- rdoc/classes/DNote/Site.html | 4 + rdoc/classes/String.html | 189 ++++++++ rdoc/classes/Syckle.html | 4 + rdoc/classes/Syckle/Plugins.html | 4 + rdoc/classes/Syckle/Plugins/DNote.html | 24 +- rdoc/classes/Xacto.html | 198 ++++++++ rdoc/classes/Xacto/String.html | 351 ++++++++++++++ rdoc/created.rid | 2 +- rdoc/files/LICENSE.html | 88 ++-- rdoc/files/README_rdoc.html | 88 ++-- rdoc/files/lib/dnote/command_rb.html | 88 ++-- rdoc/files/lib/dnote/format_rb.html | 92 ++-- rdoc/files/lib/dnote/notes_rb.html | 90 ++-- rdoc/files/lib/dnote/site_rb.html | 88 ++-- rdoc/files/lib/dnote/string_rb.html | 496 ++++++++++++++++++++ rdoc/files/lib/dnote_rb.html | 90 ++-- rdoc/files/lib/plugins/syckle/dnote_rb.html | 88 ++-- rdoc/index.html | 158 ++++--- ri/DNote/cdesc-DNote.yaml | 2 +- ri/String/cdesc-String.yaml | 15 + ri/Xacto/String/cdesc-String.yaml | 25 + ri/Xacto/String/indent-i.yaml | 14 + ri/Xacto/String/margin-i.yaml | 14 + ri/Xacto/String/tabto-i.yaml | 14 + ri/Xacto/cdesc-Xacto.yaml | 15 + ri/created.rid | 2 +- 30 files changed, 1993 insertions(+), 416 deletions(-) create mode 100644 rdoc/classes/String.html create mode 100644 rdoc/classes/Xacto.html create mode 100644 rdoc/classes/Xacto/String.html create mode 100644 rdoc/files/lib/dnote/string_rb.html create mode 100644 ri/String/cdesc-String.yaml create mode 100644 ri/Xacto/String/cdesc-String.yaml create mode 100644 ri/Xacto/String/indent-i.yaml create mode 100644 ri/Xacto/String/margin-i.yaml create mode 100644 ri/Xacto/String/tabto-i.yaml create mode 100644 ri/Xacto/cdesc-Xacto.yaml diff --git a/rdoc/classes/DNote.html b/rdoc/classes/DNote.html index f8bdbcd..e550664 100644 --- a/rdoc/classes/DNote.html +++ b/rdoc/classes/DNote.html @@ -184,6 +184,10 @@

    Class Index
  • Syckle::Plugins::DNote
  • +
  • Xacto
  • + +
  • Xacto::String
  • +

    diff --git a/rdoc/classes/DNote/Format.html b/rdoc/classes/DNote/Format.html index 624b71e..122a578 100644 --- a/rdoc/classes/DNote/Format.html +++ b/rdoc/classes/DNote/Format.html @@ -104,7 +104,7 @@

    Methods

  • - #debug? + #debug?
  • @@ -119,7 +119,7 @@

    Methods

  • - #fu + #fu
  • @@ -139,12 +139,12 @@

    Methods

  • - #render_gnu + #render_gnu
  • - #render_html + #render_html
  • @@ -164,7 +164,7 @@

    Methods

  • - #render_rdoc + #render_rdoc
  • @@ -174,12 +174,12 @@

    Methods

  • - #render_xml + #render_xml
  • - #render_xoxo + #render_xoxo
  • @@ -247,6 +247,10 @@

    Class Index
  • Syckle::Plugins::DNote
  • +
  • Xacto
  • + +
  • Xacto::String
  • +

    @@ -423,7 +427,7 @@

    Public Class Methods

    -# File lib/dnote/format.rb, line 39
    +# File lib/dnote/format.rb, line 40
         def initialize(notes, options={})
           @notes  = notes
           @format = :gnu
    @@ -466,7 +470,7 @@ 

    Public Instance Methods

    -# File lib/dnote/format.rb, line 49
    +# File lib/dnote/format.rb, line 50
         def render
           if notes.empty?
             $stderr << "No #{notes.labels.join(', ')} notes.\n"
    @@ -505,7 +509,7 @@ 

    Public Instance Methods

    -# File lib/dnote/format.rb, line 122
    +# File lib/dnote/format.rb, line 123
         def render_custom
           result = erb(template)
           publish(result)    
    @@ -519,7 +523,7 @@ 

    Public Instance Methods

    - +
    @@ -540,7 +544,7 @@

    Public Instance Methods

    -# File lib/dnote/format.rb, line 102
    +# File lib/dnote/format.rb, line 103
         def render_gnu
           template = File.join(File.dirname(__FILE__), 'templates/gnu.erb')
           result = erb(template)
    @@ -555,7 +559,7 @@ 

    Public Instance Methods

    - +
    @@ -574,7 +578,7 @@

    Public Instance Methods

    -# File lib/dnote/format.rb, line 88
    +# File lib/dnote/format.rb, line 89
         def render_html
           template = File.join(File.dirname(__FILE__), 'templates/html.erb')
           result = erb(template)
    @@ -608,7 +612,7 @@ 

    Public Instance Methods

    -# File lib/dnote/format.rb, line 94
    +# File lib/dnote/format.rb, line 95
         def render_index
           template = File.join(File.dirname(__FILE__), 'templates/html.erb')
           result = erb(template)
    @@ -642,7 +646,7 @@ 

    Public Instance Methods

    -# File lib/dnote/format.rb, line 65
    +# File lib/dnote/format.rb, line 66
         def render_json
           result = notes.to_json
           publish(result)
    @@ -675,7 +679,7 @@ 

    Public Instance Methods

    -# File lib/dnote/format.rb, line 114
    +# File lib/dnote/format.rb, line 115
         def render_markdown
           template = File.join(File.dirname(__FILE__), 'templates/markdown.erb')
           result = erb(template)
    @@ -690,7 +694,7 @@ 

    Public Instance Methods

    - +
    @@ -709,7 +713,7 @@

    Public Instance Methods

    -# File lib/dnote/format.rb, line 108
    +# File lib/dnote/format.rb, line 109
         def render_rdoc
           template = File.join(File.dirname(__FILE__), 'templates/rdoc.erb')
           result = erb(template)
    @@ -745,7 +749,7 @@ 

    Public Instance Methods

    -# File lib/dnote/format.rb, line 72
    +# File lib/dnote/format.rb, line 73
         def render_soap
           result = notes.to_soap
           publish(result)
    @@ -759,7 +763,7 @@ 

    Public Instance Methods

    - +
    @@ -778,7 +782,7 @@

    Public Instance Methods

    -# File lib/dnote/format.rb, line 82
    +# File lib/dnote/format.rb, line 83
         def render_xml
           template = File.join(File.dirname(__FILE__), 'templates/xml.erb')
           result = erb(template)
    @@ -793,7 +797,7 @@ 

    Public Instance Methods

    - +
    @@ -812,7 +816,7 @@

    Public Instance Methods

    -# File lib/dnote/format.rb, line 77
    +# File lib/dnote/format.rb, line 78
         def render_xoxo
           result = notes.to_xoxo
           publish(result)
    @@ -847,7 +851,7 @@ 

    Public Instance Methods

    -# File lib/dnote/format.rb, line 60
    +# File lib/dnote/format.rb, line 61
         def render_yaml
           result = notes.to_yaml
           publish(result)
    @@ -867,7 +871,7 @@ 

    Private Instance Methods

    - +
    @@ -886,7 +890,7 @@

    Private Instance Methods

    -# File lib/dnote/format.rb, line 170
    +# File lib/dnote/format.rb, line 171
         def debug?
           $DEBUG
         end
    @@ -918,7 +922,7 @@

    Private Instance Methods

    -# File lib/dnote/format.rb, line 165
    +# File lib/dnote/format.rb, line 166
         def dryrun?
           @dryrun
         end
    @@ -950,7 +954,7 @@

    Private Instance Methods

    -# File lib/dnote/format.rb, line 130
    +# File lib/dnote/format.rb, line 131
         def erb(file)
           scope = ErbScope.new(:notes=>notes, :title=>title)
           scope.render(file)
    @@ -964,7 +968,7 @@ 

    Private Instance Methods

    - +
    @@ -983,7 +987,7 @@

    Private Instance Methods

    -# File lib/dnote/format.rb, line 175
    +# File lib/dnote/format.rb, line 176
         def fu
           @fu ||= (
             if dryrun? and debug?
    @@ -1025,7 +1029,7 @@ 

    Private Instance Methods

    -# File lib/dnote/format.rb, line 136
    +# File lib/dnote/format.rb, line 137
         def publish(result, fname=nil)
           if output
             write(result, fname)
    @@ -1062,7 +1066,7 @@ 

    Private Instance Methods

    -# File lib/dnote/format.rb, line 146
    +# File lib/dnote/format.rb, line 147
         def write(result, fname=nil)
           if output.end_with?('/') || File.directory?(output)
             ext  = EXTENSIONS[format] || format
    diff --git a/rdoc/classes/DNote/Format/ErbScope.html b/rdoc/classes/DNote/Format/ErbScope.html
    index 5dbb78b..741a801 100644
    --- a/rdoc/classes/DNote/Format/ErbScope.html
    +++ b/rdoc/classes/DNote/Format/ErbScope.html
    @@ -95,7 +95,7 @@ 

    Methods

  • - #h + #h
  • @@ -105,7 +105,7 @@

    Methods

  • - #render + #render
  • @@ -163,6 +163,10 @@

    Class Index
  • Syckle::Plugins::DNote
  • +
  • Xacto
  • + +
  • Xacto::String
  • +

    @@ -220,7 +224,7 @@

    Public Class Methods

    -# File lib/dnote/format.rb, line 192
    +# File lib/dnote/format.rb, line 193
           def initialize(data={})
             @data = data
           end
    @@ -239,7 +243,7 @@

    Public Instance Methods

    - +
    @@ -258,7 +262,7 @@

    Public Instance Methods

    -# File lib/dnote/format.rb, line 201
    +# File lib/dnote/format.rb, line 202
           def h(string)
             REXML::Text.normalize(string)
           end
    @@ -290,7 +294,7 @@

    Public Instance Methods

    -# File lib/dnote/format.rb, line 205
    +# File lib/dnote/format.rb, line 206
           def method_missing(s, *a)
             @data[s.to_sym]
           end
    @@ -303,7 +307,7 @@

    Public Instance Methods

    - +
    @@ -322,7 +326,7 @@

    Public Instance Methods

    -# File lib/dnote/format.rb, line 196
    +# File lib/dnote/format.rb, line 197
           def render(file)
             erb = ERB.new(File.read(file), nil, '<>')
             erb.result(binding)
    diff --git a/rdoc/classes/DNote/Notes.html b/rdoc/classes/DNote/Notes.html
    index f393719..61be98f 100644
    --- a/rdoc/classes/DNote/Notes.html
    +++ b/rdoc/classes/DNote/Notes.html
    @@ -90,22 +90,22 @@ 

    Methods

  • - ::new + ::new
  • - #counts + #counts
  • - #each + #each
  • - #empty? + #empty?
  • @@ -115,22 +115,22 @@

    Methods

  • - #labels= + #labels=
  • - #match_arbitrary + #match_arbitrary
  • - #match_common + #match_common
  • - #notes + #notes
  • @@ -140,7 +140,7 @@

    Methods

  • - #parse + #parse
  • @@ -155,12 +155,12 @@

    Methods

  • - #to_soap + #to_soap
  • - #to_xoxo + #to_xoxo
  • @@ -234,6 +234,10 @@

    Class Index
  • Syckle::Plugins::DNote
  • +
  • Xacto
  • + +
  • Xacto::String
  • +

    @@ -343,7 +347,7 @@

    Public Class Methods

    - +
    @@ -383,7 +387,7 @@

    Public Instance Methods

    - +
    @@ -415,7 +419,7 @@

    Public Instance Methods

    - +
    @@ -447,7 +451,7 @@

    Public Instance Methods

    - +
    @@ -498,7 +502,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 111
    +# File lib/dnote/notes.rb, line 115
         def files
           @files ||= (
             [self.paths].flatten.map do |path|
    @@ -519,7 +523,7 @@ 

    Public Instance Methods

    - +
    @@ -558,7 +562,7 @@

    Public Instance Methods

    - +
    @@ -577,7 +581,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 136
    +# File lib/dnote/notes.rb, line 140
         def match_arbitrary(line, lineno, file)
           rec = nil
           labels.each do |label|
    @@ -597,7 +601,7 @@ 

    Public Instance Methods

    - +
    @@ -616,7 +620,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 124
    +# File lib/dnote/notes.rb, line 128
         def match_common(line, lineno, file)
           rec = nil
           labels.each do |label|
    @@ -636,7 +640,7 @@ 

    Public Instance Methods

    - +
    @@ -689,7 +693,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 149
    +# File lib/dnote/notes.rb, line 153
         def organize(records)
           orecs = {}
           records.each do |record|
    @@ -712,7 +716,7 @@ 

    Public Instance Methods

    - +
    @@ -757,7 +761,11 @@

    Public Instance Methods

    text.strip! text = nil else - text << ' ' << line.gsub(/^\s*#\s*/,'') + if text[-1,1] == "\n" + text << line.gsub(/^\s*#\s*/,'') + else + text << "\n" << line.gsub(/^\s*#\s*/,'') + end end end end @@ -797,7 +805,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 164
    +# File lib/dnote/notes.rb, line 168
         def to(format)
           __send__("to_#{format}")
         end
    @@ -829,7 +837,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 175
    +# File lib/dnote/notes.rb, line 179
         def to_json
           begin
             require 'json'
    @@ -847,7 +855,7 @@ 

    Public Instance Methods

    - +
    @@ -868,7 +876,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 185
    +# File lib/dnote/notes.rb, line 189
         def to_soap
           require 'soap/marshal'
           SOAP::Marshal.marshal(notes)
    @@ -882,7 +890,7 @@ 

    Public Instance Methods

    - +
    @@ -903,7 +911,7 @@

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 191
    +# File lib/dnote/notes.rb, line 195
         def to_xoxo
           require 'xoxo'
           notes.to_xoxo
    @@ -936,7 +944,7 @@ 

    Public Instance Methods

    -# File lib/dnote/notes.rb, line 169
    +# File lib/dnote/notes.rb, line 173
         def to_yaml
           require 'yaml'
           notes.to_yaml
    diff --git a/rdoc/classes/DNote/Site.html b/rdoc/classes/DNote/Site.html
    index 3a4f739..86f0db7 100644
    --- a/rdoc/classes/DNote/Site.html
    +++ b/rdoc/classes/DNote/Site.html
    @@ -173,6 +173,10 @@ 

    Class Index
  • Syckle::Plugins::DNote
  • +
  • Xacto
  • + +
  • Xacto::String
  • +

    diff --git a/rdoc/classes/String.html b/rdoc/classes/String.html new file mode 100644 index 0000000..ceb8a37 --- /dev/null +++ b/rdoc/classes/String.html @@ -0,0 +1,189 @@ + + + + + + + + Class: String + + + + + + + + + + + + + + + + +
    + +
    +

    + +   + + D'Note  + String +

    +
    + +
    +
    + +
    +

    In Files

    +
    + +
    +
    + + + + + +
    + +
    + + + +
    +

    Parent

    +
      + +
    • Object
    • + +
    +
    + + + + + + + + + + +
    + +
    + + +
    +

    Information

    + +
    + + +
    +

    Class Index + [+]

    +
    +
    + Quicksearch + +
    +
    + + + + +
    +
    + +
    + +
    + [Validate] +
    + Generated with WebRI Redfish 1.1 +

    +
    +
    + +
    + +
    + +

    String

    + + + +
    + + + + + + + + + + +
    + + +
    + +

    Disabled; run with --debug to generate this.

    + +
    + + + + + diff --git a/rdoc/classes/Syckle.html b/rdoc/classes/Syckle.html index d138d7d..3f53e31 100644 --- a/rdoc/classes/Syckle.html +++ b/rdoc/classes/Syckle.html @@ -133,6 +133,10 @@

    Class Index
  • Syckle::Plugins::DNote
  • +
  • Xacto
  • + +
  • Xacto::String
  • +

    diff --git a/rdoc/classes/Syckle/Plugins.html b/rdoc/classes/Syckle/Plugins.html index bb99f4e..08b7cbd 100644 --- a/rdoc/classes/Syckle/Plugins.html +++ b/rdoc/classes/Syckle/Plugins.html @@ -136,6 +136,10 @@

    Class Index
  • Syckle::Plugins::DNote
  • +
  • Xacto
  • + +
  • Xacto::String
  • +

    diff --git a/rdoc/classes/Syckle/Plugins/DNote.html b/rdoc/classes/Syckle/Plugins/DNote.html index be610ac..9ba8993 100644 --- a/rdoc/classes/Syckle/Plugins/DNote.html +++ b/rdoc/classes/Syckle/Plugins/DNote.html @@ -90,27 +90,27 @@

    Methods

  • - #clean + #clean
  • - #document + #document
  • - #initialize_defaults + #initialize_defaults
  • - #output= + #output=
  • - #reset + #reset
  • @@ -168,6 +168,10 @@

    Class Index
  • Syckle::Plugins::DNote
  • +
  • Xacto
  • + +
  • Xacto::String
  • +

    @@ -320,7 +324,7 @@

    Public Instance Methods

    - +
    @@ -361,7 +365,7 @@

    Public Instance Methods

    - +
    @@ -404,7 +408,7 @@

    Public Instance Methods

    - +
    @@ -436,7 +440,7 @@

    Public Instance Methods

    - +
    @@ -479,7 +483,7 @@

    Private Instance Methods

    - +
    diff --git a/rdoc/classes/Xacto.html b/rdoc/classes/Xacto.html new file mode 100644 index 0000000..8a4271b --- /dev/null +++ b/rdoc/classes/Xacto.html @@ -0,0 +1,198 @@ + + + + + + + + Class: Xacto + + + + + + + + + + + + + + + + +
    + +
    +

    + +   + + D'Note  + Xacto +

    +
    + +
    +
    + +
    +

    In Files

    +
    + +
    +
    + + + + + +
    + +
    + + + +
    +

    Parent

    +
      + +
    • Object
    • + +
    +
    + + + + +
    +

    Namespace

    + +
    + + + + + + + +
    + +
    + + +
    +

    Information

    + +
    + + +
    +

    Class Index + [+]

    +
    +
    + Quicksearch + +
    +
    + + + + +
    +
    + +
    + +
    + [Validate] +
    + Generated with WebRI Redfish 1.1 +

    +
    +
    + +
    + +
    + +

    Xacto

    + + + +
    + + + + + + + + + + +
    + + +
    + +

    Disabled; run with --debug to generate this.

    + +
    + + + + + diff --git a/rdoc/classes/Xacto/String.html b/rdoc/classes/Xacto/String.html new file mode 100644 index 0000000..79ff516 --- /dev/null +++ b/rdoc/classes/Xacto/String.html @@ -0,0 +1,351 @@ + + + + + + + + Module: Xacto::String + + + + + + + + + + + + + + + + +
    + +
    +

    + +   + + D'Note  + Xacto::String +

    +
    + +
    +
    + +
    +

    In Files

    +
    + +
    +
    + + + + + +
    + +
    + + + + + + + + + +
    +

    Methods

    + +
    + + + + +
    + +
    + + +
    +

    Information

    + +
    + + +
    +

    Class Index + [+]

    +
    +
    + Quicksearch + +
    +
    + + + + +
    +
    + +
    + +
    + [Validate] +
    + Generated with WebRI Redfish 1.1 +

    +
    +
    + +
    + +
    + +

    String

    + + +

    +Extensions for String class. These methods are +taken directly from Ruby Facets. +

    + +
    + + + + + + + + + +
    +

    Public Instance Methods

    + + +
    + + +
    + + indent(n) + click to toggle source + +
    + +
    + +

    +Indent left or right by n spaces. (This used to be called tab and aliased +as indent.) +

    +
    + CREDIT: Gavin Sinclair
    + CREDIT: Trans
    +
    + + + +
    +
    +# File lib/dnote/string.rb, line 53
    +    def indent(n)
    +      if n >= 0
    +        gsub(/^/, ' ' * n)
    +      else
    +        gsub(/^ {0,#{-n}}/, "")
    +      end
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + margin(n=0) + click to toggle source + +
    + +
    + +

    +Provides a margin controlled string. +

    +
    +  x = %Q{
    +        | This
    +        |   is
    +        |     margin controlled!
    +        }.margin
    +
    +  NOTE: This may still need a bit of tweaking.
    +
    + CREDIT: Trans
    +
    + + + +
    +
    +# File lib/dnote/string.rb, line 21
    +    def margin(n=0)
    +      #d = /\A.*\n\s*(.)/.match( self )[1]
    +      #d = /\A\s*(.)/.match( self)[1] unless d
    +      d = ((/\A.*\n\s*(.)/.match(self)) ||
    +          (/\A\s*(.)/.match(self)))[1]
    +      return '' unless d
    +      if n == 0
    +        gsub(/\n\s*\Z/,'').gsub(/^\s*[#{d}]/, '')
    +      else
    +        gsub(/\n\s*\Z/,'').gsub(/^\s*[#{d}]/, ' ' * n)
    +      end
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + tabto(n) + click to toggle source + +
    + +
    + +

    +Preserves relative tabbing. The first non-empty line ends up with n spaces +before nonspace. +

    +
    + CREDIT: Gavin Sinclair
    +
    + + + +
    +
    +# File lib/dnote/string.rb, line 39
    +    def tabto(n)
    +      if self =~ /^( *)\S/
    +        indent(n - $1.length)
    +      else
    +        self
    +      end
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + +
    + +

    Disabled; run with --debug to generate this.

    + +
    + + + + + diff --git a/rdoc/created.rid b/rdoc/created.rid index 51e6769..ac19631 100644 --- a/rdoc/created.rid +++ b/rdoc/created.rid @@ -1 +1 @@ -Sun, 07 Feb 2010 11:08:00 -0500 +Sun, 07 Feb 2010 11:37:06 -0500 diff --git a/rdoc/files/LICENSE.html b/rdoc/files/LICENSE.html index 540d92e..f231e60 100644 --- a/rdoc/files/LICENSE.html +++ b/rdoc/files/LICENSE.html @@ -100,6 +100,10 @@

    Class Index
  • Syckle::Plugins::DNote
  • +
  • Xacto
  • + +
  • Xacto::String
  • +

    @@ -130,7 +134,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -148,7 +152,7 @@

    Method Index

  • Syckle::Plugins::DNote - #clean + #clean
  • @@ -160,19 +164,19 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • Syckle::Plugins::DNote - #document + #document
  • @@ -190,13 +194,13 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -214,7 +218,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -226,37 +230,49 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • - DNote::Site - #initialize_defaults + Xacto::String + #indent
  • Syckle::Plugins::DNote - #initialize_defaults + #initialize_defaults +
  • + + +
  • + DNote::Site + #initialize_defaults
  • DNote::Notes - #labels= + #labels= +
  • + + +
  • + Xacto::String + #margin
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • @@ -268,7 +284,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -279,20 +295,20 @@

    Method Index

  • - Syckle::Plugins::DNote - #output= + DNote::Site + #output=
  • - DNote::Site - #output= + Syckle::Plugins::DNote + #output=
  • DNote::Notes - #parse + #parse
  • @@ -303,14 +319,14 @@

    Method Index

  • - DNote::Format - #render + DNote::Format::ErbScope + #render
  • - DNote::Format::ErbScope - #render + DNote::Format + #render
  • @@ -322,13 +338,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -352,7 +368,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -364,13 +380,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • @@ -382,7 +398,7 @@

    Method Index

  • Syckle::Plugins::DNote - #reset + #reset
  • @@ -392,6 +408,12 @@

    Method Index

    +
  • + Xacto::String + #tabto +
  • + +
  • DNote #templates @@ -412,13 +434,13 @@

    Method Index

  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • diff --git a/rdoc/files/README_rdoc.html b/rdoc/files/README_rdoc.html index 0a9b1a7..eef2434 100644 --- a/rdoc/files/README_rdoc.html +++ b/rdoc/files/README_rdoc.html @@ -100,6 +100,10 @@

    Class Index
  • Syckle::Plugins::DNote
  • +
  • Xacto
  • + +
  • Xacto::String
  • +

    @@ -130,7 +134,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -148,7 +152,7 @@

    Method Index

  • Syckle::Plugins::DNote - #clean + #clean
  • @@ -160,19 +164,19 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • Syckle::Plugins::DNote - #document + #document
  • @@ -190,13 +194,13 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -214,7 +218,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -226,37 +230,49 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • - DNote::Site - #initialize_defaults + Xacto::String + #indent
  • Syckle::Plugins::DNote - #initialize_defaults + #initialize_defaults +
  • + + +
  • + DNote::Site + #initialize_defaults
  • DNote::Notes - #labels= + #labels= +
  • + + +
  • + Xacto::String + #margin
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • @@ -268,7 +284,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -279,20 +295,20 @@

    Method Index

  • - Syckle::Plugins::DNote - #output= + DNote::Site + #output=
  • - DNote::Site - #output= + Syckle::Plugins::DNote + #output=
  • DNote::Notes - #parse + #parse
  • @@ -303,14 +319,14 @@

    Method Index

  • - DNote::Format - #render + DNote::Format::ErbScope + #render
  • - DNote::Format::ErbScope - #render + DNote::Format + #render
  • @@ -322,13 +338,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -352,7 +368,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -364,13 +380,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • @@ -382,7 +398,7 @@

    Method Index

  • Syckle::Plugins::DNote - #reset + #reset
  • @@ -392,6 +408,12 @@

    Method Index

    +
  • + Xacto::String + #tabto +
  • + +
  • DNote #templates @@ -412,13 +434,13 @@

    Method Index

  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • diff --git a/rdoc/files/lib/dnote/command_rb.html b/rdoc/files/lib/dnote/command_rb.html index 74c86f8..576c159 100644 --- a/rdoc/files/lib/dnote/command_rb.html +++ b/rdoc/files/lib/dnote/command_rb.html @@ -113,6 +113,10 @@

    Class Index
  • Syckle::Plugins::DNote
  • +
  • Xacto
  • + +
  • Xacto::String
  • +

    @@ -143,7 +147,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -161,7 +165,7 @@

    Method Index

  • Syckle::Plugins::DNote - #clean + #clean
  • @@ -173,19 +177,19 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • Syckle::Plugins::DNote - #document + #document
  • @@ -203,13 +207,13 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -227,7 +231,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -239,37 +243,49 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • - DNote::Site - #initialize_defaults + Xacto::String + #indent
  • Syckle::Plugins::DNote - #initialize_defaults + #initialize_defaults +
  • + + +
  • + DNote::Site + #initialize_defaults
  • DNote::Notes - #labels= + #labels= +
  • + + +
  • + Xacto::String + #margin
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • @@ -281,7 +297,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -292,20 +308,20 @@

    Method Index

  • - Syckle::Plugins::DNote - #output= + DNote::Site + #output=
  • - DNote::Site - #output= + Syckle::Plugins::DNote + #output=
  • DNote::Notes - #parse + #parse
  • @@ -316,14 +332,14 @@

    Method Index

  • - DNote::Format - #render + DNote::Format::ErbScope + #render
  • - DNote::Format::ErbScope - #render + DNote::Format + #render
  • @@ -335,13 +351,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -365,7 +381,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -377,13 +393,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • @@ -395,7 +411,7 @@

    Method Index

  • Syckle::Plugins::DNote - #reset + #reset
  • @@ -405,6 +421,12 @@

    Method Index

    +
  • + Xacto::String + #tabto +
  • + +
  • DNote #templates @@ -425,13 +447,13 @@

    Method Index

  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • diff --git a/rdoc/files/lib/dnote/format_rb.html b/rdoc/files/lib/dnote/format_rb.html index cb9cb6b..f548c09 100644 --- a/rdoc/files/lib/dnote/format_rb.html +++ b/rdoc/files/lib/dnote/format_rb.html @@ -46,7 +46,7 @@

    File Stats

    Last Modified
    -
    Sat Feb 06 17:45:43 -0500 2010
    +
    Sun Feb 07 11:17:26 -0500 2010
    Requires
    @@ -59,6 +59,8 @@

    File Stats

  • rexml/text
  • +
  • dnote/string
  • + @@ -113,6 +115,10 @@

    Class Index
  • Syckle::Plugins::DNote
  • +
  • Xacto
  • + +
  • Xacto::String
  • +

    @@ -143,7 +149,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -161,7 +167,7 @@

    Method Index

  • Syckle::Plugins::DNote - #clean + #clean
  • @@ -173,19 +179,19 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • Syckle::Plugins::DNote - #document + #document
  • @@ -203,13 +209,13 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -227,7 +233,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -239,37 +245,49 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • - DNote::Site - #initialize_defaults + Xacto::String + #indent
  • Syckle::Plugins::DNote - #initialize_defaults + #initialize_defaults +
  • + + +
  • + DNote::Site + #initialize_defaults
  • DNote::Notes - #labels= + #labels= +
  • + + +
  • + Xacto::String + #margin
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • @@ -281,7 +299,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -292,20 +310,20 @@

    Method Index

  • - Syckle::Plugins::DNote - #output= + DNote::Site + #output=
  • - DNote::Site - #output= + Syckle::Plugins::DNote + #output=
  • DNote::Notes - #parse + #parse
  • @@ -316,14 +334,14 @@

    Method Index

  • - DNote::Format - #render + DNote::Format::ErbScope + #render
  • - DNote::Format::ErbScope - #render + DNote::Format + #render
  • @@ -335,13 +353,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -365,7 +383,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -377,13 +395,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • @@ -395,7 +413,7 @@

    Method Index

  • Syckle::Plugins::DNote - #reset + #reset
  • @@ -405,6 +423,12 @@

    Method Index

    +
  • + Xacto::String + #tabto +
  • + +
  • DNote #templates @@ -425,13 +449,13 @@

    Method Index

  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • diff --git a/rdoc/files/lib/dnote/notes_rb.html b/rdoc/files/lib/dnote/notes_rb.html index 4f5a0cc..550808c 100644 --- a/rdoc/files/lib/dnote/notes_rb.html +++ b/rdoc/files/lib/dnote/notes_rb.html @@ -46,7 +46,7 @@

    File Stats

    Last Modified
    -
    Sun Feb 07 11:04:53 -0500 2010
    +
    Sun Feb 07 11:22:28 -0500 2010
    Requires
    @@ -119,6 +119,10 @@

    Class Index
  • Syckle::Plugins::DNote
  • +
  • Xacto
  • + +
  • Xacto::String
  • +

    @@ -149,7 +153,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -167,7 +171,7 @@

    Method Index

  • Syckle::Plugins::DNote - #clean + #clean
  • @@ -179,19 +183,19 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • Syckle::Plugins::DNote - #document + #document
  • @@ -209,13 +213,13 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -233,7 +237,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -245,37 +249,49 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • - DNote::Site - #initialize_defaults + Xacto::String + #indent
  • Syckle::Plugins::DNote - #initialize_defaults + #initialize_defaults +
  • + + +
  • + DNote::Site + #initialize_defaults
  • DNote::Notes - #labels= + #labels= +
  • + + +
  • + Xacto::String + #margin
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • @@ -287,7 +303,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -298,20 +314,20 @@

    Method Index

  • - Syckle::Plugins::DNote - #output= + DNote::Site + #output=
  • - DNote::Site - #output= + Syckle::Plugins::DNote + #output=
  • DNote::Notes - #parse + #parse
  • @@ -322,14 +338,14 @@

    Method Index

  • - DNote::Format - #render + DNote::Format::ErbScope + #render
  • - DNote::Format::ErbScope - #render + DNote::Format + #render
  • @@ -341,13 +357,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -371,7 +387,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -383,13 +399,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • @@ -401,7 +417,7 @@

    Method Index

  • Syckle::Plugins::DNote - #reset + #reset
  • @@ -411,6 +427,12 @@

    Method Index

    +
  • + Xacto::String + #tabto +
  • + +
  • DNote #templates @@ -431,13 +453,13 @@

    Method Index

  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • diff --git a/rdoc/files/lib/dnote/site_rb.html b/rdoc/files/lib/dnote/site_rb.html index d03e0ba..a24763a 100644 --- a/rdoc/files/lib/dnote/site_rb.html +++ b/rdoc/files/lib/dnote/site_rb.html @@ -109,6 +109,10 @@

    Class Index
  • Syckle::Plugins::DNote
  • +
  • Xacto
  • + +
  • Xacto::String
  • +

    @@ -139,7 +143,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -157,7 +161,7 @@

    Method Index

  • Syckle::Plugins::DNote - #clean + #clean
  • @@ -169,19 +173,19 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • Syckle::Plugins::DNote - #document + #document
  • @@ -199,13 +203,13 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -223,7 +227,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -235,37 +239,49 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • - DNote::Site - #initialize_defaults + Xacto::String + #indent
  • Syckle::Plugins::DNote - #initialize_defaults + #initialize_defaults +
  • + + +
  • + DNote::Site + #initialize_defaults
  • DNote::Notes - #labels= + #labels= +
  • + + +
  • + Xacto::String + #margin
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • @@ -277,7 +293,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -288,20 +304,20 @@

    Method Index

  • - Syckle::Plugins::DNote - #output= + DNote::Site + #output=
  • - DNote::Site - #output= + Syckle::Plugins::DNote + #output=
  • DNote::Notes - #parse + #parse
  • @@ -312,14 +328,14 @@

    Method Index

  • - DNote::Format - #render + DNote::Format::ErbScope + #render
  • - DNote::Format::ErbScope - #render + DNote::Format + #render
  • @@ -331,13 +347,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -361,7 +377,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -373,13 +389,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • @@ -391,7 +407,7 @@

    Method Index

  • Syckle::Plugins::DNote - #reset + #reset
  • @@ -401,6 +417,12 @@

    Method Index

    +
  • + Xacto::String + #tabto +
  • + +
  • DNote #templates @@ -421,13 +443,13 @@

    Method Index

  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • diff --git a/rdoc/files/lib/dnote/string_rb.html b/rdoc/files/lib/dnote/string_rb.html new file mode 100644 index 0000000..d1e9eaa --- /dev/null +++ b/rdoc/files/lib/dnote/string_rb.html @@ -0,0 +1,496 @@ + + + + + + + + File: string.rb [D'Note] + + + + + + + + + + + + + + + +
    + +
    +

    +   + D'Note  + string.rb +

    +
    + +
    +
    +

    File Stats

    +
    +
    Last Modified
    +
    Sun Feb 07 11:16:58 -0500 2010
    + + + + +
    +
    + +
    + + +
    +

    Information

    + +
    + + +
    +

    Class Index + [+]

    +
    +
    + Quicksearch + +
    +
    + + + +
    + + +
    +

    Method Index

    + +
    +
    + +
    + +
    + [Validate] +
    + Generated with WebRI Redfish 1.1 +

    +
    +
    + + + +
    + +
    + +
    + + + diff --git a/rdoc/files/lib/dnote_rb.html b/rdoc/files/lib/dnote_rb.html index 4ca000b..980af5a 100644 --- a/rdoc/files/lib/dnote_rb.html +++ b/rdoc/files/lib/dnote_rb.html @@ -46,7 +46,7 @@

    File Stats

    Last Modified
    -
    Sun Feb 07 11:07:06 -0500 2010
    +
    Sun Feb 07 11:36:37 -0500 2010
    Requires
    @@ -109,6 +109,10 @@

    Class Index
  • Syckle::Plugins::DNote
  • +
  • Xacto
  • + +
  • Xacto::String
  • +

    @@ -139,7 +143,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -157,7 +161,7 @@

    Method Index

  • Syckle::Plugins::DNote - #clean + #clean
  • @@ -169,19 +173,19 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • Syckle::Plugins::DNote - #document + #document
  • @@ -199,13 +203,13 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -223,7 +227,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -235,37 +239,49 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • - DNote::Site - #initialize_defaults + Xacto::String + #indent
  • Syckle::Plugins::DNote - #initialize_defaults + #initialize_defaults +
  • + + +
  • + DNote::Site + #initialize_defaults
  • DNote::Notes - #labels= + #labels= +
  • + + +
  • + Xacto::String + #margin
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • @@ -277,7 +293,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -288,20 +304,20 @@

    Method Index

  • - Syckle::Plugins::DNote - #output= + DNote::Site + #output=
  • - DNote::Site - #output= + Syckle::Plugins::DNote + #output=
  • DNote::Notes - #parse + #parse
  • @@ -312,14 +328,14 @@

    Method Index

  • - DNote::Format - #render + DNote::Format::ErbScope + #render
  • - DNote::Format::ErbScope - #render + DNote::Format + #render
  • @@ -331,13 +347,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -361,7 +377,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -373,13 +389,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • @@ -391,7 +407,7 @@

    Method Index

  • Syckle::Plugins::DNote - #reset + #reset
  • @@ -401,6 +417,12 @@

    Method Index

    +
  • + Xacto::String + #tabto +
  • + +
  • DNote #templates @@ -421,13 +443,13 @@

    Method Index

  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • diff --git a/rdoc/files/lib/plugins/syckle/dnote_rb.html b/rdoc/files/lib/plugins/syckle/dnote_rb.html index a4c1f14..29f0e7e 100644 --- a/rdoc/files/lib/plugins/syckle/dnote_rb.html +++ b/rdoc/files/lib/plugins/syckle/dnote_rb.html @@ -111,6 +111,10 @@

    Class Index
  • Syckle::Plugins::DNote
  • +
  • Xacto
  • + +
  • Xacto::String
  • +

    @@ -141,7 +145,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -159,7 +163,7 @@

    Method Index

  • Syckle::Plugins::DNote - #clean + #clean
  • @@ -171,19 +175,19 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • Syckle::Plugins::DNote - #document + #document
  • @@ -201,13 +205,13 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -225,7 +229,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -237,37 +241,49 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • - DNote::Site - #initialize_defaults + Xacto::String + #indent
  • Syckle::Plugins::DNote - #initialize_defaults + #initialize_defaults +
  • + + +
  • + DNote::Site + #initialize_defaults
  • DNote::Notes - #labels= + #labels= +
  • + + +
  • + Xacto::String + #margin
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • @@ -279,7 +295,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -290,20 +306,20 @@

    Method Index

  • - Syckle::Plugins::DNote - #output= + DNote::Site + #output=
  • - DNote::Site - #output= + Syckle::Plugins::DNote + #output=
  • DNote::Notes - #parse + #parse
  • @@ -314,14 +330,14 @@

    Method Index

  • - DNote::Format - #render + DNote::Format::ErbScope + #render
  • - DNote::Format::ErbScope - #render + DNote::Format + #render
  • @@ -333,13 +349,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -363,7 +379,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -375,13 +391,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • @@ -393,7 +409,7 @@

    Method Index

  • Syckle::Plugins::DNote - #reset + #reset
  • @@ -403,6 +419,12 @@

    Method Index

    +
  • + Xacto::String + #tabto +
  • + +
  • DNote #templates @@ -423,13 +445,13 @@

    Method Index

  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • diff --git a/rdoc/index.html b/rdoc/index.html index 192de32..068809e 100644 --- a/rdoc/index.html +++ b/rdoc/index.html @@ -87,6 +87,10 @@

    Class Index
  • Syckle::Plugins::DNote
  • +
  • Xacto
  • + +
  • Xacto::String
  • +

    @@ -117,7 +121,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -135,7 +139,7 @@

    Method Index

  • Syckle::Plugins::DNote - #clean + #clean
  • @@ -147,19 +151,19 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • Syckle::Plugins::DNote - #document + #document
  • @@ -177,13 +181,13 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • @@ -201,7 +205,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -213,37 +217,49 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • - DNote::Site - #initialize_defaults + Xacto::String + #indent
  • Syckle::Plugins::DNote - #initialize_defaults + #initialize_defaults +
  • + + +
  • + DNote::Site + #initialize_defaults
  • DNote::Notes - #labels= + #labels= +
  • + + +
  • + Xacto::String + #margin
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • @@ -255,7 +271,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -266,20 +282,20 @@

    Method Index

  • - Syckle::Plugins::DNote - #output= + DNote::Site + #output=
  • - DNote::Site - #output= + Syckle::Plugins::DNote + #output=
  • DNote::Notes - #parse + #parse
  • @@ -290,14 +306,14 @@

    Method Index

  • - DNote::Format - #render + DNote::Format::ErbScope + #render
  • - DNote::Format::ErbScope - #render + DNote::Format + #render
  • @@ -309,13 +325,13 @@

    Method Index

  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • @@ -339,7 +355,7 @@

    Method Index

  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -351,13 +367,13 @@

    Method Index

  • DNote::Format - #render_xml + #render_xml
  • DNote::Format - #render_xoxo + #render_xoxo
  • @@ -369,7 +385,7 @@

    Method Index

  • Syckle::Plugins::DNote - #reset + #reset
  • @@ -379,6 +395,12 @@

    Method Index

    +
  • + Xacto::String + #tabto +
  • + +
  • DNote #templates @@ -399,13 +421,13 @@

    Method Index

  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • @@ -473,6 +495,10 @@

    Classes/Modules

  • Syckle::Plugins::DNote
  • +
  • Xacto
  • + +
  • Xacto::String
  • +

    Methods

    @@ -480,7 +506,7 @@

    Methods

  • ::new — DNote::Format
  • -
  • ::new — DNote::Notes
  • +
  • ::new — DNote::Notes
  • ::new — DNote::Format::ErbScope
  • @@ -490,67 +516,71 @@

    Methods

  • #__DIR__ — DNote
  • -
  • #clean — Syckle::Plugins::DNote
  • -
  • #clean — DNote::Site
  • -
  • #counts — DNote::Notes
  • +
  • #clean — Syckle::Plugins::DNote
  • + +
  • #counts — DNote::Notes
  • -
  • #debug? — DNote::Format
  • +
  • #debug? — DNote::Format
  • #document — DNote::Site
  • -
  • #document — Syckle::Plugins::DNote
  • +
  • #document — Syckle::Plugins::DNote
  • #dryrun? — DNote::Format
  • -
  • #each — DNote::Notes
  • +
  • #each — DNote::Notes
  • -
  • #empty? — DNote::Notes
  • +
  • #empty? — DNote::Notes
  • #erb — DNote::Format
  • #files — DNote::Notes
  • -
  • #fu — DNote::Format
  • -
  • #fu — DNote
  • -
  • #h — DNote::Format::ErbScope
  • +
  • #fu — DNote::Format
  • + +
  • #h — DNote::Format::ErbScope
  • + +
  • #indent — Xacto::String
  • #initialize_defaults — DNote::Site
  • -
  • #initialize_defaults — Syckle::Plugins::DNote
  • +
  • #initialize_defaults — Syckle::Plugins::DNote
  • -
  • #labels= — DNote::Notes
  • +
  • #labels= — DNote::Notes
  • -
  • #match_arbitrary — DNote::Notes
  • +
  • #margin — Xacto::String
  • -
  • #match_common — DNote::Notes
  • +
  • #match_arbitrary — DNote::Notes
  • + +
  • #match_common — DNote::Notes
  • #method_missing — DNote::Format::ErbScope
  • -
  • #notes — DNote::Notes
  • +
  • #notes — DNote::Notes
  • #organize — DNote::Notes
  • #output= — DNote::Site
  • -
  • #output= — Syckle::Plugins::DNote
  • +
  • #output= — Syckle::Plugins::DNote
  • -
  • #parse — DNote::Notes
  • +
  • #parse — DNote::Notes
  • #publish — DNote::Format
  • -
  • #render — DNote::Format::ErbScope
  • -
  • #render — DNote::Format
  • +
  • #render — DNote::Format::ErbScope
  • +
  • #render_custom — DNote::Format
  • -
  • #render_gnu — DNote::Format
  • +
  • #render_gnu — DNote::Format
  • -
  • #render_html — DNote::Format
  • +
  • #render_html — DNote::Format
  • #render_index — DNote::Format
  • @@ -558,19 +588,21 @@

    Methods

  • #render_markdown — DNote::Format
  • -
  • #render_rdoc — DNote::Format
  • +
  • #render_rdoc — DNote::Format
  • #render_soap — DNote::Format
  • -
  • #render_xml — DNote::Format
  • +
  • #render_xml — DNote::Format
  • -
  • #render_xoxo — DNote::Format
  • +
  • #render_xoxo — DNote::Format
  • #render_yaml — DNote::Format
  • +
  • #reset — Syckle::Plugins::DNote
  • +
  • #reset — DNote::Site
  • -
  • #reset — Syckle::Plugins::DNote
  • +
  • #tabto — Xacto::String
  • #templates — DNote
  • @@ -578,16 +610,16 @@

    Methods

  • #to_json — DNote::Notes
  • -
  • #to_soap — DNote::Notes
  • +
  • #to_soap — DNote::Notes
  • -
  • #to_xoxo — DNote::Notes
  • +
  • #to_xoxo — DNote::Notes
  • #to_yaml — DNote::Notes
  • -
  • #write — DNote
  • -
  • #write — DNote::Format
  • +
  • #write — DNote
  • + --> diff --git a/ri/DNote/cdesc-DNote.yaml b/ri/DNote/cdesc-DNote.yaml index 9724964..f2fd07b 100644 --- a/ri/DNote/cdesc-DNote.yaml +++ b/ri/DNote/cdesc-DNote.yaml @@ -9,7 +9,7 @@ constants: - !ruby/object:RDoc::RI::Constant comment: name: VERSION - value: "\"1.1.1\"" + value: "\"1.1.2\"" full_name: DNote includes: [] diff --git a/ri/String/cdesc-String.yaml b/ri/String/cdesc-String.yaml new file mode 100644 index 0000000..dd04515 --- /dev/null +++ b/ri/String/cdesc-String.yaml @@ -0,0 +1,15 @@ +--- !ruby/object:RDoc::RI::ClassDescription +attributes: [] + +class_methods: [] + +comment: +constants: [] + +full_name: String +includes: [] + +instance_methods: [] + +name: String +superclass: Object diff --git a/ri/Xacto/String/cdesc-String.yaml b/ri/Xacto/String/cdesc-String.yaml new file mode 100644 index 0000000..badb806 --- /dev/null +++ b/ri/Xacto/String/cdesc-String.yaml @@ -0,0 +1,25 @@ +--- !ruby/object:RDoc::RI::ModuleDescription +attributes: [] + +class_methods: [] + +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Extensions for String class. These methods are taken directly from Ruby Facets. +- !ruby/struct:RDoc::Markup::Flow::RULE + width: +- !ruby/struct:RDoc::Markup::Flow::P + body: Extensions for String class. These methods are taken directly from Ruby Facets. +constants: [] + +full_name: Xacto::String +includes: [] + +instance_methods: +- !ruby/object:RDoc::RI::MethodSummary + name: indent +- !ruby/object:RDoc::RI::MethodSummary + name: margin +- !ruby/object:RDoc::RI::MethodSummary + name: tabto +name: String diff --git a/ri/Xacto/String/indent-i.yaml b/ri/Xacto/String/indent-i.yaml new file mode 100644 index 0000000..d350333 --- /dev/null +++ b/ri/Xacto/String/indent-i.yaml @@ -0,0 +1,14 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: "Indent left or right by n spaces. (This used to be called #tab and aliased as #indent.)" +- !ruby/struct:RDoc::Markup::Flow::VERB + body: " CREDIT: Gavin Sinclair\n CREDIT: Trans\n" +full_name: Xacto::String#indent +is_singleton: false +name: indent +params: (n) +visibility: public diff --git a/ri/Xacto/String/margin-i.yaml b/ri/Xacto/String/margin-i.yaml new file mode 100644 index 0000000..7f98e58 --- /dev/null +++ b/ri/Xacto/String/margin-i.yaml @@ -0,0 +1,14 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Provides a margin controlled string. +- !ruby/struct:RDoc::Markup::Flow::VERB + body: " x = %Q{\n | This\n | is\n | margin controlled!\n }.margin\n\n NOTE: This may still need a bit of tweaking.\n\n CREDIT: Trans\n" +full_name: Xacto::String#margin +is_singleton: false +name: margin +params: (n=0) +visibility: public diff --git a/ri/Xacto/String/tabto-i.yaml b/ri/Xacto/String/tabto-i.yaml new file mode 100644 index 0000000..05be35c --- /dev/null +++ b/ri/Xacto/String/tabto-i.yaml @@ -0,0 +1,14 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Preserves relative tabbing. The first non-empty line ends up with n spaces before nonspace. +- !ruby/struct:RDoc::Markup::Flow::VERB + body: " CREDIT: Gavin Sinclair\n" +full_name: Xacto::String#tabto +is_singleton: false +name: tabto +params: (n) +visibility: public diff --git a/ri/Xacto/cdesc-Xacto.yaml b/ri/Xacto/cdesc-Xacto.yaml new file mode 100644 index 0000000..6e23b94 --- /dev/null +++ b/ri/Xacto/cdesc-Xacto.yaml @@ -0,0 +1,15 @@ +--- !ruby/object:RDoc::RI::ClassDescription +attributes: [] + +class_methods: [] + +comment: +constants: [] + +full_name: Xacto +includes: [] + +instance_methods: [] + +name: Xacto +superclass: Object diff --git a/ri/created.rid b/ri/created.rid index 43a16aa..0687c98 100644 --- a/ri/created.rid +++ b/ri/created.rid @@ -1 +1 @@ -Sun, 07 Feb 2010 11:07:56 -0500 +Sun, 07 Feb 2010 11:37:03 -0500 From e583a4a9459c6735d58999cd6348df8235e99ea6 Mon Sep 17 00:00:00 2001 From: 7rans Date: Sun, 7 Feb 2010 11:42:19 -0500 Subject: [PATCH 16/27] Updated files. --- index.html | 1 + ri/created.rid | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/index.html b/index.html index 15ef931..5cc391c 100644 --- a/index.html +++ b/index.html @@ -41,6 +41,7 @@ API Reference    Mailing List    Development    + Distribution   
    diff --git a/ri/created.rid b/ri/created.rid index 0687c98..6573141 100644 --- a/ri/created.rid +++ b/ri/created.rid @@ -1 +1 @@ -Sun, 07 Feb 2010 11:37:03 -0500 +Sun, 07 Feb 2010 11:42:14 -0500 From ea212bb534223747770de2b17b123199b7b69d48 Mon Sep 17 00:00:00 2001 From: 7rans Date: Sun, 7 Feb 2010 13:15:32 -0500 Subject: [PATCH 17/27] Updated files. --- rdoc/classes/DNote.html | 2 +- rdoc/classes/DNote/Format.html | 44 +++---- rdoc/classes/DNote/Format/ErbScope.html | 16 +-- rdoc/classes/DNote/Notes.html | 60 ++++----- rdoc/classes/Xacto/String.html | 8 +- rdoc/created.rid | 2 +- rdoc/files/LICENSE.html | 64 +++++----- rdoc/files/README_rdoc.html | 64 +++++----- rdoc/files/lib/dnote/command_rb.html | 68 +++++------ rdoc/files/lib/dnote/format_rb.html | 64 +++++----- rdoc/files/lib/dnote/notes_rb.html | 64 +++++----- rdoc/files/lib/dnote/site_rb.html | 64 +++++----- rdoc/files/lib/dnote/string_rb.html | 64 +++++----- rdoc/files/lib/dnote_rb.html | 68 ++++++----- rdoc/files/lib/plugins/syckle/dnote_rb.html | 64 +++++----- rdoc/index.html | 128 ++++++++++---------- ri/DNote/cdesc-DNote.yaml | 2 +- ri/created.rid | 2 +- 18 files changed, 424 insertions(+), 424 deletions(-) diff --git a/rdoc/classes/DNote.html b/rdoc/classes/DNote.html index e550664..7a58a39 100644 --- a/rdoc/classes/DNote.html +++ b/rdoc/classes/DNote.html @@ -257,7 +257,7 @@

    Public Class Methods

    -# File lib/dnote/command.rb, line 8
    +# File lib/dnote/command.rb, line 7
       def self.run
         options = {}
         format  = 'rdoc'
    diff --git a/rdoc/classes/DNote/Format.html b/rdoc/classes/DNote/Format.html
    index 122a578..b75aa23 100644
    --- a/rdoc/classes/DNote/Format.html
    +++ b/rdoc/classes/DNote/Format.html
    @@ -104,27 +104,27 @@ 

    Methods

  • - #debug? + #debug?
  • - #dryrun? + #dryrun?
  • - #erb + #erb
  • - #fu + #fu
  • - #publish + #publish
  • @@ -134,22 +134,22 @@

    Methods

  • - #render_custom + #render_custom
  • - #render_gnu + #render_gnu
  • - #render_html + #render_html
  • - #render_index + #render_index
  • @@ -159,12 +159,12 @@

    Methods

  • - #render_markdown + #render_markdown
  • - #render_rdoc + #render_rdoc
  • @@ -488,7 +488,7 @@

    Public Instance Methods

    - +
    @@ -523,7 +523,7 @@

    Public Instance Methods

    - +
    @@ -559,7 +559,7 @@

    Public Instance Methods

    - +
    @@ -593,7 +593,7 @@

    Public Instance Methods

    - +
    @@ -660,7 +660,7 @@

    Public Instance Methods

    - +
    @@ -694,7 +694,7 @@

    Public Instance Methods

    - +
    @@ -871,7 +871,7 @@

    Private Instance Methods

    - +
    @@ -903,7 +903,7 @@

    Private Instance Methods

    - +
    @@ -935,7 +935,7 @@

    Private Instance Methods

    - +
    @@ -968,7 +968,7 @@

    Private Instance Methods

    - +
    @@ -1010,7 +1010,7 @@

    Private Instance Methods

    - +
    diff --git a/rdoc/classes/DNote/Format/ErbScope.html b/rdoc/classes/DNote/Format/ErbScope.html index 741a801..d2916ae 100644 --- a/rdoc/classes/DNote/Format/ErbScope.html +++ b/rdoc/classes/DNote/Format/ErbScope.html @@ -90,22 +90,22 @@

    Methods

  • - ::new + ::new
  • - #h + #h
  • - #method_missing + #method_missing
  • - #render + #render
  • @@ -205,7 +205,7 @@

    Public Class Methods

    - +
    @@ -243,7 +243,7 @@

    Public Instance Methods

    - +
    @@ -275,7 +275,7 @@

    Public Instance Methods

    - +
    @@ -307,7 +307,7 @@

    Public Instance Methods

    - +
    diff --git a/rdoc/classes/DNote/Notes.html b/rdoc/classes/DNote/Notes.html index 61be98f..0dc607c 100644 --- a/rdoc/classes/DNote/Notes.html +++ b/rdoc/classes/DNote/Notes.html @@ -90,47 +90,47 @@

    Methods

  • - ::new + ::new
  • - #counts + #counts
  • - #each + #each
  • - #empty? + #empty?
  • - #files + #files
  • - #labels= + #labels=
  • - #match_arbitrary + #match_arbitrary
  • - #match_common + #match_common
  • - #notes + #notes
  • @@ -140,32 +140,32 @@

    Methods

  • - #parse + #parse
  • - #to + #to
  • - #to_json + #to_json
  • - #to_soap + #to_soap
  • - #to_xoxo + #to_xoxo
  • - #to_yaml + #to_yaml
  • @@ -347,7 +347,7 @@

    Public Class Methods

    - +
    @@ -387,7 +387,7 @@

    Public Instance Methods

    - +
    @@ -419,7 +419,7 @@

    Public Instance Methods

    - +
    @@ -451,7 +451,7 @@

    Public Instance Methods

    - +
    @@ -483,7 +483,7 @@

    Public Instance Methods

    - +
    @@ -523,7 +523,7 @@

    Public Instance Methods

    - +
    @@ -562,7 +562,7 @@

    Public Instance Methods

    - +
    @@ -601,7 +601,7 @@

    Public Instance Methods

    - +
    @@ -640,7 +640,7 @@

    Public Instance Methods

    - +
    @@ -716,7 +716,7 @@

    Public Instance Methods

    - +
    @@ -786,7 +786,7 @@

    Public Instance Methods

    - +
    @@ -818,7 +818,7 @@

    Public Instance Methods

    - +
    @@ -855,7 +855,7 @@

    Public Instance Methods

    - +
    @@ -890,7 +890,7 @@

    Public Instance Methods

    - +
    @@ -925,7 +925,7 @@

    Public Instance Methods

    - +
    diff --git a/rdoc/classes/Xacto/String.html b/rdoc/classes/Xacto/String.html index 79ff516..e81f0fe 100644 --- a/rdoc/classes/Xacto/String.html +++ b/rdoc/classes/Xacto/String.html @@ -86,12 +86,12 @@

    Methods

  • - #margin + #margin
  • - #tabto + #tabto
  • @@ -238,7 +238,7 @@

    Public Instance Methods

    - +
    @@ -292,7 +292,7 @@

    Public Instance Methods

    - +
    diff --git a/rdoc/created.rid b/rdoc/created.rid index ac19631..cc144ef 100644 --- a/rdoc/created.rid +++ b/rdoc/created.rid @@ -1 +1 @@ -Sun, 07 Feb 2010 11:37:06 -0500 +Sun, 07 Feb 2010 13:15:16 -0500 diff --git a/rdoc/files/LICENSE.html b/rdoc/files/LICENSE.html index f231e60..c3cc060 100644 --- a/rdoc/files/LICENSE.html +++ b/rdoc/files/LICENSE.html @@ -128,13 +128,13 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • DNote::Notes - ::new + ::new
  • @@ -164,13 +164,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -188,37 +188,37 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • DNote::Format - #erb + #erb
  • DNote::Notes - #files + #files
  • DNote::Format - #fu + #fu
  • @@ -230,7 +230,7 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • @@ -254,37 +254,37 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • Xacto::String - #margin + #margin
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • @@ -308,19 +308,19 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • DNote::Format - #publish + #publish
  • DNote::Format::ErbScope - #render + #render
  • @@ -332,25 +332,25 @@

    Method Index

  • DNote::Format - #render_custom + #render_custom
  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • DNote::Format - #render_index + #render_index
  • @@ -362,13 +362,13 @@

    Method Index

  • DNote::Format - #render_markdown + #render_markdown
  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -410,7 +410,7 @@

    Method Index

  • Xacto::String - #tabto + #tabto
  • @@ -422,31 +422,31 @@

    Method Index

  • DNote::Notes - #to + #to
  • DNote::Notes - #to_json + #to_json
  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • DNote::Notes - #to_yaml + #to_yaml
  • diff --git a/rdoc/files/README_rdoc.html b/rdoc/files/README_rdoc.html index eef2434..c3c5945 100644 --- a/rdoc/files/README_rdoc.html +++ b/rdoc/files/README_rdoc.html @@ -128,13 +128,13 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • DNote::Notes - ::new + ::new
  • @@ -164,13 +164,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -188,37 +188,37 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • DNote::Format - #erb + #erb
  • DNote::Notes - #files + #files
  • DNote::Format - #fu + #fu
  • @@ -230,7 +230,7 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • @@ -254,37 +254,37 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • Xacto::String - #margin + #margin
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • @@ -308,19 +308,19 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • DNote::Format - #publish + #publish
  • DNote::Format::ErbScope - #render + #render
  • @@ -332,25 +332,25 @@

    Method Index

  • DNote::Format - #render_custom + #render_custom
  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • DNote::Format - #render_index + #render_index
  • @@ -362,13 +362,13 @@

    Method Index

  • DNote::Format - #render_markdown + #render_markdown
  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -410,7 +410,7 @@

    Method Index

  • Xacto::String - #tabto + #tabto
  • @@ -422,31 +422,31 @@

    Method Index

  • DNote::Notes - #to + #to
  • DNote::Notes - #to_json + #to_json
  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • DNote::Notes - #to_yaml + #to_yaml
  • diff --git a/rdoc/files/lib/dnote/command_rb.html b/rdoc/files/lib/dnote/command_rb.html index 576c159..20c1b01 100644 --- a/rdoc/files/lib/dnote/command_rb.html +++ b/rdoc/files/lib/dnote/command_rb.html @@ -46,7 +46,7 @@

    File Stats

    Last Modified
    -
    Sat Feb 06 14:59:51 -0500 2010
    +
    Sun Feb 07 13:12:57 -0500 2010
    Requires
    @@ -57,8 +57,6 @@

    File Stats

  • dnote
  • -
  • dnote/format
  • - @@ -141,13 +139,13 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • DNote::Notes - ::new + ::new
  • @@ -177,13 +175,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -201,37 +199,37 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • DNote::Format - #erb + #erb
  • DNote::Notes - #files + #files
  • DNote::Format - #fu + #fu
  • @@ -243,7 +241,7 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • @@ -267,37 +265,37 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • Xacto::String - #margin + #margin
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • @@ -321,19 +319,19 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • DNote::Format - #publish + #publish
  • DNote::Format::ErbScope - #render + #render
  • @@ -345,25 +343,25 @@

    Method Index

  • DNote::Format - #render_custom + #render_custom
  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • DNote::Format - #render_index + #render_index
  • @@ -375,13 +373,13 @@

    Method Index

  • DNote::Format - #render_markdown + #render_markdown
  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -423,7 +421,7 @@

    Method Index

  • Xacto::String - #tabto + #tabto
  • @@ -435,31 +433,31 @@

    Method Index

  • DNote::Notes - #to + #to
  • DNote::Notes - #to_json + #to_json
  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • DNote::Notes - #to_yaml + #to_yaml
  • diff --git a/rdoc/files/lib/dnote/format_rb.html b/rdoc/files/lib/dnote/format_rb.html index f548c09..4c4eb75 100644 --- a/rdoc/files/lib/dnote/format_rb.html +++ b/rdoc/files/lib/dnote/format_rb.html @@ -143,13 +143,13 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • DNote::Notes - ::new + ::new
  • @@ -179,13 +179,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -203,37 +203,37 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • DNote::Format - #erb + #erb
  • DNote::Notes - #files + #files
  • DNote::Format - #fu + #fu
  • @@ -245,7 +245,7 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • @@ -269,37 +269,37 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • Xacto::String - #margin + #margin
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • @@ -323,19 +323,19 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • DNote::Format - #publish + #publish
  • DNote::Format::ErbScope - #render + #render
  • @@ -347,25 +347,25 @@

    Method Index

  • DNote::Format - #render_custom + #render_custom
  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • DNote::Format - #render_index + #render_index
  • @@ -377,13 +377,13 @@

    Method Index

  • DNote::Format - #render_markdown + #render_markdown
  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -425,7 +425,7 @@

    Method Index

  • Xacto::String - #tabto + #tabto
  • @@ -437,31 +437,31 @@

    Method Index

  • DNote::Notes - #to + #to
  • DNote::Notes - #to_json + #to_json
  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • DNote::Notes - #to_yaml + #to_yaml
  • diff --git a/rdoc/files/lib/dnote/notes_rb.html b/rdoc/files/lib/dnote/notes_rb.html index 550808c..e57630a 100644 --- a/rdoc/files/lib/dnote/notes_rb.html +++ b/rdoc/files/lib/dnote/notes_rb.html @@ -147,13 +147,13 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • DNote::Notes - ::new + ::new
  • @@ -183,13 +183,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -207,37 +207,37 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • DNote::Format - #erb + #erb
  • DNote::Notes - #files + #files
  • DNote::Format - #fu + #fu
  • @@ -249,7 +249,7 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • @@ -273,37 +273,37 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • Xacto::String - #margin + #margin
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • @@ -327,19 +327,19 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • DNote::Format - #publish + #publish
  • DNote::Format::ErbScope - #render + #render
  • @@ -351,25 +351,25 @@

    Method Index

  • DNote::Format - #render_custom + #render_custom
  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • DNote::Format - #render_index + #render_index
  • @@ -381,13 +381,13 @@

    Method Index

  • DNote::Format - #render_markdown + #render_markdown
  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -429,7 +429,7 @@

    Method Index

  • Xacto::String - #tabto + #tabto
  • @@ -441,31 +441,31 @@

    Method Index

  • DNote::Notes - #to + #to
  • DNote::Notes - #to_json + #to_json
  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • DNote::Notes - #to_yaml + #to_yaml
  • diff --git a/rdoc/files/lib/dnote/site_rb.html b/rdoc/files/lib/dnote/site_rb.html index a24763a..0d976cb 100644 --- a/rdoc/files/lib/dnote/site_rb.html +++ b/rdoc/files/lib/dnote/site_rb.html @@ -137,13 +137,13 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • DNote::Notes - ::new + ::new
  • @@ -173,13 +173,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -197,37 +197,37 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • DNote::Format - #erb + #erb
  • DNote::Notes - #files + #files
  • DNote::Format - #fu + #fu
  • @@ -239,7 +239,7 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • @@ -263,37 +263,37 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • Xacto::String - #margin + #margin
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • @@ -317,19 +317,19 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • DNote::Format - #publish + #publish
  • DNote::Format::ErbScope - #render + #render
  • @@ -341,25 +341,25 @@

    Method Index

  • DNote::Format - #render_custom + #render_custom
  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • DNote::Format - #render_index + #render_index
  • @@ -371,13 +371,13 @@

    Method Index

  • DNote::Format - #render_markdown + #render_markdown
  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -419,7 +419,7 @@

    Method Index

  • Xacto::String - #tabto + #tabto
  • @@ -431,31 +431,31 @@

    Method Index

  • DNote::Notes - #to + #to
  • DNote::Notes - #to_json + #to_json
  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • DNote::Notes - #to_yaml + #to_yaml
  • diff --git a/rdoc/files/lib/dnote/string_rb.html b/rdoc/files/lib/dnote/string_rb.html index d1e9eaa..ad911b1 100644 --- a/rdoc/files/lib/dnote/string_rb.html +++ b/rdoc/files/lib/dnote/string_rb.html @@ -128,13 +128,13 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • DNote::Notes - ::new + ::new
  • @@ -164,13 +164,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -188,37 +188,37 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • DNote::Format - #erb + #erb
  • DNote::Notes - #files + #files
  • DNote::Format - #fu + #fu
  • @@ -230,7 +230,7 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • @@ -254,37 +254,37 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • Xacto::String - #margin + #margin
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • @@ -308,19 +308,19 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • DNote::Format - #publish + #publish
  • DNote::Format::ErbScope - #render + #render
  • @@ -332,25 +332,25 @@

    Method Index

  • DNote::Format - #render_custom + #render_custom
  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • DNote::Format - #render_index + #render_index
  • @@ -362,13 +362,13 @@

    Method Index

  • DNote::Format - #render_markdown + #render_markdown
  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -410,7 +410,7 @@

    Method Index

  • Xacto::String - #tabto + #tabto
  • @@ -422,31 +422,31 @@

    Method Index

  • DNote::Notes - #to + #to
  • DNote::Notes - #to_json + #to_json
  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • DNote::Notes - #to_yaml + #to_yaml
  • diff --git a/rdoc/files/lib/dnote_rb.html b/rdoc/files/lib/dnote_rb.html index 980af5a..d1e637d 100644 --- a/rdoc/files/lib/dnote_rb.html +++ b/rdoc/files/lib/dnote_rb.html @@ -46,7 +46,7 @@

    File Stats

    Last Modified
    -
    Sun Feb 07 11:36:37 -0500 2010
    +
    Sun Feb 07 13:13:12 -0500 2010
    Requires
    @@ -55,6 +55,8 @@

    File Stats

  • dnote/notes
  • +
  • dnote/format
  • + @@ -137,13 +139,13 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • DNote::Notes - ::new + ::new
  • @@ -173,13 +175,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -197,37 +199,37 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • DNote::Format - #erb + #erb
  • DNote::Notes - #files + #files
  • DNote::Format - #fu + #fu
  • @@ -239,7 +241,7 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • @@ -263,37 +265,37 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • Xacto::String - #margin + #margin
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • @@ -317,19 +319,19 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • DNote::Format - #publish + #publish
  • DNote::Format::ErbScope - #render + #render
  • @@ -341,25 +343,25 @@

    Method Index

  • DNote::Format - #render_custom + #render_custom
  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • DNote::Format - #render_index + #render_index
  • @@ -371,13 +373,13 @@

    Method Index

  • DNote::Format - #render_markdown + #render_markdown
  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -419,7 +421,7 @@

    Method Index

  • Xacto::String - #tabto + #tabto
  • @@ -431,31 +433,31 @@

    Method Index

  • DNote::Notes - #to + #to
  • DNote::Notes - #to_json + #to_json
  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • DNote::Notes - #to_yaml + #to_yaml
  • diff --git a/rdoc/files/lib/plugins/syckle/dnote_rb.html b/rdoc/files/lib/plugins/syckle/dnote_rb.html index 29f0e7e..5796f21 100644 --- a/rdoc/files/lib/plugins/syckle/dnote_rb.html +++ b/rdoc/files/lib/plugins/syckle/dnote_rb.html @@ -139,13 +139,13 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • DNote::Notes - ::new + ::new
  • @@ -175,13 +175,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -199,37 +199,37 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • DNote::Format - #erb + #erb
  • DNote::Notes - #files + #files
  • DNote::Format - #fu + #fu
  • @@ -241,7 +241,7 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • @@ -265,37 +265,37 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • Xacto::String - #margin + #margin
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • @@ -319,19 +319,19 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • DNote::Format - #publish + #publish
  • DNote::Format::ErbScope - #render + #render
  • @@ -343,25 +343,25 @@

    Method Index

  • DNote::Format - #render_custom + #render_custom
  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • DNote::Format - #render_index + #render_index
  • @@ -373,13 +373,13 @@

    Method Index

  • DNote::Format - #render_markdown + #render_markdown
  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -421,7 +421,7 @@

    Method Index

  • Xacto::String - #tabto + #tabto
  • @@ -433,31 +433,31 @@

    Method Index

  • DNote::Notes - #to + #to
  • DNote::Notes - #to_json + #to_json
  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • DNote::Notes - #to_yaml + #to_yaml
  • diff --git a/rdoc/index.html b/rdoc/index.html index 068809e..f7a2ef6 100644 --- a/rdoc/index.html +++ b/rdoc/index.html @@ -115,13 +115,13 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • DNote::Notes - ::new + ::new
  • @@ -151,13 +151,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -175,37 +175,37 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • DNote::Format - #erb + #erb
  • DNote::Notes - #files + #files
  • DNote::Format - #fu + #fu
  • @@ -217,7 +217,7 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • @@ -241,37 +241,37 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • Xacto::String - #margin + #margin
  • DNote::Notes - #match_arbitrary + #match_arbitrary
  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • @@ -295,19 +295,19 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • DNote::Format - #publish + #publish
  • DNote::Format::ErbScope - #render + #render
  • @@ -319,25 +319,25 @@

    Method Index

  • DNote::Format - #render_custom + #render_custom
  • DNote::Format - #render_gnu + #render_gnu
  • DNote::Format - #render_html + #render_html
  • DNote::Format - #render_index + #render_index
  • @@ -349,13 +349,13 @@

    Method Index

  • DNote::Format - #render_markdown + #render_markdown
  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -397,7 +397,7 @@

    Method Index

  • Xacto::String - #tabto + #tabto
  • @@ -409,31 +409,31 @@

    Method Index

  • DNote::Notes - #to + #to
  • DNote::Notes - #to_json + #to_json
  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • DNote::Notes - #to_yaml + #to_yaml
  • @@ -506,9 +506,9 @@

    Methods

  • ::new — DNote::Format
  • -
  • ::new — DNote::Notes
  • +
  • ::new — DNote::Notes
  • -
  • ::new — DNote::Format::ErbScope
  • +
  • ::new — DNote::Format::ErbScope
  • ::new — DNote::Site
  • @@ -520,29 +520,29 @@

    Methods

  • #clean — Syckle::Plugins::DNote
  • -
  • #counts — DNote::Notes
  • +
  • #counts — DNote::Notes
  • -
  • #debug? — DNote::Format
  • +
  • #debug? — DNote::Format
  • #document — DNote::Site
  • #document — Syckle::Plugins::DNote
  • -
  • #dryrun? — DNote::Format
  • +
  • #dryrun? — DNote::Format
  • -
  • #each — DNote::Notes
  • +
  • #each — DNote::Notes
  • -
  • #empty? — DNote::Notes
  • +
  • #empty? — DNote::Notes
  • -
  • #erb — DNote::Format
  • +
  • #erb — DNote::Format
  • -
  • #files — DNote::Notes
  • +
  • #files — DNote::Notes
  • #fu — DNote
  • -
  • #fu — DNote::Format
  • +
  • #fu — DNote::Format
  • -
  • #h — DNote::Format::ErbScope
  • +
  • #h — DNote::Format::ErbScope
  • #indent — Xacto::String
  • @@ -550,17 +550,17 @@

    Methods

  • #initialize_defaults — Syckle::Plugins::DNote
  • -
  • #labels= — DNote::Notes
  • +
  • #labels= — DNote::Notes
  • -
  • #margin — Xacto::String
  • +
  • #margin — Xacto::String
  • -
  • #match_arbitrary — DNote::Notes
  • +
  • #match_arbitrary — DNote::Notes
  • -
  • #match_common — DNote::Notes
  • +
  • #match_common — DNote::Notes
  • -
  • #method_missing — DNote::Format::ErbScope
  • +
  • #method_missing — DNote::Format::ErbScope
  • -
  • #notes — DNote::Notes
  • +
  • #notes — DNote::Notes
  • #organize — DNote::Notes
  • @@ -568,27 +568,27 @@

    Methods

  • #output= — Syckle::Plugins::DNote
  • -
  • #parse — DNote::Notes
  • +
  • #parse — DNote::Notes
  • -
  • #publish — DNote::Format
  • +
  • #publish — DNote::Format
  • #render — DNote::Format
  • -
  • #render — DNote::Format::ErbScope
  • +
  • #render — DNote::Format::ErbScope
  • -
  • #render_custom — DNote::Format
  • +
  • #render_custom — DNote::Format
  • -
  • #render_gnu — DNote::Format
  • +
  • #render_gnu — DNote::Format
  • -
  • #render_html — DNote::Format
  • +
  • #render_html — DNote::Format
  • -
  • #render_index — DNote::Format
  • +
  • #render_index — DNote::Format
  • #render_json — DNote::Format
  • -
  • #render_markdown — DNote::Format
  • +
  • #render_markdown — DNote::Format
  • -
  • #render_rdoc — DNote::Format
  • +
  • #render_rdoc — DNote::Format
  • #render_soap — DNote::Format
  • @@ -602,19 +602,19 @@

    Methods

  • #reset — DNote::Site
  • -
  • #tabto — Xacto::String
  • +
  • #tabto — Xacto::String
  • #templates — DNote
  • -
  • #to — DNote::Notes
  • +
  • #to — DNote::Notes
  • -
  • #to_json — DNote::Notes
  • +
  • #to_json — DNote::Notes
  • -
  • #to_soap — DNote::Notes
  • +
  • #to_soap — DNote::Notes
  • -
  • #to_xoxo — DNote::Notes
  • +
  • #to_xoxo — DNote::Notes
  • -
  • #to_yaml — DNote::Notes
  • +
  • #to_yaml — DNote::Notes
  • #write — DNote::Format
  • diff --git a/ri/DNote/cdesc-DNote.yaml b/ri/DNote/cdesc-DNote.yaml index f2fd07b..20255d1 100644 --- a/ri/DNote/cdesc-DNote.yaml +++ b/ri/DNote/cdesc-DNote.yaml @@ -9,7 +9,7 @@ constants: - !ruby/object:RDoc::RI::Constant comment: name: VERSION - value: "\"1.1.2\"" + value: "\"1.1.3\"" full_name: DNote includes: [] diff --git a/ri/created.rid b/ri/created.rid index 6573141..e55194b 100644 --- a/ri/created.rid +++ b/ri/created.rid @@ -1 +1 @@ -Sun, 07 Feb 2010 11:42:14 -0500 +Sun, 07 Feb 2010 13:15:14 -0500 From f4964984be6d781a66619b8d09b7877498cb7902 Mon Sep 17 00:00:00 2001 From: 7rans Date: Thu, 11 Feb 2010 21:22:27 -0500 Subject: [PATCH 18/27] Updated files. --- example.html | 99 ++++++++++----- example.xml | 56 +++++++-- example.yaml | 53 ++++++-- index.html | 31 ++--- rdoc/classes/DNote/Format.html | 24 ++-- rdoc/classes/DNote/Format/ErbScope.html | 12 +- rdoc/classes/DNote/Notes.html | 61 ++++----- rdoc/classes/Xacto/String.html | 14 +-- rdoc/created.rid | 2 +- rdoc/files/LICENSE.html | 52 ++++---- rdoc/files/README_rdoc.html | 82 ++++++------ rdoc/files/lib/dnote/command_rb.html | 52 ++++---- rdoc/files/lib/dnote/format_rb.html | 52 ++++---- rdoc/files/lib/dnote/notes_rb.html | 54 ++++---- rdoc/files/lib/dnote/site_rb.html | 52 ++++---- rdoc/files/lib/dnote/string_rb.html | 52 ++++---- rdoc/files/lib/dnote_rb.html | 52 ++++---- rdoc/files/lib/plugins/syckle/dnote_rb.html | 52 ++++---- rdoc/index.html | 132 ++++++++++---------- ri/DNote/Notes/match_common-i.yaml | 5 +- ri/created.rid | 2 +- 21 files changed, 556 insertions(+), 435 deletions(-) diff --git a/example.html b/example.html index 58d16ba..d24664c 100644 --- a/example.html +++ b/example.html @@ -1,35 +1,78 @@ -<%= title %> - + Developer's Notes + +
    -

    <%= title %>

    -
    -

    TODO

    -
      -
    1. lib/dnote/notes.rb

        -
      1. TODO: Add ability to read header notes. They oftern -have a outline format, rather then the single line. 19
      2. -
      3. TODO: Need good CSS file. 22
      4. -
      5. TODO: Need XSL? 24
      6. -
    2. -
    3. plug/syckle/services/dnote.rb

        -
      1. TODO: Should this service be part of the +site+ cycle? 18
      2. -
    4. -
    +

    Developer's Notes

    +
    +

    CREDIT

    +
      +
    1. lib/dnote/string.rb

        +
      1. Trans 19
      2. +
      3. Gavin Sinclair 37
      4. +
      5. Gavin Sinclair 50
      6. +
      7. Trans 51
      8. +
    2. +
    +

    TODO

    +
      +
    1. lib/dnote/site.rb

        +
      1. Don't use chdir. 102
      2. +
    2. +
    3. test/cases/notes_case.rb

        +
      1. Do something or another!", 1, "foo.rb" 37
      2. +
    4. +
    5. lib/dnote/notes.rb

        +
      1. Add ability to read header notes. They often +have a outline format, rather then the single line. 15
      2. +
      3. should this be done? 79
      4. +
      5. ruby-1.9.1-p378 reports: notes.rb:131:in `match': invalid byte sequence in UTF-8 127
      6. +
    6. +
    7. lib/plugins/syckle/dnote.rb

        +
      1. Should this service be part of the +site+ cycle? 18
      2. +
      3. Is #trial? correct? 73
      4. +
    8. +
    9. lib/dnote/format.rb

        +
      1. Need good CSS file. 6
      2. +
      3. Need XSL? 8
      4. +
    10. +
    +

    TEST

    +
      +
    1. lib/dnote.rb

        +
      1. This is a test of arbitraty labels. 32
      2. +
    2. +
    +

    NOTE

    +
      +
    1. lib/dnote/command.rb

        +
      1. If DNote were a class. 124
      2. +
    2. +
    3. lib/dnote.rb

        +
      1. Toying with the idea of making DNote a class. 7
      2. +
    4. +
    5. lib/dnote/string.rb

        +
      1. This may still need a bit of tweaking. 17
      2. +
    6. +
    +
    -
    - + diff --git a/example.xml b/example.xml index e0b9758..aefcac4 100644 --- a/example.xml +++ b/example.xml @@ -1,13 +1,49 @@ + - - -TODO: Add ability to read header notes. They oftern + + + Trans + Gavin Sinclair + Gavin Sinclair + Trans + + + + + Don't use chdir. + + + Do something or another!", 1, "foo.rb" + + + Add ability to read header notes. They often have a outline format, rather then the single line. -TODO: Need good CSS file. -TODO: Need XSL? - - -TODO: Should this service be part of the +site+ cycle? - - + should this be done? + ruby-1.9.1-p378 reports: notes.rb:131:in `match': invalid byte sequence in UTF-8 + + + Should this service be part of the +site+ cycle? + Is #trial? correct? + + + Need good CSS file. + Need XSL? + + + + + This is a test of arbitraty labels. + + + + + If DNote were a class. + + + Toying with the idea of making DNote a class. + + + This may still need a bit of tweaking. + + diff --git a/example.yaml b/example.yaml index b329454..1496dde 100644 --- a/example.yaml +++ b/example.yaml @@ -1,14 +1,51 @@ --- +CREDIT: + lib/dnote/string.rb: + - - 19 + - Trans + - - 37 + - Gavin Sinclair + - - 50 + - Gavin Sinclair + - - 51 + - Trans TODO: + lib/dnote/site.rb: + - - 102 + - Don't use chdir. + test/cases/notes_case.rb: + - - 37 + - Do something or another!", 1, "foo.rb" lib/dnote/notes.rb: - - - 19 + - - 15 - |- - TODO: Add ability to read header notes. They oftern + Add ability to read header notes. They often have a outline format, rather then the single line. - - - 22 - - "TODO: Need good CSS file." - - - 24 - - "TODO: Need XSL?" - plug/syckle/services/dnote.rb: + - - 79 + - should this be done? + - - 127 + - "ruby-1.9.1-p378 reports: notes.rb:131:in `match': invalid byte sequence in UTF-8" + lib/plugins/syckle/dnote.rb: - - 18 - - "TODO: Should this service be part of the +site+ cycle?" + - Should this service be part of the +site+ cycle? + - - 73 + - "Is #trial? correct?" + lib/dnote/format.rb: + - - 6 + - Need good CSS file. + - - 8 + - Need XSL? +TEST: + lib/dnote.rb: + - - 32 + - This is a test of arbitraty labels. +NOTE: + lib/dnote/command.rb: + - - 124 + - If DNote were a class. + lib/dnote.rb: + - - 7 + - Toying with the idea of making DNote a class. + lib/dnote/string.rb: + - - 17 + - This may still need a bit of tweaking. diff --git a/index.html b/index.html index 5cc391c..e5f976c 100644 --- a/index.html +++ b/index.html @@ -55,20 +55,20 @@

    D'Note

    -

    Developer's take note! All those "TODO" and "FIXME" notes floating around - your source code are rotting away. They are trapped and in desparate need of your attention.

    +

    Developer's take note! All those TODO's and FIXME's floating around + your source code are rotting away. They are trapped, and in desperate need of your attention.

    But not to fret! D'Note will help you liberate them. D'Note will scan your - source code for labeled comments, collect, collate and sort them, and then return them to you in a + source code for labeled comments; collect, collate and sort them; and then return them to you in a format of your choosing. Wunderbar!

    Note Structure

    -

    D'Note scans for the common noting pattern used by develepors of many laguages of an all-caps label - followed bt a colon. To be more specific, for D'Note to recogznie a note, it needs ot follow this - simple set of rules:

    +

    D'Note scans for the common "LABEL:" pattern used by many developers of many languages (i.e. an all-caps + label followed by a colon). To be more specific, for D'Note to recognize a note, it needs to conform to + the following set of rules:

    -

    1) Notes start with an all-caps label puctuated with a colon, followed by the note's text.

    +

    1) Notes start with an all-caps label punctuated with a colon, followed by the note's text.

       # LABEL: description ...
    @@ -83,15 +83,16 @@ 

    Note Structure

    3) Any note that requires more than one line must remain flush to the left margin (the margin is set by the first line). This is done because RDoc will mistake - the note for a <pre> block if it is indented.

    + the second line for a <pre> block if it is indented.

       # LABEL: description ...
       # continue ...
       
    -

    3) An alternative to the limitation of the last rule is to indent the whole note, making it - a <pre> block. Then the text layout is free-form.

    +

    3) An alternative to the limitation of the last rule is to indent the whole note (making + the whole note a <pre> block with regards to RDoc). Then the text layout is + free-form.

       # This is a description of something...
    @@ -100,8 +101,8 @@ 

    Note Structure

    # continue ...
    -

    That's all there is to it, if I can convince the developers of RDoc to add recognize labels, - we may eventually be able to relax the flush rule, which would be very nice.

    +

    That's all there is to it. If I can convince the developers of RDoc to add recognition of + labels, we may eventually be able to relax the flush rule too, which would be very nice.

    Generating Notes

    @@ -139,7 +140,7 @@

    Generating Notes

    formats.

    The default path is **/*.rb and the default format --gnu. - Here is an example of DNote's current notes in RDoc format:

    + Here is an example of D'Note's own notes in RDoc format:

       = Development Notes
    @@ -148,9 +149,9 @@ 

    Generating Notes

    === file://lib/dnote/notes.rb - * TODO: Add ability to read header notes. They oftern + * TODO: Add ability to read header notes. They often have a outline format, rather then the single line. (19) - * TODO: Need good CSS file. (22) + * TODO: Need CSS? (22) * TODO: Need XSL? (24) === file://plug/syckle/services/dnote.rb diff --git a/rdoc/classes/DNote/Format.html b/rdoc/classes/DNote/Format.html index b75aa23..e7395c2 100644 --- a/rdoc/classes/DNote/Format.html +++ b/rdoc/classes/DNote/Format.html @@ -114,7 +114,7 @@

    Methods

  • - #erb + #erb
  • @@ -124,7 +124,7 @@

    Methods

  • - #publish + #publish
  • @@ -134,7 +134,7 @@

    Methods

  • - #render_custom + #render_custom
  • @@ -159,12 +159,12 @@

    Methods

  • - #render_markdown + #render_markdown
  • - #render_rdoc + #render_rdoc
  • @@ -189,7 +189,7 @@

    Methods

  • - #write + #write
  • @@ -488,7 +488,7 @@

    Public Instance Methods

    - +
    @@ -660,7 +660,7 @@

    Public Instance Methods

    - +
    @@ -694,7 +694,7 @@

    Public Instance Methods

    - +
    @@ -935,7 +935,7 @@

    Private Instance Methods

    - +
    @@ -1010,7 +1010,7 @@

    Private Instance Methods

    - +
    @@ -1047,7 +1047,7 @@

    Private Instance Methods

    - +
    diff --git a/rdoc/classes/DNote/Format/ErbScope.html b/rdoc/classes/DNote/Format/ErbScope.html index d2916ae..b2bfac1 100644 --- a/rdoc/classes/DNote/Format/ErbScope.html +++ b/rdoc/classes/DNote/Format/ErbScope.html @@ -95,17 +95,17 @@

    Methods

  • - #h + #h
  • - #method_missing + #method_missing
  • - #render + #render
  • @@ -243,7 +243,7 @@

    Public Instance Methods

    - +
    @@ -275,7 +275,7 @@

    Public Instance Methods

    - +
    @@ -307,7 +307,7 @@

    Public Instance Methods

    - +
    diff --git a/rdoc/classes/DNote/Notes.html b/rdoc/classes/DNote/Notes.html index 0dc607c..a5c3453 100644 --- a/rdoc/classes/DNote/Notes.html +++ b/rdoc/classes/DNote/Notes.html @@ -90,32 +90,32 @@

    Methods

  • - ::new + ::new
  • - #counts + #counts
  • - #each + #each
  • - #empty? + #empty?
  • - #files + #files
  • - #labels= + #labels=
  • @@ -125,22 +125,22 @@

    Methods

  • - #match_common + #match_common
  • - #notes + #notes
  • - #organize + #organize
  • - #parse + #parse
  • @@ -150,22 +150,22 @@

    Methods

  • - #to_json + #to_json
  • - #to_soap + #to_soap
  • - #to_xoxo + #to_xoxo
  • - #to_yaml + #to_yaml
  • @@ -347,7 +347,7 @@

    Public Class Methods

    - +
    @@ -387,7 +387,7 @@

    Public Instance Methods

    - +
    @@ -419,7 +419,7 @@

    Public Instance Methods

    - +
    @@ -451,7 +451,7 @@

    Public Instance Methods

    - +
    @@ -483,7 +483,7 @@

    Public Instance Methods

    - +
    @@ -523,7 +523,7 @@

    Public Instance Methods

    - +
    @@ -601,7 +601,7 @@

    Public Instance Methods

    - +
    @@ -613,7 +613,10 @@

    Public Instance Methods

    - +

    +TODO: ruby-1.9.1-p378 reports: notes.rb:131:in `match’: invalid byte +sequence in UTF-8 +

    @@ -640,7 +643,7 @@

    Public Instance Methods

    - +
    @@ -672,7 +675,7 @@

    Public Instance Methods

    - +
    @@ -716,7 +719,7 @@

    Public Instance Methods

    - +
    @@ -818,7 +821,7 @@

    Public Instance Methods

    - +
    @@ -855,7 +858,7 @@

    Public Instance Methods

    - +
    @@ -890,7 +893,7 @@

    Public Instance Methods

    - +
    @@ -925,7 +928,7 @@

    Public Instance Methods

    - +
    diff --git a/rdoc/classes/Xacto/String.html b/rdoc/classes/Xacto/String.html index e81f0fe..39de2bd 100644 --- a/rdoc/classes/Xacto/String.html +++ b/rdoc/classes/Xacto/String.html @@ -81,17 +81,17 @@

    Methods

  • - #indent + #indent
  • - #margin + #margin
  • - #tabto + #tabto
  • @@ -195,7 +195,7 @@

    Public Instance Methods

    - +
    @@ -209,7 +209,7 @@

    Public Instance Methods

    Indent left or right by n spaces. (This used to be called tab and aliased -as indent.) +as indent.)

      CREDIT: Gavin Sinclair
    @@ -238,7 +238,7 @@ 

    Public Instance Methods

    - +
    @@ -292,7 +292,7 @@

    Public Instance Methods

    - +
    diff --git a/rdoc/created.rid b/rdoc/created.rid index cc144ef..3745bf0 100644 --- a/rdoc/created.rid +++ b/rdoc/created.rid @@ -1 +1 @@ -Sun, 07 Feb 2010 13:15:16 -0500 +Thu, 11 Feb 2010 21:22:08 -0500 diff --git a/rdoc/files/LICENSE.html b/rdoc/files/LICENSE.html index c3cc060..8a35fd0 100644 --- a/rdoc/files/LICENSE.html +++ b/rdoc/files/LICENSE.html @@ -134,7 +134,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -164,7 +164,7 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • @@ -194,25 +194,25 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • DNote::Format - #erb + #erb
  • DNote::Notes - #files + #files
  • @@ -230,13 +230,13 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • Xacto::String - #indent + #indent
  • @@ -254,13 +254,13 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • Xacto::String - #margin + #margin
  • @@ -272,25 +272,25 @@

    Method Index

  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • DNote::Notes - #organize + #organize
  • @@ -308,19 +308,19 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • DNote::Format - #publish + #publish
  • DNote::Format::ErbScope - #render + #render
  • @@ -332,7 +332,7 @@

    Method Index

  • DNote::Format - #render_custom + #render_custom
  • @@ -362,13 +362,13 @@

    Method Index

  • DNote::Format - #render_markdown + #render_markdown
  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -410,7 +410,7 @@

    Method Index

  • Xacto::String - #tabto + #tabto
  • @@ -428,25 +428,25 @@

    Method Index

  • DNote::Notes - #to_json + #to_json
  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • DNote::Notes - #to_yaml + #to_yaml
  • @@ -458,7 +458,7 @@

    Method Index

  • DNote::Format - #write + #write
  • diff --git a/rdoc/files/README_rdoc.html b/rdoc/files/README_rdoc.html index c3c5945..abf69d6 100644 --- a/rdoc/files/README_rdoc.html +++ b/rdoc/files/README_rdoc.html @@ -46,7 +46,7 @@

    File Stats

    Last Modified
    -
    Sun Oct 25 23:33:14 -0400 2009
    +
    Mon Feb 08 12:58:29 -0500 2010
    @@ -134,7 +134,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -164,7 +164,7 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • @@ -194,25 +194,25 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • DNote::Format - #erb + #erb
  • DNote::Notes - #files + #files
  • @@ -230,13 +230,13 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • Xacto::String - #indent + #indent
  • @@ -254,13 +254,13 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • Xacto::String - #margin + #margin
  • @@ -272,25 +272,25 @@

    Method Index

  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • DNote::Notes - #organize + #organize
  • @@ -308,19 +308,19 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • DNote::Format - #publish + #publish
  • DNote::Format::ErbScope - #render + #render
  • @@ -332,7 +332,7 @@

    Method Index

  • DNote::Format - #render_custom + #render_custom
  • @@ -362,13 +362,13 @@

    Method Index

  • DNote::Format - #render_markdown + #render_markdown
  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -410,7 +410,7 @@

    Method Index

  • Xacto::String - #tabto + #tabto
  • @@ -428,25 +428,25 @@

    Method Index

  • DNote::Notes - #to_json + #to_json
  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • DNote::Notes - #to_yaml + #to_yaml
  • @@ -458,7 +458,7 @@

    Method Index

  • DNote::Format - #write + #write
  • @@ -504,19 +504,19 @@

    D’Note

    DESCRIPTION

    -Extract developement notes from source code and generate some nice output +Extract development notes from source code and generate some nice output formats for them.

    SYNOPSIS

    Note Structure

    -D’Note scans for the common noting pattern used by develepors of many -laguages of an all-caps label followed bt a colon. To be more specific, for -D’Note to recogznie a note, it needs ot follow this simple set of -rules: +D’Note scans for the common note patterns used by developers of many +languages in the form of an all-caps labels followed by a colon. To be more +specific, for D’Note to recognize a note, it needs to follow this +simple set of rules:

    -1) Notes start with an all-caps label puctuated with a colon, followed by +1) Notes start with an all-caps label punctuated with a colon, followed by the note’s text.

    @@ -540,9 +540,9 @@ 

    Note Structure

    # continue ...

    -4) An alternative to the limitation of the last rule is to indent the whole -note, making it a &lt;pre&gt; block. Then the text layout -is free-form. +4) An alternative to the previous limitation is to indent the whole note, +making it a &lt;pre&gt; block when rendered by RDoc. Then +the text layout is free-form.

       # This is a description of something...
    @@ -552,12 +552,12 @@ 

    Note Structure

    That’s all there is to it, if I can convince the developers of RDoc -to add recognize labels, we may eventually be able to relax the flush rule, +to recognize labels, we may eventually be able to relax the flush rule too, which would be very nice.

    Generating Notes

    -As you can see the commandline interface is quite straight-forward. +As you can see the commandline interface is pretty straight-forward.

       Usage: dnote [OPTIONS] path1 [path2 ...]
    @@ -580,7 +580,7 @@ 

    Generating Notes

    -h, --help show this help information

    -The default path is */.rb and the default format +The default path is */.rb and the default format is --rdoc. Here is an example of DNote’s current notes in RDoc format:

    @@ -591,7 +591,7 @@

    Generating Notes

    === file://lib/dnote/notes.rb - * TODO: Add ability to read header notes. They oftern + * TODO: Add ability to read header notes. They often have a outline format, rather then the single line. (19) * TODO: Need good CSS file. (22) * TODO: Need XSL? (24) @@ -604,7 +604,7 @@

    Generating Notes

    INSTALLATION

    -The usual RubyGem’s command: +The usual RubyGem’s command will do the trick.

       $ sudo gem install dnote
    diff --git a/rdoc/files/lib/dnote/command_rb.html b/rdoc/files/lib/dnote/command_rb.html
    index 20c1b01..35fe002 100644
    --- a/rdoc/files/lib/dnote/command_rb.html
    +++ b/rdoc/files/lib/dnote/command_rb.html
    @@ -145,7 +145,7 @@ 

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -175,7 +175,7 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • @@ -205,25 +205,25 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • DNote::Format - #erb + #erb
  • DNote::Notes - #files + #files
  • @@ -241,13 +241,13 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • Xacto::String - #indent + #indent
  • @@ -265,13 +265,13 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • Xacto::String - #margin + #margin
  • @@ -283,25 +283,25 @@

    Method Index

  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • DNote::Notes - #organize + #organize
  • @@ -319,19 +319,19 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • DNote::Format - #publish + #publish
  • DNote::Format::ErbScope - #render + #render
  • @@ -343,7 +343,7 @@

    Method Index

  • DNote::Format - #render_custom + #render_custom
  • @@ -373,13 +373,13 @@

    Method Index

  • DNote::Format - #render_markdown + #render_markdown
  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -421,7 +421,7 @@

    Method Index

  • Xacto::String - #tabto + #tabto
  • @@ -439,25 +439,25 @@

    Method Index

  • DNote::Notes - #to_json + #to_json
  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • DNote::Notes - #to_yaml + #to_yaml
  • @@ -469,7 +469,7 @@

    Method Index

  • DNote::Format - #write + #write
  • diff --git a/rdoc/files/lib/dnote/format_rb.html b/rdoc/files/lib/dnote/format_rb.html index 4c4eb75..a978f62 100644 --- a/rdoc/files/lib/dnote/format_rb.html +++ b/rdoc/files/lib/dnote/format_rb.html @@ -149,7 +149,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -179,7 +179,7 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • @@ -209,25 +209,25 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • DNote::Format - #erb + #erb
  • DNote::Notes - #files + #files
  • @@ -245,13 +245,13 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • Xacto::String - #indent + #indent
  • @@ -269,13 +269,13 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • Xacto::String - #margin + #margin
  • @@ -287,25 +287,25 @@

    Method Index

  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • DNote::Notes - #organize + #organize
  • @@ -323,19 +323,19 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • DNote::Format - #publish + #publish
  • DNote::Format::ErbScope - #render + #render
  • @@ -347,7 +347,7 @@

    Method Index

  • DNote::Format - #render_custom + #render_custom
  • @@ -377,13 +377,13 @@

    Method Index

  • DNote::Format - #render_markdown + #render_markdown
  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -425,7 +425,7 @@

    Method Index

  • Xacto::String - #tabto + #tabto
  • @@ -443,25 +443,25 @@

    Method Index

  • DNote::Notes - #to_json + #to_json
  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • DNote::Notes - #to_yaml + #to_yaml
  • @@ -473,7 +473,7 @@

    Method Index

  • DNote::Format - #write + #write
  • diff --git a/rdoc/files/lib/dnote/notes_rb.html b/rdoc/files/lib/dnote/notes_rb.html index e57630a..a532341 100644 --- a/rdoc/files/lib/dnote/notes_rb.html +++ b/rdoc/files/lib/dnote/notes_rb.html @@ -46,7 +46,7 @@

    File Stats

    Last Modified
    -
    Sun Feb 07 11:22:28 -0500 2010
    +
    Sun Feb 07 17:06:26 -0500 2010
    Requires
    @@ -153,7 +153,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -183,7 +183,7 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • @@ -213,25 +213,25 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • DNote::Format - #erb + #erb
  • DNote::Notes - #files + #files
  • @@ -249,13 +249,13 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • Xacto::String - #indent + #indent
  • @@ -273,13 +273,13 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • Xacto::String - #margin + #margin
  • @@ -291,25 +291,25 @@

    Method Index

  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • DNote::Notes - #organize + #organize
  • @@ -327,19 +327,19 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • DNote::Format - #publish + #publish
  • DNote::Format::ErbScope - #render + #render
  • @@ -351,7 +351,7 @@

    Method Index

  • DNote::Format - #render_custom + #render_custom
  • @@ -381,13 +381,13 @@

    Method Index

  • DNote::Format - #render_markdown + #render_markdown
  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -429,7 +429,7 @@

    Method Index

  • Xacto::String - #tabto + #tabto
  • @@ -447,25 +447,25 @@

    Method Index

  • DNote::Notes - #to_json + #to_json
  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • DNote::Notes - #to_yaml + #to_yaml
  • @@ -477,7 +477,7 @@

    Method Index

  • DNote::Format - #write + #write
  • diff --git a/rdoc/files/lib/dnote/site_rb.html b/rdoc/files/lib/dnote/site_rb.html index 0d976cb..ea9ba62 100644 --- a/rdoc/files/lib/dnote/site_rb.html +++ b/rdoc/files/lib/dnote/site_rb.html @@ -143,7 +143,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -173,7 +173,7 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • @@ -203,25 +203,25 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • DNote::Format - #erb + #erb
  • DNote::Notes - #files + #files
  • @@ -239,13 +239,13 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • Xacto::String - #indent + #indent
  • @@ -263,13 +263,13 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • Xacto::String - #margin + #margin
  • @@ -281,25 +281,25 @@

    Method Index

  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • DNote::Notes - #organize + #organize
  • @@ -317,19 +317,19 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • DNote::Format - #publish + #publish
  • DNote::Format::ErbScope - #render + #render
  • @@ -341,7 +341,7 @@

    Method Index

  • DNote::Format - #render_custom + #render_custom
  • @@ -371,13 +371,13 @@

    Method Index

  • DNote::Format - #render_markdown + #render_markdown
  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -419,7 +419,7 @@

    Method Index

  • Xacto::String - #tabto + #tabto
  • @@ -437,25 +437,25 @@

    Method Index

  • DNote::Notes - #to_json + #to_json
  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • DNote::Notes - #to_yaml + #to_yaml
  • @@ -467,7 +467,7 @@

    Method Index

  • DNote::Format - #write + #write
  • diff --git a/rdoc/files/lib/dnote/string_rb.html b/rdoc/files/lib/dnote/string_rb.html index ad911b1..423fe37 100644 --- a/rdoc/files/lib/dnote/string_rb.html +++ b/rdoc/files/lib/dnote/string_rb.html @@ -134,7 +134,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -164,7 +164,7 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • @@ -194,25 +194,25 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • DNote::Format - #erb + #erb
  • DNote::Notes - #files + #files
  • @@ -230,13 +230,13 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • Xacto::String - #indent + #indent
  • @@ -254,13 +254,13 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • Xacto::String - #margin + #margin
  • @@ -272,25 +272,25 @@

    Method Index

  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • DNote::Notes - #organize + #organize
  • @@ -308,19 +308,19 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • DNote::Format - #publish + #publish
  • DNote::Format::ErbScope - #render + #render
  • @@ -332,7 +332,7 @@

    Method Index

  • DNote::Format - #render_custom + #render_custom
  • @@ -362,13 +362,13 @@

    Method Index

  • DNote::Format - #render_markdown + #render_markdown
  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -410,7 +410,7 @@

    Method Index

  • Xacto::String - #tabto + #tabto
  • @@ -428,25 +428,25 @@

    Method Index

  • DNote::Notes - #to_json + #to_json
  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • DNote::Notes - #to_yaml + #to_yaml
  • @@ -458,7 +458,7 @@

    Method Index

  • DNote::Format - #write + #write
  • diff --git a/rdoc/files/lib/dnote_rb.html b/rdoc/files/lib/dnote_rb.html index d1e637d..6e35e1f 100644 --- a/rdoc/files/lib/dnote_rb.html +++ b/rdoc/files/lib/dnote_rb.html @@ -145,7 +145,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -175,7 +175,7 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • @@ -205,25 +205,25 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • DNote::Format - #erb + #erb
  • DNote::Notes - #files + #files
  • @@ -241,13 +241,13 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • Xacto::String - #indent + #indent
  • @@ -265,13 +265,13 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • Xacto::String - #margin + #margin
  • @@ -283,25 +283,25 @@

    Method Index

  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • DNote::Notes - #organize + #organize
  • @@ -319,19 +319,19 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • DNote::Format - #publish + #publish
  • DNote::Format::ErbScope - #render + #render
  • @@ -343,7 +343,7 @@

    Method Index

  • DNote::Format - #render_custom + #render_custom
  • @@ -373,13 +373,13 @@

    Method Index

  • DNote::Format - #render_markdown + #render_markdown
  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -421,7 +421,7 @@

    Method Index

  • Xacto::String - #tabto + #tabto
  • @@ -439,25 +439,25 @@

    Method Index

  • DNote::Notes - #to_json + #to_json
  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • DNote::Notes - #to_yaml + #to_yaml
  • @@ -469,7 +469,7 @@

    Method Index

  • DNote::Format - #write + #write
  • diff --git a/rdoc/files/lib/plugins/syckle/dnote_rb.html b/rdoc/files/lib/plugins/syckle/dnote_rb.html index 5796f21..b91cb6c 100644 --- a/rdoc/files/lib/plugins/syckle/dnote_rb.html +++ b/rdoc/files/lib/plugins/syckle/dnote_rb.html @@ -145,7 +145,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -175,7 +175,7 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • @@ -205,25 +205,25 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • DNote::Format - #erb + #erb
  • DNote::Notes - #files + #files
  • @@ -241,13 +241,13 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • Xacto::String - #indent + #indent
  • @@ -265,13 +265,13 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • Xacto::String - #margin + #margin
  • @@ -283,25 +283,25 @@

    Method Index

  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • DNote::Notes - #organize + #organize
  • @@ -319,19 +319,19 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • DNote::Format - #publish + #publish
  • DNote::Format::ErbScope - #render + #render
  • @@ -343,7 +343,7 @@

    Method Index

  • DNote::Format - #render_custom + #render_custom
  • @@ -373,13 +373,13 @@

    Method Index

  • DNote::Format - #render_markdown + #render_markdown
  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -421,7 +421,7 @@

    Method Index

  • Xacto::String - #tabto + #tabto
  • @@ -439,25 +439,25 @@

    Method Index

  • DNote::Notes - #to_json + #to_json
  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • DNote::Notes - #to_yaml + #to_yaml
  • @@ -469,7 +469,7 @@

    Method Index

  • DNote::Format - #write + #write
  • diff --git a/rdoc/index.html b/rdoc/index.html index f7a2ef6..6a6e046 100644 --- a/rdoc/index.html +++ b/rdoc/index.html @@ -121,7 +121,7 @@

    Method Index

  • DNote::Notes - ::new + ::new
  • @@ -151,7 +151,7 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • @@ -181,25 +181,25 @@

    Method Index

  • DNote::Notes - #each + #each
  • DNote::Notes - #empty? + #empty?
  • DNote::Format - #erb + #erb
  • DNote::Notes - #files + #files
  • @@ -217,13 +217,13 @@

    Method Index

  • DNote::Format::ErbScope - #h + #h
  • Xacto::String - #indent + #indent
  • @@ -241,13 +241,13 @@

    Method Index

  • DNote::Notes - #labels= + #labels=
  • Xacto::String - #margin + #margin
  • @@ -259,25 +259,25 @@

    Method Index

  • DNote::Notes - #match_common + #match_common
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • DNote::Notes - #organize + #organize
  • @@ -295,19 +295,19 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • DNote::Format - #publish + #publish
  • DNote::Format::ErbScope - #render + #render
  • @@ -319,7 +319,7 @@

    Method Index

  • DNote::Format - #render_custom + #render_custom
  • @@ -349,13 +349,13 @@

    Method Index

  • DNote::Format - #render_markdown + #render_markdown
  • DNote::Format - #render_rdoc + #render_rdoc
  • @@ -397,7 +397,7 @@

    Method Index

  • Xacto::String - #tabto + #tabto
  • @@ -415,25 +415,25 @@

    Method Index

  • DNote::Notes - #to_json + #to_json
  • DNote::Notes - #to_soap + #to_soap
  • DNote::Notes - #to_xoxo + #to_xoxo
  • DNote::Notes - #to_yaml + #to_yaml
  • @@ -445,7 +445,7 @@

    Method Index

  • DNote::Format - #write + #write
  • @@ -506,7 +506,7 @@

    Methods

  • ::new — DNote::Format
  • -
  • ::new — DNote::Notes
  • +
  • ::new — DNote::Notes
  • ::new — DNote::Format::ErbScope
  • @@ -520,7 +520,7 @@

    Methods

  • #clean — Syckle::Plugins::DNote
  • -
  • #counts — DNote::Notes
  • +
  • #counts — DNote::Notes
  • #debug? — DNote::Format
  • @@ -530,53 +530,53 @@

    Methods

  • #dryrun? — DNote::Format
  • -
  • #each — DNote::Notes
  • +
  • #each — DNote::Notes
  • -
  • #empty? — DNote::Notes
  • +
  • #empty? — DNote::Notes
  • -
  • #erb — DNote::Format
  • +
  • #erb — DNote::Format
  • -
  • #files — DNote::Notes
  • +
  • #files — DNote::Notes
  • #fu — DNote
  • #fu — DNote::Format
  • -
  • #h — DNote::Format::ErbScope
  • +
  • #h — DNote::Format::ErbScope
  • -
  • #indent — Xacto::String
  • +
  • #indent — Xacto::String
  • #initialize_defaults — DNote::Site
  • #initialize_defaults — Syckle::Plugins::DNote
  • -
  • #labels= — DNote::Notes
  • +
  • #labels= — DNote::Notes
  • -
  • #margin — Xacto::String
  • +
  • #margin — Xacto::String
  • #match_arbitrary — DNote::Notes
  • -
  • #match_common — DNote::Notes
  • +
  • #match_common — DNote::Notes
  • -
  • #method_missing — DNote::Format::ErbScope
  • +
  • #method_missing — DNote::Format::ErbScope
  • -
  • #notes — DNote::Notes
  • +
  • #notes — DNote::Notes
  • -
  • #organize — DNote::Notes
  • +
  • #organize — DNote::Notes
  • #output= — DNote::Site
  • #output= — Syckle::Plugins::DNote
  • -
  • #parse — DNote::Notes
  • +
  • #parse — DNote::Notes
  • -
  • #publish — DNote::Format
  • +
  • #publish — DNote::Format
  • #render — DNote::Format
  • -
  • #render — DNote::Format::ErbScope
  • +
  • #render — DNote::Format::ErbScope
  • -
  • #render_custom — DNote::Format
  • +
  • #render_custom — DNote::Format
  • #render_gnu — DNote::Format
  • @@ -586,9 +586,9 @@

    Methods

  • #render_json — DNote::Format
  • -
  • #render_markdown — DNote::Format
  • +
  • #render_markdown — DNote::Format
  • -
  • #render_rdoc — DNote::Format
  • +
  • #render_rdoc — DNote::Format
  • #render_soap — DNote::Format
  • @@ -602,21 +602,21 @@

    Methods

  • #reset — DNote::Site
  • -
  • #tabto — Xacto::String
  • +
  • #tabto — Xacto::String
  • #templates — DNote
  • #to — DNote::Notes
  • -
  • #to_json — DNote::Notes
  • +
  • #to_json — DNote::Notes
  • -
  • #to_soap — DNote::Notes
  • +
  • #to_soap — DNote::Notes
  • -
  • #to_xoxo — DNote::Notes
  • +
  • #to_xoxo — DNote::Notes
  • -
  • #to_yaml — DNote::Notes
  • +
  • #to_yaml — DNote::Notes
  • -
  • #write — DNote::Format
  • +
  • #write — DNote::Format
  • #write — DNote
  • @@ -642,19 +642,19 @@

    D’Note

    DESCRIPTION

    -Extract developement notes from source code and generate some nice output +Extract development notes from source code and generate some nice output formats for them.

    SYNOPSIS

    Note Structure

    -D’Note scans for the common noting pattern used by develepors of many -laguages of an all-caps label followed bt a colon. To be more specific, for -D’Note to recogznie a note, it needs ot follow this simple set of -rules: +D’Note scans for the common note patterns used by developers of many +languages in the form of an all-caps labels followed by a colon. To be more +specific, for D’Note to recognize a note, it needs to follow this +simple set of rules:

    -1) Notes start with an all-caps label puctuated with a colon, followed by +1) Notes start with an all-caps label punctuated with a colon, followed by the note’s text.

    @@ -678,9 +678,9 @@ 

    Note Structure

    # continue ...

    -4) An alternative to the limitation of the last rule is to indent the whole -note, making it a &lt;pre&gt; block. Then the text layout -is free-form. +4) An alternative to the previous limitation is to indent the whole note, +making it a &lt;pre&gt; block when rendered by RDoc. Then +the text layout is free-form.

       # This is a description of something...
    @@ -690,12 +690,12 @@ 

    Note Structure

    That’s all there is to it, if I can convince the developers of RDoc -to add recognize labels, we may eventually be able to relax the flush rule, +to recognize labels, we may eventually be able to relax the flush rule too, which would be very nice.

    Generating Notes

    -As you can see the commandline interface is quite straight-forward. +As you can see the commandline interface is pretty straight-forward.

       Usage: dnote [OPTIONS] path1 [path2 ...]
    @@ -718,7 +718,7 @@ 

    Generating Notes

    -h, --help show this help information

    -The default path is */.rb and the default format +The default path is */.rb and the default format is --rdoc. Here is an example of DNote’s current notes in RDoc format:

    @@ -729,7 +729,7 @@

    Generating Notes

    === file://lib/dnote/notes.rb - * TODO: Add ability to read header notes. They oftern + * TODO: Add ability to read header notes. They often have a outline format, rather then the single line. (19) * TODO: Need good CSS file. (22) * TODO: Need XSL? (24) @@ -742,7 +742,7 @@

    Generating Notes

    INSTALLATION

    -The usual RubyGem’s command: +The usual RubyGem’s command will do the trick.

       $ sudo gem install dnote
    diff --git a/ri/DNote/Notes/match_common-i.yaml b/ri/DNote/Notes/match_common-i.yaml
    index aacfc03..be020bb 100644
    --- a/ri/DNote/Notes/match_common-i.yaml
    +++ b/ri/DNote/Notes/match_common-i.yaml
    @@ -2,8 +2,9 @@
     aliases: []
     
     block_params: 
    -comment: []
    -
    +comment: 
    +- !ruby/struct:RDoc::Markup::Flow::P 
    +  body: "TODO: ruby-1.9.1-p378 reports: notes.rb:131:in `match': invalid byte sequence in UTF-8"
     full_name: DNote::Notes#match_common
     is_singleton: false
     name: match_common
    diff --git a/ri/created.rid b/ri/created.rid
    index e55194b..0d6c585 100644
    --- a/ri/created.rid
    +++ b/ri/created.rid
    @@ -1 +1 @@
    -Sun, 07 Feb 2010 13:15:14 -0500
    +Thu, 11 Feb 2010 21:22:06 -0500
    
    From b4510d633f799a002fe6bf3d530e60bb008bf5d0 Mon Sep 17 00:00:00 2001
    From: 7rans 
    Date: Thu, 11 Feb 2010 21:27:33 -0500
    Subject: [PATCH 19/27] Updated files.
    
    ---
     index.html | 8 ++++----
     1 file changed, 4 insertions(+), 4 deletions(-)
    
    diff --git a/index.html b/index.html
    index e5f976c..397ea02 100644
    --- a/index.html
    +++ b/index.html
    @@ -64,9 +64,9 @@ 

    D'Note

    Note Structure

    -

    D'Note scans for the common "LABEL:" pattern used by many developers of many languages (i.e. an all-caps - label followed by a colon). To be more specific, for D'Note to recognize a note, it needs to conform to - the following set of rules:

    +

    D'Note scans for the common "LABEL:" pattern (all-caps label followed by a colon) used by many + developers of many languages. To be more specific, for D'Note to recognize a note, it needs to + conform to the following simple set of rules:

    1) Notes start with an all-caps label punctuated with a colon, followed by the note's text.

    @@ -90,7 +90,7 @@

    Note Structure

    # continue ...
    -

    3) An alternative to the limitation of the last rule is to indent the whole note (making +

    4) An alternative to the limitation of the last rule is to indent the whole note (making the whole note a <pre> block with regards to RDoc). Then the text layout is free-form.

    From 3c9aeffe4da8b21202b115283be87cff074fea27 Mon Sep 17 00:00:00 2001 From: 7rans Date: Thu, 18 Feb 2010 12:20:27 -0500 Subject: [PATCH 20/27] Updated files. --- index.html | 55 +- rdoc/classes/DNote.html | 364 +------ rdoc/classes/DNote/Format.html | 472 ++------- rdoc/classes/DNote/Format/ErbScope.html | 28 +- rdoc/classes/DNote/{Site.html => Note.html} | 328 ++++--- rdoc/classes/DNote/Notes.html | 566 ++++++----- rdoc/classes/DNote/Session.html | 925 ++++++++++++++++++ rdoc/classes/String.html | 4 +- rdoc/classes/Syckle.html | 4 +- rdoc/classes/Syckle/Plugins.html | 4 +- rdoc/classes/Syckle/Plugins/DNote.html | 121 ++- rdoc/classes/Xacto.html | 4 +- rdoc/classes/Xacto/String.html | 12 +- rdoc/created.rid | 2 +- rdoc/files/LICENSE.html | 214 ++-- rdoc/files/README_rdoc.html | 214 ++-- rdoc/files/lib/dnote/format_rb.html | 216 ++-- .../dnote/{command_rb.html => note_rb.html} | 231 ++--- rdoc/files/lib/dnote/notes_rb.html | 226 ++--- .../dnote/{site_rb.html => session_rb.html} | 224 +++-- rdoc/files/lib/dnote/string_rb.html | 214 ++-- rdoc/files/lib/dnote_rb.html | 220 ++--- rdoc/files/lib/plugins/syckle/dnote_rb.html | 216 ++-- rdoc/index.html | 334 +++---- ri/DNote/Format/cdesc-Format.yaml | 25 +- ri/DNote/Format/new-c.yaml | 4 +- ri/DNote/Format/render_custom-i.yaml | 5 +- ri/DNote/Format/render_index-i.yaml | 10 - ri/DNote/Format/render_json-i.yaml | 10 - ri/DNote/Format/render_markdown-i.yaml | 10 - .../render_template-i.yaml} | 4 +- ri/DNote/Format/render_xoxo-i.yaml | 10 - .../%3c%3d%3e-i.yaml} | 8 +- ri/DNote/Note/cdesc-Note.yaml | 47 + ri/DNote/{Site => Note}/new-c.yaml | 4 +- .../to_json-i.yaml => Note/textline-i.yaml} | 4 +- ri/DNote/{__DIR__-i.yaml => Note/to_h-i.yaml} | 4 +- .../to_h_raw-i.yaml} | 4 +- .../to_json-i.yaml} | 6 +- ri/DNote/{fu-i.yaml => Note/to_s-i.yaml} | 4 +- .../files-i.yaml => Note/to_str-i.yaml} | 4 +- ri/DNote/{Notes => Note}/to_yaml-i.yaml | 7 +- .../by_file-i.yaml} | 6 +- ri/DNote/Notes/by_file_label-i.yaml | 12 + ri/DNote/Notes/by_label-i.yaml | 12 + ri/DNote/Notes/by_label_file-i.yaml | 12 + ri/DNote/Notes/cdesc-Notes.yaml | 54 +- ri/DNote/Notes/counts-i.yaml | 5 +- ri/DNote/Notes/each-i.yaml | 5 +- ri/DNote/Notes/empty%3f-i.yaml | 5 +- ri/DNote/Notes/labels%3d-i.yaml | 11 - .../{match_arbitrary-i.yaml => match-i.yaml} | 4 +- ...tch_common-i.yaml => match_general-i.yaml} | 6 +- ri/DNote/Notes/match_general_regex-i.yaml | 11 + .../{organize-i.yaml => match_special-i.yaml} | 8 +- .../match_special_regex-i.yaml} | 8 +- ri/DNote/Notes/new-c.yaml | 7 +- ri/DNote/Notes/notes-i.yaml | 5 +- ri/DNote/Notes/parse-i.yaml | 2 +- ri/DNote/Notes/to-i.yaml | 11 - .../render_soap-i.yaml => Notes/to_a-i.yaml} | 6 +- .../Notes/{to_xoxo-i.yaml => to_h-i.yaml} | 6 +- ri/DNote/Session/cdesc-Session.yaml | 115 +++ ri/DNote/Session/exclude%3d-i.yaml | 12 + ri/DNote/Session/files-i.yaml | 12 + ri/DNote/Session/glob-i.yaml | 12 + ri/DNote/Session/ignore%3d-i.yaml | 12 + ri/DNote/Session/initialize_defaults-i.yaml | 12 + .../{write-i.yaml => Session/main-c.yaml} | 10 +- ri/DNote/Session/new-c.yaml | 12 + .../to_soap-i.yaml => Session/run-i.yaml} | 6 +- ri/DNote/Site/cdesc-Site.yaml | 59 -- ri/DNote/Site/clean-i.yaml | 12 - ri/DNote/Site/initialize_defaults-i.yaml | 11 - ri/DNote/Site/output%3d-i.yaml | 11 - ri/DNote/Site/reset-i.yaml | 12 - ri/DNote/cdesc-DNote.yaml | 18 +- ri/DNote/run-c.yaml | 10 - ri/DNote/templates-i.yaml | 12 - ri/Syckle/Plugins/DNote/cdesc-DNote.yaml | 23 +- ri/created.rid | 2 +- 81 files changed, 3208 insertions(+), 2729 deletions(-) rename rdoc/classes/DNote/{Site.html => Note.html} (54%) create mode 100644 rdoc/classes/DNote/Session.html rename rdoc/files/lib/dnote/{command_rb.html => note_rb.html} (70%) rename rdoc/files/lib/dnote/{site_rb.html => session_rb.html} (71%) delete mode 100644 ri/DNote/Format/render_index-i.yaml delete mode 100644 ri/DNote/Format/render_json-i.yaml delete mode 100644 ri/DNote/Format/render_markdown-i.yaml rename ri/DNote/{Site/document-i.yaml => Format/render_template-i.yaml} (68%) delete mode 100644 ri/DNote/Format/render_xoxo-i.yaml rename ri/DNote/{Format/render_gnu-i.yaml => Note/%3c%3d%3e-i.yaml} (62%) create mode 100644 ri/DNote/Note/cdesc-Note.yaml rename ri/DNote/{Site => Note}/new-c.yaml (68%) rename ri/DNote/{Notes/to_json-i.yaml => Note/textline-i.yaml} (74%) rename ri/DNote/{__DIR__-i.yaml => Note/to_h-i.yaml} (77%) rename ri/DNote/{Format/render_xml-i.yaml => Note/to_h_raw-i.yaml} (71%) rename ri/DNote/{Format/render_rdoc-i.yaml => Note/to_json-i.yaml} (65%) rename ri/DNote/{fu-i.yaml => Note/to_s-i.yaml} (77%) rename ri/DNote/{Notes/files-i.yaml => Note/to_str-i.yaml} (76%) rename ri/DNote/{Notes => Note}/to_yaml-i.yaml (69%) rename ri/DNote/{Format/render_yaml-i.yaml => Notes/by_file-i.yaml} (62%) create mode 100644 ri/DNote/Notes/by_file_label-i.yaml create mode 100644 ri/DNote/Notes/by_label-i.yaml create mode 100644 ri/DNote/Notes/by_label_file-i.yaml delete mode 100644 ri/DNote/Notes/labels%3d-i.yaml rename ri/DNote/Notes/{match_arbitrary-i.yaml => match-i.yaml} (71%) rename ri/DNote/Notes/{match_common-i.yaml => match_general-i.yaml} (55%) create mode 100644 ri/DNote/Notes/match_general_regex-i.yaml rename ri/DNote/Notes/{organize-i.yaml => match_special-i.yaml} (58%) rename ri/DNote/{Format/render_html-i.yaml => Notes/match_special_regex-i.yaml} (53%) delete mode 100644 ri/DNote/Notes/to-i.yaml rename ri/DNote/{Format/render_soap-i.yaml => Notes/to_a-i.yaml} (68%) rename ri/DNote/Notes/{to_xoxo-i.yaml => to_h-i.yaml} (70%) create mode 100644 ri/DNote/Session/cdesc-Session.yaml create mode 100644 ri/DNote/Session/exclude%3d-i.yaml create mode 100644 ri/DNote/Session/files-i.yaml create mode 100644 ri/DNote/Session/glob-i.yaml create mode 100644 ri/DNote/Session/ignore%3d-i.yaml create mode 100644 ri/DNote/Session/initialize_defaults-i.yaml rename ri/DNote/{write-i.yaml => Session/main-c.yaml} (56%) create mode 100644 ri/DNote/Session/new-c.yaml rename ri/DNote/{Notes/to_soap-i.yaml => Session/run-i.yaml} (70%) delete mode 100644 ri/DNote/Site/cdesc-Site.yaml delete mode 100644 ri/DNote/Site/clean-i.yaml delete mode 100644 ri/DNote/Site/initialize_defaults-i.yaml delete mode 100644 ri/DNote/Site/output%3d-i.yaml delete mode 100644 ri/DNote/Site/reset-i.yaml delete mode 100644 ri/DNote/run-c.yaml delete mode 100644 ri/DNote/templates-i.yaml diff --git a/index.html b/index.html index 397ea02..af9903e 100644 --- a/index.html +++ b/index.html @@ -74,14 +74,16 @@

    Note Structure

    # LABEL: description ...
    + -

    3) Any note that requires more than one line must remain flush to the left +

    2) Any note that requires more than one line must remain flush to the left margin (the margin is set by the first line). This is done because RDoc will mistake the second line for a <pre> block if it is indented.

    @@ -90,7 +92,7 @@

    Note Structure

    # continue ...
    -

    4) An alternative to the limitation of the last rule is to indent the whole note (making +

    3) An alternative to the limitation of the last rule is to indent the whole note (making the whole note a <pre> block with regards to RDoc). Then the text layout is free-form.

    @@ -104,43 +106,46 @@

    Note Structure

    That's all there is to it. If I can convince the developers of RDoc to add recognition of labels, we may eventually be able to relax the flush rule too, which would be very nice.

    +

    There is also a command-line option, --no-colon, which deactives the need for + a colon after the note label. However this often produces false positives, so it's use is + discouraged.

    Generating Notes

    As you can see the commandline interface is quite straight-forward.

    -  Usage: dnote [OPTIONS] path1 [path2 ...]
    +  USAGE:
    +
    +    dnote [OPTIONS] path1 [path2 ...]
        
       OUTPUT FORMAT: (choose one)
    -          --gnu                        Plain text format (default)
    -          --rdoc                       RDoc comment format
    -          --markdown                   Markdown wiki format
    -          --soap                       SOAP XML envelope format
    -          --xoxo                       XOXO microformat format
    -          --xml                        XML markup format
    -          --html                       HTML markup format
    -          --yaml                       YAML serialization format
    -          --json                       JSON serialization format
    -      -t, --template FILE              Use a custom Erb template
    +      -f, --format NAME                select a format [text]
    +      -c, --custom FILE                use a custom ERB template
    +          --file                       shortcut for text/file format
    +          --list                       shortcut for text/list format
        
       OTHER OPTIONS:
    -          --label                      labels to collect
    -          --title [TITLE]              title to use in headers
    -      -o, --output [PATH]              name of file or directory
    -   
    -  STANDARD OPTIONS:
    -          --debug                      debug mode
    +      -l, --label LABEL                labels to collect
    +          --[no-]colon                 match labels with/without colon suffix
    +      -x, --exclude PATH               exclude file or directory
    +      -i, --ignore NAME                ignore based on any part of the pathname
    +      -t, --title TITLE                title to use in header
    +      -o, --output PATH                name of file or directory
           -n, --dryrun                     do not actually write to disk
    +          --debug                      debug mode
    +   
    +  COMMAND OPTIONS:
    +      -T, --templates                  list available format templates
           -h, --help                       show this help information
       
    -

    As you can see by the command help a variety of formats are available, here are examples of the +

    There are a variety of formats are available, here are examples of some of the XML, HTML and YAML - formats.

    + formats. You can get a list of all available format templates using the -T option.

    -

    The default path is **/*.rb and the default format --gnu. - Here is an example of D'Note's own notes in RDoc format:

    +

    The default path is **/*.rb and the default format -f text. + Here is an example of DNote's own notes in -f rdoc format:

       = Development Notes
    @@ -161,9 +166,7 @@ 

    Generating Notes

    (4 TODOs)
    -

    In the future the Notes class will model things a bit better (so the YAML output will improve), - and the parsing will be made more flexible. For instance, it would be nice if page-top outlined notes - could be parsed as well.

    +

    In the future the parsing may imnprove to allow page-top outlined notes as well.

    diff --git a/rdoc/classes/DNote.html b/rdoc/classes/DNote.html index 7a58a39..a65748b 100644 --- a/rdoc/classes/DNote.html +++ b/rdoc/classes/DNote.html @@ -55,11 +55,8 @@

    In Files

  • lib/dnote.rb
  • -
  • lib/dnote/command.rb
  • - -
  • lib/dnote/site.rb
  • +
  • lib/dnote/note.rb
  • lib/dnote/format.rb
  • @@ -67,6 +64,9 @@

    In Files

  • lib/dnote/notes.rb
  • +
  • lib/dnote/session.rb
  • +
    @@ -90,9 +90,11 @@

    Namespace

  • DNote::Format
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • @@ -100,38 +102,6 @@

    Namespace

    -
    -

    Methods

    - -
    - @@ -174,9 +144,11 @@

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • @@ -233,320 +205,6 @@

    Constants

    -
    -

    Public Class Methods

    - - -
    - - -
    - - run() - click to toggle source - -
    - -
    - -

    (Not documented)

    - - - -
    -
    -# File lib/dnote/command.rb, line 7
    -  def self.run
    -    options = {}
    -    format  = 'rdoc'
    -
    -    opts = OptionParser.new do |opt|
    -
    -      opt.banner = "Usage: dnote [OPTIONS] path1 [path2 ...]"
    -
    -      opt.separator(" ")
    -      opt.separator("OUTPUT FORMAT: (choose one)")
    -
    -      opt.on("--gnu", "Plain text format (default)") do
    -        options[:format] = 'gnu'
    -      end
    -
    -      opt.on("--rdoc", "RDoc comment format") do
    -        options[:format] = 'rdoc'
    -      end
    -
    -      opt.on("--markdown", "Markdown wiki format") do
    -        options[:format] = 'markdown'
    -      end
    -
    -      opt.on("--soap", "SOAP XML envelope format") do
    -        options[:format] = 'soap'
    -      end
    -
    -      opt.on("--xoxo", "XOXO microformat format") do
    -        options[:format] = 'xoxo'
    -      end
    -
    -      opt.on("--xml", "XML markup format") do
    -        options[:format] = 'xml'
    -      end
    -
    -      opt.on("--html", "HTML markup format") do
    -        options[:format] = 'html'
    -      end
    -
    -      opt.on("--yaml", "YAML serialization format") do
    -        options[:format] = 'yaml'
    -      end
    -
    -      opt.on("--json", "JSON serialization format") do
    -        options[:format] = 'json'
    -      end
    -
    -      opt.on("--template", "-t FILE", "Use a custom Erb template") do |file|
    -        options[:format] = 'custom'
    -        options[:template] = file
    -      end
    -
    -      opt.separator(" ")
    -      opt.separator("OTHER OPTIONS:")
    -
    -      opt.on("--label", "labels to collect") do |lbl|
    -        options[:labels] ||= []
    -        options[:labels] << lbl
    -      end
    -
    -      opt.on("--title", "-t [TITLE]", "title to use in headers") do |title|
    -        options[:title] = title
    -      end
    -
    -      opt.on("--output", "-o [PATH]", "name of file or directory") do |path|
    -        options[:output] = path
    -      end
    -
    -      opt.separator(" ")
    -      opt.separator("STANDARD OPTIONS:")
    -
    -      #opt.on("--verbose", "-v", "extra verbose output") do
    -      #  options[:verbose] = true
    -      #end
    -
    -      opt.on("--debug", "debug mode") do
    -        $DEBUG = true
    -      end
    -
    -      #opt.on("--quiet", "-q", "surpress non-essential output") do
    -      #  options[:quiet] = true
    -      #end
    -
    -      #opt.on("--noharm", "-n", "only pretend to write to disk") do
    -      #  options[:noharm] = true
    -      #end
    -
    -      opt.on("--dryrun", "-n", "do not actually write to disk") do
    -        options[:dryrun] = true
    -      end
    -
    -      #opt.on("--trace", "debug and verbose modes combined") do
    -      #  $DEBUG = true
    -      #  options[:verbose] = true
    -      #end
    -
    -      opt.on_tail('--help', '-h', "show this help information") do
    -        puts opt
    -        exit
    -      end
    -
    -    end
    -
    -    begin
    -      opts.parse!
    -    rescue => err
    -      puts err
    -      exit 1
    -    end
    -
    -    paths = ARGV.dup
    -    paths = ['**/*.rb'] if paths.empty?
    -
    -    notes  = Notes.new(paths, options[:labels])
    -    format = Format.new(notes, options)
    -    format.render
    -
    -    # NOTE: If DNote were a class.
    -
    -    #if output
    -    #  dnote.save(format, output)
    -    #else
    -    #  dnote.display(format)
    -    #end
    -  end
    -
    - -
    - - -
    - - -
    - -
    -

    Public Instance Methods

    - - -
    - - -
    - - __DIR__() - click to toggle source - -
    - -
    - -

    (Not documented)

    - - - -
    -
    -# File lib/dnote/site.rb, line 119
    -    def __DIR__
    -      File.dirname(__FILE__)
    -    end
    -
    - -
    - - -
    - - -
    - - -
    - - fu() - click to toggle source - -
    - -
    - - - - - -
    -
    -# File lib/dnote/site.rb, line 124
    -    def fu
    -      @fu ||= (
    -        if $NOOP and $DEBUG
    -          FileUtils::DryRun
    -        elsif $NOOP
    -          FileUtils::Noop
    -        elsif $DEBUG
    -          FileUtils::Verbose
    -        else
    -          FileUtils
    -        end
    -      )
    -    end
    -
    - -
    - - -
    - - -
    - - -
    - - templates(format) - click to toggle source - -
    - -
    - -

    -TODO: Don’t use chdir. -

    - - - -
    -
    -# File lib/dnote/site.rb, line 103
    -    def templates(format)
    -      temps = []
    -      Dir.chdir(tempdir(format)) do
    -        temps = Dir['**/*.erb']
    -      end
    -      temps
    -    end
    -
    - -
    - - -
    - - -
    - - -
    - - write(fname, text) - click to toggle source - -
    - -
    - -

    -Save file to output. -

    - - - -
    -
    -# File lib/dnote/site.rb, line 113
    -    def write(fname, text)
    -      file = output + fname
    -      fu.mkdir_p(file.parent)
    -      File.open(file, 'w') { |f| f << text } unless $NOOP
    -    end
    -
    - -
    - - -
    - - -
    -
    diff --git a/rdoc/classes/DNote/Format.html b/rdoc/classes/DNote/Format.html index e7395c2..f928870 100644 --- a/rdoc/classes/DNote/Format.html +++ b/rdoc/classes/DNote/Format.html @@ -99,97 +99,52 @@

    Methods

  • - ::new + ::new
  • - #debug? + #debug?
  • - #dryrun? + #dryrun?
  • - #erb + #erb
  • - #fu + #fu
  • - #publish + #publish
  • - #render + #render
  • - #render_custom + #render_custom
  • - #render_gnu + #render_template
  • - #render_html -
  • - - -
  • - #render_index -
  • - - -
  • - #render_json -
  • - - -
  • - #render_markdown -
  • - - -
  • - #render_rdoc -
  • - - -
  • - #render_soap -
  • - - -
  • - #render_xml -
  • - - -
  • - #render_xoxo -
  • - - -
  • - #render_yaml -
  • - - -
  • - #write + #write
  • @@ -237,9 +192,11 @@

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • @@ -327,6 +284,23 @@

    Attributes

    +
    +
    + +
    + + + + +
    + subtype[RW] +
    + +
    + + +
    @@ -408,7 +382,7 @@

    Public Class Methods

    - +
    @@ -427,14 +401,14 @@

    Public Class Methods

    -# File lib/dnote/format.rb, line 40
    +# File lib/dnote/format.rb, line 43
         def initialize(notes, options={})
    -      @notes  = notes
    -      @format = :gnu
    -      @title  = "Developer's Notes"
    -      options.each do |k,v|
    -        __send__("#{k}=", v) if v
    -      end
    +      @notes   = notes
    +      @format  = 'text'
    +      @subtype = 'label'
    +      @title   = "Developer's Notes"
    +      options.each{ |k,v| __send__("#{k}=", v) if v }
    +      yield(self) if block_given?
         end
    @@ -451,7 +425,7 @@

    Public Instance Methods

    - +
    @@ -470,13 +444,17 @@

    Public Instance Methods

    -# File lib/dnote/format.rb, line 50
    +# File lib/dnote/format.rb, line 53
         def render
           if notes.empty?
             $stderr << "No #{notes.labels.join(', ')} notes.\n"
           else
    -        raise ArgumentError unless respond_to?("render_#{format}")
    -        __send__("render_#{format}")
    +        case format
    +        when 'custom'
    +          render_custom
    +        else
    +          render_template
    +        end
           end
         end
    @@ -488,7 +466,7 @@

    Public Instance Methods

    - +
    @@ -500,17 +478,16 @@

    Public Instance Methods

    -

    -C U S T O M T E M P L A T E -

    +
    -# File lib/dnote/format.rb, line 123
    +# File lib/dnote/format.rb, line 69
         def render_custom
    +      #raise ArgumentError unless File.exist?(template)
           result = erb(template)
           publish(result)    
         end
    @@ -522,252 +499,12 @@

    Public Instance Methods

    -
    - - -
    - - render_gnu() - click to toggle source - -
    - -
    - -

    -W I K I M A R K U P -

    - - - -
    -
    -# File lib/dnote/format.rb, line 103
    -    def render_gnu
    -      template = File.join(File.dirname(__FILE__), 'templates/gnu.erb')
    -      result = erb(template)
    -      publish(result)
    -    end
    -
    - -
    - - -
    - - -
    - - -
    - - render_html() - click to toggle source - -
    - -
    - -

    (Not documented)

    - - - -
    -
    -# File lib/dnote/format.rb, line 89
    -    def render_html
    -      template = File.join(File.dirname(__FILE__), 'templates/html.erb')
    -      result = erb(template)
    -      publish(result)
    -    end
    -
    - -
    - - -
    - - -
    - - -
    - - render_index() - click to toggle source - -
    - -
    - -

    (Not documented)

    - - - -
    -
    -# File lib/dnote/format.rb, line 95
    -    def render_index
    -      template = File.join(File.dirname(__FILE__), 'templates/html.erb')
    -      result = erb(template)
    -      publish(result, 'index.html')
    -    end
    -
    - -
    - - -
    - - -
    - - -
    - - render_json() - click to toggle source - -
    - -
    - -

    (Not documented)

    - - - -
    -
    -# File lib/dnote/format.rb, line 66
    -    def render_json
    -      result = notes.to_json
    -      publish(result)
    -    end
    -
    - -
    - - -
    - - -
    - - -
    - - render_markdown() - click to toggle source - -
    - -
    - -

    (Not documented)

    - - - -
    -
    -# File lib/dnote/format.rb, line 115
    -    def render_markdown
    -      template = File.join(File.dirname(__FILE__), 'templates/markdown.erb')
    -      result = erb(template)
    -      publish(result)
    -    end
    -
    - -
    - - -
    - - -
    - - -
    - - render_rdoc() - click to toggle source - -
    - -
    - -

    (Not documented)

    - - - -
    -
    -# File lib/dnote/format.rb, line 109
    -    def render_rdoc
    -      template = File.join(File.dirname(__FILE__), 'templates/rdoc.erb')
    -      result = erb(template)
    -      publish(result)
    -    end
    -
    - -
    - - -
    - - -
    - - -
    - - render_soap() - click to toggle source - -
    - -
    - -

    -M L M A R K U P -

    - - - -
    -
    -# File lib/dnote/format.rb, line 73
    -    def render_soap
    -      result = notes.to_soap
    -      publish(result)
    -    end
    -
    - -
    - - -
    - - -
    - +
    +
    - render_xmlrender_template() click to toggle source @@ -775,86 +512,19 @@

    Public Instance Methods

    -

    (Not documented)

    - - -
    -
    -# File lib/dnote/format.rb, line 83
    -    def render_xml
    -      template = File.join(File.dirname(__FILE__), 'templates/xml.erb')
    -      result = erb(template)
    -      publish(result)
    -    end
    -
    - -
    - - -
    - - -
    - - -
    - - render_xoxo() - click to toggle source - -
    - -
    - -

    (Not documented)

    + id="render-template-source">
     # File lib/dnote/format.rb, line 78
    -    def render_xoxo
    -      result = notes.to_xoxo
    -      publish(result)
    -    end
    -
    - -
    - - -
    - - -
    - - -
    - - render_yaml() - click to toggle source - -
    - -
    - -

    -S E R I A L I Z A T I O N -

    - - - -
    -
    -# File lib/dnote/format.rb, line 61
    -    def render_yaml
    -      result = notes.to_yaml
    -      publish(result)
    +    def render_template
    +      template = File.join(File.dirname(__FILE__), 'templates', "#{format}.erb")
    +      raise "No such format - #{format}" unless File.exist?(template)
    +      result = erb(template)
    +      publish(result)  
         end
    @@ -871,7 +541,7 @@

    Private Instance Methods

    - +
    @@ -890,7 +560,7 @@

    Private Instance Methods

    -# File lib/dnote/format.rb, line 171
    +# File lib/dnote/format.rb, line 128
         def debug?
           $DEBUG
         end
    @@ -903,7 +573,7 @@

    Private Instance Methods

    - +
    @@ -922,7 +592,7 @@

    Private Instance Methods

    -# File lib/dnote/format.rb, line 166
    +# File lib/dnote/format.rb, line 123
         def dryrun?
           @dryrun
         end
    @@ -935,7 +605,7 @@

    Private Instance Methods

    - +
    @@ -954,7 +624,7 @@

    Private Instance Methods

    -# File lib/dnote/format.rb, line 131
    +# File lib/dnote/format.rb, line 88
         def erb(file)
           scope = ErbScope.new(:notes=>notes, :title=>title)
           scope.render(file)
    @@ -968,7 +638,7 @@ 

    Private Instance Methods

    - +
    @@ -987,7 +657,7 @@

    Private Instance Methods

    -# File lib/dnote/format.rb, line 176
    +# File lib/dnote/format.rb, line 133
         def fu
           @fu ||= (
             if dryrun? and debug?
    @@ -1010,7 +680,7 @@ 

    Private Instance Methods

    - +
    @@ -1029,7 +699,7 @@

    Private Instance Methods

    -# File lib/dnote/format.rb, line 137
    +# File lib/dnote/format.rb, line 94
         def publish(result, fname=nil)
           if output
             write(result, fname)
    @@ -1047,7 +717,7 @@ 

    Private Instance Methods

    - +
    @@ -1066,7 +736,7 @@

    Private Instance Methods

    -# File lib/dnote/format.rb, line 147
    +# File lib/dnote/format.rb, line 104
         def write(result, fname=nil)
           if output.end_with?('/') || File.directory?(output)
             ext  = EXTENSIONS[format] || format
    diff --git a/rdoc/classes/DNote/Format/ErbScope.html b/rdoc/classes/DNote/Format/ErbScope.html
    index b2bfac1..3812f20 100644
    --- a/rdoc/classes/DNote/Format/ErbScope.html
    +++ b/rdoc/classes/DNote/Format/ErbScope.html
    @@ -90,22 +90,22 @@ 

    Methods

  • - ::new + ::new
  • - #h + #h
  • - #method_missing + #method_missing
  • - #render + #render
  • @@ -153,9 +153,11 @@

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • @@ -205,7 +207,7 @@

    Public Class Methods

    - +
    @@ -224,7 +226,7 @@

    Public Class Methods

    -# File lib/dnote/format.rb, line 193
    +# File lib/dnote/format.rb, line 150
           def initialize(data={})
             @data = data
           end
    @@ -243,7 +245,7 @@

    Public Instance Methods

    - +
    @@ -262,7 +264,7 @@

    Public Instance Methods

    -# File lib/dnote/format.rb, line 202
    +# File lib/dnote/format.rb, line 159
           def h(string)
             REXML::Text.normalize(string)
           end
    @@ -275,7 +277,7 @@

    Public Instance Methods

    - +
    @@ -294,7 +296,7 @@

    Public Instance Methods

    -# File lib/dnote/format.rb, line 206
    +# File lib/dnote/format.rb, line 163
           def method_missing(s, *a)
             @data[s.to_sym]
           end
    @@ -307,7 +309,7 @@

    Public Instance Methods

    - +
    @@ -326,7 +328,7 @@

    Public Instance Methods

    -# File lib/dnote/format.rb, line 197
    +# File lib/dnote/format.rb, line 154
           def render(file)
             erb = ERB.new(File.read(file), nil, '<>')
             erb.result(binding)
    diff --git a/rdoc/classes/DNote/Site.html b/rdoc/classes/DNote/Note.html
    similarity index 54%
    rename from rdoc/classes/DNote/Site.html
    rename to rdoc/classes/DNote/Note.html
    index 86f0db7..e6ecc1e 100644
    --- a/rdoc/classes/DNote/Site.html
    +++ b/rdoc/classes/DNote/Note.html
    @@ -5,7 +5,7 @@
     
       
     
    -  Class: DNote::Site
    +  Class: DNote::Note
     
       
         
    @@ -40,7 +40,7 @@ 

      D'Note  - DNote::Site + DNote::Note

    @@ -52,8 +52,8 @@

    In Files

    @@ -90,32 +90,47 @@

    Methods

  • - ::new + ::new
  • - #clean + #<=>
  • - #document + #textline
  • - #initialize_defaults + #to_h
  • - #output= + #to_h_raw
  • - #reset + #to_json +
  • + + +
  • + #to_s +
  • + + +
  • + #to_str +
  • + + +
  • + #to_yaml
  • @@ -163,9 +178,11 @@

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • @@ -196,33 +213,14 @@

    Class Index
    -

    Site

    +

    Note

    -

    -Site class is used to build a “pretty” -output set. The template files are saved to the output directory. -Additional formats can be saved to the directory as well. -

    - +
    -
    -

    Constants

    -
    - -
    DEFAULT_OUTPUT
    - -

    -Default output directory is log/dnote/. -

    - - -
    -
    - @@ -230,76 +228,62 @@

    Constants

    Attributes

    -
    - - - +
    +
    - title[RW] + file[R]
    -

    -Title to use in any headers. -

    +

    (Not documented)

    -
    - - - +
    +
    - output[RW] + label[R]
    -

    -Directory to save output. -

    +

    (Not documented)

    -
    - - - +
    +
    - formats[RW] + line[R]
    -

    -Additional Formats to supply besides the html (xml, rdoc, markdown, etc.) -

    +

    (Not documented)

    -
    - +
    +
    - notestext[R]
    -

    -Notes object. -

    +

    (Not documented)

    @@ -314,12 +298,12 @@

    Public Class Methods

    - +
    new(paths, options) + class="method-args">(file, label, line, text) click to toggle source
    @@ -333,16 +317,12 @@

    Public Class Methods

    -# File lib/dnote/site.rb, line 27
    -    def initialize(paths, options)
    -      initialize_defaults
    -
    -      self.title   = options[:title]          if options[:title]
    -
    -      self.output  = options.delete(:output)  if options[:output]
    -      self.formats = options.delete(:formats) if options[:formats]
    -
    -      @notes = Notes.new(paths, options)
    +# File lib/dnote/note.rb, line 10
    +    def initialize(file, label, line, text)
    +      @file  = file
    +      @label = label
    +      @line  = line
    +      @text  = text.rstrip
         end
    @@ -358,13 +338,13 @@

    Public Class Methods

    Public Instance Methods

    -
    - +
    +
    - clean() + <=>(other) click to toggle source
    @@ -372,20 +352,19 @@

    Public Instance Methods

    -Remove output directory. +Sort by file name and line number.

    + id="--source">
    -# File lib/dnote/site.rb, line 90
    -    def clean
    -      if File.directory?(output)
    -        fu.rm_r(output)
    -        puts "removed #{output}"
    -      end
    +# File lib/dnote/note.rb, line 33
    +    def <=>(other)
    +      s = file <=> other.file
    +      return s unless s == 0
    +      line <=> other.line
         end
    @@ -395,12 +374,12 @@

    Public Instance Methods

    -
    - +
    +
    - documenttextline() click to toggle source @@ -413,18 +392,11 @@

    Public Instance Methods

    + id="textline-source">
    -# File lib/dnote/site.rb, line 52
    -    def document
    -      fu.mkdir_p(output)
    -
    -      # produce requested additional formats
    -      formats.each do |format|
    -??
    -        text = notes.to(format)
    -        write("notes.#{format}", text)
    -      end
    +# File lib/dnote/note.rb, line 28
    +    def textline
    +      text.gsub("\n", " ")
         end
    @@ -434,12 +406,12 @@

    Public Instance Methods

    -
    - +
    +
    - initialize_defaultsto_h() click to toggle source @@ -447,18 +419,48 @@

    Public Instance Methods

    +

    (Not documented)

    + + +
    +
    +# File lib/dnote/note.rb, line 39
    +    def to_h
    +      { 'label'=>label, 'text'=>textline, 'file'=>file, 'line'=>line }
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + to_h_raw() + click to toggle source + +
    + +
    + +

    (Not documented)

    + id="to-h-raw-source">
    -# File lib/dnote/site.rb, line 39
    -    def initialize_defaults
    -      @output   = DEFAULT_OUTPUT
    -      @title    = "Development Notes"
    -      @formats  = ['html']
    +# File lib/dnote/note.rb, line 43
    +    def to_h_raw
    +      { 'label'=>label, 'text'=>text, 'file'=>file, 'line'=>line }
         end
    @@ -468,13 +470,45 @@

    Public Instance Methods

    -
    - +
    + + +
    + + to_json(*args) + click to toggle source + +
    + +
    + +

    (Not documented)

    + + + +
    +
    +# File lib/dnote/note.rb, line 47
    +    def to_json(*args)
    +      to_h_raw.to_json(*args)
    +    end
    +
    + +
    + + +
    + + +
    +
    - output=(path) + to_s() click to toggle source
    @@ -486,12 +520,11 @@

    Public Instance Methods

    + id="to-s-source">
    -# File lib/dnote/site.rb, line 46
    -    def output=(path)
    -      raise "output cannot be root" if File.expand_path(path) == "/"
    -      @output = Pathname.new(path)
    +# File lib/dnote/note.rb, line 18
    +    def to_s
    +      "#{label}: #{text}"
         end
    @@ -501,12 +534,12 @@

    Public Instance Methods

    -
    - +
    +
    - resetto_str() click to toggle source @@ -514,21 +547,48 @@

    Public Instance Methods

    -

    -Reset output directory, marking it as out-of-date. -

    + + + + +
    +
    +# File lib/dnote/note.rb, line 23
    +    def to_str
    +      "#{label}: #{text}"
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + to_yaml(*args) + click to toggle source + +
    + +
    + +

    (Not documented)

    + id="to-yaml-source">
    -# File lib/dnote/site.rb, line 82
    -    def reset
    -      if File.directory?(output)
    -        File.utime(0,0,output) unless $NOOP
    -        puts "marked #{output}"
    -      end
    +# File lib/dnote/note.rb, line 51
    +    def to_yaml(*args)
    +      to_h_raw.to_yaml(*args)
         end
    diff --git a/rdoc/classes/DNote/Notes.html b/rdoc/classes/DNote/Notes.html index a5c3453..6cf0af1 100644 --- a/rdoc/classes/DNote/Notes.html +++ b/rdoc/classes/DNote/Notes.html @@ -90,82 +90,87 @@

    Methods

  • - ::new + ::new
  • - #counts + #by_file
  • - #each + #by_file_label
  • - #empty? + #by_label
  • - #files + #by_label_file
  • - #labels= + #counts
  • - #match_arbitrary + #each
  • - #match_common + #empty?
  • - #notes + #match
  • - #organize + #match_general
  • - #parse + #match_general_regex
  • - #to + #match_special
  • - #to_json + #match_special_regex
  • - #to_soap + #notes
  • - #to_xoxo + #parse
  • - #to_yaml + #to_a +
  • + + +
  • + #to_h
  • @@ -224,9 +229,11 @@

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • @@ -261,10 +268,12 @@

    Class Index

    Developer Notes

    This class goes through you source files and compiles a list of any labeled -comments. Labels are single word prefixes to a comment ending in a colon. +comments. Labels are all-cap single word prefixes to a comment ending in a +colon.

    -By default the labels supported are TODO, FIXME, OPTIMIZE and DEPRECATE. +Special labels do require the colon. By default these are TODO, +FIXME, OPTIMIZE and DEPRECATE.

    @@ -285,7 +294,7 @@

    Constants

    DEFAULT_LABELS

    -Default note labels to look for in source code. +Default note labels to look for in source code. (NOT CURRENTLY USED!)

    @@ -299,20 +308,20 @@

    Constants

    Attributes

    -
    - +
    + - +
    - pathsfiles[RW]

    -Paths to search. +Files to search for notes.

    @@ -331,7 +340,27 @@

    Attributes

    -Labels to document. Defaults are: TODO, FIXME, OPTIMIZE and DEPRECATE. +Labels to document. Defaults are: TODO, FIXME, +OPTIMIZE and DEPRECATE. +

    + +
    +
    + +
    + + + + +
    + colon[RW] +
    + +
    + +

    +Require label colon? Default is true.

    @@ -347,29 +376,32 @@

    Public Class Methods

    - +
    new(paths, labels=nil) + class="method-args">(files, options={}) click to toggle source
    - +

    +New set of notes for give files and optional special labels. +

    -# File lib/dnote/notes.rb, line 34
    -    def initialize(paths, labels=nil)
    -      @paths  = [paths  || DEFAULT_PATHS ].flatten
    -      @labels = [labels || DEFAULT_LABELS].flatten
    +# File lib/dnote/notes.rb, line 38
    +    def initialize(files, options={})
    +      @files  = [files].flatten
    +      @labels = [options[:labels]].flatten.compact
    +      @colon  = options[:colon].nil? ? true : options[:colon]
           parse
         end
    @@ -386,12 +418,12 @@

    Public Class Methods

    Public Instance Methods

    -
    - +
    +
    - countsby_file() click to toggle source @@ -399,16 +431,26 @@

    Public Instance Methods

    - +

    +Organize notes into a hash with filename for keys. +

    + id="by-file-source">
    -# File lib/dnote/notes.rb, line 46
    -    def counts
    -      @counts
    +# File lib/dnote/notes.rb, line 178
    +    def by_file
    +      @by_file ||= (
    +        list = {}
    +        notes.each do |note|
    +          list[note.file] ||= []
    +          list[note.file] << note
    +          list[note.file].sort! #!{ |a,b| a.line <=> b.line }
    +        end
    +        list
    +      )
         end
    @@ -418,29 +460,41 @@

    Public Instance Methods

    -
    - +
    +
    - each(&block) + by_file_label() click to toggle source
    - +

    +Organize notes into a hash with filenames for keys, followed by a hash with +labels for keys. +

    + id="by-file-label-source">
    -# File lib/dnote/notes.rb, line 51
    -    def each(&block)
    -      notes.each(&block)
    +# File lib/dnote/notes.rb, line 207
    +    def by_file_label
    +      @by_file ||= (
    +        list = {}
    +        notes.each do |note|
    +          list[note.file] ||= {}
    +          list[note.file][note.label] ||= []
    +          list[note.file][note.label] << note
    +          list[note.file][note.label].sort! #{ |a,b| a.line <=> b.line }
    +        end
    +        list
    +      )
         end
    @@ -450,12 +504,12 @@

    Public Instance Methods

    -
    - +
    +
    - empty?by_label() click to toggle source @@ -463,16 +517,26 @@

    Public Instance Methods

    - +

    +Organize notes into a hash with labels for keys. +

    + id="by-label-source">
    -# File lib/dnote/notes.rb, line 56
    -    def empty?
    -      notes.empty?
    +# File lib/dnote/notes.rb, line 165
    +    def by_label
    +      @by_label ||= (
    +        list = {}
    +        notes.each do |note|
    +          list[note.label] ||= []
    +          list[note.label] << note
    +          list[note.label].sort #!{ |a,b| a.line <=> b.line }
    +        end
    +        list
    +      )
         end
    @@ -482,12 +546,12 @@

    Public Instance Methods

    -
    - +
    +
    - filesby_label_file() click to toggle source @@ -495,23 +559,27 @@

    Public Instance Methods

    - +

    +Organize notes into a hash with labels for keys, followed by a hash with +filename for keys. +

    + id="by-label-file-source">
    -# File lib/dnote/notes.rb, line 115
    -    def files
    -      @files ||= (
    -        [self.paths].flatten.map do |path|
    -          if File.directory?(path)
    -            Dir.glob(File.join(path, '**/*'))
    -          else
    -            Dir.glob(path)
    -          end
    -        end.flatten.uniq
    +# File lib/dnote/notes.rb, line 192
    +    def by_label_file
    +      @by_label ||= (
    +        list = {}
    +        notes.each do |note|
    +          list[note.label] ||= {}
    +          list[note.label][note.file] ||= []
    +          list[note.label][note.file] << note
    +          list[note.label][note.file].sort! #{ |a,b| a.line <=> b.line }
    +        end
    +        list
           )
         end
    @@ -522,35 +590,36 @@

    Public Instance Methods

    -
    - +
    +
    - labels=(labels) + counts() click to toggle source
    - +

    +Notes counts by label. +

    + id="counts-source">
    -# File lib/dnote/notes.rb, line 61
    -    def labels=(labels)
    -      @labels = (
    -        case labels
    -        when String
    -          labels.split(/[:;,]/)
    -        else
    -          labels = [labels].flatten.compact.uniq.map{ |s| s.to_s }
    +# File lib/dnote/notes.rb, line 51
    +    def counts
    +      @counts ||= (
    +        h = {}
    +        by_label.each do |label, notes|
    +          h[label] = notes.size
             end
    +        h
           )
         end
    @@ -561,36 +630,31 @@

    Public Instance Methods

    -
    - +
    +
    - match_arbitrary(line, lineno, file) + each(&block) click to toggle source
    - +

    +Iterate through notes. +

    + id="each-source">
    -# File lib/dnote/notes.rb, line 140
    -    def match_arbitrary(line, lineno, file)
    -      rec = nil
    -      labels.each do |label|
    -        if md = /\#\s*([A-Z]+)[:]\s*(.*?)$/.match(line)
    -          label, text = md[1], md[2]
    -          rec = {'label'=>label,'file'=>file,'line'=>lineno,'note'=>text}
    -        end
    -      end
    -      return rec
    +# File lib/dnote/notes.rb, line 62
    +    def each(&block)
    +      notes.each(&block)
         end
    @@ -600,13 +664,13 @@

    Public Instance Methods

    -
    - +
    +
    - match_common(line, lineno, file) + empty?() click to toggle source
    @@ -614,25 +678,17 @@

    Public Instance Methods

    -TODO: ruby-1.9.1-p378 reports: notes.rb:131:in `match’: invalid byte -sequence in UTF-8 +No notes?

    + id="empty--source">
    -# File lib/dnote/notes.rb, line 128
    -    def match_common(line, lineno, file)
    -      rec = nil
    -      labels.each do |label|
    -        if md = /\#\s*#{Regexp.escape(label)}[:]?\s*(.*?)$/.match(line)
    -          text = md[1]
    -          rec = {'label'=>label,'file'=>file,'line'=>lineno,'note'=>text}
    -        end
    -      end
    -      return rec
    +# File lib/dnote/notes.rb, line 67
    +    def empty?
    +      notes.empty?
         end
    @@ -642,13 +698,13 @@

    Public Instance Methods

    -
    - +
    +
    - notes() + match(line, lineno, file) click to toggle source
    @@ -660,11 +716,15 @@

    Public Instance Methods

    + id="match-source">
    -# File lib/dnote/notes.rb, line 41
    -    def notes
    -      @notes
    +# File lib/dnote/notes.rb, line 112
    +    def match(line, lineno, file)
    +      if labels.empty?
    +        match_general(line, lineno, file)
    +      else
    +        match_special(line, lineno, file)
    +      end
         end
    @@ -674,13 +734,13 @@

    Public Instance Methods

    -
    - +
    +
    - organize(records) + match_general(line, lineno, file) click to toggle source
    @@ -688,27 +748,23 @@

    Public Instance Methods

    -Organize records in heirarchical form. +Match notes that are labeled with a colon.

    + id="match-general-source">
    -# File lib/dnote/notes.rb, line 153
    -    def organize(records)
    -      orecs = {}
    -      records.each do |record|
    -        label = record['label']
    -        file  = record['file']
    -        line  = record['line']
    -        note  = record['note'].rstrip
    -        orecs[label] ||= {}
    -        orecs[label][file] ||= []
    -        orecs[label][file] << [line, note]
    +# File lib/dnote/notes.rb, line 145
    +    def match_general(line, lineno, file)
    +      rec = nil
    +      if md = match_general_regex.match(line)
    +        label, text = md[1], md[2]
    +        #rec = {'label'=>label,'file'=>file,'line'=>lineno,'note'=>text}
    +        rec = Note.new(file, label, lineno, text)
           end
    -      orecs
    +      return rec
         end
    @@ -718,12 +774,12 @@

    Public Instance Methods

    -
    +
    - parsematch_general_regex() click to toggle source @@ -731,54 +787,62 @@

    Public Instance Methods

    + + + + +
    +
    +# File lib/dnote/notes.rb, line 156
    +    def match_general_regex
    +      if colon
    +        /\#\s*([A-Z]+)[:]\s+(.*?)$/
    +      else
    +        /\#\s*([A-Z]+)[:]?\s+(.*?)$/
    +      end
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + match_special(line, lineno, file) + click to toggle source + +
    + +
    +

    -Gather and count notes. This returns two elements, a hash in the form of -label=>notes and a counts hash. +Match special notes.

    + id="match-special-source">
    -# File lib/dnote/notes.rb, line 75
    -    def parse
    -      records, counts = [], Hash.new(0)
    -      files.each do |fname|
    -        next unless File.file?(fname)
    -        #next unless fname =~ /\.rb$/      # TODO: should this be done?
    -        File.open(fname) do |f|
    -          lineno, save, text = 0, nil, nil
    -          while line = f.gets
    -            lineno += 1
    -            save = match_common(line, lineno, fname) || match_arbitrary(line, lineno, fname)
    -            if save
    -              #file = fname
    -              text = save['note']
    -              #save = {'label'=>label,'file'=>file,'line'=>line_no,'note'=>text}
    -              records << save
    -              counts[save['label']] += 1
    -            else
    -              if text
    -                if line =~ /^\s*[#]{0,1}\s*$/ or line !~ /^\s*#/ or line =~ /^\s*#[+][+]/
    -                  text.strip!
    -                  text = nil
    -                else
    -                  if text[-1,1] == "\n"
    -                    text << line.gsub(/^\s*#\s*/,'')
    -                  else
    -                    text << "\n" << line.gsub(/^\s*#\s*/,'')
    -                  end
    -                end
    -              end
    -            end
    -          end
    +# File lib/dnote/notes.rb, line 121
    +    def match_special(line, lineno, file)
    +      rec = nil
    +      labels.each do |label|
    +        if md = match_special_regex(label).match(line)
    +          text = md[1]
    +          #rec = {'label'=>label,'file'=>file,'line'=>lineno,'note'=>text}
    +          rec = Note.new(file, label, lineno, text)
             end
           end
    -      # organize the notes
    -      notes = organize(records)
    -      #
    -      @notes, @counts = notes, counts
    +      rec
         end
    @@ -788,13 +852,13 @@

    Public Instance Methods

    -
    - +
    +
    - to(format) + match_special_regex(label) click to toggle source
    @@ -806,11 +870,15 @@

    Public Instance Methods

    + id="match-special-regex-source">
    -# File lib/dnote/notes.rb, line 168
    -    def to(format)
    -      __send__("to_#{format}")
    +# File lib/dnote/notes.rb, line 136
    +    def match_special_regex(label)
    +      if colon
    +        /\#\s*#{Regexp.escape(label)}[:]\s*(.*?)$/
    +      else
    +        /\#\s*#{Regexp.escape(label)}[:]?\s*(.*?)$/
    +      end
         end
    @@ -820,12 +888,12 @@

    Public Instance Methods

    -
    - +
    +
    - to_jsonnotes() click to toggle source @@ -833,21 +901,18 @@

    Public Instance Methods

    - +

    +Array of notes. +

    + id="notes-source">
    -# File lib/dnote/notes.rb, line 179
    -    def to_json
    -      begin
    -        require 'json'
    -      rescue LoadError
    -        require 'json_pure'
    -      end
    -      notes.to_json
    +# File lib/dnote/notes.rb, line 46
    +    def notes
    +      @notes
         end
    @@ -857,12 +922,12 @@

    Public Instance Methods

    -
    - +
    +
    - to_soapparse() click to toggle source @@ -871,18 +936,49 @@

    Public Instance Methods

    -Soap envelope XML. +Gather notes.

    + id="parse-source">
    -# File lib/dnote/notes.rb, line 189
    -    def to_soap
    -      require 'soap/marshal'
    -      SOAP::Marshal.marshal(notes)
    +# File lib/dnote/notes.rb, line 75
    +    def parse
    +      records = []
    +      files.each do |fname|
    +        next unless File.file?(fname)
    +        #next unless fname =~ /\.rb$/      # TODO: should this be done?
    +        File.open(fname) do |f|
    +          lineno, save, text = 0, nil, nil
    +          while line = f.gets
    +            lineno += 1
    +            save = match(line, lineno, fname)
    +            if save
    +              #file = fname
    +              text = save.text
    +              #save = {'label'=>label,'file'=>file,'line'=>line_no,'note'=>text}
    +              records << save
    +            else
    +              if text
    +                if line =~ /^\s*[#]{0,1}\s*$/ or line !~ /^\s*#/ or line =~ /^\s*#[+][+]/
    +                  text.strip!
    +                  text = nil
    +                else
    +                  if text[-1,1] == "\n"
    +                    text << line.gsub(/^\s*#\s*/,'')
    +                  else
    +                    text << "\n" << line.gsub(/^\s*#\s*/,'')
    +                  end
    +                end
    +              end
    +            end
    +          end
    +        end
    +      end
    +
    +      @notes  = records.sort
         end
    @@ -892,12 +988,12 @@

    Public Instance Methods

    -
    - +
    +
    - to_xoxoto_a() click to toggle source @@ -906,18 +1002,17 @@

    Public Instance Methods

    -XOXO microformat. +Convert to an array of hashes.

    + id="to-a-source">
    -# File lib/dnote/notes.rb, line 195
    -    def to_xoxo
    -      require 'xoxo'
    -      notes.to_xoxo
    +# File lib/dnote/notes.rb, line 221
    +    def to_a
    +      notes.map{ |n| n.to_h }
         end
    @@ -927,12 +1022,12 @@

    Public Instance Methods

    -
    - +
    +
    - to_yamlto_h() click to toggle source @@ -940,17 +1035,18 @@

    Public Instance Methods

    - +

    +Same as by_label. +

    + id="to-h-source">
    -# File lib/dnote/notes.rb, line 173
    -    def to_yaml
    -      require 'yaml'
    -      notes.to_yaml
    +# File lib/dnote/notes.rb, line 226
    +    def to_h
    +      by_label
         end
    diff --git a/rdoc/classes/DNote/Session.html b/rdoc/classes/DNote/Session.html new file mode 100644 index 0000000..a5ff2c2 --- /dev/null +++ b/rdoc/classes/DNote/Session.html @@ -0,0 +1,925 @@ + + + + + + + + Class: DNote::Session + + + + + + + + + + + + + + + + +
    + +
    +

    + +   + + D'Note  + DNote::Session +

    +
    + +
    +
    + +
    +

    In Files

    +
    + +
    +
    + + + + + +
    + +
    + + + +
    +

    Parent

    +
      + +
    • Object
    • + +
    +
    + + + + + + + +
    +

    Methods

    + +
    + + + + +
    + +
    + + +
    +

    Information

    + +
    + + +
    +

    Class Index + [+]

    +
    +
    + Quicksearch + +
    +
    + + + + +
    +
    + +
    + +
    + [Validate] +
    + Generated with WebRI Redfish 1.1 +

    +
    +
    + +
    + +
    + +

    Session

    + + +

    +User session which is used by commandline interface. +

    +

    +By making this a class it makes it easy for external libraries to use this +library just as if they were calling the commandline, but without the need +to shellout. +

    + +
    + + + +
    +

    Constants

    +
    + +
    DIR
    + +

    +Directory relative to this script. This is used to lookup the available +format templates. +

    + + +
    DEFAULT_FORMAT
    + +

    +Default format. +

    + + +
    DEFAULT_TITLE
    + +

    +Default title. +

    + + +
    +
    + + + + +
    +

    Attributes

    + + +
    + + + + +
    + paths[RW] +
    + +
    + +

    +Paths to include. +

    + +
    +
    + +
    + + + + +
    + exclude[RW] +
    + +
    + +

    +Paths to exclude (match by pathname). +

    + +
    +
    + +
    + + + + +
    + ignore[RW] +
    + +
    + +

    +Paths to ignore (match by basename). +

    + +
    +
    + +
    + + + + +
    + labels[RW] +
    + +
    + +

    +Labels to lookup. By default these are TODO, FIXME and OPTIMIZE. +

    + +
    +
    + +
    + + + + +
    + colon[RW] +
    + +
    + +

    +Selected labels can optionally do without the colon. +

    + +
    +
    + +
    + + + + +
    + format[RW] +
    + +
    + +

    +Output format. +

    + +
    +
    + +
    + + + + +
    + template[RW] +
    + +
    + +

    +If custom format, specify template file. +

    + +
    +
    + +
    + + + + +
    + title[RW] +
    + +
    + +

    +Some format put a title at the top of the output. The default is +“Developer’s Notes”. +

    + +
    +
    + +
    + + + + +
    + output[RW] +
    + +
    + +

    +Output to a file instead of STDOUT. +

    + +
    +
    + +
    + + + + +
    + dryrun[RW] +
    + +
    + +

    +If output path given, don’t actually write to disk. +

    + +
    +
    + +
    + + + + +
    +

    Public Class Methods

    + + +
    + + +
    + + main(*argv) + click to toggle source + +
    + +
    + +

    +Commandline interface. +

    + + + +
    +
    +# File lib/dnote/session.rb, line 139
    +    def self.main(*argv)
    +      require 'optparse'
    +
    +      session = Session.new
    +
    +      opts = OptionParser.new do |opt|
    +
    +        opt.banner = "DNote v#{DNote::VERSION}"
    +
    +        opt.separator(" ")
    +        opt.separator("USAGE:\n  dnote [OPTIONS] path1 [path2 ...]")
    +
    +        opt.separator(" ")
    +        opt.separator("OUTPUT FORMAT: (choose one)")
    +
    +        #opt.on("--default", "Plain text format (default)") do
    +        #  session.format = 'label'
    +        #end
    +
    +        #opt.on("--yaml", "YAML serialization format") do
    +        #  session.format = 'yaml'
    +        #end
    +
    +        #opt.on("--json", "JSON serialization format") do
    +        #  session.format = 'json'
    +        #end
    +
    +        #opt.on("--soap", "SOAP XML envelope format") do
    +        #  session.format = 'soap'
    +        #end
    +
    +        #opt.on("--xoxo", "XOXO microformat format") do
    +        #  session.format = 'xoxo'
    +        #end
    +
    +        #opt.on("--xml", "XML markup format") do
    +        #  session.format = 'xml'
    +        #end
    +
    +        #opt.on("--html", "HTML markup format") do
    +        #  session.format = 'html'
    +        #end
    +
    +        #opt.on("--rdoc", "rdoc comment format") do
    +        #  session.format = 'rdoc'
    +        #end
    +
    +        #opt.on("--markdown", "markdown wiki format") do
    +        #  session.format = 'md'
    +        #end
    +
    +        opt.on("--format", "-f NAME", "select a format [text]") do |format|
    +          session.format = format
    +        end
    +
    +        opt.on("--custom", "-c FILE", "use a custom ERB template") do |file|
    +          session.format = 'custom'
    +          session.template = file
    +        end
    +
    +        opt.on("--file", "shortcut for text/file format") do
    +          session.format = 'text/file'
    +        end
    +
    +        opt.on("--list", "shortcut for text/list format") do
    +          session.format = 'text/list'
    +        end
    +
    +        opt.separator(" ")
    +        opt.separator("OTHER OPTIONS:")
    +
    +        opt.on("--label", "-l LABEL", "labels to collect") do |lbl|
    +          session.labels.concat(lbl.split(':'))
    +        end
    +
    +        opt.on("--[no-]colon", "match labels with/without colon suffix") do |val|
    +          session.colon = val
    +        end
    +
    +        opt.on("--exclude", "-x PATH", "exclude file or directory") do |path|
    +          session.exclude << path
    +        end
    +
    +        opt.on("--ignore", "-i NAME", "ignore based on any part of the pathname") do |name|
    +          session.ignore << name
    +        end
    +
    +        opt.on("--title", "-t TITLE", "title to use in header") do |title|
    +          session.title = title
    +        end
    +
    +        opt.on("--output", "-o PATH", "name of file or directory") do |path|
    +          session.output = path
    +        end
    +
    +        opt.on("--dryrun", "-n", "do not actually write to disk") do
    +          session.dryrun = true
    +        end
    +
    +        opt.on("--debug", "debug mode") do
    +          $DEBUG = true
    +          $VERBOSE = true
    +        end
    +
    +        opt.separator(" ")
    +        opt.separator("COMMAND OPTIONS:")
    +
    +        opt.on_tail('--templates', "-T", "list available format templates") do
    +          tdir   = File.join(DIR, 'templates')
    +          tfiles = Dir[File.join(tdir, '**/*.erb')]
    +          tnames = tfiles.map{ |tname| tname.sub(tdir+'/', '').chomp('.erb') }
    +          groups = tnames.group_by{ |tname| tname.split('/').first }
    +          groups.sort.each do |(type, names)|
    +            puts ("%-18s " * names.size) % names.sort
    +          end
    +          exit
    +        end
    +
    +        opt.on_tail('--help', '-h', "show this help information") do
    +          puts opt
    +          exit
    +        end
    +      end
    +
    +      begin
    +        opts.parse!(argv)
    +        session.paths.replace(argv)
    +        session.run
    +      rescue => err
    +        raise err if $DEBUG
    +        puts err
    +        exit 1
    +      end
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + new(options={}) + click to toggle source + +
    + +
    + +

    +New Session. +

    + + + +
    +
    +# File lib/dnote/session.rb, line 59
    +    def initialize(options={})
    +      options ||= {}
    +      initialize_defaults
    +      options.each{ |k,v| __send__("#{k}=", v) }
    +      yield(self) if block_given?
    +    end
    +
    + +
    + + +
    + + +
    + +
    +

    Public Instance Methods

    + + +
    + + +
    + + exclude=(list) + click to toggle source + +
    + +
    + +

    +Set exclude list ensuring that the value is an array. +

    + + + +
    +
    +# File lib/dnote/session.rb, line 80
    +    def exclude=(list)
    +      @exclude = [list].flatten.compact
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + files() + click to toggle source + +
    + +
    + +

    +Collect path globs and remove exclusions. This method uses paths, exclude and ignore to compile the list of files. +

    + + + +
    +
    +# File lib/dnote/session.rb, line 104
    +    def files
    +      list = [paths].flatten.compact
    +      list = ['**/*.rb'] if list.empty?
    +      list = glob(list)
    +      list = list - glob(exclude)
    +      list.reject do |path|
    +        path.split('/').any?{ |part| ignore.any?{ |ig| File.fnmatch?(ig, part) } }
    +      end
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + glob(paths) + click to toggle source + +
    + +
    + +

    +Collect the file glob of each path given. If a path is a directory, inclue +all content. +

    + + + +
    +
    +# File lib/dnote/session.rb, line 116
    +    def glob(paths)
    +      paths.map do |path|
    +        if File.directory?(path)
    +          Dir.glob(File.join(path, '**/*'))
    +        else
    +          Dir.glob(path)
    +        end
    +      end.flatten.uniq
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + ignore=(list) + click to toggle source + +
    + +
    + +

    +Set ignore list ensuring that the value is an array. +

    + + + +
    +
    +# File lib/dnote/session.rb, line 85
    +    def ignore=(list)
    +      @ignore = [list].flatten.compact
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + run() + click to toggle source + +
    + +
    + +

    +Run session. +

    + + + +
    +
    +# File lib/dnote/session.rb, line 90
    +    def run
    +      notes = Notes.new(files, :labels=>labels, :colon=>colon)
    +      formatter = Format.new(notes) do |f|
    +        f.format   = format
    +        f.template = template
    +        f.title    = title
    +        f.output   = output
    +      end
    +      formatter.render
    +    end
    +
    + +
    + + +
    + + +
    + +
    +

    Private Instance Methods

    + + +
    + + +
    + + initialize_defaults() + click to toggle source + +
    + +
    + +

    +Set default values for attributes. +

    + + + +
    +
    +# File lib/dnote/session.rb, line 67
    +    def initialize_defaults
    +      @paths   = []
    +      @labels  = []
    +      @exclude = []
    +      @ignore  = []
    +      @format  = DEFAULT_FORMAT
    +      @title   = DEFAULT_TITLE
    +      @dryrun  = false
    +    end
    +
    + +
    + + +
    + + +
    + + +
    + + +
    + +

    Disabled; run with --debug to generate this.

    + +
    + + + + + diff --git a/rdoc/classes/String.html b/rdoc/classes/String.html index ceb8a37..0e808a1 100644 --- a/rdoc/classes/String.html +++ b/rdoc/classes/String.html @@ -126,9 +126,11 @@

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • diff --git a/rdoc/classes/Syckle.html b/rdoc/classes/Syckle.html index 3f53e31..58a0394 100644 --- a/rdoc/classes/Syckle.html +++ b/rdoc/classes/Syckle.html @@ -123,9 +123,11 @@

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • diff --git a/rdoc/classes/Syckle/Plugins.html b/rdoc/classes/Syckle/Plugins.html index 08b7cbd..6986c7b 100644 --- a/rdoc/classes/Syckle/Plugins.html +++ b/rdoc/classes/Syckle/Plugins.html @@ -126,9 +126,11 @@

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • diff --git a/rdoc/classes/Syckle/Plugins/DNote.html b/rdoc/classes/Syckle/Plugins/DNote.html index 9ba8993..7d4dbbb 100644 --- a/rdoc/classes/Syckle/Plugins/DNote.html +++ b/rdoc/classes/Syckle/Plugins/DNote.html @@ -90,27 +90,27 @@

    Methods

  • - #clean + #clean
  • - #document + #document
  • - #initialize_defaults + #initialize_defaults
  • - #output= + #output=
  • - #reset + #reset
  • @@ -158,9 +158,11 @@

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • @@ -211,6 +213,20 @@

    Developmer’s Notes Plugin

    +
    +

    Constants

    +
    + +
    DEFAULT_LABELS
    + +

    +Default note labels to looked for in source code. +

    + + +
    +
    + @@ -231,7 +247,7 @@

    Attributes

    -Paths to search. +File paths to search.

    @@ -256,6 +272,44 @@

    Attributes

    +
    + + + + +
    + exclude[RW] +
    + +
    + +

    +Exclude paths. +

    + +
    +
    + +
    + + + + +
    + ignore[RW] +
    + +
    + +

    +Ignore paths based on any part of pathname. +

    + +
    +
    +
    @@ -324,7 +378,7 @@

    Public Instance Methods

    - +
    @@ -345,7 +399,7 @@

    Public Instance Methods

    -# File lib/plugins/syckle/dnote.rb, line 97
    +# File lib/plugins/syckle/dnote.rb, line 124
         def clean
           if File.directory?(output)
             formats.each do |format|
    @@ -365,7 +419,7 @@ 

    Public Instance Methods

    - +
    @@ -386,18 +440,39 @@

    Public Instance Methods

    -# File lib/plugins/syckle/dnote.rb, line 75
    +# File lib/plugins/syckle/dnote.rb, line 81
         def document
    -      notes = ::DNote::Notes.new(files, labels)
    -      [formats].flatten.each do |format|
    +      session = ::DNote::Session.new do |s|
    +        s.paths   = files
    +        s.exclude = exclude
    +        s.ignore  = ignore
    +        s.labels  = labels #|| DEFAULT_LABELS   
    +        s.title   = title
    +        s.output  = output
    +        s.dryrun  = trial?
    +      end
    +      formats.each do |format|
             if format == 'index'
    -          format = 'html'
    -          output = File.join(self.output, 'index.html')
    +          session.format = 'html'
    +          session.output = File.join(self.output, 'index.html')
    +        else
    +          session.format = format
             end
    -        format = ::DNote::Format.new(notes, :format=>format, :output=>output.to_s, :title=>title, :dryrun=>trial?)
    -        format.render
    +        session.run
             report "Updated #{output.to_s.sub(Dir.pwd+'/','')}" unless trial?
           end
    +
    +      #files = files.map{ |f| Dir[f] }.flatten
    +      #notes = ::DNote::Notes.new(files, :labels=>labels)
    +      #[formats].flatten.each do |format|
    +      #  if format == 'index'
    +      #    format = 'html'
    +      #    output = File.join(self.output, 'index.html')
    +      #  end
    +      #  format = ::DNote::Format.new(notes, :format=>format, :output=>output.to_s, :title=>title, :dryrun=>trial?)
    +      #  format.render
    +      #  report "Updated #{output.to_s.sub(Dir.pwd+'/','')}" unless trial?
    +      #end
         end
    @@ -408,7 +483,7 @@

    Public Instance Methods

    - +
    @@ -427,7 +502,7 @@

    Public Instance Methods

    -# File lib/plugins/syckle/dnote.rb, line 62
    +# File lib/plugins/syckle/dnote.rb, line 68
         def output=(path)
           @output = Pathname.new(path)
         end
    @@ -440,7 +515,7 @@

    Public Instance Methods

    - +
    @@ -461,7 +536,7 @@

    Public Instance Methods

    -# File lib/plugins/syckle/dnote.rb, line 89
    +# File lib/plugins/syckle/dnote.rb, line 116
         def reset
           if File.directory?(output)
             File.utime(0,0,output) unless $NOOP
    @@ -483,7 +558,7 @@ 

    Private Instance Methods

    - +
    @@ -502,7 +577,7 @@

    Private Instance Methods

    -# File lib/plugins/syckle/dnote.rb, line 111
    +# File lib/plugins/syckle/dnote.rb, line 138
         def initialize_defaults
           @files   = "**/*.rb"
           @output  = project.log + 'dnote'
    diff --git a/rdoc/classes/Xacto.html b/rdoc/classes/Xacto.html
    index 8a4271b..4bf4b1a 100644
    --- a/rdoc/classes/Xacto.html
    +++ b/rdoc/classes/Xacto.html
    @@ -135,9 +135,11 @@ 

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • diff --git a/rdoc/classes/Xacto/String.html b/rdoc/classes/Xacto/String.html index 39de2bd..acff433 100644 --- a/rdoc/classes/Xacto/String.html +++ b/rdoc/classes/Xacto/String.html @@ -86,12 +86,12 @@

    Methods

  • - #margin + #margin
  • - #tabto + #tabto
  • @@ -139,9 +139,11 @@

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • @@ -238,7 +240,7 @@

    Public Instance Methods

    - +
    @@ -292,7 +294,7 @@

    Public Instance Methods

    - +
    diff --git a/rdoc/created.rid b/rdoc/created.rid index 3745bf0..b6bb81d 100644 --- a/rdoc/created.rid +++ b/rdoc/created.rid @@ -1 +1 @@ -Thu, 11 Feb 2010 21:22:08 -0500 +Thu, 18 Feb 2010 11:54:11 -0500 diff --git a/rdoc/files/LICENSE.html b/rdoc/files/LICENSE.html index 8a35fd0..7668edc 100644 --- a/rdoc/files/LICENSE.html +++ b/rdoc/files/LICENSE.html @@ -90,9 +90,11 @@

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • @@ -115,350 +117,338 @@

    Method Index

  • - DNote::Site - ::new + DNote::Session + ::main
  • - DNote::Format - ::new + DNote::Format::ErbScope + ::new
  • - DNote::Format::ErbScope - ::new + DNote::Note + ::new +
  • + + +
  • + DNote::Format + ::new
  • DNote::Notes - ::new + ::new
  • - DNote - ::run + DNote::Session + ::new
  • - DNote - #__DIR__ + DNote::Note + #<=>
  • - Syckle::Plugins::DNote - #clean + DNote::Notes + #by_file
  • - DNote::Site - #clean + DNote::Notes + #by_file_label
  • DNote::Notes - #counts + #by_label
  • - DNote::Format - #debug? + DNote::Notes + #by_label_file
  • Syckle::Plugins::DNote - #document + #clean
  • - DNote::Site - #document + DNote::Notes + #counts
  • DNote::Format - #dryrun? + #debug?
  • - DNote::Notes - #each + Syckle::Plugins::DNote + #document
  • - DNote::Notes - #empty? + DNote::Format + #dryrun?
  • - DNote::Format - #erb + DNote::Notes + #each
  • DNote::Notes - #files + #empty?
  • DNote::Format - #fu + #erb
  • - DNote - #fu + DNote::Session + #exclude=
  • - DNote::Format::ErbScope - #h + DNote::Session + #files
  • - Xacto::String - #indent + DNote::Format + #fu
  • - Syckle::Plugins::DNote - #initialize_defaults + DNote::Session + #glob
  • - DNote::Site - #initialize_defaults + DNote::Format::ErbScope + #h
  • - DNote::Notes - #labels= + DNote::Session + #ignore=
  • Xacto::String - #margin + #indent
  • - DNote::Notes - #match_arbitrary + DNote::Session + #initialize_defaults
  • - DNote::Notes - #match_common + Syckle::Plugins::DNote + #initialize_defaults
  • - DNote::Format::ErbScope - #method_missing + Xacto::String + #margin
  • DNote::Notes - #notes + #match
  • DNote::Notes - #organize + #match_general
  • - DNote::Site - #output= -
  • - - -
  • - Syckle::Plugins::DNote - #output= + DNote::Notes + #match_general_regex
  • DNote::Notes - #parse + #match_special
  • - DNote::Format - #publish + DNote::Notes + #match_special_regex
  • DNote::Format::ErbScope - #render -
  • - - -
  • - DNote::Format - #render + #method_missing
  • - DNote::Format - #render_custom -
  • - - -
  • - DNote::Format - #render_gnu + DNote::Notes + #notes
  • - DNote::Format - #render_html + Syckle::Plugins::DNote + #output=
  • - DNote::Format - #render_index + DNote::Notes + #parse
  • DNote::Format - #render_json + #publish
  • DNote::Format - #render_markdown + #render
  • - DNote::Format - #render_rdoc + DNote::Format::ErbScope + #render
  • DNote::Format - #render_soap + #render_custom
  • DNote::Format - #render_xml + #render_template
  • - DNote::Format - #render_xoxo + Syckle::Plugins::DNote + #reset
  • - DNote::Format - #render_yaml + DNote::Session + #run
  • - Syckle::Plugins::DNote - #reset + Xacto::String + #tabto
  • - DNote::Site - #reset + DNote::Note + #textline
  • - Xacto::String - #tabto + DNote::Notes + #to_a
  • - DNote - #templates + DNote::Note + #to_h
  • DNote::Notes - #to + #to_h
  • - DNote::Notes - #to_json + DNote::Note + #to_h_raw
  • - DNote::Notes - #to_soap + DNote::Note + #to_json
  • - DNote::Notes - #to_xoxo + DNote::Note + #to_s
  • - DNote::Notes - #to_yaml + DNote::Note + #to_str
  • - DNote - #write + DNote::Note + #to_yaml
  • DNote::Format - #write + #write
  • diff --git a/rdoc/files/README_rdoc.html b/rdoc/files/README_rdoc.html index abf69d6..2505041 100644 --- a/rdoc/files/README_rdoc.html +++ b/rdoc/files/README_rdoc.html @@ -90,9 +90,11 @@

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • @@ -115,350 +117,338 @@

    Method Index

  • - DNote::Site - ::new + DNote::Session + ::main
  • - DNote::Format - ::new + DNote::Format::ErbScope + ::new
  • - DNote::Format::ErbScope - ::new + DNote::Note + ::new +
  • + + +
  • + DNote::Format + ::new
  • DNote::Notes - ::new + ::new
  • - DNote - ::run + DNote::Session + ::new
  • - DNote - #__DIR__ + DNote::Note + #<=>
  • - Syckle::Plugins::DNote - #clean + DNote::Notes + #by_file
  • - DNote::Site - #clean + DNote::Notes + #by_file_label
  • DNote::Notes - #counts + #by_label
  • - DNote::Format - #debug? + DNote::Notes + #by_label_file
  • Syckle::Plugins::DNote - #document + #clean
  • - DNote::Site - #document + DNote::Notes + #counts
  • DNote::Format - #dryrun? + #debug?
  • - DNote::Notes - #each + Syckle::Plugins::DNote + #document
  • - DNote::Notes - #empty? + DNote::Format + #dryrun?
  • - DNote::Format - #erb + DNote::Notes + #each
  • DNote::Notes - #files + #empty?
  • DNote::Format - #fu + #erb
  • - DNote - #fu + DNote::Session + #exclude=
  • - DNote::Format::ErbScope - #h + DNote::Session + #files
  • - Xacto::String - #indent + DNote::Format + #fu
  • - Syckle::Plugins::DNote - #initialize_defaults + DNote::Session + #glob
  • - DNote::Site - #initialize_defaults + DNote::Format::ErbScope + #h
  • - DNote::Notes - #labels= + DNote::Session + #ignore=
  • Xacto::String - #margin + #indent
  • - DNote::Notes - #match_arbitrary + DNote::Session + #initialize_defaults
  • - DNote::Notes - #match_common + Syckle::Plugins::DNote + #initialize_defaults
  • - DNote::Format::ErbScope - #method_missing + Xacto::String + #margin
  • DNote::Notes - #notes + #match
  • DNote::Notes - #organize + #match_general
  • - DNote::Site - #output= -
  • - - -
  • - Syckle::Plugins::DNote - #output= + DNote::Notes + #match_general_regex
  • DNote::Notes - #parse + #match_special
  • - DNote::Format - #publish + DNote::Notes + #match_special_regex
  • DNote::Format::ErbScope - #render -
  • - - -
  • - DNote::Format - #render + #method_missing
  • - DNote::Format - #render_custom -
  • - - -
  • - DNote::Format - #render_gnu + DNote::Notes + #notes
  • - DNote::Format - #render_html + Syckle::Plugins::DNote + #output=
  • - DNote::Format - #render_index + DNote::Notes + #parse
  • DNote::Format - #render_json + #publish
  • DNote::Format - #render_markdown + #render
  • - DNote::Format - #render_rdoc + DNote::Format::ErbScope + #render
  • DNote::Format - #render_soap + #render_custom
  • DNote::Format - #render_xml + #render_template
  • - DNote::Format - #render_xoxo + Syckle::Plugins::DNote + #reset
  • - DNote::Format - #render_yaml + DNote::Session + #run
  • - Syckle::Plugins::DNote - #reset + Xacto::String + #tabto
  • - DNote::Site - #reset + DNote::Note + #textline
  • - Xacto::String - #tabto + DNote::Notes + #to_a
  • - DNote - #templates + DNote::Note + #to_h
  • DNote::Notes - #to + #to_h
  • - DNote::Notes - #to_json + DNote::Note + #to_h_raw
  • - DNote::Notes - #to_soap + DNote::Note + #to_json
  • - DNote::Notes - #to_xoxo + DNote::Note + #to_s
  • - DNote::Notes - #to_yaml + DNote::Note + #to_str
  • - DNote - #write + DNote::Note + #to_yaml
  • DNote::Format - #write + #write
  • diff --git a/rdoc/files/lib/dnote/format_rb.html b/rdoc/files/lib/dnote/format_rb.html index a978f62..0994483 100644 --- a/rdoc/files/lib/dnote/format_rb.html +++ b/rdoc/files/lib/dnote/format_rb.html @@ -46,7 +46,7 @@

    File Stats

    Last Modified
    -
    Sun Feb 07 11:17:26 -0500 2010
    +
    Thu Feb 18 08:13:30 -0500 2010
    Requires
    @@ -105,9 +105,11 @@

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • @@ -130,350 +132,338 @@

    Method Index

  • - DNote::Site - ::new + DNote::Session + ::main
  • - DNote::Format - ::new + DNote::Format::ErbScope + ::new
  • - DNote::Format::ErbScope - ::new + DNote::Note + ::new +
  • + + +
  • + DNote::Format + ::new
  • DNote::Notes - ::new + ::new
  • - DNote - ::run + DNote::Session + ::new
  • - DNote - #__DIR__ + DNote::Note + #<=>
  • - Syckle::Plugins::DNote - #clean + DNote::Notes + #by_file
  • - DNote::Site - #clean + DNote::Notes + #by_file_label
  • DNote::Notes - #counts + #by_label
  • - DNote::Format - #debug? + DNote::Notes + #by_label_file
  • Syckle::Plugins::DNote - #document + #clean
  • - DNote::Site - #document + DNote::Notes + #counts
  • DNote::Format - #dryrun? + #debug?
  • - DNote::Notes - #each + Syckle::Plugins::DNote + #document
  • - DNote::Notes - #empty? + DNote::Format + #dryrun?
  • - DNote::Format - #erb + DNote::Notes + #each
  • DNote::Notes - #files + #empty?
  • DNote::Format - #fu + #erb
  • - DNote - #fu + DNote::Session + #exclude=
  • - DNote::Format::ErbScope - #h + DNote::Session + #files
  • - Xacto::String - #indent + DNote::Format + #fu
  • - Syckle::Plugins::DNote - #initialize_defaults + DNote::Session + #glob
  • - DNote::Site - #initialize_defaults + DNote::Format::ErbScope + #h
  • - DNote::Notes - #labels= + DNote::Session + #ignore=
  • Xacto::String - #margin + #indent
  • - DNote::Notes - #match_arbitrary + DNote::Session + #initialize_defaults
  • - DNote::Notes - #match_common + Syckle::Plugins::DNote + #initialize_defaults
  • - DNote::Format::ErbScope - #method_missing + Xacto::String + #margin
  • DNote::Notes - #notes + #match
  • DNote::Notes - #organize + #match_general
  • - DNote::Site - #output= -
  • - - -
  • - Syckle::Plugins::DNote - #output= + DNote::Notes + #match_general_regex
  • DNote::Notes - #parse + #match_special
  • - DNote::Format - #publish + DNote::Notes + #match_special_regex
  • DNote::Format::ErbScope - #render -
  • - - -
  • - DNote::Format - #render + #method_missing
  • - DNote::Format - #render_custom -
  • - - -
  • - DNote::Format - #render_gnu + DNote::Notes + #notes
  • - DNote::Format - #render_html + Syckle::Plugins::DNote + #output=
  • - DNote::Format - #render_index + DNote::Notes + #parse
  • DNote::Format - #render_json + #publish
  • DNote::Format - #render_markdown + #render
  • - DNote::Format - #render_rdoc + DNote::Format::ErbScope + #render
  • DNote::Format - #render_soap + #render_custom
  • DNote::Format - #render_xml + #render_template
  • - DNote::Format - #render_xoxo + Syckle::Plugins::DNote + #reset
  • - DNote::Format - #render_yaml + DNote::Session + #run
  • - Syckle::Plugins::DNote - #reset + Xacto::String + #tabto
  • - DNote::Site - #reset + DNote::Note + #textline
  • - Xacto::String - #tabto + DNote::Notes + #to_a
  • - DNote - #templates + DNote::Note + #to_h
  • DNote::Notes - #to + #to_h
  • - DNote::Notes - #to_json + DNote::Note + #to_h_raw
  • - DNote::Notes - #to_soap + DNote::Note + #to_json
  • - DNote::Notes - #to_xoxo + DNote::Note + #to_s
  • - DNote::Notes - #to_yaml + DNote::Note + #to_str
  • - DNote - #write + DNote::Note + #to_yaml
  • DNote::Format - #write + #write
  • diff --git a/rdoc/files/lib/dnote/command_rb.html b/rdoc/files/lib/dnote/note_rb.html similarity index 70% rename from rdoc/files/lib/dnote/command_rb.html rename to rdoc/files/lib/dnote/note_rb.html index 35fe002..1c016e6 100644 --- a/rdoc/files/lib/dnote/command_rb.html +++ b/rdoc/files/lib/dnote/note_rb.html @@ -5,7 +5,7 @@ - File: command.rb [D'Note] + File: note.rb [D'Note] @@ -37,7 +37,7 @@

      D'Note  - command.rb + note.rb

    @@ -46,20 +46,9 @@

    File Stats

    Last Modified
    -
    Sun Feb 07 13:12:57 -0500 2010
    +
    Thu Feb 18 07:32:04 -0500 2010
    -
    Requires
    -
    -
      - -
    • optparse
    • - -
    • dnote
    • - -
    -
    -
    @@ -101,9 +90,11 @@

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • @@ -126,350 +117,338 @@

    Method Index

  • - DNote::Site - ::new + DNote::Session + ::main
  • - DNote::Format - ::new + DNote::Format::ErbScope + ::new
  • - DNote::Format::ErbScope - ::new + DNote::Note + ::new +
  • + + +
  • + DNote::Format + ::new
  • DNote::Notes - ::new + ::new
  • - DNote - ::run + DNote::Session + ::new
  • - DNote - #__DIR__ + DNote::Note + #<=>
  • - Syckle::Plugins::DNote - #clean + DNote::Notes + #by_file
  • - DNote::Site - #clean + DNote::Notes + #by_file_label
  • DNote::Notes - #counts + #by_label
  • - DNote::Format - #debug? + DNote::Notes + #by_label_file
  • Syckle::Plugins::DNote - #document + #clean
  • - DNote::Site - #document + DNote::Notes + #counts
  • DNote::Format - #dryrun? + #debug?
  • - DNote::Notes - #each + Syckle::Plugins::DNote + #document
  • - DNote::Notes - #empty? + DNote::Format + #dryrun?
  • - DNote::Format - #erb + DNote::Notes + #each
  • DNote::Notes - #files + #empty?
  • DNote::Format - #fu + #erb
  • - DNote - #fu + DNote::Session + #exclude=
  • - DNote::Format::ErbScope - #h + DNote::Session + #files
  • - Xacto::String - #indent + DNote::Format + #fu
  • - Syckle::Plugins::DNote - #initialize_defaults + DNote::Session + #glob
  • - DNote::Site - #initialize_defaults + DNote::Format::ErbScope + #h
  • - DNote::Notes - #labels= + DNote::Session + #ignore=
  • Xacto::String - #margin + #indent
  • - DNote::Notes - #match_arbitrary + DNote::Session + #initialize_defaults
  • - DNote::Notes - #match_common + Syckle::Plugins::DNote + #initialize_defaults
  • - DNote::Format::ErbScope - #method_missing + Xacto::String + #margin
  • DNote::Notes - #notes + #match
  • DNote::Notes - #organize + #match_general
  • - DNote::Site - #output= -
  • - - -
  • - Syckle::Plugins::DNote - #output= + DNote::Notes + #match_general_regex
  • DNote::Notes - #parse + #match_special
  • - DNote::Format - #publish + DNote::Notes + #match_special_regex
  • DNote::Format::ErbScope - #render + #method_missing
  • - DNote::Format - #render -
  • - - -
  • - DNote::Format - #render_custom -
  • - - -
  • - DNote::Format - #render_gnu + DNote::Notes + #notes
  • - DNote::Format - #render_html + Syckle::Plugins::DNote + #output=
  • - DNote::Format - #render_index + DNote::Notes + #parse
  • DNote::Format - #render_json + #publish
  • DNote::Format - #render_markdown + #render
  • - DNote::Format - #render_rdoc + DNote::Format::ErbScope + #render
  • DNote::Format - #render_soap + #render_custom
  • DNote::Format - #render_xml + #render_template
  • - DNote::Format - #render_xoxo + Syckle::Plugins::DNote + #reset
  • - DNote::Format - #render_yaml + DNote::Session + #run
  • - Syckle::Plugins::DNote - #reset + Xacto::String + #tabto
  • - DNote::Site - #reset + DNote::Note + #textline
  • - Xacto::String - #tabto + DNote::Notes + #to_a
  • - DNote - #templates + DNote::Note + #to_h
  • DNote::Notes - #to + #to_h
  • - DNote::Notes - #to_json + DNote::Note + #to_h_raw
  • - DNote::Notes - #to_soap + DNote::Note + #to_json
  • - DNote::Notes - #to_xoxo + DNote::Note + #to_s
  • - DNote::Notes - #to_yaml + DNote::Note + #to_str
  • - DNote - #write + DNote::Note + #to_yaml
  • DNote::Format - #write + #write
  • diff --git a/rdoc/files/lib/dnote/notes_rb.html b/rdoc/files/lib/dnote/notes_rb.html index a532341..531591c 100644 --- a/rdoc/files/lib/dnote/notes_rb.html +++ b/rdoc/files/lib/dnote/notes_rb.html @@ -46,7 +46,7 @@

    File Stats

    Last Modified
    -
    Sun Feb 07 17:06:26 -0500 2010
    +
    Thu Feb 18 10:25:48 -0500 2010
    Requires
    @@ -55,15 +55,7 @@

    File Stats

  • pathname
  • -
  • yaml
  • - -
  • json
  • - -
  • json_pure
  • - -
  • soap/marshal
  • - -
  • xoxo
  • +
  • dnote/note
  • @@ -109,9 +101,11 @@

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • @@ -134,350 +128,338 @@

    Method Index

  • - DNote::Site - ::new + DNote::Session + ::main
  • - DNote::Format - ::new + DNote::Format::ErbScope + ::new
  • - DNote::Format::ErbScope - ::new + DNote::Note + ::new +
  • + + +
  • + DNote::Format + ::new
  • DNote::Notes - ::new + ::new
  • - DNote - ::run + DNote::Session + ::new
  • - DNote - #__DIR__ + DNote::Note + #<=>
  • - Syckle::Plugins::DNote - #clean + DNote::Notes + #by_file
  • - DNote::Site - #clean + DNote::Notes + #by_file_label
  • DNote::Notes - #counts + #by_label
  • - DNote::Format - #debug? + DNote::Notes + #by_label_file
  • Syckle::Plugins::DNote - #document + #clean
  • - DNote::Site - #document + DNote::Notes + #counts
  • DNote::Format - #dryrun? + #debug?
  • - DNote::Notes - #each + Syckle::Plugins::DNote + #document
  • - DNote::Notes - #empty? + DNote::Format + #dryrun?
  • - DNote::Format - #erb + DNote::Notes + #each
  • DNote::Notes - #files + #empty?
  • DNote::Format - #fu + #erb
  • - DNote - #fu + DNote::Session + #exclude=
  • - DNote::Format::ErbScope - #h + DNote::Session + #files
  • - Xacto::String - #indent + DNote::Format + #fu
  • - Syckle::Plugins::DNote - #initialize_defaults + DNote::Session + #glob
  • - DNote::Site - #initialize_defaults + DNote::Format::ErbScope + #h
  • - DNote::Notes - #labels= + DNote::Session + #ignore=
  • Xacto::String - #margin + #indent
  • - DNote::Notes - #match_arbitrary + DNote::Session + #initialize_defaults
  • - DNote::Notes - #match_common + Syckle::Plugins::DNote + #initialize_defaults
  • - DNote::Format::ErbScope - #method_missing + Xacto::String + #margin
  • DNote::Notes - #notes + #match
  • DNote::Notes - #organize + #match_general
  • - DNote::Site - #output= -
  • - - -
  • - Syckle::Plugins::DNote - #output= + DNote::Notes + #match_general_regex
  • DNote::Notes - #parse + #match_special
  • - DNote::Format - #publish + DNote::Notes + #match_special_regex
  • DNote::Format::ErbScope - #render + #method_missing
  • - DNote::Format - #render -
  • - - -
  • - DNote::Format - #render_custom -
  • - - -
  • - DNote::Format - #render_gnu + DNote::Notes + #notes
  • - DNote::Format - #render_html + Syckle::Plugins::DNote + #output=
  • - DNote::Format - #render_index + DNote::Notes + #parse
  • DNote::Format - #render_json + #publish
  • DNote::Format - #render_markdown + #render
  • - DNote::Format - #render_rdoc + DNote::Format::ErbScope + #render
  • DNote::Format - #render_soap + #render_custom
  • DNote::Format - #render_xml + #render_template
  • - DNote::Format - #render_xoxo + Syckle::Plugins::DNote + #reset
  • - DNote::Format - #render_yaml + DNote::Session + #run
  • - Syckle::Plugins::DNote - #reset + Xacto::String + #tabto
  • - DNote::Site - #reset + DNote::Note + #textline
  • - Xacto::String - #tabto + DNote::Notes + #to_a
  • - DNote - #templates + DNote::Note + #to_h
  • DNote::Notes - #to + #to_h
  • - DNote::Notes - #to_json + DNote::Note + #to_h_raw
  • - DNote::Notes - #to_soap + DNote::Note + #to_json
  • - DNote::Notes - #to_xoxo + DNote::Note + #to_s
  • - DNote::Notes - #to_yaml + DNote::Note + #to_str
  • - DNote - #write + DNote::Note + #to_yaml
  • DNote::Format - #write + #write
  • diff --git a/rdoc/files/lib/dnote/site_rb.html b/rdoc/files/lib/dnote/session_rb.html similarity index 71% rename from rdoc/files/lib/dnote/site_rb.html rename to rdoc/files/lib/dnote/session_rb.html index ea9ba62..bdc776b 100644 --- a/rdoc/files/lib/dnote/site_rb.html +++ b/rdoc/files/lib/dnote/session_rb.html @@ -5,7 +5,7 @@ - File: site.rb [D'Note] + File: session.rb [D'Note] @@ -37,7 +37,7 @@

      D'Note  - site.rb + session.rb

    @@ -46,7 +46,7 @@

    File Stats

    Last Modified
    -
    Sat Feb 06 00:55:22 -0500 2010
    +
    Thu Feb 18 11:43:54 -0500 2010
    Requires
    @@ -55,6 +55,10 @@

    File Stats

  • dnote/notes
  • +
  • dnote/format
  • + +
  • optparse
  • + @@ -99,9 +103,11 @@

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • @@ -124,350 +130,338 @@

    Method Index

  • - DNote::Site - ::new + DNote::Session + ::main
  • - DNote::Format - ::new + DNote::Format::ErbScope + ::new
  • - DNote::Format::ErbScope - ::new + DNote::Note + ::new +
  • + + +
  • + DNote::Format + ::new
  • DNote::Notes - ::new + ::new
  • - DNote - ::run + DNote::Session + ::new
  • - DNote - #__DIR__ + DNote::Note + #<=>
  • - Syckle::Plugins::DNote - #clean + DNote::Notes + #by_file
  • - DNote::Site - #clean + DNote::Notes + #by_file_label
  • DNote::Notes - #counts + #by_label
  • - DNote::Format - #debug? + DNote::Notes + #by_label_file
  • Syckle::Plugins::DNote - #document + #clean
  • - DNote::Site - #document + DNote::Notes + #counts
  • DNote::Format - #dryrun? + #debug?
  • - DNote::Notes - #each + Syckle::Plugins::DNote + #document
  • - DNote::Notes - #empty? + DNote::Format + #dryrun?
  • - DNote::Format - #erb + DNote::Notes + #each
  • DNote::Notes - #files + #empty?
  • DNote::Format - #fu + #erb
  • - DNote - #fu + DNote::Session + #exclude=
  • - DNote::Format::ErbScope - #h + DNote::Session + #files
  • - Xacto::String - #indent + DNote::Format + #fu
  • - Syckle::Plugins::DNote - #initialize_defaults + DNote::Session + #glob
  • - DNote::Site - #initialize_defaults + DNote::Format::ErbScope + #h
  • - DNote::Notes - #labels= + DNote::Session + #ignore=
  • Xacto::String - #margin + #indent
  • - DNote::Notes - #match_arbitrary + DNote::Session + #initialize_defaults
  • - DNote::Notes - #match_common + Syckle::Plugins::DNote + #initialize_defaults
  • - DNote::Format::ErbScope - #method_missing + Xacto::String + #margin
  • DNote::Notes - #notes + #match
  • DNote::Notes - #organize + #match_general
  • - DNote::Site - #output= -
  • - - -
  • - Syckle::Plugins::DNote - #output= + DNote::Notes + #match_general_regex
  • DNote::Notes - #parse + #match_special
  • - DNote::Format - #publish + DNote::Notes + #match_special_regex
  • DNote::Format::ErbScope - #render -
  • - - -
  • - DNote::Format - #render + #method_missing
  • - DNote::Format - #render_custom -
  • - - -
  • - DNote::Format - #render_gnu + DNote::Notes + #notes
  • - DNote::Format - #render_html + Syckle::Plugins::DNote + #output=
  • - DNote::Format - #render_index + DNote::Notes + #parse
  • DNote::Format - #render_json + #publish
  • DNote::Format - #render_markdown + #render
  • - DNote::Format - #render_rdoc + DNote::Format::ErbScope + #render
  • DNote::Format - #render_soap + #render_custom
  • DNote::Format - #render_xml + #render_template
  • - DNote::Format - #render_xoxo + Syckle::Plugins::DNote + #reset
  • - DNote::Format - #render_yaml + DNote::Session + #run
  • - Syckle::Plugins::DNote - #reset + Xacto::String + #tabto
  • - DNote::Site - #reset + DNote::Note + #textline
  • - Xacto::String - #tabto + DNote::Notes + #to_a
  • - DNote - #templates + DNote::Note + #to_h
  • DNote::Notes - #to + #to_h
  • - DNote::Notes - #to_json + DNote::Note + #to_h_raw
  • - DNote::Notes - #to_soap + DNote::Note + #to_json
  • - DNote::Notes - #to_xoxo + DNote::Note + #to_s
  • - DNote::Notes - #to_yaml + DNote::Note + #to_str
  • - DNote - #write + DNote::Note + #to_yaml
  • DNote::Format - #write + #write
  • diff --git a/rdoc/files/lib/dnote/string_rb.html b/rdoc/files/lib/dnote/string_rb.html index 423fe37..dc9ec8c 100644 --- a/rdoc/files/lib/dnote/string_rb.html +++ b/rdoc/files/lib/dnote/string_rb.html @@ -90,9 +90,11 @@

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • @@ -115,350 +117,338 @@

    Method Index

  • - DNote::Site - ::new + DNote::Session + ::main
  • - DNote::Format - ::new + DNote::Format::ErbScope + ::new
  • - DNote::Format::ErbScope - ::new + DNote::Note + ::new +
  • + + +
  • + DNote::Format + ::new
  • DNote::Notes - ::new + ::new
  • - DNote - ::run + DNote::Session + ::new
  • - DNote - #__DIR__ + DNote::Note + #<=>
  • - Syckle::Plugins::DNote - #clean + DNote::Notes + #by_file
  • - DNote::Site - #clean + DNote::Notes + #by_file_label
  • DNote::Notes - #counts + #by_label
  • - DNote::Format - #debug? + DNote::Notes + #by_label_file
  • Syckle::Plugins::DNote - #document + #clean
  • - DNote::Site - #document + DNote::Notes + #counts
  • DNote::Format - #dryrun? + #debug?
  • - DNote::Notes - #each + Syckle::Plugins::DNote + #document
  • - DNote::Notes - #empty? + DNote::Format + #dryrun?
  • - DNote::Format - #erb + DNote::Notes + #each
  • DNote::Notes - #files + #empty?
  • DNote::Format - #fu + #erb
  • - DNote - #fu + DNote::Session + #exclude=
  • - DNote::Format::ErbScope - #h + DNote::Session + #files
  • - Xacto::String - #indent + DNote::Format + #fu
  • - Syckle::Plugins::DNote - #initialize_defaults + DNote::Session + #glob
  • - DNote::Site - #initialize_defaults + DNote::Format::ErbScope + #h
  • - DNote::Notes - #labels= + DNote::Session + #ignore=
  • Xacto::String - #margin + #indent
  • - DNote::Notes - #match_arbitrary + DNote::Session + #initialize_defaults
  • - DNote::Notes - #match_common + Syckle::Plugins::DNote + #initialize_defaults
  • - DNote::Format::ErbScope - #method_missing + Xacto::String + #margin
  • DNote::Notes - #notes + #match
  • DNote::Notes - #organize + #match_general
  • - DNote::Site - #output= -
  • - - -
  • - Syckle::Plugins::DNote - #output= + DNote::Notes + #match_general_regex
  • DNote::Notes - #parse + #match_special
  • - DNote::Format - #publish + DNote::Notes + #match_special_regex
  • DNote::Format::ErbScope - #render -
  • - - -
  • - DNote::Format - #render + #method_missing
  • - DNote::Format - #render_custom -
  • - - -
  • - DNote::Format - #render_gnu + DNote::Notes + #notes
  • - DNote::Format - #render_html + Syckle::Plugins::DNote + #output=
  • - DNote::Format - #render_index + DNote::Notes + #parse
  • DNote::Format - #render_json + #publish
  • DNote::Format - #render_markdown + #render
  • - DNote::Format - #render_rdoc + DNote::Format::ErbScope + #render
  • DNote::Format - #render_soap + #render_custom
  • DNote::Format - #render_xml + #render_template
  • - DNote::Format - #render_xoxo + Syckle::Plugins::DNote + #reset
  • - DNote::Format - #render_yaml + DNote::Session + #run
  • - Syckle::Plugins::DNote - #reset + Xacto::String + #tabto
  • - DNote::Site - #reset + DNote::Note + #textline
  • - Xacto::String - #tabto + DNote::Notes + #to_a
  • - DNote - #templates + DNote::Note + #to_h
  • DNote::Notes - #to + #to_h
  • - DNote::Notes - #to_json + DNote::Note + #to_h_raw
  • - DNote::Notes - #to_soap + DNote::Note + #to_json
  • - DNote::Notes - #to_xoxo + DNote::Note + #to_s
  • - DNote::Notes - #to_yaml + DNote::Note + #to_str
  • - DNote - #write + DNote::Note + #to_yaml
  • DNote::Format - #write + #write
  • diff --git a/rdoc/files/lib/dnote_rb.html b/rdoc/files/lib/dnote_rb.html index 6e35e1f..9d94fe3 100644 --- a/rdoc/files/lib/dnote_rb.html +++ b/rdoc/files/lib/dnote_rb.html @@ -46,16 +46,14 @@

    File Stats

    Last Modified
    -
    Sun Feb 07 13:13:12 -0500 2010
    +
    Tue Feb 16 18:06:30 -0500 2010
    Requires
      -
    • dnote/notes
    • - -
    • dnote/format
    • +
    • dnote/session
    @@ -101,9 +99,11 @@

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • @@ -126,350 +126,338 @@

    Method Index

  • - DNote::Site - ::new + DNote::Session + ::main
  • - DNote::Format - ::new + DNote::Format::ErbScope + ::new
  • - DNote::Format::ErbScope - ::new + DNote::Note + ::new +
  • + + +
  • + DNote::Format + ::new
  • DNote::Notes - ::new + ::new
  • - DNote - ::run + DNote::Session + ::new
  • - DNote - #__DIR__ + DNote::Note + #<=>
  • - Syckle::Plugins::DNote - #clean + DNote::Notes + #by_file
  • - DNote::Site - #clean + DNote::Notes + #by_file_label
  • DNote::Notes - #counts + #by_label
  • - DNote::Format - #debug? + DNote::Notes + #by_label_file
  • Syckle::Plugins::DNote - #document + #clean
  • - DNote::Site - #document + DNote::Notes + #counts
  • DNote::Format - #dryrun? + #debug?
  • - DNote::Notes - #each + Syckle::Plugins::DNote + #document
  • - DNote::Notes - #empty? + DNote::Format + #dryrun?
  • - DNote::Format - #erb + DNote::Notes + #each
  • DNote::Notes - #files + #empty?
  • DNote::Format - #fu + #erb
  • - DNote - #fu + DNote::Session + #exclude=
  • - DNote::Format::ErbScope - #h + DNote::Session + #files
  • - Xacto::String - #indent + DNote::Format + #fu
  • - Syckle::Plugins::DNote - #initialize_defaults + DNote::Session + #glob
  • - DNote::Site - #initialize_defaults + DNote::Format::ErbScope + #h
  • - DNote::Notes - #labels= + DNote::Session + #ignore=
  • Xacto::String - #margin + #indent
  • - DNote::Notes - #match_arbitrary + DNote::Session + #initialize_defaults
  • - DNote::Notes - #match_common + Syckle::Plugins::DNote + #initialize_defaults
  • - DNote::Format::ErbScope - #method_missing + Xacto::String + #margin
  • DNote::Notes - #notes + #match
  • DNote::Notes - #organize -
  • - - -
  • - DNote::Site - #output= + #match_general
  • - Syckle::Plugins::DNote - #output= + DNote::Notes + #match_general_regex
  • DNote::Notes - #parse + #match_special
  • - DNote::Format - #publish + DNote::Notes + #match_special_regex
  • DNote::Format::ErbScope - #render -
  • - - -
  • - DNote::Format - #render + #method_missing
  • - DNote::Format - #render_custom -
  • - - -
  • - DNote::Format - #render_gnu + DNote::Notes + #notes
  • - DNote::Format - #render_html + Syckle::Plugins::DNote + #output=
  • - DNote::Format - #render_index + DNote::Notes + #parse
  • DNote::Format - #render_json + #publish
  • DNote::Format - #render_markdown + #render
  • - DNote::Format - #render_rdoc + DNote::Format::ErbScope + #render
  • DNote::Format - #render_soap + #render_custom
  • DNote::Format - #render_xml + #render_template
  • - DNote::Format - #render_xoxo + Syckle::Plugins::DNote + #reset
  • - DNote::Format - #render_yaml + DNote::Session + #run
  • - Syckle::Plugins::DNote - #reset + Xacto::String + #tabto
  • - DNote::Site - #reset + DNote::Note + #textline
  • - Xacto::String - #tabto + DNote::Notes + #to_a
  • - DNote - #templates + DNote::Note + #to_h
  • DNote::Notes - #to + #to_h
  • - DNote::Notes - #to_json + DNote::Note + #to_h_raw
  • - DNote::Notes - #to_soap + DNote::Note + #to_json
  • - DNote::Notes - #to_xoxo + DNote::Note + #to_s
  • - DNote::Notes - #to_yaml + DNote::Note + #to_str
  • - DNote - #write + DNote::Note + #to_yaml
  • DNote::Format - #write + #write
  • diff --git a/rdoc/files/lib/plugins/syckle/dnote_rb.html b/rdoc/files/lib/plugins/syckle/dnote_rb.html index b91cb6c..27d302a 100644 --- a/rdoc/files/lib/plugins/syckle/dnote_rb.html +++ b/rdoc/files/lib/plugins/syckle/dnote_rb.html @@ -46,7 +46,7 @@

    File Stats

    Last Modified
    -
    Sat Feb 06 14:30:26 -0500 2010
    +
    Thu Feb 18 11:31:14 -0500 2010
    Requires
    @@ -101,9 +101,11 @@

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • @@ -126,350 +128,338 @@

    Method Index

  • - DNote::Site - ::new + DNote::Session + ::main
  • - DNote::Format - ::new + DNote::Format::ErbScope + ::new
  • - DNote::Format::ErbScope - ::new + DNote::Note + ::new +
  • + + +
  • + DNote::Format + ::new
  • DNote::Notes - ::new + ::new
  • - DNote - ::run + DNote::Session + ::new
  • - DNote - #__DIR__ + DNote::Note + #<=>
  • - Syckle::Plugins::DNote - #clean + DNote::Notes + #by_file
  • - DNote::Site - #clean + DNote::Notes + #by_file_label
  • DNote::Notes - #counts + #by_label
  • - DNote::Format - #debug? + DNote::Notes + #by_label_file
  • Syckle::Plugins::DNote - #document + #clean
  • - DNote::Site - #document + DNote::Notes + #counts
  • DNote::Format - #dryrun? + #debug?
  • - DNote::Notes - #each + Syckle::Plugins::DNote + #document
  • - DNote::Notes - #empty? + DNote::Format + #dryrun?
  • - DNote::Format - #erb + DNote::Notes + #each
  • DNote::Notes - #files + #empty?
  • DNote::Format - #fu + #erb
  • - DNote - #fu + DNote::Session + #exclude=
  • - DNote::Format::ErbScope - #h + DNote::Session + #files
  • - Xacto::String - #indent + DNote::Format + #fu
  • - Syckle::Plugins::DNote - #initialize_defaults + DNote::Session + #glob
  • - DNote::Site - #initialize_defaults + DNote::Format::ErbScope + #h
  • - DNote::Notes - #labels= + DNote::Session + #ignore=
  • Xacto::String - #margin + #indent
  • - DNote::Notes - #match_arbitrary + DNote::Session + #initialize_defaults
  • - DNote::Notes - #match_common + Syckle::Plugins::DNote + #initialize_defaults
  • - DNote::Format::ErbScope - #method_missing + Xacto::String + #margin
  • DNote::Notes - #notes + #match
  • DNote::Notes - #organize + #match_general
  • - DNote::Site - #output= -
  • - - -
  • - Syckle::Plugins::DNote - #output= + DNote::Notes + #match_general_regex
  • DNote::Notes - #parse + #match_special
  • - DNote::Format - #publish + DNote::Notes + #match_special_regex
  • DNote::Format::ErbScope - #render -
  • - - -
  • - DNote::Format - #render + #method_missing
  • - DNote::Format - #render_custom -
  • - - -
  • - DNote::Format - #render_gnu + DNote::Notes + #notes
  • - DNote::Format - #render_html + Syckle::Plugins::DNote + #output=
  • - DNote::Format - #render_index + DNote::Notes + #parse
  • DNote::Format - #render_json + #publish
  • DNote::Format - #render_markdown + #render
  • - DNote::Format - #render_rdoc + DNote::Format::ErbScope + #render
  • DNote::Format - #render_soap + #render_custom
  • DNote::Format - #render_xml + #render_template
  • - DNote::Format - #render_xoxo + Syckle::Plugins::DNote + #reset
  • - DNote::Format - #render_yaml + DNote::Session + #run
  • - Syckle::Plugins::DNote - #reset + Xacto::String + #tabto
  • - DNote::Site - #reset + DNote::Note + #textline
  • - Xacto::String - #tabto + DNote::Notes + #to_a
  • - DNote - #templates + DNote::Note + #to_h
  • DNote::Notes - #to + #to_h
  • - DNote::Notes - #to_json + DNote::Note + #to_h_raw
  • - DNote::Notes - #to_soap + DNote::Note + #to_json
  • - DNote::Notes - #to_xoxo + DNote::Note + #to_s
  • - DNote::Notes - #to_yaml + DNote::Note + #to_str
  • - DNote - #write + DNote::Note + #to_yaml
  • DNote::Format - #write + #write
  • diff --git a/rdoc/index.html b/rdoc/index.html index 6a6e046..726581e 100644 --- a/rdoc/index.html +++ b/rdoc/index.html @@ -77,9 +77,11 @@

    Class Index
  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • @@ -102,350 +104,338 @@

    Method Index

  • - DNote::Site - ::new + DNote::Session + ::main
  • - DNote::Format - ::new + DNote::Format::ErbScope + ::new
  • - DNote::Format::ErbScope - ::new + DNote::Note + ::new +
  • + + +
  • + DNote::Format + ::new
  • DNote::Notes - ::new + ::new
  • - DNote - ::run + DNote::Session + ::new
  • - DNote - #__DIR__ + DNote::Note + #<=>
  • - Syckle::Plugins::DNote - #clean + DNote::Notes + #by_file
  • - DNote::Site - #clean + DNote::Notes + #by_file_label
  • DNote::Notes - #counts + #by_label
  • - DNote::Format - #debug? + DNote::Notes + #by_label_file
  • Syckle::Plugins::DNote - #document + #clean
  • - DNote::Site - #document + DNote::Notes + #counts
  • DNote::Format - #dryrun? + #debug?
  • - DNote::Notes - #each + Syckle::Plugins::DNote + #document
  • - DNote::Notes - #empty? + DNote::Format + #dryrun?
  • - DNote::Format - #erb + DNote::Notes + #each
  • DNote::Notes - #files + #empty?
  • DNote::Format - #fu + #erb
  • - DNote - #fu + DNote::Session + #exclude=
  • - DNote::Format::ErbScope - #h + DNote::Session + #files
  • - Xacto::String - #indent + DNote::Format + #fu
  • - Syckle::Plugins::DNote - #initialize_defaults + DNote::Session + #glob
  • - DNote::Site - #initialize_defaults + DNote::Format::ErbScope + #h
  • - DNote::Notes - #labels= + DNote::Session + #ignore=
  • Xacto::String - #margin + #indent
  • - DNote::Notes - #match_arbitrary + DNote::Session + #initialize_defaults
  • - DNote::Notes - #match_common + Syckle::Plugins::DNote + #initialize_defaults
  • - DNote::Format::ErbScope - #method_missing + Xacto::String + #margin
  • DNote::Notes - #notes + #match
  • DNote::Notes - #organize -
  • - - -
  • - DNote::Site - #output= + #match_general
  • - Syckle::Plugins::DNote - #output= + DNote::Notes + #match_general_regex
  • DNote::Notes - #parse + #match_special
  • - DNote::Format - #publish + DNote::Notes + #match_special_regex
  • DNote::Format::ErbScope - #render -
  • - - -
  • - DNote::Format - #render + #method_missing
  • - DNote::Format - #render_custom -
  • - - -
  • - DNote::Format - #render_gnu + DNote::Notes + #notes
  • - DNote::Format - #render_html + Syckle::Plugins::DNote + #output=
  • - DNote::Format - #render_index + DNote::Notes + #parse
  • DNote::Format - #render_json + #publish
  • DNote::Format - #render_markdown + #render
  • - DNote::Format - #render_rdoc + DNote::Format::ErbScope + #render
  • DNote::Format - #render_soap + #render_custom
  • DNote::Format - #render_xml + #render_template
  • - DNote::Format - #render_xoxo + Syckle::Plugins::DNote + #reset
  • - DNote::Format - #render_yaml + DNote::Session + #run
  • - Syckle::Plugins::DNote - #reset + Xacto::String + #tabto
  • - DNote::Site - #reset + DNote::Note + #textline
  • - Xacto::String - #tabto + DNote::Notes + #to_a
  • - DNote - #templates + DNote::Note + #to_h
  • DNote::Notes - #to + #to_h
  • - DNote::Notes - #to_json + DNote::Note + #to_h_raw
  • - DNote::Notes - #to_soap + DNote::Note + #to_json
  • - DNote::Notes - #to_xoxo + DNote::Note + #to_s
  • - DNote::Notes - #to_yaml + DNote::Note + #to_str
  • - DNote - #write + DNote::Note + #to_yaml
  • DNote::Format - #write + #write
  • @@ -485,9 +475,11 @@

    Classes/Modules

  • DNote::Format::ErbScope
  • +
  • DNote::Note
  • +
  • DNote::Notes
  • -
  • DNote::Site
  • +
  • DNote::Session
  • Syckle
  • @@ -504,121 +496,117 @@

    Classes/Modules

    Methods

    --> diff --git a/ri/DNote/Format/cdesc-Format.yaml b/ri/DNote/Format/cdesc-Format.yaml index a399527..2a2e7b7 100644 --- a/ri/DNote/Format/cdesc-Format.yaml +++ b/ri/DNote/Format/cdesc-Format.yaml @@ -23,6 +23,11 @@ attributes: - !ruby/object:RDoc::RI::Attribute comment: [] + name: subtype + rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: [] + name: template rw: RW - !ruby/object:RDoc::RI::Attribute @@ -68,25 +73,7 @@ instance_methods: - !ruby/object:RDoc::RI::MethodSummary name: render_custom - !ruby/object:RDoc::RI::MethodSummary - name: render_gnu -- !ruby/object:RDoc::RI::MethodSummary - name: render_html -- !ruby/object:RDoc::RI::MethodSummary - name: render_index -- !ruby/object:RDoc::RI::MethodSummary - name: render_json -- !ruby/object:RDoc::RI::MethodSummary - name: render_markdown -- !ruby/object:RDoc::RI::MethodSummary - name: render_rdoc -- !ruby/object:RDoc::RI::MethodSummary - name: render_soap -- !ruby/object:RDoc::RI::MethodSummary - name: render_xml -- !ruby/object:RDoc::RI::MethodSummary - name: render_xoxo -- !ruby/object:RDoc::RI::MethodSummary - name: render_yaml + name: render_template - !ruby/object:RDoc::RI::MethodSummary name: write name: Format diff --git a/ri/DNote/Format/new-c.yaml b/ri/DNote/Format/new-c.yaml index a43c485..7846a89 100644 --- a/ri/DNote/Format/new-c.yaml +++ b/ri/DNote/Format/new-c.yaml @@ -1,11 +1,11 @@ --- !ruby/object:RDoc::RI::MethodDescription aliases: [] -block_params: +block_params: (self) comment: [] full_name: DNote::Format::new is_singleton: true name: new -params: (notes, options={}) +params: (notes, options={}) {|self| ...} visibility: public diff --git a/ri/DNote/Format/render_custom-i.yaml b/ri/DNote/Format/render_custom-i.yaml index d742e2c..8044621 100644 --- a/ri/DNote/Format/render_custom-i.yaml +++ b/ri/DNote/Format/render_custom-i.yaml @@ -2,9 +2,8 @@ aliases: [] block_params: -comment: -- !ruby/struct:RDoc::Markup::Flow::P - body: C U S T O M T E M P L A T E +comment: [] + full_name: DNote::Format#render_custom is_singleton: false name: render_custom diff --git a/ri/DNote/Format/render_index-i.yaml b/ri/DNote/Format/render_index-i.yaml deleted file mode 100644 index 779ac29..0000000 --- a/ri/DNote/Format/render_index-i.yaml +++ /dev/null @@ -1,10 +0,0 @@ ---- !ruby/object:RDoc::RI::MethodDescription -aliases: [] - -block_params: -comment: -full_name: DNote::Format#render_index -is_singleton: false -name: render_index -params: () -visibility: public diff --git a/ri/DNote/Format/render_json-i.yaml b/ri/DNote/Format/render_json-i.yaml deleted file mode 100644 index 8ac9f6f..0000000 --- a/ri/DNote/Format/render_json-i.yaml +++ /dev/null @@ -1,10 +0,0 @@ ---- !ruby/object:RDoc::RI::MethodDescription -aliases: [] - -block_params: -comment: -full_name: DNote::Format#render_json -is_singleton: false -name: render_json -params: () -visibility: public diff --git a/ri/DNote/Format/render_markdown-i.yaml b/ri/DNote/Format/render_markdown-i.yaml deleted file mode 100644 index 1731e16..0000000 --- a/ri/DNote/Format/render_markdown-i.yaml +++ /dev/null @@ -1,10 +0,0 @@ ---- !ruby/object:RDoc::RI::MethodDescription -aliases: [] - -block_params: -comment: -full_name: DNote::Format#render_markdown -is_singleton: false -name: render_markdown -params: () -visibility: public diff --git a/ri/DNote/Site/document-i.yaml b/ri/DNote/Format/render_template-i.yaml similarity index 68% rename from ri/DNote/Site/document-i.yaml rename to ri/DNote/Format/render_template-i.yaml index 7ac9e16..e9174ca 100644 --- a/ri/DNote/Site/document-i.yaml +++ b/ri/DNote/Format/render_template-i.yaml @@ -4,8 +4,8 @@ aliases: [] block_params: comment: [] -full_name: DNote::Site#document +full_name: DNote::Format#render_template is_singleton: false -name: document +name: render_template params: () visibility: public diff --git a/ri/DNote/Format/render_xoxo-i.yaml b/ri/DNote/Format/render_xoxo-i.yaml deleted file mode 100644 index 180de0c..0000000 --- a/ri/DNote/Format/render_xoxo-i.yaml +++ /dev/null @@ -1,10 +0,0 @@ ---- !ruby/object:RDoc::RI::MethodDescription -aliases: [] - -block_params: -comment: -full_name: DNote::Format#render_xoxo -is_singleton: false -name: render_xoxo -params: () -visibility: public diff --git a/ri/DNote/Format/render_gnu-i.yaml b/ri/DNote/Note/%3c%3d%3e-i.yaml similarity index 62% rename from ri/DNote/Format/render_gnu-i.yaml rename to ri/DNote/Note/%3c%3d%3e-i.yaml index 32d69cf..6f453e9 100644 --- a/ri/DNote/Format/render_gnu-i.yaml +++ b/ri/DNote/Note/%3c%3d%3e-i.yaml @@ -4,9 +4,9 @@ aliases: [] block_params: comment: - !ruby/struct:RDoc::Markup::Flow::P - body: W I K I M A R K U P -full_name: DNote::Format#render_gnu + body: Sort by file name and line number. +full_name: DNote::Note#<=> is_singleton: false -name: render_gnu -params: () +name: <=> +params: (other) visibility: public diff --git a/ri/DNote/Note/cdesc-Note.yaml b/ri/DNote/Note/cdesc-Note.yaml new file mode 100644 index 0000000..d92f75a --- /dev/null +++ b/ri/DNote/Note/cdesc-Note.yaml @@ -0,0 +1,47 @@ +--- !ruby/object:RDoc::RI::ClassDescription +attributes: +- !ruby/object:RDoc::RI::Attribute + comment: + name: file + rw: R +- !ruby/object:RDoc::RI::Attribute + comment: + name: label + rw: R +- !ruby/object:RDoc::RI::Attribute + comment: + name: line + rw: R +- !ruby/object:RDoc::RI::Attribute + comment: + name: text + rw: R +class_methods: +- !ruby/object:RDoc::RI::MethodSummary + name: new +comment: [] + +constants: [] + +full_name: DNote::Note +includes: [] + +instance_methods: +- !ruby/object:RDoc::RI::MethodSummary + name: <=> +- !ruby/object:RDoc::RI::MethodSummary + name: textline +- !ruby/object:RDoc::RI::MethodSummary + name: to_h +- !ruby/object:RDoc::RI::MethodSummary + name: to_h_raw +- !ruby/object:RDoc::RI::MethodSummary + name: to_json +- !ruby/object:RDoc::RI::MethodSummary + name: to_s +- !ruby/object:RDoc::RI::MethodSummary + name: to_str +- !ruby/object:RDoc::RI::MethodSummary + name: to_yaml +name: Note +superclass: Object diff --git a/ri/DNote/Site/new-c.yaml b/ri/DNote/Note/new-c.yaml similarity index 68% rename from ri/DNote/Site/new-c.yaml rename to ri/DNote/Note/new-c.yaml index 73c4fc5..e87c242 100644 --- a/ri/DNote/Site/new-c.yaml +++ b/ri/DNote/Note/new-c.yaml @@ -3,8 +3,8 @@ aliases: [] block_params: comment: -full_name: DNote::Site::new +full_name: DNote::Note::new is_singleton: true name: new -params: (paths, options) +params: (file, label, line, text) visibility: public diff --git a/ri/DNote/Notes/to_json-i.yaml b/ri/DNote/Note/textline-i.yaml similarity index 74% rename from ri/DNote/Notes/to_json-i.yaml rename to ri/DNote/Note/textline-i.yaml index 3119c70..45950bf 100644 --- a/ri/DNote/Notes/to_json-i.yaml +++ b/ri/DNote/Note/textline-i.yaml @@ -4,8 +4,8 @@ aliases: [] block_params: comment: [] -full_name: DNote::Notes#to_json +full_name: DNote::Note#textline is_singleton: false -name: to_json +name: textline params: () visibility: public diff --git a/ri/DNote/__DIR__-i.yaml b/ri/DNote/Note/to_h-i.yaml similarity index 77% rename from ri/DNote/__DIR__-i.yaml rename to ri/DNote/Note/to_h-i.yaml index 518dffe..777681f 100644 --- a/ri/DNote/__DIR__-i.yaml +++ b/ri/DNote/Note/to_h-i.yaml @@ -3,8 +3,8 @@ aliases: [] block_params: comment: -full_name: DNote#__DIR__ +full_name: DNote::Note#to_h is_singleton: false -name: __DIR__ +name: to_h params: () visibility: public diff --git a/ri/DNote/Format/render_xml-i.yaml b/ri/DNote/Note/to_h_raw-i.yaml similarity index 71% rename from ri/DNote/Format/render_xml-i.yaml rename to ri/DNote/Note/to_h_raw-i.yaml index 1158ec5..35c80bd 100644 --- a/ri/DNote/Format/render_xml-i.yaml +++ b/ri/DNote/Note/to_h_raw-i.yaml @@ -3,8 +3,8 @@ aliases: [] block_params: comment: -full_name: DNote::Format#render_xml +full_name: DNote::Note#to_h_raw is_singleton: false -name: render_xml +name: to_h_raw params: () visibility: public diff --git a/ri/DNote/Format/render_rdoc-i.yaml b/ri/DNote/Note/to_json-i.yaml similarity index 65% rename from ri/DNote/Format/render_rdoc-i.yaml rename to ri/DNote/Note/to_json-i.yaml index 667c43f..1905e90 100644 --- a/ri/DNote/Format/render_rdoc-i.yaml +++ b/ri/DNote/Note/to_json-i.yaml @@ -3,8 +3,8 @@ aliases: [] block_params: comment: -full_name: DNote::Format#render_rdoc +full_name: DNote::Note#to_json is_singleton: false -name: render_rdoc -params: () +name: to_json +params: (*args) visibility: public diff --git a/ri/DNote/fu-i.yaml b/ri/DNote/Note/to_s-i.yaml similarity index 77% rename from ri/DNote/fu-i.yaml rename to ri/DNote/Note/to_s-i.yaml index 7e27038..1827dcc 100644 --- a/ri/DNote/fu-i.yaml +++ b/ri/DNote/Note/to_s-i.yaml @@ -4,8 +4,8 @@ aliases: [] block_params: comment: [] -full_name: DNote#fu +full_name: DNote::Note#to_s is_singleton: false -name: fu +name: to_s params: () visibility: public diff --git a/ri/DNote/Notes/files-i.yaml b/ri/DNote/Note/to_str-i.yaml similarity index 76% rename from ri/DNote/Notes/files-i.yaml rename to ri/DNote/Note/to_str-i.yaml index b48e3d3..e202105 100644 --- a/ri/DNote/Notes/files-i.yaml +++ b/ri/DNote/Note/to_str-i.yaml @@ -4,8 +4,8 @@ aliases: [] block_params: comment: [] -full_name: DNote::Notes#files +full_name: DNote::Note#to_str is_singleton: false -name: files +name: to_str params: () visibility: public diff --git a/ri/DNote/Notes/to_yaml-i.yaml b/ri/DNote/Note/to_yaml-i.yaml similarity index 69% rename from ri/DNote/Notes/to_yaml-i.yaml rename to ri/DNote/Note/to_yaml-i.yaml index 3433d37..ec851e1 100644 --- a/ri/DNote/Notes/to_yaml-i.yaml +++ b/ri/DNote/Note/to_yaml-i.yaml @@ -2,10 +2,9 @@ aliases: [] block_params: -comment: [] - -full_name: DNote::Notes#to_yaml +comment: +full_name: DNote::Note#to_yaml is_singleton: false name: to_yaml -params: () +params: (*args) visibility: public diff --git a/ri/DNote/Format/render_yaml-i.yaml b/ri/DNote/Notes/by_file-i.yaml similarity index 62% rename from ri/DNote/Format/render_yaml-i.yaml rename to ri/DNote/Notes/by_file-i.yaml index ed1c546..c22e4c0 100644 --- a/ri/DNote/Format/render_yaml-i.yaml +++ b/ri/DNote/Notes/by_file-i.yaml @@ -4,9 +4,9 @@ aliases: [] block_params: comment: - !ruby/struct:RDoc::Markup::Flow::P - body: S E R I A L I Z A T I O N -full_name: DNote::Format#render_yaml + body: Organize notes into a hash with filename for keys. +full_name: DNote::Notes#by_file is_singleton: false -name: render_yaml +name: by_file params: () visibility: public diff --git a/ri/DNote/Notes/by_file_label-i.yaml b/ri/DNote/Notes/by_file_label-i.yaml new file mode 100644 index 0000000..66c409f --- /dev/null +++ b/ri/DNote/Notes/by_file_label-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Organize notes into a hash with filenames for keys, followed by a hash with labels for keys. +full_name: DNote::Notes#by_file_label +is_singleton: false +name: by_file_label +params: () +visibility: public diff --git a/ri/DNote/Notes/by_label-i.yaml b/ri/DNote/Notes/by_label-i.yaml new file mode 100644 index 0000000..6ea61e8 --- /dev/null +++ b/ri/DNote/Notes/by_label-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Organize notes into a hash with labels for keys. +full_name: DNote::Notes#by_label +is_singleton: false +name: by_label +params: () +visibility: public diff --git a/ri/DNote/Notes/by_label_file-i.yaml b/ri/DNote/Notes/by_label_file-i.yaml new file mode 100644 index 0000000..7299a7f --- /dev/null +++ b/ri/DNote/Notes/by_label_file-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Organize notes into a hash with labels for keys, followed by a hash with filename for keys. +full_name: DNote::Notes#by_label_file +is_singleton: false +name: by_label_file +params: () +visibility: public diff --git a/ri/DNote/Notes/cdesc-Notes.yaml b/ri/DNote/Notes/cdesc-Notes.yaml index 790f780..0bf8116 100644 --- a/ri/DNote/Notes/cdesc-Notes.yaml +++ b/ri/DNote/Notes/cdesc-Notes.yaml @@ -3,14 +3,20 @@ attributes: - !ruby/object:RDoc::RI::Attribute comment: - !ruby/struct:RDoc::Markup::Flow::P - body: "Labels to document. Defaults are: TODO, FIXME, OPTIMIZE and DEPRECATE." - name: labels + body: Require label colon? Default is true. + name: colon rw: RW - !ruby/object:RDoc::RI::Attribute comment: - !ruby/struct:RDoc::Markup::Flow::P - body: Paths to search. - name: paths + body: Files to search for notes. + name: files + rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: "Labels to document. Defaults are: TODO, FIXME, OPTIMIZE and DEPRECATE." + name: labels rw: RW class_methods: - !ruby/object:RDoc::RI::MethodSummary @@ -20,23 +26,23 @@ comment: level: 1 text: Developer Notes - !ruby/struct:RDoc::Markup::Flow::P - body: This class goes through you source files and compiles a list of any labeled comments. Labels are single word prefixes to a comment ending in a colon. + body: This class goes through you source files and compiles a list of any labeled comments. Labels are all-cap single word prefixes to a comment ending in a colon. - !ruby/struct:RDoc::Markup::Flow::P - body: By default the labels supported are TODO, FIXME, OPTIMIZE and DEPRECATE. + body: Special labels do require the colon. By default these are TODO, FIXME, OPTIMIZE and DEPRECATE. - !ruby/struct:RDoc::Markup::Flow::RULE width: - !ruby/struct:RDoc::Markup::Flow::H level: 1 text: Developer Notes - !ruby/struct:RDoc::Markup::Flow::P - body: This class goes through you source files and compiles a list of any labeled comments. Labels are single word prefixes to a comment ending in a colon. + body: This class goes through you source files and compiles a list of any labeled comments. Labels are all-cap single word prefixes to a comment ending in a colon. - !ruby/struct:RDoc::Markup::Flow::P - body: By default the labels supported are TODO, FIXME, OPTIMIZE and DEPRECATE. + body: Special labels do require the colon. By default these are TODO, FIXME, OPTIMIZE and DEPRECATE. constants: - !ruby/object:RDoc::RI::Constant comment: - !ruby/struct:RDoc::Markup::Flow::P - body: Default note labels to look for in source code. + body: Default note labels to look for in source code. (NOT CURRENTLY USED!) name: DEFAULT_LABELS value: "['TODO', 'FIXME', 'OPTIMIZE', 'DEPRECATE']" - !ruby/object:RDoc::RI::Constant @@ -50,6 +56,14 @@ includes: - !ruby/object:RDoc::RI::IncludedModule name: Enumerable instance_methods: +- !ruby/object:RDoc::RI::MethodSummary + name: by_file +- !ruby/object:RDoc::RI::MethodSummary + name: by_file_label +- !ruby/object:RDoc::RI::MethodSummary + name: by_label +- !ruby/object:RDoc::RI::MethodSummary + name: by_label_file - !ruby/object:RDoc::RI::MethodSummary name: counts - !ruby/object:RDoc::RI::MethodSummary @@ -57,28 +71,22 @@ instance_methods: - !ruby/object:RDoc::RI::MethodSummary name: empty? - !ruby/object:RDoc::RI::MethodSummary - name: files + name: match - !ruby/object:RDoc::RI::MethodSummary - name: labels= + name: match_general - !ruby/object:RDoc::RI::MethodSummary - name: match_arbitrary + name: match_general_regex - !ruby/object:RDoc::RI::MethodSummary - name: match_common + name: match_special - !ruby/object:RDoc::RI::MethodSummary - name: notes + name: match_special_regex - !ruby/object:RDoc::RI::MethodSummary - name: organize + name: notes - !ruby/object:RDoc::RI::MethodSummary name: parse - !ruby/object:RDoc::RI::MethodSummary - name: to -- !ruby/object:RDoc::RI::MethodSummary - name: to_json -- !ruby/object:RDoc::RI::MethodSummary - name: to_soap -- !ruby/object:RDoc::RI::MethodSummary - name: to_xoxo + name: to_a - !ruby/object:RDoc::RI::MethodSummary - name: to_yaml + name: to_h name: Notes superclass: Object diff --git a/ri/DNote/Notes/counts-i.yaml b/ri/DNote/Notes/counts-i.yaml index ef9150c..248875d 100644 --- a/ri/DNote/Notes/counts-i.yaml +++ b/ri/DNote/Notes/counts-i.yaml @@ -2,8 +2,9 @@ aliases: [] block_params: -comment: [] - +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Notes counts by label. full_name: DNote::Notes#counts is_singleton: false name: counts diff --git a/ri/DNote/Notes/each-i.yaml b/ri/DNote/Notes/each-i.yaml index e57584a..5608601 100644 --- a/ri/DNote/Notes/each-i.yaml +++ b/ri/DNote/Notes/each-i.yaml @@ -2,8 +2,9 @@ aliases: [] block_params: -comment: [] - +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Iterate through notes. full_name: DNote::Notes#each is_singleton: false name: each diff --git a/ri/DNote/Notes/empty%3f-i.yaml b/ri/DNote/Notes/empty%3f-i.yaml index 1504eae..4865917 100644 --- a/ri/DNote/Notes/empty%3f-i.yaml +++ b/ri/DNote/Notes/empty%3f-i.yaml @@ -2,8 +2,9 @@ aliases: [] block_params: -comment: [] - +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: No notes? full_name: DNote::Notes#empty? is_singleton: false name: empty? diff --git a/ri/DNote/Notes/labels%3d-i.yaml b/ri/DNote/Notes/labels%3d-i.yaml deleted file mode 100644 index 628fa3e..0000000 --- a/ri/DNote/Notes/labels%3d-i.yaml +++ /dev/null @@ -1,11 +0,0 @@ ---- !ruby/object:RDoc::RI::MethodDescription -aliases: [] - -block_params: -comment: [] - -full_name: DNote::Notes#labels= -is_singleton: false -name: labels= -params: (labels) -visibility: public diff --git a/ri/DNote/Notes/match_arbitrary-i.yaml b/ri/DNote/Notes/match-i.yaml similarity index 71% rename from ri/DNote/Notes/match_arbitrary-i.yaml rename to ri/DNote/Notes/match-i.yaml index e0788b7..cd91819 100644 --- a/ri/DNote/Notes/match_arbitrary-i.yaml +++ b/ri/DNote/Notes/match-i.yaml @@ -4,8 +4,8 @@ aliases: [] block_params: comment: [] -full_name: DNote::Notes#match_arbitrary +full_name: DNote::Notes#match is_singleton: false -name: match_arbitrary +name: match params: (line, lineno, file) visibility: public diff --git a/ri/DNote/Notes/match_common-i.yaml b/ri/DNote/Notes/match_general-i.yaml similarity index 55% rename from ri/DNote/Notes/match_common-i.yaml rename to ri/DNote/Notes/match_general-i.yaml index be020bb..444dc66 100644 --- a/ri/DNote/Notes/match_common-i.yaml +++ b/ri/DNote/Notes/match_general-i.yaml @@ -4,9 +4,9 @@ aliases: [] block_params: comment: - !ruby/struct:RDoc::Markup::Flow::P - body: "TODO: ruby-1.9.1-p378 reports: notes.rb:131:in `match': invalid byte sequence in UTF-8" -full_name: DNote::Notes#match_common + body: Match notes that are labeled with a colon. +full_name: DNote::Notes#match_general is_singleton: false -name: match_common +name: match_general params: (line, lineno, file) visibility: public diff --git a/ri/DNote/Notes/match_general_regex-i.yaml b/ri/DNote/Notes/match_general_regex-i.yaml new file mode 100644 index 0000000..df03b1b --- /dev/null +++ b/ri/DNote/Notes/match_general_regex-i.yaml @@ -0,0 +1,11 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: [] + +full_name: DNote::Notes#match_general_regex +is_singleton: false +name: match_general_regex +params: () +visibility: public diff --git a/ri/DNote/Notes/organize-i.yaml b/ri/DNote/Notes/match_special-i.yaml similarity index 58% rename from ri/DNote/Notes/organize-i.yaml rename to ri/DNote/Notes/match_special-i.yaml index b37a7fe..c2eb502 100644 --- a/ri/DNote/Notes/organize-i.yaml +++ b/ri/DNote/Notes/match_special-i.yaml @@ -4,9 +4,9 @@ aliases: [] block_params: comment: - !ruby/struct:RDoc::Markup::Flow::P - body: Organize records in heirarchical form. -full_name: DNote::Notes#organize + body: Match special notes. +full_name: DNote::Notes#match_special is_singleton: false -name: organize -params: (records) +name: match_special +params: (line, lineno, file) visibility: public diff --git a/ri/DNote/Format/render_html-i.yaml b/ri/DNote/Notes/match_special_regex-i.yaml similarity index 53% rename from ri/DNote/Format/render_html-i.yaml rename to ri/DNote/Notes/match_special_regex-i.yaml index 24cf6fe..709f575 100644 --- a/ri/DNote/Format/render_html-i.yaml +++ b/ri/DNote/Notes/match_special_regex-i.yaml @@ -2,9 +2,9 @@ aliases: [] block_params: -comment: -full_name: DNote::Format#render_html +comment: "" +full_name: DNote::Notes#match_special_regex is_singleton: false -name: render_html -params: () +name: match_special_regex +params: (label) visibility: public diff --git a/ri/DNote/Notes/new-c.yaml b/ri/DNote/Notes/new-c.yaml index caa8bdf..46f319e 100644 --- a/ri/DNote/Notes/new-c.yaml +++ b/ri/DNote/Notes/new-c.yaml @@ -2,10 +2,11 @@ aliases: [] block_params: -comment: [] - +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: New set of notes for give files and optional special labels. full_name: DNote::Notes::new is_singleton: true name: new -params: (paths, labels=nil) +params: (files, options={}) visibility: public diff --git a/ri/DNote/Notes/notes-i.yaml b/ri/DNote/Notes/notes-i.yaml index e056b55..e2f83da 100644 --- a/ri/DNote/Notes/notes-i.yaml +++ b/ri/DNote/Notes/notes-i.yaml @@ -2,8 +2,9 @@ aliases: [] block_params: -comment: [] - +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Array of notes. full_name: DNote::Notes#notes is_singleton: false name: notes diff --git a/ri/DNote/Notes/parse-i.yaml b/ri/DNote/Notes/parse-i.yaml index 3c5548b..b0b33bf 100644 --- a/ri/DNote/Notes/parse-i.yaml +++ b/ri/DNote/Notes/parse-i.yaml @@ -4,7 +4,7 @@ aliases: [] block_params: comment: - !ruby/struct:RDoc::Markup::Flow::P - body: Gather and count notes. This returns two elements, a hash in the form of label=>notes and a counts hash. + body: Gather notes. full_name: DNote::Notes#parse is_singleton: false name: parse diff --git a/ri/DNote/Notes/to-i.yaml b/ri/DNote/Notes/to-i.yaml deleted file mode 100644 index 3a15262..0000000 --- a/ri/DNote/Notes/to-i.yaml +++ /dev/null @@ -1,11 +0,0 @@ ---- !ruby/object:RDoc::RI::MethodDescription -aliases: [] - -block_params: -comment: [] - -full_name: DNote::Notes#to -is_singleton: false -name: to -params: (format) -visibility: public diff --git a/ri/DNote/Format/render_soap-i.yaml b/ri/DNote/Notes/to_a-i.yaml similarity index 68% rename from ri/DNote/Format/render_soap-i.yaml rename to ri/DNote/Notes/to_a-i.yaml index c47e7af..67cf9e8 100644 --- a/ri/DNote/Format/render_soap-i.yaml +++ b/ri/DNote/Notes/to_a-i.yaml @@ -4,9 +4,9 @@ aliases: [] block_params: comment: - !ruby/struct:RDoc::Markup::Flow::P - body: M L M A R K U P -full_name: DNote::Format#render_soap + body: Convert to an array of hashes. +full_name: DNote::Notes#to_a is_singleton: false -name: render_soap +name: to_a params: () visibility: public diff --git a/ri/DNote/Notes/to_xoxo-i.yaml b/ri/DNote/Notes/to_h-i.yaml similarity index 70% rename from ri/DNote/Notes/to_xoxo-i.yaml rename to ri/DNote/Notes/to_h-i.yaml index dd0e5b7..617edee 100644 --- a/ri/DNote/Notes/to_xoxo-i.yaml +++ b/ri/DNote/Notes/to_h-i.yaml @@ -4,9 +4,9 @@ aliases: [] block_params: comment: - !ruby/struct:RDoc::Markup::Flow::P - body: XOXO microformat. -full_name: DNote::Notes#to_xoxo + body: "Same as #by_label." +full_name: DNote::Notes#to_h is_singleton: false -name: to_xoxo +name: to_h params: () visibility: public diff --git a/ri/DNote/Session/cdesc-Session.yaml b/ri/DNote/Session/cdesc-Session.yaml new file mode 100644 index 0000000..4015d08 --- /dev/null +++ b/ri/DNote/Session/cdesc-Session.yaml @@ -0,0 +1,115 @@ +--- !ruby/object:RDoc::RI::ClassDescription +attributes: +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Selected labels can optionally do without the colon. + name: colon + rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: If output path given, don't actually write to disk. + name: dryrun + rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Paths to exclude (match by pathname). + name: exclude + rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Output format. + name: format + rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Paths to ignore (match by basename). + name: ignore + rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Labels to lookup. By default these are TODO, FIXME and OPTIMIZE. + name: labels + rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Output to a file instead of STDOUT. + name: output + rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Paths to include. + name: paths + rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: If custom format, specify template file. + name: template + rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Some format put a title at the top of the output. The default is "Developer's Notes". + name: title + rw: RW +class_methods: +- !ruby/object:RDoc::RI::MethodSummary + name: main +- !ruby/object:RDoc::RI::MethodSummary + name: new +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: User session which is used by commandline interface. +- !ruby/struct:RDoc::Markup::Flow::P + body: By making this a class it makes it easy for external libraries to use this library just as if they were calling the commandline, but without the need to shellout. +- !ruby/struct:RDoc::Markup::Flow::RULE + width: +- !ruby/struct:RDoc::Markup::Flow::P + body: User session which is used by commandline interface. +- !ruby/struct:RDoc::Markup::Flow::P + body: By making this a class it makes it easy for external libraries to use this library just as if they were calling the commandline, but without the need to shellout. +constants: +- !ruby/object:RDoc::RI::Constant + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Default format. + name: DEFAULT_FORMAT + value: "\"text\"" +- !ruby/object:RDoc::RI::Constant + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Default title. + name: DEFAULT_TITLE + value: "\"Developer's Notes\"" +- !ruby/object:RDoc::RI::Constant + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Directory relative to this script. This is used to lookup the available format templates. + name: DIR + value: File.dirname(__FILE__) +full_name: DNote::Session +includes: [] + +instance_methods: +- !ruby/object:RDoc::RI::MethodSummary + name: exclude= +- !ruby/object:RDoc::RI::MethodSummary + name: files +- !ruby/object:RDoc::RI::MethodSummary + name: glob +- !ruby/object:RDoc::RI::MethodSummary + name: ignore= +- !ruby/object:RDoc::RI::MethodSummary + name: initialize_defaults +- !ruby/object:RDoc::RI::MethodSummary + name: run +name: Session +superclass: Object diff --git a/ri/DNote/Session/exclude%3d-i.yaml b/ri/DNote/Session/exclude%3d-i.yaml new file mode 100644 index 0000000..dbe4c0e --- /dev/null +++ b/ri/DNote/Session/exclude%3d-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Set exclude list ensuring that the value is an array. +full_name: DNote::Session#exclude= +is_singleton: false +name: exclude= +params: (list) +visibility: public diff --git a/ri/DNote/Session/files-i.yaml b/ri/DNote/Session/files-i.yaml new file mode 100644 index 0000000..7d4659e --- /dev/null +++ b/ri/DNote/Session/files-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: "Collect path globs and remove exclusions. This method uses #paths, #exclude and #ignore to compile the list of files." +full_name: DNote::Session#files +is_singleton: false +name: files +params: () +visibility: public diff --git a/ri/DNote/Session/glob-i.yaml b/ri/DNote/Session/glob-i.yaml new file mode 100644 index 0000000..b47daf4 --- /dev/null +++ b/ri/DNote/Session/glob-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Collect the file glob of each path given. If a path is a directory, inclue all content. +full_name: DNote::Session#glob +is_singleton: false +name: glob +params: (paths) +visibility: public diff --git a/ri/DNote/Session/ignore%3d-i.yaml b/ri/DNote/Session/ignore%3d-i.yaml new file mode 100644 index 0000000..77cc97d --- /dev/null +++ b/ri/DNote/Session/ignore%3d-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Set ignore list ensuring that the value is an array. +full_name: DNote::Session#ignore= +is_singleton: false +name: ignore= +params: (list) +visibility: public diff --git a/ri/DNote/Session/initialize_defaults-i.yaml b/ri/DNote/Session/initialize_defaults-i.yaml new file mode 100644 index 0000000..86d889e --- /dev/null +++ b/ri/DNote/Session/initialize_defaults-i.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: Set default values for attributes. +full_name: DNote::Session#initialize_defaults +is_singleton: false +name: initialize_defaults +params: () +visibility: private diff --git a/ri/DNote/write-i.yaml b/ri/DNote/Session/main-c.yaml similarity index 56% rename from ri/DNote/write-i.yaml rename to ri/DNote/Session/main-c.yaml index 3554534..e936a0a 100644 --- a/ri/DNote/write-i.yaml +++ b/ri/DNote/Session/main-c.yaml @@ -4,9 +4,9 @@ aliases: [] block_params: comment: - !ruby/struct:RDoc::Markup::Flow::P - body: Save file to output. -full_name: DNote#write -is_singleton: false -name: write -params: (fname, text) + body: Commandline interface. +full_name: DNote::Session::main +is_singleton: true +name: main +params: (*argv) visibility: public diff --git a/ri/DNote/Session/new-c.yaml b/ri/DNote/Session/new-c.yaml new file mode 100644 index 0000000..93bdade --- /dev/null +++ b/ri/DNote/Session/new-c.yaml @@ -0,0 +1,12 @@ +--- !ruby/object:RDoc::RI::MethodDescription +aliases: [] + +block_params: (self) +comment: +- !ruby/struct:RDoc::Markup::Flow::P + body: New Session. +full_name: DNote::Session::new +is_singleton: true +name: new +params: (options={}) {|self| ...} +visibility: public diff --git a/ri/DNote/Notes/to_soap-i.yaml b/ri/DNote/Session/run-i.yaml similarity index 70% rename from ri/DNote/Notes/to_soap-i.yaml rename to ri/DNote/Session/run-i.yaml index cb7c9d8..7cb8f10 100644 --- a/ri/DNote/Notes/to_soap-i.yaml +++ b/ri/DNote/Session/run-i.yaml @@ -4,9 +4,9 @@ aliases: [] block_params: comment: - !ruby/struct:RDoc::Markup::Flow::P - body: Soap envelope XML. -full_name: DNote::Notes#to_soap + body: Run session. +full_name: DNote::Session#run is_singleton: false -name: to_soap +name: run params: () visibility: public diff --git a/ri/DNote/Site/cdesc-Site.yaml b/ri/DNote/Site/cdesc-Site.yaml deleted file mode 100644 index 48ce833..0000000 --- a/ri/DNote/Site/cdesc-Site.yaml +++ /dev/null @@ -1,59 +0,0 @@ ---- !ruby/object:RDoc::RI::ClassDescription -attributes: -- !ruby/object:RDoc::RI::Attribute - comment: - - !ruby/struct:RDoc::Markup::Flow::P - body: Additional Formats to supply besides the html (xml, rdoc, markdown, etc.) - name: formats - rw: RW -- !ruby/object:RDoc::RI::Attribute - comment: - - !ruby/struct:RDoc::Markup::Flow::P - body: Notes object. - name: notes - rw: R -- !ruby/object:RDoc::RI::Attribute - comment: - - !ruby/struct:RDoc::Markup::Flow::P - body: Directory to save output. - name: output - rw: RW -- !ruby/object:RDoc::RI::Attribute - comment: - - !ruby/struct:RDoc::Markup::Flow::P - body: Title to use in any headers. - name: title - rw: RW -class_methods: -- !ruby/object:RDoc::RI::MethodSummary - name: new -comment: -- !ruby/struct:RDoc::Markup::Flow::P - body: Site class is used to build a "pretty" output set. The template files are saved to the output directory. Additional formats can be saved to the directory as well. -- !ruby/struct:RDoc::Markup::Flow::RULE - width: -- !ruby/struct:RDoc::Markup::Flow::P - body: Site class is used to build a "pretty" output set. The template files are saved to the output directory. Additional formats can be saved to the directory as well. -constants: -- !ruby/object:RDoc::RI::Constant - comment: - - !ruby/struct:RDoc::Markup::Flow::P - body: Default output directory is log/dnote/. - name: DEFAULT_OUTPUT - value: Pathname.new('log/dnote') -full_name: DNote::Site -includes: [] - -instance_methods: -- !ruby/object:RDoc::RI::MethodSummary - name: clean -- !ruby/object:RDoc::RI::MethodSummary - name: document -- !ruby/object:RDoc::RI::MethodSummary - name: initialize_defaults -- !ruby/object:RDoc::RI::MethodSummary - name: output= -- !ruby/object:RDoc::RI::MethodSummary - name: reset -name: Site -superclass: Object diff --git a/ri/DNote/Site/clean-i.yaml b/ri/DNote/Site/clean-i.yaml deleted file mode 100644 index 58fff51..0000000 --- a/ri/DNote/Site/clean-i.yaml +++ /dev/null @@ -1,12 +0,0 @@ ---- !ruby/object:RDoc::RI::MethodDescription -aliases: [] - -block_params: -comment: -- !ruby/struct:RDoc::Markup::Flow::P - body: Remove output directory. -full_name: DNote::Site#clean -is_singleton: false -name: clean -params: () -visibility: public diff --git a/ri/DNote/Site/initialize_defaults-i.yaml b/ri/DNote/Site/initialize_defaults-i.yaml deleted file mode 100644 index 9ed3c0f..0000000 --- a/ri/DNote/Site/initialize_defaults-i.yaml +++ /dev/null @@ -1,11 +0,0 @@ ---- !ruby/object:RDoc::RI::MethodDescription -aliases: [] - -block_params: -comment: [] - -full_name: DNote::Site#initialize_defaults -is_singleton: false -name: initialize_defaults -params: () -visibility: public diff --git a/ri/DNote/Site/output%3d-i.yaml b/ri/DNote/Site/output%3d-i.yaml deleted file mode 100644 index 731ff79..0000000 --- a/ri/DNote/Site/output%3d-i.yaml +++ /dev/null @@ -1,11 +0,0 @@ ---- !ruby/object:RDoc::RI::MethodDescription -aliases: [] - -block_params: -comment: [] - -full_name: DNote::Site#output= -is_singleton: false -name: output= -params: (path) -visibility: public diff --git a/ri/DNote/Site/reset-i.yaml b/ri/DNote/Site/reset-i.yaml deleted file mode 100644 index fc4fb29..0000000 --- a/ri/DNote/Site/reset-i.yaml +++ /dev/null @@ -1,12 +0,0 @@ ---- !ruby/object:RDoc::RI::MethodDescription -aliases: [] - -block_params: -comment: -- !ruby/struct:RDoc::Markup::Flow::P - body: Reset output directory, marking it as out-of-date. -full_name: DNote::Site#reset -is_singleton: false -name: reset -params: () -visibility: public diff --git a/ri/DNote/cdesc-DNote.yaml b/ri/DNote/cdesc-DNote.yaml index 20255d1..450aa95 100644 --- a/ri/DNote/cdesc-DNote.yaml +++ b/ri/DNote/cdesc-DNote.yaml @@ -1,25 +1,17 @@ --- !ruby/object:RDoc::RI::ModuleDescription attributes: [] -class_methods: -- !ruby/object:RDoc::RI::MethodSummary - name: run +class_methods: [] + comment: constants: - !ruby/object:RDoc::RI::Constant comment: name: VERSION - value: "\"1.1.3\"" + value: "\"1.2.0\"" full_name: DNote includes: [] -instance_methods: -- !ruby/object:RDoc::RI::MethodSummary - name: __DIR__ -- !ruby/object:RDoc::RI::MethodSummary - name: fu -- !ruby/object:RDoc::RI::MethodSummary - name: templates -- !ruby/object:RDoc::RI::MethodSummary - name: write +instance_methods: [] + name: DNote diff --git a/ri/DNote/run-c.yaml b/ri/DNote/run-c.yaml deleted file mode 100644 index b5b39b5..0000000 --- a/ri/DNote/run-c.yaml +++ /dev/null @@ -1,10 +0,0 @@ ---- !ruby/object:RDoc::RI::MethodDescription -aliases: [] - -block_params: -comment: -full_name: DNote::run -is_singleton: true -name: run -params: () -visibility: public diff --git a/ri/DNote/templates-i.yaml b/ri/DNote/templates-i.yaml deleted file mode 100644 index 0d0b0b3..0000000 --- a/ri/DNote/templates-i.yaml +++ /dev/null @@ -1,12 +0,0 @@ ---- !ruby/object:RDoc::RI::MethodDescription -aliases: [] - -block_params: -comment: -- !ruby/struct:RDoc::Markup::Flow::P - body: "TODO: Don't use chdir." -full_name: DNote#templates -is_singleton: false -name: templates -params: (format) -visibility: public diff --git a/ri/Syckle/Plugins/DNote/cdesc-DNote.yaml b/ri/Syckle/Plugins/DNote/cdesc-DNote.yaml index 007c170..1279520 100644 --- a/ri/Syckle/Plugins/DNote/cdesc-DNote.yaml +++ b/ri/Syckle/Plugins/DNote/cdesc-DNote.yaml @@ -3,7 +3,13 @@ attributes: - !ruby/object:RDoc::RI::Attribute comment: - !ruby/struct:RDoc::Markup::Flow::P - body: Paths to search. + body: Exclude paths. + name: exclude + rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: File paths to search. name: files rw: RW - !ruby/object:RDoc::RI::Attribute @@ -12,6 +18,12 @@ attributes: body: Formats (xml, html, rdoc). name: formats rw: RW +- !ruby/object:RDoc::RI::Attribute + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Ignore paths based on any part of pathname. + name: ignore + rw: RW - !ruby/object:RDoc::RI::Attribute comment: - !ruby/struct:RDoc::Markup::Flow::P @@ -64,8 +76,13 @@ comment: body: By default this label supports the TODO, FIXME, OPTIMIZE and DEPRECATE. - !ruby/struct:RDoc::Markup::Flow::P body: Output is a set of files in HTML, XML and RDoc's simple markup format. This plugin can run automatically if there is a notes/ directory in the project's log directory. -constants: [] - +constants: +- !ruby/object:RDoc::RI::Constant + comment: + - !ruby/struct:RDoc::Markup::Flow::P + body: Default note labels to looked for in source code. + name: DEFAULT_LABELS + value: "['TODO', 'FIXME', 'OPTIMIZE', 'DEPRECATE']" full_name: Syckle::Plugins::DNote includes: [] diff --git a/ri/created.rid b/ri/created.rid index 0d6c585..fb5654c 100644 --- a/ri/created.rid +++ b/ri/created.rid @@ -1 +1 @@ -Thu, 11 Feb 2010 21:22:06 -0500 +Thu, 18 Feb 2010 11:54:08 -0500 From 9fe27dd41c7c0df1886912289cddb778394432b6 Mon Sep 17 00:00:00 2001 From: 7rans Date: Fri, 19 Feb 2010 08:29:38 -0500 Subject: [PATCH 21/27] Updated files. --- example.html | 29 +++-- example.xml | 44 +++---- example.yaml | 132 ++++++++++++-------- rdoc/classes/DNote/Format.html | 12 +- rdoc/classes/DNote/Format/ErbScope.html | 4 +- rdoc/classes/DNote/Notes.html | 24 ++-- rdoc/classes/DNote/Session.html | 8 +- rdoc/created.rid | 2 +- rdoc/files/LICENSE.html | 24 ++-- rdoc/files/README_rdoc.html | 46 ++++--- rdoc/files/lib/dnote/format_rb.html | 24 ++-- rdoc/files/lib/dnote/note_rb.html | 24 ++-- rdoc/files/lib/dnote/notes_rb.html | 24 ++-- rdoc/files/lib/dnote/session_rb.html | 24 ++-- rdoc/files/lib/dnote/string_rb.html | 24 ++-- rdoc/files/lib/dnote_rb.html | 24 ++-- rdoc/files/lib/plugins/syckle/dnote_rb.html | 24 ++-- rdoc/index.html | 68 +++++----- 18 files changed, 297 insertions(+), 264 deletions(-) diff --git a/example.html b/example.html index d24664c..3ce9218 100644 --- a/example.html +++ b/example.html @@ -33,21 +33,24 @@

    CREDIT

    TODO

      -
    1. lib/dnote/site.rb

        -
      1. Don't use chdir. 102
      2. -
    2. test/cases/notes_case.rb

        -
      1. Do something or another!", 1, "foo.rb" 37
      2. +
      3. Do something or another!", 1, "foo.rb" 27
      4. +
      5. Do something or another!", 1, "foo.rb" 34
    3. lib/dnote/notes.rb

        -
      1. Add ability to read header notes. They often -have a outline format, rather then the single line. 15
      2. +
      3. Add ability to read header notes. They often +have a outline format, rather then the single line. 16
      4. +
      5. Play gold with Notes#parse. 73
      6. should this be done? 79
      7. -
      8. ruby-1.9.1-p378 reports: notes.rb:131:in `match': invalid byte sequence in UTF-8 127
      9. +
      10. ruby-1.9.1-p378 reports: `match': invalid byte sequence in UTF-8 134
      11. +
      12. Would to_xoxo be better organized by label and or file? 254
    4. lib/plugins/syckle/dnote.rb

      1. Should this service be part of the +site+ cycle? 18
      2. -
      3. Is #trial? correct? 73
      4. +
      5. Is #trial? correct? 79
      6. +
    5. +
    6. work/site.rb

        +
      1. Don't use chdir. 102
    7. lib/dnote/format.rb

      1. Need good CSS file. 6
      2. @@ -57,20 +60,20 @@

        TODO

        TEST

        1. lib/dnote.rb

            -
          1. This is a test of arbitraty labels. 32
          2. +
          3. This is a test of arbitraty labels. 31

        NOTE

          -
        1. lib/dnote/command.rb

            -
          1. If DNote were a class. 124
          2. -
        2. lib/dnote.rb

            -
          1. Toying with the idea of making DNote a class. 7
          2. +
          3. Toying with the idea of making DNote a class. 6
        3. lib/dnote/string.rb

          1. This may still need a bit of tweaking. 17
        4. +
        5. work/command.rb

            +
          1. If DNote were a class. 139
          2. +
    diff --git a/example.xml b/example.xml index aefcac4..69a7874 100644 --- a/example.xml +++ b/example.xml @@ -1,49 +1,51 @@ - + - - - Don't use chdir. - + + - + + - - - If DNote were a class. + This is a test of arbitraty labels. + + + + If DNote were a class. + + diff --git a/example.yaml b/example.yaml index 1496dde..fa5d043 100644 --- a/example.yaml +++ b/example.yaml @@ -1,51 +1,83 @@ --- -CREDIT: - lib/dnote/string.rb: - - - 19 - - Trans - - - 37 - - Gavin Sinclair - - - 50 - - Gavin Sinclair - - - 51 - - Trans -TODO: - lib/dnote/site.rb: - - - 102 - - Don't use chdir. - test/cases/notes_case.rb: - - - 37 - - Do something or another!", 1, "foo.rb" - lib/dnote/notes.rb: - - - 15 - - |- - Add ability to read header notes. They often - have a outline format, rather then the single line. - - - 79 - - should this be done? - - - 127 - - "ruby-1.9.1-p378 reports: notes.rb:131:in `match': invalid byte sequence in UTF-8" - lib/plugins/syckle/dnote.rb: - - - 18 - - Should this service be part of the +site+ cycle? - - - 73 - - "Is #trial? correct?" - lib/dnote/format.rb: - - - 6 - - Need good CSS file. - - - 8 - - Need XSL? -TEST: - lib/dnote.rb: - - - 32 - - This is a test of arbitraty labels. -NOTE: - lib/dnote/command.rb: - - - 124 - - If DNote were a class. - lib/dnote.rb: - - - 7 - - Toying with the idea of making DNote a class. - lib/dnote/string.rb: - - - 17 - - This may still need a bit of tweaking. +- label: NOTE + line: 6 + text: Toying with the idea of making DNote a class. + file: lib/dnote.rb +- label: TEST + line: 31 + text: This is a test of arbitraty labels. + file: lib/dnote.rb +- label: TODO + line: 6 + text: Need good CSS file. + file: lib/dnote/format.rb +- label: TODO + line: 8 + text: Need XSL? + file: lib/dnote/format.rb +- label: TODO + line: 16 + text: |- + Add ability to read header notes. They often + have a outline format, rather then the single line. + file: lib/dnote/notes.rb +- label: TODO + line: 73 + text: Play gold with Notes#parse. + file: lib/dnote/notes.rb +- label: TODO + line: 79 + text: should this be done? + file: lib/dnote/notes.rb +- label: TODO + line: 134 + text: "ruby-1.9.1-p378 reports: `match': invalid byte sequence in UTF-8" + file: lib/dnote/notes.rb +- label: TODO + line: 254 + text: Would to_xoxo be better organized by label and or file? + file: lib/dnote/notes.rb +- label: NOTE + line: 17 + text: This may still need a bit of tweaking. + file: lib/dnote/string.rb +- label: CREDIT + line: 19 + text: Trans + file: lib/dnote/string.rb +- label: CREDIT + line: 37 + text: Gavin Sinclair + file: lib/dnote/string.rb +- label: CREDIT + line: 50 + text: Gavin Sinclair + file: lib/dnote/string.rb +- label: CREDIT + line: 51 + text: Trans + file: lib/dnote/string.rb +- label: TODO + line: 18 + text: Should this service be part of the +site+ cycle? + file: lib/plugins/syckle/dnote.rb +- label: TODO + line: 79 + text: "Is #trial? correct?" + file: lib/plugins/syckle/dnote.rb +- label: TODO + line: 27 + text: Do something or another!", 1, "foo.rb" + file: test/cases/notes_case.rb +- label: TODO + line: 34 + text: Do something or another!", 1, "foo.rb" + file: test/cases/notes_case.rb +- label: NOTE + line: 139 + text: If DNote were a class. + file: work/command.rb +- label: TODO + line: 102 + text: Don't use chdir. + file: work/site.rb diff --git a/rdoc/classes/DNote/Format.html b/rdoc/classes/DNote/Format.html index f928870..160958d 100644 --- a/rdoc/classes/DNote/Format.html +++ b/rdoc/classes/DNote/Format.html @@ -104,12 +104,12 @@

    Methods

  • - #debug? + #debug?
  • - #dryrun? + #dryrun?
  • @@ -119,7 +119,7 @@

    Methods

  • - #fu + #fu
  • @@ -541,7 +541,7 @@

    Private Instance Methods

    - +
    @@ -573,7 +573,7 @@

    Private Instance Methods

    - +
    @@ -638,7 +638,7 @@

    Private Instance Methods

    - +
    diff --git a/rdoc/classes/DNote/Format/ErbScope.html b/rdoc/classes/DNote/Format/ErbScope.html index 3812f20..38eeaa3 100644 --- a/rdoc/classes/DNote/Format/ErbScope.html +++ b/rdoc/classes/DNote/Format/ErbScope.html @@ -90,7 +90,7 @@

    Methods

  • - ::new + ::new
  • @@ -207,7 +207,7 @@

    Public Class Methods

    - +
    diff --git a/rdoc/classes/DNote/Notes.html b/rdoc/classes/DNote/Notes.html index 6cf0af1..fea7170 100644 --- a/rdoc/classes/DNote/Notes.html +++ b/rdoc/classes/DNote/Notes.html @@ -100,7 +100,7 @@

    Methods

  • - #by_file_label + #by_file_label
  • @@ -110,12 +110,12 @@

    Methods

  • - #by_label_file + #by_label_file
  • - #counts + #counts
  • @@ -125,7 +125,7 @@

    Methods

  • - #empty? + #empty?
  • @@ -155,12 +155,12 @@

    Methods

  • - #notes + #notes
  • - #parse + #parse
  • @@ -461,7 +461,7 @@

    Public Instance Methods

    - +
    @@ -547,7 +547,7 @@

    Public Instance Methods

    - +
    @@ -591,7 +591,7 @@

    Public Instance Methods

    - +
    @@ -665,7 +665,7 @@

    Public Instance Methods

    - +
    @@ -889,7 +889,7 @@

    Public Instance Methods

    - +
    @@ -923,7 +923,7 @@

    Public Instance Methods

    - +
    diff --git a/rdoc/classes/DNote/Session.html b/rdoc/classes/DNote/Session.html index a5ff2c2..5d54663 100644 --- a/rdoc/classes/DNote/Session.html +++ b/rdoc/classes/DNote/Session.html @@ -95,12 +95,12 @@

    Methods

  • - ::new + ::new
  • - #exclude= + #exclude=
  • @@ -626,7 +626,7 @@

    Public Class Methods

    - +
    @@ -669,7 +669,7 @@

    Public Instance Methods

    - +
    diff --git a/rdoc/created.rid b/rdoc/created.rid index b6bb81d..3c52b1d 100644 --- a/rdoc/created.rid +++ b/rdoc/created.rid @@ -1 +1 @@ -Thu, 18 Feb 2010 11:54:11 -0500 +Fri, 19 Feb 2010 08:29:15 -0500 diff --git a/rdoc/files/LICENSE.html b/rdoc/files/LICENSE.html index 7668edc..e7f318f 100644 --- a/rdoc/files/LICENSE.html +++ b/rdoc/files/LICENSE.html @@ -124,7 +124,7 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • @@ -148,7 +148,7 @@

    Method Index

  • DNote::Session - ::new + ::new
  • @@ -166,7 +166,7 @@

    Method Index

  • DNote::Notes - #by_file_label + #by_file_label
  • @@ -178,7 +178,7 @@

    Method Index

  • DNote::Notes - #by_label_file + #by_label_file
  • @@ -190,13 +190,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -208,7 +208,7 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • @@ -220,7 +220,7 @@

    Method Index

  • DNote::Notes - #empty? + #empty?
  • @@ -232,7 +232,7 @@

    Method Index

  • DNote::Session - #exclude= + #exclude=
  • @@ -244,7 +244,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -328,7 +328,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -340,7 +340,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • diff --git a/rdoc/files/README_rdoc.html b/rdoc/files/README_rdoc.html index 2505041..d92ec67 100644 --- a/rdoc/files/README_rdoc.html +++ b/rdoc/files/README_rdoc.html @@ -46,7 +46,7 @@

    File Stats

    Last Modified
    -
    Mon Feb 08 12:58:29 -0500 2010
    +
    Fri Feb 19 08:23:01 -0500 2010
    @@ -124,7 +124,7 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • @@ -148,7 +148,7 @@

    Method Index

  • DNote::Session - ::new + ::new
  • @@ -166,7 +166,7 @@

    Method Index

  • DNote::Notes - #by_file_label + #by_file_label
  • @@ -178,7 +178,7 @@

    Method Index

  • DNote::Notes - #by_label_file + #by_label_file
  • @@ -190,13 +190,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -208,7 +208,7 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • @@ -220,7 +220,7 @@

    Method Index

  • DNote::Notes - #empty? + #empty?
  • @@ -232,7 +232,7 @@

    Method Index

  • DNote::Session - #exclude= + #exclude=
  • @@ -244,7 +244,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -328,7 +328,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -340,7 +340,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • @@ -513,14 +513,7 @@

    Note Structure

    # LABEL: description ...

    -2) Specially designated notes can omit the colon. By default these are -TODO, FIXME and OPTIMIZE. -

    -
    -  # TODO description ...
    -
    -

    -3) Any note that requires more than one line must remain flush to the left +2) Any note that requires more than one line must remain flush to the left margin (the margin is set by the first line). This is done because RDoc will mistake the note for a &lt;pre&gt; block if it is indented. @@ -530,7 +523,7 @@

    Note Structure

    # continue ...

    -4) An alternative to the previous limitation is to indent the whole note, +3) An alternative to the previous limitation is to indent the whole note, making it a &lt;pre&gt; block when rendered by RDoc. Then the text layout is free-form.

    @@ -545,6 +538,11 @@

    Note Structure

    to recognize labels, we may eventually be able to relax the flush rule too, which would be very nice.

    +

    +There is also a command-line option, --no-colon, which deactives +the need for a colon after the note label. However this often produces +false positives, so it’s use is discouraged. +

    Generating Notes

    As you can see the commandline interface is pretty straight-forward. @@ -570,8 +568,8 @@

    Generating Notes

    -h, --help show this help information

    -The default path is */.rb and the default format is ---rdoc. Here is an example of DNote’s current notes in RDoc +The default path is */.rb and the default format is -f +rdoc. Here is an example of DNote’s current notes in RDoc format:

    diff --git a/rdoc/files/lib/dnote/format_rb.html b/rdoc/files/lib/dnote/format_rb.html
    index 0994483..cfb1f2b 100644
    --- a/rdoc/files/lib/dnote/format_rb.html
    +++ b/rdoc/files/lib/dnote/format_rb.html
    @@ -139,7 +139,7 @@ 

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • @@ -163,7 +163,7 @@

    Method Index

  • DNote::Session - ::new + ::new
  • @@ -181,7 +181,7 @@

    Method Index

  • DNote::Notes - #by_file_label + #by_file_label
  • @@ -193,7 +193,7 @@

    Method Index

  • DNote::Notes - #by_label_file + #by_label_file
  • @@ -205,13 +205,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -223,7 +223,7 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • @@ -235,7 +235,7 @@

    Method Index

  • DNote::Notes - #empty? + #empty?
  • @@ -247,7 +247,7 @@

    Method Index

  • DNote::Session - #exclude= + #exclude=
  • @@ -259,7 +259,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -343,7 +343,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -355,7 +355,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • diff --git a/rdoc/files/lib/dnote/note_rb.html b/rdoc/files/lib/dnote/note_rb.html index 1c016e6..c48f9a3 100644 --- a/rdoc/files/lib/dnote/note_rb.html +++ b/rdoc/files/lib/dnote/note_rb.html @@ -124,7 +124,7 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • @@ -148,7 +148,7 @@

    Method Index

  • DNote::Session - ::new + ::new
  • @@ -166,7 +166,7 @@

    Method Index

  • DNote::Notes - #by_file_label + #by_file_label
  • @@ -178,7 +178,7 @@

    Method Index

  • DNote::Notes - #by_label_file + #by_label_file
  • @@ -190,13 +190,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -208,7 +208,7 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • @@ -220,7 +220,7 @@

    Method Index

  • DNote::Notes - #empty? + #empty?
  • @@ -232,7 +232,7 @@

    Method Index

  • DNote::Session - #exclude= + #exclude=
  • @@ -244,7 +244,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -328,7 +328,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -340,7 +340,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • diff --git a/rdoc/files/lib/dnote/notes_rb.html b/rdoc/files/lib/dnote/notes_rb.html index 531591c..f575ff1 100644 --- a/rdoc/files/lib/dnote/notes_rb.html +++ b/rdoc/files/lib/dnote/notes_rb.html @@ -135,7 +135,7 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • @@ -159,7 +159,7 @@

    Method Index

  • DNote::Session - ::new + ::new
  • @@ -177,7 +177,7 @@

    Method Index

  • DNote::Notes - #by_file_label + #by_file_label
  • @@ -189,7 +189,7 @@

    Method Index

  • DNote::Notes - #by_label_file + #by_label_file
  • @@ -201,13 +201,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -219,7 +219,7 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • @@ -231,7 +231,7 @@

    Method Index

  • DNote::Notes - #empty? + #empty?
  • @@ -243,7 +243,7 @@

    Method Index

  • DNote::Session - #exclude= + #exclude=
  • @@ -255,7 +255,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -339,7 +339,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -351,7 +351,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • diff --git a/rdoc/files/lib/dnote/session_rb.html b/rdoc/files/lib/dnote/session_rb.html index bdc776b..a7a56d4 100644 --- a/rdoc/files/lib/dnote/session_rb.html +++ b/rdoc/files/lib/dnote/session_rb.html @@ -137,7 +137,7 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • @@ -161,7 +161,7 @@

    Method Index

  • DNote::Session - ::new + ::new
  • @@ -179,7 +179,7 @@

    Method Index

  • DNote::Notes - #by_file_label + #by_file_label
  • @@ -191,7 +191,7 @@

    Method Index

  • DNote::Notes - #by_label_file + #by_label_file
  • @@ -203,13 +203,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -221,7 +221,7 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • @@ -233,7 +233,7 @@

    Method Index

  • DNote::Notes - #empty? + #empty?
  • @@ -245,7 +245,7 @@

    Method Index

  • DNote::Session - #exclude= + #exclude=
  • @@ -257,7 +257,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -341,7 +341,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -353,7 +353,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • diff --git a/rdoc/files/lib/dnote/string_rb.html b/rdoc/files/lib/dnote/string_rb.html index dc9ec8c..ce9ce42 100644 --- a/rdoc/files/lib/dnote/string_rb.html +++ b/rdoc/files/lib/dnote/string_rb.html @@ -124,7 +124,7 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • @@ -148,7 +148,7 @@

    Method Index

  • DNote::Session - ::new + ::new
  • @@ -166,7 +166,7 @@

    Method Index

  • DNote::Notes - #by_file_label + #by_file_label
  • @@ -178,7 +178,7 @@

    Method Index

  • DNote::Notes - #by_label_file + #by_label_file
  • @@ -190,13 +190,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -208,7 +208,7 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • @@ -220,7 +220,7 @@

    Method Index

  • DNote::Notes - #empty? + #empty?
  • @@ -232,7 +232,7 @@

    Method Index

  • DNote::Session - #exclude= + #exclude=
  • @@ -244,7 +244,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -328,7 +328,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -340,7 +340,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • diff --git a/rdoc/files/lib/dnote_rb.html b/rdoc/files/lib/dnote_rb.html index 9d94fe3..315ae27 100644 --- a/rdoc/files/lib/dnote_rb.html +++ b/rdoc/files/lib/dnote_rb.html @@ -133,7 +133,7 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • @@ -157,7 +157,7 @@

    Method Index

  • DNote::Session - ::new + ::new
  • @@ -175,7 +175,7 @@

    Method Index

  • DNote::Notes - #by_file_label + #by_file_label
  • @@ -187,7 +187,7 @@

    Method Index

  • DNote::Notes - #by_label_file + #by_label_file
  • @@ -199,13 +199,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -217,7 +217,7 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • @@ -229,7 +229,7 @@

    Method Index

  • DNote::Notes - #empty? + #empty?
  • @@ -241,7 +241,7 @@

    Method Index

  • DNote::Session - #exclude= + #exclude=
  • @@ -253,7 +253,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -337,7 +337,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -349,7 +349,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • diff --git a/rdoc/files/lib/plugins/syckle/dnote_rb.html b/rdoc/files/lib/plugins/syckle/dnote_rb.html index 27d302a..9af050d 100644 --- a/rdoc/files/lib/plugins/syckle/dnote_rb.html +++ b/rdoc/files/lib/plugins/syckle/dnote_rb.html @@ -135,7 +135,7 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • @@ -159,7 +159,7 @@

    Method Index

  • DNote::Session - ::new + ::new
  • @@ -177,7 +177,7 @@

    Method Index

  • DNote::Notes - #by_file_label + #by_file_label
  • @@ -189,7 +189,7 @@

    Method Index

  • DNote::Notes - #by_label_file + #by_label_file
  • @@ -201,13 +201,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -219,7 +219,7 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • @@ -231,7 +231,7 @@

    Method Index

  • DNote::Notes - #empty? + #empty?
  • @@ -243,7 +243,7 @@

    Method Index

  • DNote::Session - #exclude= + #exclude=
  • @@ -255,7 +255,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -339,7 +339,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -351,7 +351,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • diff --git a/rdoc/index.html b/rdoc/index.html index 726581e..0f93fef 100644 --- a/rdoc/index.html +++ b/rdoc/index.html @@ -111,7 +111,7 @@

    Method Index

  • DNote::Format::ErbScope - ::new + ::new
  • @@ -135,7 +135,7 @@

    Method Index

  • DNote::Session - ::new + ::new
  • @@ -153,7 +153,7 @@

    Method Index

  • DNote::Notes - #by_file_label + #by_file_label
  • @@ -165,7 +165,7 @@

    Method Index

  • DNote::Notes - #by_label_file + #by_label_file
  • @@ -177,13 +177,13 @@

    Method Index

  • DNote::Notes - #counts + #counts
  • DNote::Format - #debug? + #debug?
  • @@ -195,7 +195,7 @@

    Method Index

  • DNote::Format - #dryrun? + #dryrun?
  • @@ -207,7 +207,7 @@

    Method Index

  • DNote::Notes - #empty? + #empty?
  • @@ -219,7 +219,7 @@

    Method Index

  • DNote::Session - #exclude= + #exclude=
  • @@ -231,7 +231,7 @@

    Method Index

  • DNote::Format - #fu + #fu
  • @@ -315,7 +315,7 @@

    Method Index

  • DNote::Notes - #notes + #notes
  • @@ -327,7 +327,7 @@

    Method Index

  • DNote::Notes - #parse + #parse
  • @@ -498,13 +498,13 @@

    Methods

  • ::main — DNote::Session
  • -
  • ::new — DNote::Format::ErbScope
  • +
  • ::new — DNote::Format::ErbScope
  • ::new — DNote::Format
  • ::new — DNote::Notes
  • -
  • ::new — DNote::Session
  • +
  • ::new — DNote::Session
  • ::new — DNote::Note
  • @@ -512,33 +512,33 @@

    Methods

  • #by_file — DNote::Notes
  • -
  • #by_file_label — DNote::Notes
  • +
  • #by_file_label — DNote::Notes
  • #by_label — DNote::Notes
  • -
  • #by_label_file — DNote::Notes
  • +
  • #by_label_file — DNote::Notes
  • #clean — Syckle::Plugins::DNote
  • -
  • #counts — DNote::Notes
  • +
  • #counts — DNote::Notes
  • -
  • #debug? — DNote::Format
  • +
  • #debug? — DNote::Format
  • #document — Syckle::Plugins::DNote
  • -
  • #dryrun? — DNote::Format
  • +
  • #dryrun? — DNote::Format
  • #each — DNote::Notes
  • -
  • #empty? — DNote::Notes
  • +
  • #empty? — DNote::Notes
  • #erb — DNote::Format
  • -
  • #exclude= — DNote::Session
  • +
  • #exclude= — DNote::Session
  • #files — DNote::Session
  • -
  • #fu — DNote::Format
  • +
  • #fu — DNote::Format
  • #glob — DNote::Session
  • @@ -566,11 +566,11 @@

    Methods

  • #method_missing — DNote::Format::ErbScope
  • -
  • #notes — DNote::Notes
  • +
  • #notes — DNote::Notes
  • #output= — Syckle::Plugins::DNote
  • -
  • #parse — DNote::Notes
  • +
  • #parse — DNote::Notes
  • #publish — DNote::Format
  • @@ -649,14 +649,7 @@

    Note Structure

    # LABEL: description ...

    -2) Specially designated notes can omit the colon. By default these are -TODO, FIXME and OPTIMIZE. -

    -
    -  # TODO description ...
    -
    -

    -3) Any note that requires more than one line must remain flush to the left +2) Any note that requires more than one line must remain flush to the left margin (the margin is set by the first line). This is done because RDoc will mistake the note for a &lt;pre&gt; block if it is indented. @@ -666,7 +659,7 @@

    Note Structure

    # continue ...

    -4) An alternative to the previous limitation is to indent the whole note, +3) An alternative to the previous limitation is to indent the whole note, making it a &lt;pre&gt; block when rendered by RDoc. Then the text layout is free-form.

    @@ -681,6 +674,11 @@

    Note Structure

    to recognize labels, we may eventually be able to relax the flush rule too, which would be very nice.

    +

    +There is also a command-line option, --no-colon, which deactives +the need for a colon after the note label. However this often produces +false positives, so it’s use is discouraged. +

    Generating Notes

    As you can see the commandline interface is pretty straight-forward. @@ -706,8 +704,8 @@

    Generating Notes

    -h, --help show this help information

    -The default path is */.rb and the default format is ---rdoc. Here is an example of DNote’s current notes in RDoc +The default path is */.rb and the default format is -f +rdoc. Here is an example of DNote’s current notes in RDoc format:

    
    From deae820f401621057a1f1011d45d45a2603b2896 Mon Sep 17 00:00:00 2001
    From: 7rans 
    Date: Fri, 13 May 2011 11:28:30 -0400
    Subject: [PATCH 22/27] Updated files.
    
    ---
     .rsync-filter                                 |    8 +
     assets/fork-me.png                            |  Bin 0 -> 7791 bytes
     assets/{images => }/logo.jpg                  |  Bin
     {rdoc/classes => docs/api}/DNote.html         |   79 +-
     docs/api/DNote/Format.html                    |  530 ++++++++
     .../api}/DNote/Format/ErbScope.html           |  123 +-
     docs/api/DNote/Note.html                      |  800 +++++++++++
     docs/api/DNote/Notes.html                     | 1181 +++++++++++++++++
     docs/api/DNote/Session.html                   |  847 ++++++++++++
     docs/api/DNoteTask.html                       |  586 ++++++++
     docs/api/Enumerable.html                      |  242 ++++
     docs/api/LICENSE_txt.html                     |  713 ++++++++++
     docs/api/README_rdoc.html                     |  636 +++++++++
     .../Plugins.html => docs/api/Redline.html     |   74 +-
     .../api/Redline/Plugins.html                  |   54 +-
     docs/api/Redline/Plugins/DNote.html           |  547 ++++++++
     {rdoc/classes => docs/api}/Xacto.html         |   69 +-
     docs/api/Xacto/String.html                    |  350 +++++
     {rdoc => docs/api}/assets/favicon.ico         |  Bin
     .../api}/assets/highlight/AUTHORS.en.txt      |    0
     .../api}/assets/highlight/AUTHORS.ru.txt      |    0
     {rdoc => docs/api}/assets/highlight/LICENSE   |    0
     .../api}/assets/highlight/export.html         |    0
     .../api}/assets/highlight/highlight.js        |    0
     .../api}/assets/highlight/highlight.pack.js   |    0
     .../api}/assets/highlight/languages/1c.js     |    0
     .../api}/assets/highlight/languages/apache.js |    0
     .../api}/assets/highlight/languages/avrasm.js |    0
     .../api}/assets/highlight/languages/axapta.js |    0
     .../api}/assets/highlight/languages/bash.js   |    0
     .../api}/assets/highlight/languages/cpp.js    |    0
     .../api}/assets/highlight/languages/cs.js     |    0
     .../api}/assets/highlight/languages/css.js    |    0
     .../api}/assets/highlight/languages/delphi.js |    0
     .../api}/assets/highlight/languages/diff.js   |    0
     .../api}/assets/highlight/languages/django.js |    0
     .../api}/assets/highlight/languages/dos.js    |    0
     .../assets/highlight/languages/html-xml.js    |    0
     .../api}/assets/highlight/languages/ini.js    |    0
     .../api}/assets/highlight/languages/java.js   |    0
     .../assets/highlight/languages/javascript.js  |    0
     .../api}/assets/highlight/languages/lisp.js   |    0
     .../api}/assets/highlight/languages/mel.js    |    0
     .../assets/highlight/languages/parser3.js     |    0
     .../api}/assets/highlight/languages/perl.js   |    0
     .../api}/assets/highlight/languages/php.js    |    0
     .../assets/highlight/languages/profile.js     |    0
     .../api}/assets/highlight/languages/python.js |    0
     .../assets/highlight/languages/renderman.js   |    0
     .../api}/assets/highlight/languages/ruby.js   |    0
     .../assets/highlight/languages/smalltalk.js   |    0
     .../api}/assets/highlight/languages/sql.js    |    0
     .../assets/highlight/languages/vbscript.js    |    0
     .../api}/assets/highlight/readme.eng.txt      |    0
     .../api}/assets/highlight/readme.rus.txt      |    0
     .../api}/assets/highlight/styles/ascetic.css  |    0
     .../assets/highlight/styles/brown_paper.css   |    0
     .../assets/highlight/styles/brown_papersq.png |  Bin
     .../api}/assets/highlight/styles/dark.css     |    0
     .../api}/assets/highlight/styles/default.css  |    0
     .../api}/assets/highlight/styles/far.css      |    0
     .../api}/assets/highlight/styles/github.css   |    0
     .../api}/assets/highlight/styles/idea.css     |    0
     .../api}/assets/highlight/styles/ir_black.css |    0
     .../api}/assets/highlight/styles/magula.css   |    0
     .../api}/assets/highlight/styles/rubylang.css |    0
     .../assets/highlight/styles/school_book.css   |    0
     .../assets/highlight/styles/school_book.png   |  Bin
     .../api}/assets/highlight/styles/sunburst.css |    0
     .../api}/assets/highlight/styles/vs.css       |    0
     .../api}/assets/highlight/styles/zenburn.css  |    0
     {rdoc => docs/api}/assets/highlight/test.html |    0
     .../api}/assets/highlight/wp_highlight.js.php |    0
     docs/api/assets/icon/alias.png                |  Bin 0 -> 583 bytes
     {rdoc => docs/api}/assets/icon/attribute.png  |  Bin
     {rdoc => docs/api}/assets/icon/bug.png        |  Bin
     {rdoc => docs/api}/assets/icon/bullet.png     |  Bin
     .../api}/assets/icon/bullet_minus.png         |  Bin
     .../api}/assets/icon/bullet_plus.png          |  Bin
     {rdoc => docs/api}/assets/icon/check.png      |  Bin
     {rdoc => docs/api}/assets/icon/class.png      |  Bin
     {rdoc => docs/api}/assets/icon/date.png       |  Bin
     {rdoc => docs/api}/assets/icon/file.png       |  Bin
     {rdoc => docs/api}/assets/icon/find.png       |  Bin
     {rdoc => docs/api}/assets/icon/fixme.png      |  Bin
     {rdoc => docs/api}/assets/icon/list.png       |  Bin
     {rdoc => docs/api}/assets/icon/loading.gif    |  Bin
     docs/api/assets/icon/method.png               |  Bin 0 -> 582 bytes
     {rdoc => docs/api}/assets/icon/module.png     |  Bin
     {rdoc => docs/api}/assets/icon/page.png       |  Bin
     {rdoc => docs/api}/assets/icon/plugin.png     |  Bin
     {rdoc => docs/api}/assets/icon/project.png    |  Bin
     {rdoc => docs/api}/assets/icon/ruby.png       |  Bin
     docs/api/assets/icon/singleton.png            |  Bin 0 -> 507 bytes
     {rdoc => docs/api}/assets/icon/stat.png       |  Bin
     {rdoc => docs/api}/assets/icon/tool.png       |  Bin
     {rdoc => docs/api}/assets/icon/zoom.png       |  Bin
     {rdoc => docs/api}/assets/jquery.js           |    0
     {rdoc => docs/api}/assets/main.js             |   10 +-
     {rdoc => docs/api}/assets/quicksearch.js      |    0
     {rdoc => docs/api}/assets/rdoc.css            |   99 +-
     {rdoc => docs/api}/assets/ruby.png            |  Bin
     docs/api/created.rid                          |   13 +
     docs/api/index.html                           |  627 +++++++++
     docs/api/lib/dnote/core_ext_rb.html           |  511 +++++++
     docs/api/lib/dnote/format_rb.html             |  526 ++++++++
     .../api/lib/dnote/note_rb.html                |  230 ++--
     .../api}/lib/dnote/notes_rb.html              |  239 ++--
     .../api/lib/dnote/session_rb.html             |  247 ++--
     .../api}/lib/dnote/string_rb.html             |  237 ++--
     docs/api/lib/dnote/version_rb.html            |  511 +++++++
     .../api/lib/dnote_rb.html                     |  262 ++--
     .../api/lib/plugins/rake/task_rb.html         |  231 ++--
     .../api/lib/plugins/redline/dnote_rb.html     |  225 ++--
     index.html                                    |   66 +-
     log/dnote/index.html                          |  100 ++
     log/stats/index.html                          |   39 +
     log/stats/stats.txt                           |   14 +
     rdoc/assets/icon/alias.png                    |  Bin 764 -> 0 bytes
     rdoc/assets/icon/method.png                   |  Bin 452 -> 0 bytes
     rdoc/assets/icon/singleton.png                |  Bin 829 -> 0 bytes
     rdoc/classes/DNote/Format.html                |  780 -----------
     rdoc/classes/DNote/Note.html                  |  616 ---------
     rdoc/classes/DNote/Notes.html                 | 1074 ---------------
     rdoc/classes/DNote/Session.html               |  925 -------------
     rdoc/classes/String.html                      |  191 ---
     rdoc/classes/Syckle/Plugins/DNote.html        |  610 ---------
     rdoc/classes/Xacto/String.html                |  353 -----
     rdoc/created.rid                              |    1 -
     rdoc/files/README_rdoc.html                   |  622 ---------
     rdoc/files/lib/dnote/note_rb.html             |  486 -------
     rdoc/index.html                               |  759 -----------
     ri/DNote/Format/ErbScope/cdesc-ErbScope.yaml  |   22 -
     ri/DNote/Format/ErbScope/h-i.yaml             |   11 -
     .../Format/ErbScope/method_missing-i.yaml     |   11 -
     ri/DNote/Format/ErbScope/new-c.yaml           |   11 -
     ri/DNote/Format/ErbScope/render-i.yaml        |   11 -
     ri/DNote/Format/cdesc-Format.yaml             |   80 --
     ri/DNote/Format/debug%3f-i.yaml               |   11 -
     ri/DNote/Format/dryrun%3f-i.yaml              |   11 -
     ri/DNote/Format/erb-i.yaml                    |   11 -
     ri/DNote/Format/fu-i.yaml                     |   11 -
     ri/DNote/Format/new-c.yaml                    |   11 -
     ri/DNote/Format/publish-i.yaml                |   11 -
     ri/DNote/Format/render-i.yaml                 |   11 -
     ri/DNote/Format/render_custom-i.yaml          |   11 -
     ri/DNote/Format/render_template-i.yaml        |   11 -
     ri/DNote/Format/write-i.yaml                  |   11 -
     ri/DNote/Note/%3c%3d%3e-i.yaml                |   12 -
     ri/DNote/Note/cdesc-Note.yaml                 |   47 -
     ri/DNote/Note/new-c.yaml                      |   10 -
     ri/DNote/Note/textline-i.yaml                 |   11 -
     ri/DNote/Note/to_h-i.yaml                     |   10 -
     ri/DNote/Note/to_h_raw-i.yaml                 |   10 -
     ri/DNote/Note/to_json-i.yaml                  |   10 -
     ri/DNote/Note/to_s-i.yaml                     |   11 -
     ri/DNote/Note/to_str-i.yaml                   |   11 -
     ri/DNote/Note/to_yaml-i.yaml                  |   10 -
     ri/DNote/Notes/by_file-i.yaml                 |   12 -
     ri/DNote/Notes/by_file_label-i.yaml           |   12 -
     ri/DNote/Notes/by_label-i.yaml                |   12 -
     ri/DNote/Notes/by_label_file-i.yaml           |   12 -
     ri/DNote/Notes/cdesc-Notes.yaml               |   92 --
     ri/DNote/Notes/counts-i.yaml                  |   12 -
     ri/DNote/Notes/each-i.yaml                    |   12 -
     ri/DNote/Notes/empty%3f-i.yaml                |   12 -
     ri/DNote/Notes/match-i.yaml                   |   11 -
     ri/DNote/Notes/match_general-i.yaml           |   12 -
     ri/DNote/Notes/match_general_regex-i.yaml     |   11 -
     ri/DNote/Notes/match_special-i.yaml           |   12 -
     ri/DNote/Notes/match_special_regex-i.yaml     |   10 -
     ri/DNote/Notes/new-c.yaml                     |   12 -
     ri/DNote/Notes/notes-i.yaml                   |   12 -
     ri/DNote/Notes/parse-i.yaml                   |   12 -
     ri/DNote/Notes/to_a-i.yaml                    |   12 -
     ri/DNote/Notes/to_h-i.yaml                    |   12 -
     ri/DNote/Session/cdesc-Session.yaml           |  115 --
     ri/DNote/Session/exclude%3d-i.yaml            |   12 -
     ri/DNote/Session/files-i.yaml                 |   12 -
     ri/DNote/Session/glob-i.yaml                  |   12 -
     ri/DNote/Session/ignore%3d-i.yaml             |   12 -
     ri/DNote/Session/initialize_defaults-i.yaml   |   12 -
     ri/DNote/Session/main-c.yaml                  |   12 -
     ri/DNote/Session/new-c.yaml                   |   12 -
     ri/DNote/Session/run-i.yaml                   |   12 -
     ri/DNote/cdesc-DNote.yaml                     |   17 -
     ri/String/cdesc-String.yaml                   |   15 -
     ri/Syckle/Plugins/DNote/cdesc-DNote.yaml      |  101 --
     ri/Syckle/Plugins/DNote/clean-i.yaml          |   12 -
     ri/Syckle/Plugins/DNote/document-i.yaml       |   12 -
     .../Plugins/DNote/initialize_defaults-i.yaml  |   11 -
     ri/Syckle/Plugins/DNote/output%3d-i.yaml      |   11 -
     ri/Syckle/Plugins/DNote/reset-i.yaml          |   12 -
     ri/Syckle/Plugins/cdesc-Plugins.yaml          |   14 -
     ri/Syckle/cdesc-Syckle.yaml                   |   14 -
     ri/Xacto/String/cdesc-String.yaml             |   25 -
     ri/Xacto/String/indent-i.yaml                 |   14 -
     ri/Xacto/String/margin-i.yaml                 |   14 -
     ri/Xacto/String/tabto-i.yaml                  |   14 -
     ri/Xacto/cdesc-Xacto.yaml                     |   15 -
     ri/created.rid                                |    1 -
     201 files changed, 9997 insertions(+), 8649 deletions(-)
     create mode 100644 .rsync-filter
     create mode 100644 assets/fork-me.png
     rename assets/{images => }/logo.jpg (100%)
     rename {rdoc/classes => docs/api}/DNote.html (57%)
     create mode 100644 docs/api/DNote/Format.html
     rename {rdoc/classes => docs/api}/DNote/Format/ErbScope.html (54%)
     create mode 100644 docs/api/DNote/Note.html
     create mode 100644 docs/api/DNote/Notes.html
     create mode 100644 docs/api/DNote/Session.html
     create mode 100644 docs/api/DNoteTask.html
     create mode 100644 docs/api/Enumerable.html
     create mode 100644 docs/api/LICENSE_txt.html
     create mode 100644 docs/api/README_rdoc.html
     rename rdoc/classes/Syckle/Plugins.html => docs/api/Redline.html (51%)
     rename rdoc/classes/Syckle.html => docs/api/Redline/Plugins.html (64%)
     create mode 100644 docs/api/Redline/Plugins/DNote.html
     rename {rdoc/classes => docs/api}/Xacto.html (56%)
     create mode 100644 docs/api/Xacto/String.html
     rename {rdoc => docs/api}/assets/favicon.ico (100%)
     rename {rdoc => docs/api}/assets/highlight/AUTHORS.en.txt (100%)
     rename {rdoc => docs/api}/assets/highlight/AUTHORS.ru.txt (100%)
     rename {rdoc => docs/api}/assets/highlight/LICENSE (100%)
     rename {rdoc => docs/api}/assets/highlight/export.html (100%)
     rename {rdoc => docs/api}/assets/highlight/highlight.js (100%)
     rename {rdoc => docs/api}/assets/highlight/highlight.pack.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/1c.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/apache.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/avrasm.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/axapta.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/bash.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/cpp.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/cs.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/css.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/delphi.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/diff.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/django.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/dos.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/html-xml.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/ini.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/java.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/javascript.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/lisp.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/mel.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/parser3.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/perl.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/php.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/profile.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/python.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/renderman.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/ruby.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/smalltalk.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/sql.js (100%)
     rename {rdoc => docs/api}/assets/highlight/languages/vbscript.js (100%)
     rename {rdoc => docs/api}/assets/highlight/readme.eng.txt (100%)
     rename {rdoc => docs/api}/assets/highlight/readme.rus.txt (100%)
     rename {rdoc => docs/api}/assets/highlight/styles/ascetic.css (100%)
     rename {rdoc => docs/api}/assets/highlight/styles/brown_paper.css (100%)
     rename {rdoc => docs/api}/assets/highlight/styles/brown_papersq.png (100%)
     rename {rdoc => docs/api}/assets/highlight/styles/dark.css (100%)
     rename {rdoc => docs/api}/assets/highlight/styles/default.css (100%)
     rename {rdoc => docs/api}/assets/highlight/styles/far.css (100%)
     rename {rdoc => docs/api}/assets/highlight/styles/github.css (100%)
     rename {rdoc => docs/api}/assets/highlight/styles/idea.css (100%)
     rename {rdoc => docs/api}/assets/highlight/styles/ir_black.css (100%)
     rename {rdoc => docs/api}/assets/highlight/styles/magula.css (100%)
     rename {rdoc => docs/api}/assets/highlight/styles/rubylang.css (100%)
     rename {rdoc => docs/api}/assets/highlight/styles/school_book.css (100%)
     rename {rdoc => docs/api}/assets/highlight/styles/school_book.png (100%)
     rename {rdoc => docs/api}/assets/highlight/styles/sunburst.css (100%)
     rename {rdoc => docs/api}/assets/highlight/styles/vs.css (100%)
     rename {rdoc => docs/api}/assets/highlight/styles/zenburn.css (100%)
     rename {rdoc => docs/api}/assets/highlight/test.html (100%)
     rename {rdoc => docs/api}/assets/highlight/wp_highlight.js.php (100%)
     create mode 100644 docs/api/assets/icon/alias.png
     rename {rdoc => docs/api}/assets/icon/attribute.png (100%)
     rename {rdoc => docs/api}/assets/icon/bug.png (100%)
     rename {rdoc => docs/api}/assets/icon/bullet.png (100%)
     rename {rdoc => docs/api}/assets/icon/bullet_minus.png (100%)
     rename {rdoc => docs/api}/assets/icon/bullet_plus.png (100%)
     rename {rdoc => docs/api}/assets/icon/check.png (100%)
     rename {rdoc => docs/api}/assets/icon/class.png (100%)
     rename {rdoc => docs/api}/assets/icon/date.png (100%)
     rename {rdoc => docs/api}/assets/icon/file.png (100%)
     rename {rdoc => docs/api}/assets/icon/find.png (100%)
     rename {rdoc => docs/api}/assets/icon/fixme.png (100%)
     rename {rdoc => docs/api}/assets/icon/list.png (100%)
     rename {rdoc => docs/api}/assets/icon/loading.gif (100%)
     create mode 100644 docs/api/assets/icon/method.png
     rename {rdoc => docs/api}/assets/icon/module.png (100%)
     rename {rdoc => docs/api}/assets/icon/page.png (100%)
     rename {rdoc => docs/api}/assets/icon/plugin.png (100%)
     rename {rdoc => docs/api}/assets/icon/project.png (100%)
     rename {rdoc => docs/api}/assets/icon/ruby.png (100%)
     create mode 100644 docs/api/assets/icon/singleton.png
     rename {rdoc => docs/api}/assets/icon/stat.png (100%)
     rename {rdoc => docs/api}/assets/icon/tool.png (100%)
     rename {rdoc => docs/api}/assets/icon/zoom.png (100%)
     rename {rdoc => docs/api}/assets/jquery.js (100%)
     rename {rdoc => docs/api}/assets/main.js (91%)
     rename {rdoc => docs/api}/assets/quicksearch.js (100%)
     rename {rdoc => docs/api}/assets/rdoc.css (89%)
     rename {rdoc => docs/api}/assets/ruby.png (100%)
     create mode 100644 docs/api/created.rid
     create mode 100644 docs/api/index.html
     create mode 100644 docs/api/lib/dnote/core_ext_rb.html
     create mode 100644 docs/api/lib/dnote/format_rb.html
     rename rdoc/files/lib/dnote_rb.html => docs/api/lib/dnote/note_rb.html (62%)
     rename {rdoc/files => docs/api}/lib/dnote/notes_rb.html (57%)
     rename rdoc/files/lib/plugins/syckle/dnote_rb.html => docs/api/lib/dnote/session_rb.html (57%)
     rename {rdoc/files => docs/api}/lib/dnote/string_rb.html (57%)
     create mode 100644 docs/api/lib/dnote/version_rb.html
     rename rdoc/files/LICENSE.html => docs/api/lib/dnote_rb.html (61%)
     rename rdoc/files/lib/dnote/format_rb.html => docs/api/lib/plugins/rake/task_rb.html (61%)
     rename rdoc/files/lib/dnote/session_rb.html => docs/api/lib/plugins/redline/dnote_rb.html (61%)
     create mode 100644 log/dnote/index.html
     create mode 100644 log/stats/index.html
     create mode 100644 log/stats/stats.txt
     delete mode 100644 rdoc/assets/icon/alias.png
     delete mode 100644 rdoc/assets/icon/method.png
     delete mode 100644 rdoc/assets/icon/singleton.png
     delete mode 100644 rdoc/classes/DNote/Format.html
     delete mode 100644 rdoc/classes/DNote/Note.html
     delete mode 100644 rdoc/classes/DNote/Notes.html
     delete mode 100644 rdoc/classes/DNote/Session.html
     delete mode 100644 rdoc/classes/String.html
     delete mode 100644 rdoc/classes/Syckle/Plugins/DNote.html
     delete mode 100644 rdoc/classes/Xacto/String.html
     delete mode 100644 rdoc/created.rid
     delete mode 100644 rdoc/files/README_rdoc.html
     delete mode 100644 rdoc/files/lib/dnote/note_rb.html
     delete mode 100644 rdoc/index.html
     delete mode 100644 ri/DNote/Format/ErbScope/cdesc-ErbScope.yaml
     delete mode 100644 ri/DNote/Format/ErbScope/h-i.yaml
     delete mode 100644 ri/DNote/Format/ErbScope/method_missing-i.yaml
     delete mode 100644 ri/DNote/Format/ErbScope/new-c.yaml
     delete mode 100644 ri/DNote/Format/ErbScope/render-i.yaml
     delete mode 100644 ri/DNote/Format/cdesc-Format.yaml
     delete mode 100644 ri/DNote/Format/debug%3f-i.yaml
     delete mode 100644 ri/DNote/Format/dryrun%3f-i.yaml
     delete mode 100644 ri/DNote/Format/erb-i.yaml
     delete mode 100644 ri/DNote/Format/fu-i.yaml
     delete mode 100644 ri/DNote/Format/new-c.yaml
     delete mode 100644 ri/DNote/Format/publish-i.yaml
     delete mode 100644 ri/DNote/Format/render-i.yaml
     delete mode 100644 ri/DNote/Format/render_custom-i.yaml
     delete mode 100644 ri/DNote/Format/render_template-i.yaml
     delete mode 100644 ri/DNote/Format/write-i.yaml
     delete mode 100644 ri/DNote/Note/%3c%3d%3e-i.yaml
     delete mode 100644 ri/DNote/Note/cdesc-Note.yaml
     delete mode 100644 ri/DNote/Note/new-c.yaml
     delete mode 100644 ri/DNote/Note/textline-i.yaml
     delete mode 100644 ri/DNote/Note/to_h-i.yaml
     delete mode 100644 ri/DNote/Note/to_h_raw-i.yaml
     delete mode 100644 ri/DNote/Note/to_json-i.yaml
     delete mode 100644 ri/DNote/Note/to_s-i.yaml
     delete mode 100644 ri/DNote/Note/to_str-i.yaml
     delete mode 100644 ri/DNote/Note/to_yaml-i.yaml
     delete mode 100644 ri/DNote/Notes/by_file-i.yaml
     delete mode 100644 ri/DNote/Notes/by_file_label-i.yaml
     delete mode 100644 ri/DNote/Notes/by_label-i.yaml
     delete mode 100644 ri/DNote/Notes/by_label_file-i.yaml
     delete mode 100644 ri/DNote/Notes/cdesc-Notes.yaml
     delete mode 100644 ri/DNote/Notes/counts-i.yaml
     delete mode 100644 ri/DNote/Notes/each-i.yaml
     delete mode 100644 ri/DNote/Notes/empty%3f-i.yaml
     delete mode 100644 ri/DNote/Notes/match-i.yaml
     delete mode 100644 ri/DNote/Notes/match_general-i.yaml
     delete mode 100644 ri/DNote/Notes/match_general_regex-i.yaml
     delete mode 100644 ri/DNote/Notes/match_special-i.yaml
     delete mode 100644 ri/DNote/Notes/match_special_regex-i.yaml
     delete mode 100644 ri/DNote/Notes/new-c.yaml
     delete mode 100644 ri/DNote/Notes/notes-i.yaml
     delete mode 100644 ri/DNote/Notes/parse-i.yaml
     delete mode 100644 ri/DNote/Notes/to_a-i.yaml
     delete mode 100644 ri/DNote/Notes/to_h-i.yaml
     delete mode 100644 ri/DNote/Session/cdesc-Session.yaml
     delete mode 100644 ri/DNote/Session/exclude%3d-i.yaml
     delete mode 100644 ri/DNote/Session/files-i.yaml
     delete mode 100644 ri/DNote/Session/glob-i.yaml
     delete mode 100644 ri/DNote/Session/ignore%3d-i.yaml
     delete mode 100644 ri/DNote/Session/initialize_defaults-i.yaml
     delete mode 100644 ri/DNote/Session/main-c.yaml
     delete mode 100644 ri/DNote/Session/new-c.yaml
     delete mode 100644 ri/DNote/Session/run-i.yaml
     delete mode 100644 ri/DNote/cdesc-DNote.yaml
     delete mode 100644 ri/String/cdesc-String.yaml
     delete mode 100644 ri/Syckle/Plugins/DNote/cdesc-DNote.yaml
     delete mode 100644 ri/Syckle/Plugins/DNote/clean-i.yaml
     delete mode 100644 ri/Syckle/Plugins/DNote/document-i.yaml
     delete mode 100644 ri/Syckle/Plugins/DNote/initialize_defaults-i.yaml
     delete mode 100644 ri/Syckle/Plugins/DNote/output%3d-i.yaml
     delete mode 100644 ri/Syckle/Plugins/DNote/reset-i.yaml
     delete mode 100644 ri/Syckle/Plugins/cdesc-Plugins.yaml
     delete mode 100644 ri/Syckle/cdesc-Syckle.yaml
     delete mode 100644 ri/Xacto/String/cdesc-String.yaml
     delete mode 100644 ri/Xacto/String/indent-i.yaml
     delete mode 100644 ri/Xacto/String/margin-i.yaml
     delete mode 100644 ri/Xacto/String/tabto-i.yaml
     delete mode 100644 ri/Xacto/cdesc-Xacto.yaml
     delete mode 100644 ri/created.rid
    
    diff --git a/.rsync-filter b/.rsync-filter
    new file mode 100644
    index 0000000..62c9380
    --- /dev/null
    +++ b/.rsync-filter
    @@ -0,0 +1,8 @@
    +- .svn
    +- scrap
    +P wiki
    +P robot.txt
    +P robots.txt
    +P statcvs
    +P statsvn
    +P usage
    diff --git a/assets/fork-me.png b/assets/fork-me.png
    new file mode 100644
    index 0000000000000000000000000000000000000000..146ef8a800602169cf78c686fc5a6d138a76bc0a
    GIT binary patch
    literal 7791
    zcmV-#9+2UQP)O>+M%?x9Q-Aclg+SU{aR>iZ-V5ENM}s?g?o3TCz>p076pgIvo9@XSFn67!Z(L}aTexp
    zAcOn{GYF{63{x3Y|KXge7Rgs|WVGqumV|_UKRatZba(eaMP)S%4i5UolZ=m#gN&6H
    zmI^z-ZZEFv>uz~$@a{kh`_f(c8kBDZWBCYFpnBH^sV@HRRs-u`N=owgva>frJ9_~y
    z=NB-xxa}8DG&D36Hs@wTUtd2CdUUM)X%#d;KqN)YP2#
    z_^;<-cz77hCZpdx(Ob7}LG_JVh>MGXRhb#7OC#dmSQNY@PELi3`5Qx|LfHxOUyn#Cxw_JmE!)7C}zd2I%VPfy&CNs?N3sbt=3g7;AQ!
    zieJO>w_x=xDdui%V$*mbN0Lu~sdb3uD_gP4P(_*Zq
    z#wHuqu7V6fVDh7K!<{>KprN4&EU77wlbw|o9cL2a-N#JjF=K^CL@>sZ$_=F@<#g*0
    z5wnaX3v>g(;b-KeR9gt$0Zy*d+o_XgKjL$uM`*AKXdnQlpi
    zT|4tENoI=>?>=TKj~Q!8NT@Y?<9g_38mqjbimLE410?Cj>F$B+wm9*5FHcB-j0_93
    zw6sEzv{xt?%a@?SpI5yzrwlB!*=*gkDGNGT%E`ZS75e*cc^6O`Fu8@53S7!_4hdNT
    zn4)npQC?9|-Q=jY3SiBA`cngI+NrRvuFm$i^Pe%68Ud5hI75JPDpciks$X)t+`Z~p
    zq^+&1hs4C?ux9n@)Ue2SQEu=hQ>lJt+Kjax#sH;0M#J}4|I@o=xu2~MXv^(nyF
    z^T0P@?V8na=-DIuRi}sPj;(mPA#1}r=<3E4T~XED(Im(TS9Kynu
    zf+cN**8t_@fMU0M?*AqnJ^Ty->*(P_3R#W8R=nI$?`R;6wR6Yzv_xZ?5bwTZDsM0r
    z?iJ=_Z-5@AWf(Egi#pwuCp|Xl6Av&TJ$K|;`bvGhgX&~w-~BaXtfTUCHK>?tbi~HS
    zP@^CAi4~WW3i0kMrt$`3(OzLgBe7L(ZWg7Vsju~%08VAqrv}uIpZO_#?duOfQBg5t
    ztZ%`AeUIqa%KdBJ+S*1fJV{B3khg8C*emoks5}MMjp`e=4?g@DhKGhBCD}A3mePQW
    zJp?tN&R_Tp&Yt}>?fE^lcR!pv_b0|yzZnxq`snZPr%sFTh;T@^q=~&kU#35ArNV@S
    z1Zyseca{nZt`$xo-c?%4De(?zs3Xs4Qr9j26r
    zpU1R?fWkERAk$MAXaD;*(9_+kVk_w(8r+l@^bsB&25VQZg7%IM(daiDpz;J*k_rcU6DNNu@sIpCw=+<^_R32T!2pIq`s$JW
    zU@s~e4J>Wp-7UzXqn82J*LwT<;Cf+EwWGFT-dEmz3My}u8+akIth_?^xAhft(3BLM
    zGK0PK<|zWy3&(y=I_v0>|0L#m;s*y^#ZQB*x6~jqi~%luI*Ex1bcnXCwVkaH3+Fv!
    z`5aW90?TMJT61%|EjKSMh7ezOdx~n%$p}E{h`J}!H)6Khkt+w#%S5OI}~m*
    zxD)JSSKTp|EV&1;7auzv%F8RNnj3G-Tk#$=8-LUj@$RU1*gpOI5{!(Du+?0W9(U~lm(N@A9yD8j*b`vgY-+Myy;cOvS=!mUc@u5zj1Me{buiuGzTbVjzeIq-l^|-W
    z7mmHm0JR$4I(?EZiQPsBP^in^{N?K;$j1W~KAqayI{4H39}wWvEta(Tx(OXLn}6IB
    zVDJenFJwla$pQz*zA0NxWo=&S(
    zdvVFU67PNiDo=rxl9EEe>gec#OZit+2UhjMUFlemR)Z2NA)rXSzaxov{P^uNZ%BYT
    zi-0=J9!=1cK!t%l?@}-REhs51MN^P@QEmwGmj~iWDy*rgvHj)a^Ds0tq%#E>od&sZ
    zkBo?b*Is#10hBD>^?<^!8R>UAVX}LKJo;}9K-G;}h>eYg%#4hAvsdUhOyv#6ii?Yr
    z_6qy^;QDntrNr?{4Oq9r>m66cJ&aNz0*V(#5oCD#@FNGnZZDazsn1;m2L}T(X*V_c
    zRR+8%h~I(A6JSNfm>)NpOxDcIm2#^}(Zt13xrT*W3R58h3I#mgVyOY|V@(VJRm84Q
    z757O3%b1i1n{qbN@vqDISE`yDYXTNnehDgXRNiwpWl?uSd1V#cVrgh1V7+?$80_Bt
    zC8;%rf#|^gN8t;9e;?F49I9FusC1PArpbaUDk>6It;&Fo_73z$4OsE+x1jPASgC1g
    zR_;!G>0&+%4h^|q70S;6SB2QL_xed2{QkFR>GNOv#vWCbT@50G4nKw|0SkS*a8tan
    z$R3b;g+cy|cu&N8bybyO3X+;Ks*a^zy&-l{f1NmWnhAXqr9P~@8`J<%fe=qIQ|~)J
    znKMDPT^*>aii^w0w<}OhLHrt2o&u|{x5viaiSON&H>&ckN?w}%z9M@uocqI{rIcsT
    z$}$x8SP;d76TCFRb=hQqh1GWK#ro?f7s!Wn!-jR1xaG+KwWZ_N>CaoKFfl2~%H4^J
    zi%a!SVANq#lQ9YE>K&TzA%TnDXf
    z9q{?ZO98Vg^n0fA24gigG}!X5T!Z+ySSm(hQBqUNGH4_>F^R#TNq#IPDuBWsElgui
    z|L9+(?Hg55Rbi}&UuQh5`u+zW!7$T%X{jsH0wopB8Blp66}sGs*$Pa9Dt(bul@cXD
    zt!61tsk}db>}A^G!T2s)C3*rZ6ztVE&=f@4D+~lvkU5k7yp;;?SrTI9?!;9%KtQu9
    zRId!B`~>ig{Ugj5Sg4rhWQYVb&n$t|>DPwiC*3uFCk3TsNA)z6(%Dd;D#TvHK
    zw#@()M$KlU3Q#{KJ@wqtpU}s+&GYyZKcwHa`zv3ZGF$OzXl#P>=Rc>TXvQStoT|Jp
    zga8RoG!}pn-HEMP8`jdvnoF0j$Q`7TKvMLT^xLtHb@J3N>8KcXh5qHkb1rsz@PTi`
    z3-v#zk2!0BT3gBYC&O5{Z#ifmgxuV0SQZs&v6qzCRC|SftFZzi{dsFu7#SI94dySln;+?{ymj%}*FLW4%Tb2ATqq8S0SPHyZ&HyLEC7he1YZRKbRp*l-Q
    zr}EF(bTcvnb#)H-=;QNrwva6rEdK7@5OARK6j(QJ-n11Ipee{gx2?(Q&IS%FEPCRJ
    zoZtWMT`)1dg)KAhl0^|{x)_|G?QEDzcY|wy00aD{ob0ric>f(B5OC?wTd6QCJltgp
    zf_1EZ*GXviexfMKab-wVbvJ~dN`FitYe|41ePtbvNl?lC#Cw0#+nzP@)TG&
    zK;Xis7ir9i))d5D+l+FUv+zO6I5gLM4hrXVI`
    zBCKDx)^AKf7Q#FV&kCgUB3id>&Vi`NNGP8OcLa@`}ze^UI_Cz
    zJkeM+K&`}9G(*Dy0!pKwtHV!Wd}`VQI(dT|)+bKk!3hLZ1POJM+>T7!Ix-EZJ5RO5
    z#2>D~wNb5RE9`l%s;YrCt1@8a%JfvG>rSZ{%O@IZ-ljiqrNX%Qcq?}&Mt46&yz2_2
    z8vjx3UxFhzfs}(uULDFWJpPgWOq`DgC`^m596u%x5>Ns`h2P&p
    z;2pc223vO=jz$7jO!Ts}%lQl6P?>_vC}Rnx@)Bd=00EUd@ffBcssfaJpo03}K`WBf
    zEY>aeY+-XCt|Ad+_%kocCwE)`R#oxU5g8c)t1~m8qqEazrXT`TUIG>$AV8)dOfY{=
    z0|bUO!ynKY+3qMOch{uSAjYz&C|XdUJ-9DS
    zLFVo1&)ciQuJ(E|1yS6IQ+01lWo78r!$A%_n2Ml5(T*!b67LGR!MStq!?9z>RjWjR
    ziCSp7y1T(%TnhIrxrZ$(l4pFcP%zaDq{1Ylk^Hgn(8HB0S1Bdxi=<->5y-#v39;2f
    z5AT~z52gZqa6{J{OLRpO7IJ*@R6
    z)o)7cr-HFh#KpxzW=1-+;s60Jnt}+X@&RKF-0HX0*EcX`NP}(LHj_1@TegycaO|by
    zkdwPp0*gEZQv;}nAA=p+w-Iaco-On&0;d74;Q1$ioG_;8a0*fC5J9_w8
    zDw4i>`~{k?Gb$bGQsKbB0Jwa+GQBfEK%_q(r^1-nSSxoYzINR%?-h<1HBwLpb&g^mOA;k6!!PzX%#Xv
    zj#0--N?J}+?4SBYW|X1h&ec(b{(&ddvkz
    z4k!}!3}`eKg*}o;YOOg%t4DO8u@{$2SRjqYQFjdR9qqVRIK4(cp{Zs`W8of
    zQ<5P&Ya^u}F4pxP?|fCqXYJt0=^e7!nwp`=-1gv8lo}&wEXpaDkXLZ(9QRBG9#Xa2
    zOX+XqUBD5KOV5~
    zcK`lIr~t}qRz-!y^gY{|-ul&BvdOJWUzNC8o85OdxKD++SD2Ht5qfDrXH`|}&Du$6
    zERp{FAQhr1NPfXpVhFt{h+&L*g=heR+Dc&|X?y42pMKKy)3`Fk)gm6eaH^~Bprk=<
    z)m=*vWD4SFgtXKYoMfLC9XB~s5W!S_#8_ww!rh5WODm}VX`+>(gcT<>_Nl$GUXZ=s
    z-#%j_p^g?u%DlpdO0K9k>>X^yjCk&}=qaxjQk=)lvMh)B;{Ruh3{pq5>&DoO=HJrwma0
    z=zFm2fE9OSt*?E34|PPKmjfAy*o$HB-hYAa-X569&ItD{X+Wpci(l2$;BrmABfmlJ
    z3Q+kmu;Swr=#)--dk1P6{r~)^BletqKKkH2(otDC+liq#p!iA=g+1;iVmU&x<~|@>
    zb5C4uz^7w2n_&Gq$+zqCi
    zv-#1%ySJJ}Nns9%_wKGP8#*P2g)gOJ_B!5Bl^a~`0%Q@1F}Mf#f~sSx)Hv5TOmXM9r-b%FHEnRjg28gxVE+qC@Cqc=!&sdvWQnMEaXUsj#}b
    z+V;VRf2BjJ$;l>78gw`E1RMPjP-w8mQ{MB(enBh02nI}KDh$nN-?0~dV+O8FvC{$#
    zN75~67Qs|=P`p=GR$I}X7~6mqQ;@M4i{?CoWNM4x!a)K&^`ZWfrczAbJqQoa;^^L{
    zo6WE(d!y*5nu{6>?YNCbqifi>VhS>`#!?%8&@|PTj)TifYl?cxU6@(A6`-2K;$3YD
    zQc+P!Ez0hJrOcebE>dJD6zW_@P1VPJ!sjGFHFtraQimx
    z6^4h0qwTe-HQ9GlZ$6Pzd$F6z?umkRIt=;o#t)U@8%w
    zn}VP_@k&c7Y}=ZvH3gaB5Sl80HC7E^e|eu3-HFi@q_nI;fJ%gS#CvI35SfC+#6+u1
    zK}7l!!15p!c67AcxI1y`iew?wMR-rVW96N@6IWDJlQ)%MDiK~7-7C2hXKh?ZGnfTa
    ziSP*d*U63
    zjjIO;3~9#738oT^<-xFVJWPRxwILzX-zyZFN@y$!1Xdlpy*+T-itfZ_lgW)KhyaxU
    z)-?ADhlWRJ*!Z&OC@3r}p7LIyNPi*~x-kXmw3U{X!P3xBNE>AeB80jS@1B~1DDK4M
    znIM=-gvWb@DtBTC4h|MfCBi$56&V?6KdxN$H&L%1_+4s
    zCsN@wQ(;SUvyHnGCr_|fDAJ!ug;O*I3Ab{0VmxB6n1TqV5{%`6c(1K<&}=~Txx&#W
    zf~iD!%2>hjxx&ZLow%!~hZ_CR_)IXB2u~R6_`pE_Deg|ZbH_F+l#11#i0Q5h@%u))
    z+Z{j0+o7SM1L#hShP9=#DTn}-h^Ye0DKptH1J+9hFbv9DK4{#ajc&uiSB82jD@Q;C==V{xV$ku`ZxdrQsp!y_ZZO*fl=fbPVCsYH0fST5%3
    zYODL%o!bL1I~p21FDZmaCC;&Rw036RsOM?`ji
     
    -  
    +  
     
       Module: DNote
     
       
    -    
    +    
       
     
    -  
    -  
    +  
    +  
     
    -  
    -  
    -  
    -  
    +  
    +  
    +  
    +  
     
       
     
    @@ -37,9 +40,9 @@
       

    -   +   - D'Note  + "DNote"  DNote

    @@ -52,19 +55,19 @@

    In Files

    @@ -124,7 +127,7 @@

    Information

    Class Index - [+]

    @@ -138,27 +141,31 @@

    Class Index @@ -168,9 +175,9 @@

    Class Index
    - [Validate] + [Validate]
    - Generated with WebRI Redfish 1.1 + Generated with Newfish 0.2.0

    @@ -193,7 +200,7 @@

    Constants

    VERSION
    -
    (Not documented)
    +
    diff --git a/docs/api/DNote/Format.html b/docs/api/DNote/Format.html new file mode 100644 index 0000000..8a71de5 --- /dev/null +++ b/docs/api/DNote/Format.html @@ -0,0 +1,530 @@ + + + + + + + + Class: DNote::Format + + + + + + + + + + + + + + + + +
    + +
    +

    + +   + + "DNote"  + DNote::Format +

    +
    + +
    +
    + +
    +

    In Files

    +
    + +
    +
    + + + + + +
    + +
    + + + +
    +

    Parent

    +
      + + +
    • Object
    • + + +
    +
    + + + + +
    +

    Namespace

    + +
    + + + + +
    +

    Methods

    + +
    + + + + +
    + +
    + + +
    +

    Information

    + +
    + + +
    +

    Class Index + [+]

    + +
    + Quicksearch + +
    + + + + + +
    +
    + +
    + +
    + [Validate] +
    + Generated with Newfish 0.2.0 +

    +
    +
    + +
    + +
    + + + +

    Notes Formatter

    + +
    + + + +
    +

    Constants

    +
    + +
    EXTENSIONS
    + +

    DEFAULT_OUTPUT_DIR = “log/dnote”

    + + +
    +
    + + + + +
    +

    Attributes

    + + +
    + + +
    + notes[R] +
    + +
    + + + +
    +
    + +
    + + + + +
    + format[RW] +
    + +
    + + + +
    +
    + +
    + + + + +
    + subtype[RW] +
    + +
    + + + +
    +
    + +
    + + + + +
    + output[RW] +
    + +
    + + + +
    +
    + +
    + + + + +
    + template[RW] +
    + +
    + + + +
    +
    + +
    + + + + +
    + title[RW] +
    + +
    + + + +
    +
    + +
    + + + + +
    + dryrun[RW] +
    + +
    + + + +
    +
    + +
    + + + + +
    +

    Public Class Methods

    + + +
    + + +
    + + new(notes, options={}) + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/dnote/format.rb, line 43
    +def initialize(notes, options={})
    +  @notes   = notes
    +  @format  = 'text'
    +  @subtype = 'label'
    +  @title   = "Developer's Notes"
    +  options.each{ |k,v| __send__("#{k}=", v) if v }
    +  yield(self) if block_given?
    +end
    +
    + +
    + + +
    + + +
    + +
    +

    Public Instance Methods

    + + +
    + + +
    + + render() + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/dnote/format.rb, line 53
    +def render
    +  if notes.empty?
    +    $stderr << "No #{notes.labels.join(', ')} notes.\n"
    +  else
    +    case format
    +    when 'custom'
    +      render_custom
    +    else
    +      render_template
    +    end
    +  end
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + render_custom() + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/dnote/format.rb, line 69
    +def render_custom
    +  #raise ArgumentError unless File.exist?(template)
    +  result = erb(template)
    +  publish(result)    
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + render_template() + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/dnote/format.rb, line 78
    +def render_template
    +  template = File.join(File.dirname(__FILE__), 'templates', "#{format}.erb")
    +  raise "No such format - #{format}" unless File.exist?(template)
    +  result = erb(template)
    +  publish(result)  
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + +
    + +

    Disabled; run with --debug to generate this.

    + +
    + + + + + diff --git a/rdoc/classes/DNote/Format/ErbScope.html b/docs/api/DNote/Format/ErbScope.html similarity index 54% rename from rdoc/classes/DNote/Format/ErbScope.html rename to docs/api/DNote/Format/ErbScope.html index 38eeaa3..388cb8e 100644 --- a/rdoc/classes/DNote/Format/ErbScope.html +++ b/docs/api/DNote/Format/ErbScope.html @@ -3,31 +3,34 @@ - + Class: DNote::Format::ErbScope - + - - + + - - - - + + + + @@ -37,9 +40,9 @@ @@ -52,7 +55,7 @@

    In Files

    @@ -73,7 +76,9 @@

    In Files

    Parent

      -
    • Object
    • + +
    • Object
    • +
    @@ -90,22 +95,22 @@

    Methods

  • - ::new + ::new
  • - #h + #h
  • - #method_missing + #method_missing
  • - #render + #render
  • @@ -123,9 +128,9 @@

    Methods

    Information

    @@ -133,7 +138,7 @@

    Information

    Class Index - [+]

    @@ -147,27 +152,31 @@

    Class Index @@ -177,9 +186,9 @@

    Class Index
    - [Validate] + [Validate]
    - Generated with WebRI Redfish 1.1 + Generated with Newfish 0.2.0

    @@ -207,7 +216,7 @@

    Public Class Methods

    - +
    @@ -226,10 +235,10 @@

    Public Class Methods

    -# File lib/dnote/format.rb, line 150
    -      def initialize(data={})
    -        @data = data
    -      end
    +# File lib/dnote/format.rb, line 151 +def initialize(data={}) + @data = data +end
    @@ -245,7 +254,7 @@

    Public Instance Methods

    - +
    @@ -264,10 +273,10 @@

    Public Instance Methods

    -# File lib/dnote/format.rb, line 159
    -      def h(string)
    -        REXML::Text.normalize(string)
    -      end
    +# File lib/dnote/format.rb, line 160 +def h(string) + REXML::Text.normalize(string) +end
    @@ -276,8 +285,8 @@

    Public Instance Methods

    -
    - +
    +
    @@ -294,12 +303,12 @@

    Public Instance Methods

    + id="method_missing-source">
    -# File lib/dnote/format.rb, line 163
    -      def method_missing(s, *a)
    -        @data[s.to_sym]
    -      end
    +# File lib/dnote/format.rb, line 164 +def method_missing(s, *a) + @data[s.to_sym] +end
    @@ -309,7 +318,7 @@

    Public Instance Methods

    - +
    @@ -328,11 +337,11 @@

    Public Instance Methods

    -# File lib/dnote/format.rb, line 154
    -      def render(file)
    -        erb = ERB.new(File.read(file), nil, '<>')
    -        erb.result(binding)
    -      end
    +# File lib/dnote/format.rb, line 155 +def render(file) + erb = ERB.new(File.read(file), nil, '<>') + erb.result(binding) +end
    diff --git a/docs/api/DNote/Note.html b/docs/api/DNote/Note.html new file mode 100644 index 0000000..9819308 --- /dev/null +++ b/docs/api/DNote/Note.html @@ -0,0 +1,800 @@ + + + + + + + + Class: DNote::Note + + + + + + + + + + + + + + + + +
    + +
    +

    + +   + + "DNote"  + DNote::Note +

    +
    + +
    +
    + +
    +

    In Files

    +
    + +
    +
    + + + + + +
    + +
    + + + +
    +

    Parent

    +
      + + +
    • Object
    • + + +
    +
    + + + + + + + +
    +

    Methods

    + +
    + + + + +
    + +
    + + +
    +

    Information

    + +
    + + +
    +

    Class Index + [+]

    + +
    + Quicksearch + +
    + + + + + +
    +
    + +
    + +
    + [Validate] +
    + Generated with Newfish 0.2.0 +

    +
    +
    + +
    + +
    + +

    Note

    + + + +

    The Note class encapsulates a single note made in a +source file.

    + +

    Each note instance holds a reference, notes, to the set of notes +being generated for a given session. This allows the note to access general +options applicable to all notes.

    + +
    + + + +
    +

    Constants

    +
    + +
    CONTEXT_DEPTH
    + +

    Number of lines to provide in source context.

    + + +
    +
    + + + + +
    +

    Attributes

    + + +
    + + +
    + notes[R] +
    + +
    + +

    Set of notes to which this note belongs.

    + +
    +
    + +
    + + +
    + file[R] +
    + +
    + +

    The file in which the note is made.

    + +
    +
    + +
    + + +
    + label[R] +
    + +
    + +

    The type of note.

    + +
    +
    + +
    + + +
    + line[R] +
    + +
    + +

    The line number of the note.

    + +
    +
    + +
    + + +
    + text[R] +
    + +
    + +

    The verbatim text of the note.

    + +
    +
    + +
    + + +
    + mark[R] +
    + +
    + +

    Remark marker used in parsing the note.

    + +
    +
    + +
    + + + + +
    +

    Public Class Methods

    + + +
    + + +
    + + new(notes, file, label, line, text, mark) + click to toggle source + +
    + +
    + +

    Initialize new Note instance.

    + + + +
    +
    +# File lib/dnote/note.rb, line 32
    +def initialize(notes, file, label, line, text, mark)
    +  @notes   = notes
    +
    +  @file    = file
    +  @label   = label
    +  @line    = line
    +  @text    = text.rstrip
    +  @mark    = mark
    +end
    +
    + +
    + + +
    + + +
    + +
    +

    Public Instance Methods

    + + +
    + + +
    + + <=>(other) + click to toggle source + +
    + +
    + +

    Sort by file name and line number.

    + + + +
    +
    +# File lib/dnote/note.rb, line 58
    +def <=>(other)
    +  s = file <=> other.file
    +  return s unless s == 0
    +  line <=> other.line
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + context() + click to toggle source + +
    + +
    + +

    This isn’t being used currently b/c the URL solution as deeemd better, +but the code is here for custom templates. Note +that the CONTEXT_DEPTH is presently a +fixed value (5 lines).

    + + + +
    +
    +# File lib/dnote/note.rb, line 100
    +def context
    +  @context ||= (
    +    lines = file_cache(file) #.lines.to_a
    +    count = line()
    +    count +=1 while /^\s*#{mark}/ =~ lines[count]
    +    lines[count, CONTEXT_DEPTH]
    +  )
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + file_cache(file) + click to toggle source + +
    + +
    + +

    Read in file, parse into lines and cache.

    + + + +
    +
    +# File lib/dnote/note.rb, line 110
    +def file_cache(file)
    +  @@file_cache ||= {}
    +  @@file_cache[file] ||= File.read(file).lines.to_a
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + textline() + click to toggle source + +
    + +
    + +

    Remove newlines from note text.

    + + + +
    +
    +# File lib/dnote/note.rb, line 53
    +def textline
    +  text.gsub("\n", " ")
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + to_h() + click to toggle source + +
    + +
    + +

    Convert to Hash.

    + + + +
    +
    +# File lib/dnote/note.rb, line 68
    +def to_h
    +  { 'label'=>label, 'text'=>textline, 'file'=>file, 'line'=>line }
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + to_h_raw() + click to toggle source + +
    + +
    + +

    Convert to Hash, leaving the note text verbatim.

    + + + +
    +
    +# File lib/dnote/note.rb, line 73
    +def to_h_raw
    +  { 'label'=>label, 'text'=>text, 'file'=>file, 'line'=>line }
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + to_json(*args) + click to toggle source + +
    + +
    + +

    Convert to JSON.

    + + + +
    +
    +# File lib/dnote/note.rb, line 78
    +def to_json(*args)
    +  to_h_raw.to_json(*args)
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + to_s() + click to toggle source + +
    + +
    + +

    Convert to string representation.

    + + + +
    +
    +# File lib/dnote/note.rb, line 43
    +def to_s
    +  "#{label}: #{text}"
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + to_str() + click to toggle source + +
    + +
    + +

    Convert to string representation.

    + + + +
    +
    +# File lib/dnote/note.rb, line 48
    +def to_str
    +  "#{label}: #{text}"
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + to_yaml(*args) + click to toggle source + +
    + +
    + +

    Convert to YAML.

    + + + +
    +
    +# File lib/dnote/note.rb, line 83
    +def to_yaml(*args)
    +  to_h_raw.to_yaml(*args)
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + url() + click to toggle source + +
    + +
    + +

    Return line URL based on URL template. If no template was set, then returns +the file.

    + + + +
    +
    +# File lib/dnote/note.rb, line 89
    +def url
    +  if notes.url
    +    notes.url % [file, line]
    +  else
    +    file
    +  end
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + +
    + +

    Disabled; run with --debug to generate this.

    + +
    + + + + + diff --git a/docs/api/DNote/Notes.html b/docs/api/DNote/Notes.html new file mode 100644 index 0000000..df85b91 --- /dev/null +++ b/docs/api/DNote/Notes.html @@ -0,0 +1,1181 @@ + + + + + + + + Class: DNote::Notes + + + + + + + + + + + + + + + + +
    + +
    +

    + +   + + "DNote"  + DNote::Notes +

    +
    + +
    +
    + +
    +

    In Files

    +
    + +
    +
    + + + + + +
    + +
    + + + +
    +

    Parent

    +
      + + +
    • Object
    • + + +
    +
    + + + + + + + +
    +

    Methods

    + +
    + + + + +
    +

    Included Modules

    + +
    + +
    + +
    + + +
    +

    Information

    + +
    + + +
    +

    Class Index + [+]

    +
    +
    + Quicksearch + +
    +
    + + + + +
    +
    + +
    + +
    + [Validate] +
    + Generated with Newfish 0.2.0 +

    +
    +
    + +
    + +
    + + + +

    Developer Notes

    + +

    This class goes through you source files and compiles a list of any labeled +comments. Labels are all-cap single word prefixes to a comment ending in a +colon.

    + +

    Special labels do not require the colon. By default these are +TODO, FIXME, OPTIMIZE, THINK and +DEPRECATE.

    + +
    + + + +
    +

    Constants

    +
    + +
    DEFAULT_PATHS
    + +

    Default paths (all ruby scripts).

    + + +
    DEFAULT_LABELS
    + +

    Default note labels to look for in source code. (NOT CURRENTLY USED!)

    + + +
    +
    + + + + +
    +

    Attributes

    + + +
    + + + + +
    + files[RW] +
    + +
    + +

    Files to search for notes.

    + +
    +
    + +
    + + + + +
    + labels[RW] +
    + +
    + +

    Labels to document. Defaults are: TODO, FIXME, +OPTIMIZE and DEPRECATE.

    + +
    +
    + +
    + + + + +
    + colon[RW] +
    + +
    + +

    Require label colon? Default is true.

    + +
    +
    + +
    + + + + +
    + marker[RW] +
    + +
    + +

    Specific remark marker (nil for auto).

    + +
    +
    + +
    + + + + +
    + url[RW] +
    + +
    + +

    Link template.

    + +
    +
    + +
    + + + + +
    +

    Public Class Methods

    + + +
    + + +
    + + new(files, options={}) + click to toggle source + +
    + +
    + +

    New set of notes for give files and optional special labels.

    + + + +
    +
    +# File lib/dnote/notes.rb, line 44
    +def initialize(files, options={})
    +  @files  = [files].flatten
    +  @labels = [options[:labels] || DEFAULT_LABELS].flatten.compact
    +  @colon  = options[:colon].nil? ? true : options[:colon]
    +  @marker = options[:marker] #|| '#'
    +  @url    = options[:url]
    +  @remark = {}
    +  parse
    +end
    +
    + +
    + + +
    + + +
    + +
    +

    Public Instance Methods

    + + +
    + + +
    + + by_file() + click to toggle source + +
    + +
    + +

    Organize notes into a hash with filename for keys.

    + + + +
    +
    +# File lib/dnote/notes.rb, line 194
    +def by_file
    +  @by_file ||= (
    +    list = {}
    +    notes.each do |note|
    +      list[note.file] ||= []
    +      list[note.file] << note
    +      list[note.file].sort! #!{ |a,b| a.line <=> b.line }
    +    end
    +    list
    +  )
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + by_file_label() + click to toggle source + +
    + +
    + +

    Organize notes into a hash with filenames for keys, followed by a hash with +labels for keys.

    + + + +
    +
    +# File lib/dnote/notes.rb, line 223
    +def by_file_label
    +  @by_file ||= (
    +    list = {}
    +    notes.each do |note|
    +      list[note.file] ||= {}
    +      list[note.file][note.label] ||= []
    +      list[note.file][note.label] << note
    +      list[note.file][note.label].sort! #{ |a,b| a.line <=> b.line }
    +    end
    +    list
    +  )
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + by_label() + click to toggle source + +
    + +
    + +

    Organize notes into a hash with labels for keys.

    + + + +
    +
    +# File lib/dnote/notes.rb, line 181
    +def by_label
    +  @by_label ||= (
    +    list = {}
    +    notes.each do |note|
    +      list[note.label] ||= []
    +      list[note.label] << note
    +      list[note.label].sort #!{ |a,b| a.line <=> b.line }
    +    end
    +    list
    +  )
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + by_label_file() + click to toggle source + +
    + +
    + +

    Organize notes into a hash with labels for keys, followed by a hash with +filename for keys.

    + + + +
    +
    +# File lib/dnote/notes.rb, line 208
    +def by_label_file
    +  @by_label ||= (
    +    list = {}
    +    notes.each do |note|
    +      list[note.label] ||= {}
    +      list[note.label][note.file] ||= []
    +      list[note.label][note.file] << note
    +      list[note.label][note.file].sort! #{ |a,b| a.line <=> b.line }
    +    end
    +    list
    +  )
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + counts() + click to toggle source + +
    + +
    + +

    Notes counts by label.

    + + + +
    +
    +# File lib/dnote/notes.rb, line 60
    +def counts
    +  @counts ||= (
    +    h = {}
    +    by_label.each do |label, notes|
    +      h[label] = notes.size
    +    end
    +    h
    +  )
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + each(&block) + click to toggle source + +
    + +
    + +

    Iterate through notes.

    + + + +
    +
    +# File lib/dnote/notes.rb, line 71
    +def each(&block)
    +  notes.each(&block)
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + empty?() + click to toggle source + +
    + +
    + +

    No notes?

    + + + +
    +
    +# File lib/dnote/notes.rb, line 76
    +def empty?
    +  notes.empty?
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + guess_marker(file) + click to toggle source + +
    + +
    + +

    Guess marker based on file extension. Fallsback to ‘#’ if the extension +is unknown.

    + +

    TODO: Continue to add comment types.

    + + + +
    +
    +# File lib/dnote/notes.rb, line 258
    +def guess_marker(file)
    +  return @marker if @marker # forced marker
    +  case File.extname(file)
    +  when '.js', '.c', 'cpp', '.css'
    +    '//'
    +  when '.bas'
    +    "'"
    +  when '.sql', '.ada'
    +    '--'
    +  when '.asm'
    +    ';'
    +  else
    +    '#'        
    +  end
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + match(line, lineno, file) + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/dnote/notes.rb, line 126
    +def match(line, lineno, file)
    +  if labels.empty?
    +    match_general(line, lineno, file)
    +  else
    +    match_special(line, lineno, file)
    +  end
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + match_general(line, lineno, file) + click to toggle source + +
    + +
    + +

    Match notes that are labeled with a colon.

    + + + +
    +
    +# File lib/dnote/notes.rb, line 160
    +def match_general(line, lineno, file)
    +  rec = nil
    +  if md = match_general_regex(file).match(line)
    +    label, text = md[1], md[2]
    +    #rec = {'label'=>label,'file'=>file,'line'=>lineno,'note'=>text}
    +    rec = Note.new(self, file, label, lineno, text, remark(file))
    +  end
    +  return rec
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + match_general_regex(file) + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/dnote/notes.rb, line 171
    +def match_general_regex(file)
    +  mark = remark(file)
    +  if colon
    +    /#{mark}\s*([A-Z]+)[:]\s+(.*?)$/
    +  else
    +    /#{mark}\s*([A-Z]+)[:]?\s+(.*?)$/
    +  end
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + match_special(line, lineno, file) + click to toggle source + +
    + +
    + +

    Match special notes.

    + + + +
    +
    +# File lib/dnote/notes.rb, line 135
    +def match_special(line, lineno, file)
    +  rec = nil
    +  labels.each do |label|
    +    if md = match_special_regex(label, file).match(line)
    +      text = md[1]
    +      #rec = {'label'=>label,'file'=>file,'line'=>lineno,'note'=>text}
    +      rec = Note.new(self, file, label, lineno, text, remark(file))
    +    end
    +  end
    +  rec
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + match_special_regex(label, file) + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/dnote/notes.rb, line 150
    +def match_special_regex(label, file)
    +  mark = remark(file)
    +  if colon
    +    /#{mark}\s*#{Regexp.escape(label)}[:]\s*(.*?)$/
    +  else
    +    /#{mark}\s*#{Regexp.escape(label)}[:]?\s*(.*?)$/
    +  end
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + notes() + click to toggle source + +
    + +
    + +

    Array of notes.

    + + + +
    +
    +# File lib/dnote/notes.rb, line 55
    +def notes
    +  @notes
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + parse() + click to toggle source + +
    + +
    + +

    Gather notes.

    + + + +
    +
    +# File lib/dnote/notes.rb, line 84
    +def parse
    +  records = []
    +  files.each do |fname|
    +    next unless File.file?(fname)
    +    #next unless fname =~ /\.rb$/      # TODO: should this be done?
    +    mark = remark(fname)
    +    lineno, save, text = 0, nil, nil
    +    File.readlines(fname).each do |line|
    +      #while line = f.gets
    +        lineno += 1
    +        save = match(line, lineno, fname)
    +        if save
    +          #file = fname
    +          text = save.text
    +          #save = {'label'=>label,'file'=>file,'line'=>line_no,'note'=>text}
    +          records << save
    +        else
    +          if text
    +            case line
    +            when /^\s*#{mark}+\s*$/, /^\s*#{mark}\-\-/, /^\s*#{mark}\+\+/
    +              text.strip!
    +              text = nil
    +            when /^\s*#{mark}/
    +              if text[-1,1] == "\n"
    +                text << line.gsub(/^\s*#{mark}\s*/,'')
    +              else
    +                text << "\n" << line.gsub(/^\s*#{mark}\s*/,'')
    +              end
    +            else
    +              text.strip!
    +              text = nil
    +            end
    +          end
    +        end
    +      #end
    +    end
    +  end
    +
    +  @notes  = records.sort
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + remark(file) + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/dnote/notes.rb, line 247
    +def remark(file)
    +  @remark[File.extname(file)] ||= (
    +    mark = guess_marker(file)
    +    Regexp.escape(mark)
    +  )
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + to_a() + click to toggle source + +
    + +
    + +

    Convert to an array of hashes.

    + + + +
    +
    +# File lib/dnote/notes.rb, line 237
    +def to_a
    +  notes.map{ |n| n.to_h }
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + to_h() + click to toggle source + +
    + +
    + +

    Same as by_label.

    + + + +
    +
    +# File lib/dnote/notes.rb, line 242
    +def to_h
    +  by_label
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + +
    + +

    Disabled; run with --debug to generate this.

    + +
    + + + + + diff --git a/docs/api/DNote/Session.html b/docs/api/DNote/Session.html new file mode 100644 index 0000000..46d1fc2 --- /dev/null +++ b/docs/api/DNote/Session.html @@ -0,0 +1,847 @@ + + + + + + + + Class: DNote::Session + + + + + + + + + + + + + + + + +
    + +
    +

    + +   + + "DNote"  + DNote::Session +

    +
    + +
    +
    + +
    +

    In Files

    +
    + +
    +
    + + + + + +
    + +
    + + + +
    +

    Parent

    +
      + + +
    • Object
    • + + +
    +
    + + + + + + + +
    +

    Methods

    + +
    + + + + +
    + +
    + + +
    +

    Information

    + +
    + + +
    +

    Class Index + [+]

    +
    +
    + Quicksearch + +
    +
    + + + + +
    +
    + +
    + +
    + [Validate] +
    + Generated with Newfish 0.2.0 +

    +
    +
    + +
    + +
    + +

    Session

    + + + +

    User session which is used by commandline interface.

    + +

    By making this a class it makes it easy for external libraries to use this +library just as if they were calling the commandline, but without the need +to shellout.

    + +
    + + + +
    +

    Constants

    +
    + +
    DIR
    + +

    Directory relative to this script. This is used to lookup the available +format templates.

    + + +
    DEFAULT_FORMAT
    + +

    Default format.

    + + +
    DEFAULT_TITLE
    + +

    Default title.

    + + +
    +
    + + + + +
    +

    Attributes

    + + +
    + + + + +
    + paths[RW] +
    + +
    + +

    Paths to include.

    + +
    +
    + +
    + + +
    + exclude[R] +
    + +
    + +

    Paths to exclude (match by pathname).

    + +
    +
    + +
    + + +
    + ignore[R] +
    + +
    + +

    Paths to ignore (match by basename).

    + +
    +
    + +
    + + + + +
    + labels[RW] +
    + +
    + +

    Labels to lookup. By default these are TODO, FIXME and OPTIMIZE.

    + +
    +
    + +
    + + + + +
    + colon[RW] +
    + +
    + +

    Selected labels can optionally do without the colon.

    + +
    +
    + +
    + + + + +
    + marker[RW] +
    + +
    + +

    Alternate remark marker. Useful to other languages besides Ruby.

    + +
    +
    + +
    + + + + +
    + format[RW] +
    + +
    + +

    Output format.

    + +
    +
    + +
    + + + + +
    + template[RW] +
    + +
    + +

    If custom format, specify template file.

    + +
    +
    + +
    + + + + +
    + title[RW] +
    + +
    + +

    Some format put a title at the top of the output. The default is +“Developer’s Notes”.

    + +
    +
    + +
    + + + + +
    + output[RW] +
    + +
    + +

    Output to a file instead of STDOUT.

    + +
    +
    + +
    + + + + +
    + dryrun[RW] +
    + +
    + +

    If output path given, don’t actually write to disk.

    + +
    +
    + +
    + + + + +
    + url[RW] +
    + +
    + +

    String template for line URLs (mainly for HTML format). For example, DNote uses GitHub so we could use a link template:

    + +
    "https://github.com/rubyworks/dnote/blob/master/%s#L%s"
    + +
    +
    + +
    + + + + +
    +

    Public Class Methods

    + + +
    + + +
    + + main(*argv) + click to toggle source + +
    + +
    + +

    Commandline interface.

    + + + +
    +
    +# File lib/dnote/session.rb, line 152
    +def self.main(*argv)
    +  require 'optparse'
    +
    +  session = Session.new
    +
    +  opts = OptionParser.new do |opt|
    +
    +    opt.banner = "DNote v#{DNote::VERSION}"
    +
    +    opt.separator(" ")
    +    opt.separator("USAGE:\n  dnote [OPTIONS] path1 [path2 ...]")
    +
    +    opt.separator(" ")
    +    opt.separator("OUTPUT FORMAT: (choose one)")
    +
    +    opt.on("--format", "-f NAME", "select a format [text]") do |format|
    +      session.format = format
    +    end
    +
    +    opt.on("--custom", "-c FILE", "use a custom ERB template") do |file|
    +      session.format = 'custom'
    +      session.template = file
    +    end
    +
    +    opt.on("--file", "shortcut for text/file format") do
    +      session.format = 'text/file'
    +    end
    +
    +    opt.on("--list", "shortcut for text/list format") do
    +      session.format = 'text/list'
    +    end
    +
    +    opt.separator(" ")
    +    opt.separator("OTHER OPTIONS:")
    +
    +    opt.on("--label", "-l LABEL", "labels to collect") do |lbl|
    +      session.labels.concat(lbl.split(':'))
    +    end
    +
    +    opt.on("--[no-]colon", "match labels with/without colon suffix") do |val|
    +      session.colon = val
    +    end
    +
    +    opt.on("--marker", "-m MARK", "alternative remark marker") do |mark|
    +       session.marker = mark 
    +    end
    +
    +    opt.on("--url", "-u TEMPLATE", "url template for line entries (for HTML)") do |temp|
    +       session.url = temp
    +    end
    +
    +    opt.on("--exclude", "-x PATH", "exclude file or directory") do |path|
    +      session.exclude << path
    +    end
    +
    +    opt.on("--ignore", "-i NAME", "ignore file based on any part of pathname") do |name|
    +      session.ignore << name
    +    end
    +
    +    opt.on("--title", "-t TITLE", "title to use in header") do |title|
    +      session.title = title
    +    end
    +
    +    opt.on("--output", "-o PATH", "save to file or directory") do |path|
    +      session.output = path
    +    end
    +
    +    opt.on("--dryrun", "-n", "do not actually write to disk") do
    +      session.dryrun = true
    +    end
    +
    +    opt.on("--debug", "debug mode") do
    +      $DEBUG = true
    +      $VERBOSE = true
    +    end
    +
    +    opt.separator(" ")
    +    opt.separator("COMMAND OPTIONS:")
    +
    +    opt.on_tail('--templates', "-T", "list available format templates") do
    +      tdir   = File.join(DIR, 'templates')
    +      tfiles = Dir[File.join(tdir, '**/*.erb')]
    +      tnames = tfiles.map{ |tname| tname.sub(tdir+'/', '').chomp('.erb') }
    +      groups = tnames.group_by{ |tname| tname.split('/').first }
    +      groups.sort.each do |(type, names)|
    +        puts("%-18s " * names.size) % names.sort
    +      end
    +      exit
    +    end
    +
    +    opt.on_tail('--help', '-h', "show this help information") do
    +      puts opt
    +      exit
    +    end
    +  end
    +
    +  begin
    +    opts.parse!(argv)
    +    session.paths.replace(argv)
    +    session.run
    +  rescue => err
    +    raise err if $DEBUG
    +    puts err
    +    exit 1
    +  end
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + new(options={}) + click to toggle source + +
    + +
    + +

    New Session.

    + + + +
    +
    +# File lib/dnote/session.rb, line 70
    +def initialize(options={})
    +  options ||= {}
    +  initialize_defaults
    +  options.each{ |k,v| __send__("#{k}=", v) }
    +  yield(self) if block_given?
    +end
    +
    + +
    + + +
    + + +
    + +
    +

    Public Instance Methods

    + + +
    + + +
    + + exclude=(list) + click to toggle source + +
    + +
    + +

    Set exclude list ensuring that the value is an array.

    + + + +
    +
    +# File lib/dnote/session.rb, line 93
    +def exclude=(list)
    +  @exclude = [list].flatten.compact
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + files() + click to toggle source + +
    + +
    + +

    Collect path globs and remove exclusions. This method uses paths, exclude and ignore to compile the list of +files.

    + + + +
    +
    +# File lib/dnote/session.rb, line 117
    +def files
    +  list = [paths].flatten.compact
    +  list = ['**/*.rb'] if list.empty?
    +  list = glob(list)
    +  list = list - glob(exclude)
    +  list.reject do |path|
    +    path.split('/').any?{ |part| ignore.any?{ |ig| File.fnmatch?(ig, part) } }
    +  end
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + glob(paths) + click to toggle source + +
    + +
    + +

    Collect the file glob of each path given. If a path is a directory, inclue +all content.

    + + + +
    +
    +# File lib/dnote/session.rb, line 129
    +def glob(paths)
    +  paths.map do |path|
    +    if File.directory?(path)
    +      Dir.glob(File.join(path, '**/*'))
    +    else
    +      Dir.glob(path)
    +    end
    +  end.flatten.uniq
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + ignore=(list) + click to toggle source + +
    + +
    + +

    Set ignore list ensuring that the value is an array.

    + + + +
    +
    +# File lib/dnote/session.rb, line 98
    +def ignore=(list)
    +  @ignore = [list].flatten.compact
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + run() + click to toggle source + +
    + +
    + +

    Run session.

    + + + +
    +
    +# File lib/dnote/session.rb, line 103
    +def run
    +  notes = Notes.new(files, :labels=>labels, :colon=>colon, :marker=>marker, :url=>url)
    +  formatter = Format.new(notes) do |f|
    +    f.format   = format
    +    f.template = template
    +    f.title    = title
    +    f.output   = output
    +  end
    +  formatter.render
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + +
    + +

    Disabled; run with --debug to generate this.

    + +
    + + + + + diff --git a/docs/api/DNoteTask.html b/docs/api/DNoteTask.html new file mode 100644 index 0000000..a29a286 --- /dev/null +++ b/docs/api/DNoteTask.html @@ -0,0 +1,586 @@ + + + + + + + + Class: DNoteTask + + + + + + + + + + + + + + + + +
    + +
    +

    + +   + + "DNote"  + DNoteTask +

    +
    + +
    +
    + +
    +

    In Files

    + +
    + + + + + +
    + +
    + + + +
    +

    Parent

    +
      + + +
    • Rake::TaskLib
    • + + +
    +
    + + + + + + + +
    +

    Methods

    + +
    + + + + +
    + +
    + + +
    +

    Information

    + +
    + + +
    +

    Class Index + [+]

    +
    +
    + Quicksearch + +
    +
    + + + + +
    +
    + +
    + +
    + [Validate] +
    + Generated with Newfish 0.2.0 +

    +
    +
    + +
    + +
    + + + +

    Developmer’s Notes Rake Task

    + +
    + + + +
    +

    Constants

    +
    + +
    DEFAULT_LABELS
    + +

    Default note labels to looked for in source code.

    + + +
    +
    + + + + +
    +

    Attributes

    + + +
    + + + + +
    + files[RW] +
    + +
    + +

    File paths to search.

    + +
    +
    + +
    + + + + +
    + labels[RW] +
    + +
    + +

    Labels to document. Defaults are: TODO, FIXME, OPTIMIZE and DEPRECATE.

    + +
    +
    + +
    + + + + +
    + formats[RW] +
    + +
    + +

    Formats (xml, html, rdoc, rdoc/list and so on).

    + +
    +
    + +
    + + + + +
    + exclude[RW] +
    + +
    + +

    Exclude paths.

    + +
    +
    + +
    + + + + +
    + ignore[RW] +
    + +
    + +

    Ignore paths based on any part of pathname.

    + +
    +
    + +
    + + + + +
    + output[RW] +
    + +
    + +

    Output directory to save notes file. Defaults to dnote/ under the +project log directory (eg. log/dnote/).

    + +
    +
    + +
    + + + + +
    + title[RW] +
    + +
    + +

    Title to use if temaplte can use it.

    + +
    +
    + +
    + + + + +
    +

    Public Instance Methods

    + + +
    + + +
    + + clean() + click to toggle source + +
    + +
    + +

    Remove output files.

    + + + +
    +
    +# File lib/plugins/rake/task.rb, line 94
    +def clean
    +  #if File.directory?(output)
    +    formats.each do |format|
    +      if format == 'index'
    +        file = (output + "index.html").to_s
    +      else
    +        ext = ::DNote::Format::EXTENSIONS[format] || format
    +        file = (output + "notes.#{ext}").to_s
    +      end
    +      rm(file)
    +      report "Removed #{output}"
    +    end
    +  #else
    +  #  rm(output)
    +  #  report "Removed #{output}"
    +  #end
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + define() + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/plugins/rake/task.rb, line 48
    +def define
    +  desc "Collect Developer's Notes"
    +  task 'dnote' do
    +    document
    +  end
    +  task 'dnote:clobber' do
    +    clean
    +  end
    +  task :clobber => ['dnote:clobber']
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + document() + click to toggle source + +
    + +
    + +

    Generate notes document(s).

    + + + +
    +
    +# File lib/plugins/rake/task.rb, line 60
    +def document
    +  abort "dnote: #{output} is not a directory" unless output.directory?
    +
    +  session = ::DNote::Session.new do |s|
    +    s.paths   = files
    +    s.exclude = exclude
    +    s.ignore  = ignore
    +    s.labels  = labels #|| DEFAULT_LABELS   
    +    s.title   = title
    +    s.output  = output
    +    s.dryrun  = application.options.dryrun #trial?
    +  end
    +
    +  formats.each do |format|
    +    if format == 'index'
    +      session.format = 'html'
    +      session.output = File.join(self.output, 'index.html')
    +    else
    +      session.format = format
    +    end
    +    session.run
    +    report "Updated #{output.to_s.sub(Dir.pwd+'/','')}" unless trial?
    +  end
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + init() + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/plugins/rake/task.rb, line 38
    +def init
    +  require 'dnote'
    +  require 'dnote/format'
    +  @files   = "**/*.rb"
    +  @output  = 'log/dnote'
    +  @formats = ['index']
    +  @labels  = nil #DEFAULT_LABELS
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + reset() + click to toggle source + +
    + +
    + +

    Reset output directory, marking it as out-of-date.

    + + + +
    +
    +# File lib/plugins/rake/task.rb, line 86
    +def reset
    +  #if File.directory?(output)
    +    File.utime(0,0,output) unless $NOOP
    +    puts "Marked #{output} as out-of-date"
    +  #end
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + +
    + +

    Disabled; run with --debug to generate this.

    + +
    + + + + + diff --git a/docs/api/Enumerable.html b/docs/api/Enumerable.html new file mode 100644 index 0000000..40908bf --- /dev/null +++ b/docs/api/Enumerable.html @@ -0,0 +1,242 @@ + + + + + + + + Module: Enumerable + + + + + + + + + + + + + + + + +
    + +
    +

    + +   + + "DNote"  + Enumerable +

    +
    + +
    +
    + +
    +

    In Files

    +
    + +
    +
    + + + + + +
    + +
    + + + + + + + + + +
    +

    Methods

    + +
    + + + + +
    + +
    + + +
    +

    Information

    + +
    + + +
    +

    Class Index + [+]

    +
    +
    + Quicksearch + +
    +
    + + + + +
    +
    + +
    + +
    + [Validate] +
    + Generated with Newfish 0.2.0 +

    +
    +
    + +
    + +
    + +

    Enumerable

    + + + +
    + + + + + + + + + +
    +

    Public Instance Methods

    + + +
    + + +
    + + group_by() + click to toggle source + +
    + +
    + +

    Taken from Ruby Facets.

    + + + +
    +
    +# File lib/dnote/core_ext.rb, line 4
    +def group_by #:yield:
    +  #h = k = e = nil
    +  r = Hash.new
    +  each{ |e| (r[yield(e)] ||= []) << e }
    +  r
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + +
    + +

    Disabled; run with --debug to generate this.

    + +
    + + + + + diff --git a/docs/api/LICENSE_txt.html b/docs/api/LICENSE_txt.html new file mode 100644 index 0000000..1568fff --- /dev/null +++ b/docs/api/LICENSE_txt.html @@ -0,0 +1,713 @@ + + + + + + + + File: LICENSE.txt ["DNote"] + + + + + + + + + + + + + + + +
    + +
    +

    +   + "DNote"  + LICENSE.txt +

    +
    + +
    +
    +

    File Stats

    +
    +
    Last Modified
    +
    Fri Nov 12 23:40:07 -0500 2010
    + + + + +
    +
    + +
    + + +
    +

    Information

    + +
    + + +
    +

    Class Index + [+]

    +
    +
    + Quicksearch + +
    +
    + + + +
    + + +
    +

    Method Index

    + +
    +
    + +
    + +
    + [Validate] +
    + Generated with Newfish 0.2.0 +

    +
    +
    + + + +
    + +
            Apache License
    +   Version 2.0, January 2004
    +http://www.apache.org/licenses/
    + +

    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

    +
    1. +

      Definitions.

      + +

      “License” shall mean the terms and conditions for use, reproduction, +and distribution as defined by Sections 1 through 9 of this document.

      + +

      “Licensor” shall mean the copyright owner or entity authorized by the +copyright owner that is granting the License.

      + +

      “Legal Entity” shall mean the union of the acting entity and all other +entities that control, are controlled by, or are under common control with +that entity. For the purposes of this definition, “control” means (i) +the power, direct or indirect, to cause the direction or management of such +entity, whether by contract or otherwise, or (ii) ownership of fifty +percent (50%) or more of the outstanding shares, or (iii) beneficial +ownership of such entity.

      + +

      “You” (or “Your”) shall mean an individual or Legal Entity +exercising permissions granted by this License.

      + +

      “Source” form shall mean the preferred form for making modifications, +including but not limited to software source code, documentation source, +and configuration files.

      + +

      “Object” form shall mean any form resulting from mechanical +transformation or translation of a Source form, including but not limited +to compiled object code, generated documentation, and conversions to other +media types.

      + +

      “Work” shall mean the work of authorship, whether in Source or Object +form, made available under the License, as indicated by a copyright notice +that is included in or attached to the work (an example is provided in the +Appendix below).

      + +

      “Derivative Works” shall mean any work, whether in Source or Object +form, that is based on (or derived from) the Work and for which the +editorial revisions, annotations, elaborations, or other modifications +represent, as a whole, an original work of authorship. For the purposes of +this License, Derivative Works shall not include works that remain +separable from, or merely link (or bind by name) to the interfaces of, the +Work and Derivative Works thereof.

      + +

      “Contribution” shall mean any work of authorship, including the +original version of the Work and any modifications or additions to that +Work or Derivative Works thereof, that is intentionally submitted to +Licensor for inclusion in the Work by the copyright owner or by an +individual or Legal Entity authorized to submit on behalf of the copyright +owner. For the purposes of this definition, “submitted” means any form +of electronic, verbal, or written communication sent to the Licensor or its +representatives, including but not limited to communication on electronic +mailing lists, source code control systems, and issue tracking systems that +are managed by, or on behalf of, the Licensor for the purpose of discussing +and improving the Work, but excluding communication that is conspicuously +marked or otherwise designated in writing by the copyright owner as “Not +a Contribution.”

      + +

      “Contributor” shall mean Licensor and any individual or Legal Entity on +behalf of whom a Contribution has been received by Licensor and +subsequently incorporated within the Work.

      +
    2. +

      Grant of Copyright License. Subject to the terms and conditions of this +License, each Contributor hereby grants to You a perpetual, worldwide, +non-exclusive, no-charge, royalty-free, irrevocable copyright license to +reproduce, prepare Derivative Works of, publicly display, publicly perform, +sublicense, and distribute the Work and such Derivative Works in Source or +Object form.

      +
    3. +

      Grant of Patent License. Subject to the terms and conditions of this +License, each Contributor hereby grants to You a perpetual, worldwide, +non-exclusive, no-charge, royalty-free, irrevocable (except as stated in +this section) patent license to make, have made, use, offer to sell, sell, +import, and otherwise transfer the Work, where such license applies only to +those patent claims licensable by such Contributor that are necessarily +infringed by their Contribution(s) alone or by combination of their +Contribution(s) with the Work to which such Contribution(s) was submitted. +If You institute patent litigation against any entity (including a +cross-claim or counterclaim in a lawsuit) alleging that the Work or a +Contribution incorporated within the Work constitutes direct or +contributory patent infringement, then any patent licenses granted to You +under this License for that Work shall terminate as of the date such +litigation is filed.

      +
    4. +

      Redistribution. You may reproduce and distribute copies of the Work or +Derivative Works thereof in any medium, with or without modifications, and +in Source or Object form, provided that You meet the following conditions:

      + +

      (a) You must give any other recipients of the Work or

      + +
      Derivative Works a copy of this License; and
      + +

      (b) You must cause any modified files to carry prominent notices

      + +
      stating that You changed the files; and
      + +

      © You must retain, in the Source form of any Derivative Works

      + +
      that You distribute, all copyright, patent, trademark, and
      +attribution notices from the Source form of the Work,
      +excluding those notices that do not pertain to any part of
      +the Derivative Works; and
      + +

      (d) If the Work includes a “NOTICE” text file as part of its

      + +
      distribution, then any Derivative Works that You distribute must
      +include a readable copy of the attribution notices contained
      +within such NOTICE file, excluding those notices that do not
      +pertain to any part of the Derivative Works, in at least one
      +of the following places: within a NOTICE text file distributed
      +as part of the Derivative Works; within the Source form or
      +documentation, if provided along with the Derivative Works; or,
      +within a display generated by the Derivative Works, if and
      +wherever such third-party notices normally appear. The contents
      +of the NOTICE file are for informational purposes only and
      +do not modify the License. You may add Your own attribution
      +notices within Derivative Works that You distribute, alongside
      +or as an addendum to the NOTICE text from the Work, provided
      +that such additional attribution notices cannot be construed
      +as modifying the License.
      + +

      You may add Your own copyright statement to Your modifications and may +provide additional or different license terms and conditions for use, +reproduction, or distribution of Your modifications, or for any such +Derivative Works as a whole, provided Your use, reproduction, and +distribution of the Work otherwise complies with the conditions stated in +this License.

      +
    5. +

      Submission of Contributions. Unless You explicitly state otherwise, any +Contribution intentionally submitted for inclusion in the Work by You to +the Licensor shall be under the terms and conditions of this License, +without any additional terms or conditions. Notwithstanding the above, +nothing herein shall supersede or modify the terms of any separate license +agreement you may have executed with Licensor regarding such Contributions.

      +
    6. +

      Trademarks. This License does not grant permission to use the trade names, +trademarks, service marks, or product names of the Licensor, except as +required for reasonable and customary use in describing the origin of the +Work and reproducing the content of the NOTICE file.

      +
    7. +

      Disclaimer of Warranty. Unless required by applicable law or agreed to in +writing, Licensor provides the Work (and each Contributor provides its +Contributions) on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF +ANY KIND, either express or implied, including, without limitation, any +warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or +FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for +determining the appropriateness of using or redistributing the Work and +assume any risks associated with Your exercise of permissions under this +License.

      +
    8. +

      Limitation of Liability. In no event and under no legal theory, whether in +tort (including negligence), contract, or otherwise, unless required by +applicable law (such as deliberate and grossly negligent acts) or agreed to +in writing, shall any Contributor be liable to You for damages, including +any direct, indirect, special, incidental, or consequential damages of any +character arising as a result of this License or out of the use or +inability to use the Work (including but not limited to damages for loss of +goodwill, work stoppage, computer failure or malfunction, or any and all +other commercial damages or losses), even if such Contributor has been +advised of the possibility of such damages.

      +
    9. +

      Accepting Warranty or Additional Liability. While redistributing the Work +or Derivative Works thereof, You may choose to offer, and charge a fee for, +acceptance of support, warranty, indemnity, or other liability obligations +and/or rights consistent with this License. However, in accepting such +obligations, You may act only on Your own behalf and on Your sole +responsibility, not on behalf of any other Contributor, and only if You +agree to indemnify, defend, and hold each Contributor harmless for any +liability incurred by, or claims asserted against, such Contributor by +reason of your accepting any such warranty or additional liability.

      +
    + +

    END OF TERMS AND CONDITIONS

    + +

    APPENDIX: How to apply the Apache License to your work.

    + +
    To apply the Apache License to your work, attach the following
    +boilerplate notice, with the fields enclosed by brackets "[]"
    +replaced with your own identifying information. (Don't include
    +the brackets!)  The text should be enclosed in the appropriate
    +comment syntax for the file format. We also recommend that a
    +file or class name and description of purpose be included on the
    +same "printed page" as the copyright notice for easier
    +identification within third-party archives.
    + +

    Copyright [yyyy] [name of copyright owner]

    + +

    Licensed under the Apache License, Version 2.0 (the “License”); you may +not use this file except in compliance with the License. You may obtain a +copy of the License at

    + +
    http://www.apache.org/licenses/LICENSE-2.0
    + +

    Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an “AS IS” BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License.

    + +
    + +
    + + + diff --git a/docs/api/README_rdoc.html b/docs/api/README_rdoc.html new file mode 100644 index 0000000..16a8e2e --- /dev/null +++ b/docs/api/README_rdoc.html @@ -0,0 +1,636 @@ + + + + + + + + File: README.rdoc ["DNote"] + + + + + + + + + + + + + + + +
    + +
    +

    +   + "DNote"  + README.rdoc +

    +
    + +
    +
    +

    File Stats

    +
    +
    Last Modified
    +
    Sat Nov 27 11:45:06 -0500 2010
    + + + + +
    +
    + +
    + + +
    +

    Information

    + +
    + + +
    +

    Class Index + [+]

    +
    +
    + Quicksearch + +
    +
    + + + +
    + + +
    +

    Method Index

    + +
    +
    + +
    + +
    + [Validate] +
    + Generated with Newfish 0.2.0 +

    +
    +
    + + + +
    + +

    D’Note

    + + +

    DESCRIPTION

    + +

    Extract development notes from source code and generate some nice output +formats for them.

    + +

    SYNOPSIS

    + +

    Note Structure

    + +

    DNote scans for the common note patterns used by +developers of many languages in the form of an all-caps labels followed by +a colon. To be more specific, for D’Note to recognize a note, it needs to +follow this simple set of rules:

    + +

    1) Notes start with an all-caps label punctuated with a colon, followed by +the note’s text.

    + +
    # LABEL: description ...
    + +

    2) Any note that requires more than one line must remain flush to the left +margin (the margin is set by the first line). This is done because RDoc +will mistake the note for a pre block if it is indented.

    + +
    # LABEL: description ...
    +# continue ...
    + +

    3) An alternative to the previous limitation is to indent the whole note, +making it a &lt;pre&gt; block when rendered by RDoc. Then +the text layout is free-form.

    + +
    # This is a description of something...
    +#
    +#   LABEL: description ...
    +#          continue ...
    + +

    That’s all there is to it, if I can convince the developers of RDoc to +recognize labels, we may eventually be able to relax the flush rule too, +which would be very nice.

    + +

    There is also a command-line option, --no-colon, which deactives +the need for a colon after the note label. However this often produces +false positives, so it’s use is discouraged.

    + +

    Generating Notes

    + +

    As you can see the commandline interface is pretty straight-forward.

    + +
    USAGE:
    +
    +  dnote [OPTIONS] path1 [path2 ...]
    +
    +OUTPUT FORMAT: (choose one)
    +    -f, --format NAME                select a format [text]
    +    -c, --custom FILE                use a custom ERB template
    +        --file                       shortcut for text/file format
    +        --list                       shortcut for text/list format
    +
    +OTHER OPTIONS:
    +    -l, --label LABEL                labels to collect
    +        --[no-]colon                 match labels with/without colon suffix
    +    -m, --marker MARK                alternative remark marker
    +    -u  --url TEMPLATE               url template for line entries (for HTML)
    +    -x, --exclude PATH               exclude file or directory
    +    -i, --ignore NAME                ignore based on any part of the pathname
    +    -t, --title TITLE                title to use in header
    +    -o, --output PATH                name of file or directory
    +    -n, --dryrun                     do not actually write to disk
    +        --debug                      debug mode
    +
    +COMMAND OPTIONS:
    +    -T, --templates                  list available format templates
    +    -h, --help                       show this help information
    + +

    The default path is */.rb and the default format is -f +rdoc. Here is an example of DNote’s current notes in RDoc format:

    + +
    = Development Notes
    +
    +== TODO
    +
    +=== file://lib/dnote/notes.rb
    +
    +* TODO: Add ability to read header notes. They often
    +have a outline format, rather then the single line. (19)
    +* TODO: Need good CSS file. (22)
    +* TODO: Need XSL? (24)
    +
    +=== file://plug/syckle/services/dnote.rb
    +
    +* TODO: Should this service be part of the +site+ cycle? (18)
    +
    +(4 TODOs)
    + +

    INSTALLATION

    + +

    The usual RubyGem’s command will do the trick.

    + +
    $ sudo gem install dnote
    + +

    COPYRIGHT

    + +

    Copyright © 2006 Thomas Sawyer

    + +

    Licensed under the Apache License, Version 2.0 (the “License”); you may +not use this file except in compliance with the License. You may obtain a +copy of the License at

    + +
    http://www.apache.org/licenses/LICENSE-2.0
    + +

    Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an “AS IS” BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License.

    + +
    + +
    + + + diff --git a/rdoc/classes/Syckle/Plugins.html b/docs/api/Redline.html similarity index 51% rename from rdoc/classes/Syckle/Plugins.html rename to docs/api/Redline.html index 6986c7b..110ca68 100644 --- a/rdoc/classes/Syckle/Plugins.html +++ b/docs/api/Redline.html @@ -3,31 +3,34 @@ - + - Module: Syckle::Plugins + Module: Redline - + - - + + - - - - + + + + @@ -37,10 +40,10 @@

    -   +   - D'Note  - Syckle::Plugins + "DNote"  + Redline

    @@ -52,9 +55,6 @@

    In Files

    @@ -76,7 +76,7 @@

    In Files

    Namespace

    @@ -96,9 +96,9 @@

    Namespace

    Information

    @@ -106,7 +106,7 @@

    Information

    Class Index - [+]

    @@ -120,27 +120,31 @@

    Class Index @@ -150,9 +154,9 @@

    Class Index
    - [Validate] + [Validate]
    - Generated with WebRI Redfish 1.1 + Generated with Newfish 0.2.0

    @@ -161,7 +165,7 @@

    Class Index
    -

    Plugins

    +

    Redline

    diff --git a/rdoc/classes/Syckle.html b/docs/api/Redline/Plugins.html similarity index 64% rename from rdoc/classes/Syckle.html rename to docs/api/Redline/Plugins.html index 58a0394..07dc2a1 100644 --- a/rdoc/classes/Syckle.html +++ b/docs/api/Redline/Plugins.html @@ -3,9 +3,9 @@ - + - Module: Syckle + Module: Redline::Plugins @@ -21,13 +21,16 @@ @@ -39,8 +42,8 @@

      - D'Note  - Syckle + "DNote"  + Redline::Plugins

    @@ -52,6 +55,9 @@

    In Files

    @@ -73,7 +79,7 @@

    In Files

    Namespace

    @@ -93,9 +99,9 @@

    Namespace

    Information

    @@ -117,27 +123,31 @@

    Class Index @@ -149,7 +159,7 @@

    Class Index
    [Validate]
    - Generated with WebRI Redfish 1.1 + Generated with Newfish 0.2.0

    @@ -158,7 +168,7 @@

    Class Index
    -

    Syckle

    +

    Plugins

    diff --git a/docs/api/Redline/Plugins/DNote.html b/docs/api/Redline/Plugins/DNote.html new file mode 100644 index 0000000..24caceb --- /dev/null +++ b/docs/api/Redline/Plugins/DNote.html @@ -0,0 +1,547 @@ + + + + + + + + Class: Redline::Plugins::DNote + + + + + + + + + + + + + + + + +
    + +
    +

    + +   + + "DNote"  + Redline::Plugins::DNote +

    +
    + +
    +
    + +
    +

    In Files

    + +
    + + + + + +
    + +
    + + + +
    +

    Parent

    +
      + + +
    • Service
    • + + +
    +
    + + + + + + + +
    +

    Methods

    + +
    + + + + +
    + +
    + + +
    +

    Information

    + +
    + + +
    +

    Class Index + [+]

    + +
    + Quicksearch + +
    + + + + + +
    +
    + +
    + +
    + [Validate] +
    + Generated with Newfish 0.2.0 +

    +
    +
    + +
    + +
    + + + +

    Developmer’s Notes Plugin

    + +

    This plugin goes through you source files and compiles a list of any +labeled comments. Labels are single word prefixes to a comment ending in a +colon. For example, you might note somewhere in your code:

    + +

    By default this label supports the TODO, FIXME, OPTIMIZE and DEPRECATE.

    + +

    Output is a set of files in HTML, XML and RDoc’s simple markup format. +This plugin can run automatically if there is a notes/ directory +in the project’s log directory.

    + +
    + + + +
    +

    Constants

    +
    + +
    DEFAULT_LABELS
    + +

    Default note labels to looked for in source code.

    + + +
    +
    + + + + +
    +

    Attributes

    + + +
    + + + + +
    + files[RW] +
    + +
    + +

    File paths to search.

    + +
    +
    + +
    + + + + +
    + labels[RW] +
    + +
    + +

    Labels to document. Defaults are: TODO, FIXME, OPTIMIZE and DEPRECATE.

    + +
    +
    + +
    + + + + +
    + exclude[RW] +
    + +
    + +

    Exclude paths.

    + +
    +
    + +
    + + + + +
    + ignore[RW] +
    + +
    + +

    Ignore paths based on any part of pathname.

    + +
    +
    + +
    + + +
    + output[R] +
    + +
    + +

    Output directory to save notes file. Defaults to dnote/ under the +project log directory (eg. log/dnote/).

    + +
    +
    + +
    + + + + +
    + formats[RW] +
    + +
    + +

    Formats (xml, html, rdoc).

    + +
    +
    + +
    + + + + +
    + title[RW] +
    + +
    + +

    Title to use if temaplte can use it.

    + +
    +
    + +
    + + + + +
    +

    Public Instance Methods

    + + +
    + + +
    + + clean() + click to toggle source + +
    + +
    + +

    Remove output files.

    + + + +
    +
    +# File lib/plugins/redline/dnote.rb, line 124
    +def clean
    +  if File.directory?(output)
    +    formats.each do |format|
    +      ext = ::DNote::Format::EXTENSIONS[format] || format
    +      file = (output + "notes.#{ext}").to_s
    +      rm(file)
    +      report "Removed #{output}"
    +    end
    +  end
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + document() + click to toggle source + +
    + +
    + +

    Generate notes documents.

    + + + +
    +
    +# File lib/plugins/redline/dnote.rb, line 81
    +def document
    +  session = ::DNote::Session.new do |s|
    +    s.paths   = files
    +    s.exclude = exclude
    +    s.ignore  = ignore
    +    s.labels  = labels #|| DEFAULT_LABELS   
    +    s.title   = title
    +    s.output  = output
    +    s.dryrun  = trial?
    +  end
    +  formats.each do |format|
    +    if format == 'index'
    +      session.format = 'html'
    +      session.output = File.join(self.output, 'index.html')
    +    else
    +      session.format = format
    +    end
    +    session.run
    +    report "Updated #{output.to_s.sub(Dir.pwd+'/','')}" unless trial?
    +  end
    +
    +  #files = files.map{ |f| Dir[f] }.flatten
    +  #notes = ::DNote::Notes.new(files, :labels=>labels)
    +  #[formats].flatten.each do |format|
    +  #  if format == 'index'
    +  #    format = 'html'
    +  #    output = File.join(self.output, 'index.html')
    +  #  end
    +  #  format = ::DNote::Format.new(notes, :format=>format, :output=>output.to_s, :title=>title, :dryrun=>trial?)
    +  #  format.render
    +  #  report "Updated #{output.to_s.sub(Dir.pwd+'/','')}" unless trial?
    +  #end
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + output=(path) + click to toggle source + +
    + +
    + + + + + +
    +
    +# File lib/plugins/redline/dnote.rb, line 68
    +def output=(path)
    +  @output = Pathname.new(path)
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + reset() + click to toggle source + +
    + +
    + +

    Reset output directory, marking it as out-of-date.

    + + + +
    +
    +# File lib/plugins/redline/dnote.rb, line 116
    +def reset
    +  if File.directory?(output)
    +    File.utime(0,0,output) unless $NOOP
    +    puts "Marked #{output}"
    +  end
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + +
    + +

    Disabled; run with --debug to generate this.

    + +
    + + + + + diff --git a/rdoc/classes/Xacto.html b/docs/api/Xacto.html similarity index 56% rename from rdoc/classes/Xacto.html rename to docs/api/Xacto.html index 4bf4b1a..c41c4b6 100644 --- a/rdoc/classes/Xacto.html +++ b/docs/api/Xacto.html @@ -3,31 +3,34 @@ - + Class: Xacto - + - - + + - - - - + + + + @@ -37,9 +40,9 @@

    -   +   - D'Note  + "DNote"  Xacto

    @@ -52,7 +55,7 @@

    In Files

    @@ -73,7 +76,9 @@

    In Files

    Parent

      -
    • Object
    • + +
    • Object
    • +
    @@ -105,9 +110,9 @@

    Namespace

    Information

    @@ -115,7 +120,7 @@

    Information

    Class Index - [+]

    @@ -129,27 +134,31 @@

    Class Index @@ -159,9 +168,9 @@

    Class Index
    - [Validate] + [Validate]
    - Generated with WebRI Redfish 1.1 + Generated with Newfish 0.2.0

    diff --git a/docs/api/Xacto/String.html b/docs/api/Xacto/String.html new file mode 100644 index 0000000..2acf9b8 --- /dev/null +++ b/docs/api/Xacto/String.html @@ -0,0 +1,350 @@ + + + + + + + + Module: Xacto::String + + + + + + + + + + + + + + + + +
    + +
    +

    + +   + + "DNote"  + Xacto::String +

    +
    + +
    +
    + +
    +

    In Files

    +
    + +
    +
    + + + + + +
    + +
    + + + + + + + + + +
    +

    Methods

    + +
    + + + + +
    + +
    + + +
    +

    Information

    + +
    + + +
    +

    Class Index + [+]

    + +
    + Quicksearch + +
    + + + + + +
    +
    + +
    + +
    + [Validate] +
    + Generated with Newfish 0.2.0 +

    +
    +
    + +
    + +
    + +

    String

    + + + +

    Extensions for String class. These methods are +taken directly from Ruby Facets.

    + +
    + + + + + + + + + +
    +

    Public Instance Methods

    + + +
    + + +
    + + indent(n) + click to toggle source + +
    + +
    + +

    Indent left or right by n spaces. (This used to be called #tab and aliased +as indent.)

    + +
    CREDIT: Gavin Sinclair
    +CREDIT: Trans
    + + + +
    +
    +# File lib/dnote/string.rb, line 53
    +def indent(n)
    +  if n >= 0
    +    gsub(/^/, ' ' * n)
    +  else
    +    gsub(/^ {0,#{-n}}/, "")
    +  end
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + margin(n=0) + click to toggle source + +
    + +
    + +

    Provides a margin controlled string.

    + +
     x = %Q{
    +       | This
    +       |   is
    +       |     margin controlled!
    +       }.margin
    +
    + NOTE: This may still need a bit of tweaking.
    +
    +CREDIT: Trans
    + + + +
    +
    +# File lib/dnote/string.rb, line 21
    +def margin(n=0)
    +  #d = /\A.*\n\s*(.)/.match( self )[1]
    +  #d = /\A\s*(.)/.match( self)[1] unless d
    +  d = ((/\A.*\n\s*(.)/.match(self)) ||
    +      (/\A\s*(.)/.match(self)))[1]
    +  return '' unless d
    +  if n == 0
    +    gsub(/\n\s*\Z/,'').gsub(/^\s*[#{d}]/, '')
    +  else
    +    gsub(/\n\s*\Z/,'').gsub(/^\s*[#{d}]/, ' ' * n)
    +  end
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + tabto(n) + click to toggle source + +
    + +
    + +

    Preserves relative tabbing. The first non-empty line ends up with n spaces +before nonspace.

    + +
    CREDIT: Gavin Sinclair
    + + + +
    +
    +# File lib/dnote/string.rb, line 39
    +def tabto(n)
    +  if self =~ /^( *)\S/
    +    indent(n - $1.length)
    +  else
    +    self
    +  end
    +end
    +
    + +
    + + +
    + + +
    + + +
    + + +
    + +

    Disabled; run with --debug to generate this.

    + +
    + + + + + diff --git a/rdoc/assets/favicon.ico b/docs/api/assets/favicon.ico similarity index 100% rename from rdoc/assets/favicon.ico rename to docs/api/assets/favicon.ico diff --git a/rdoc/assets/highlight/AUTHORS.en.txt b/docs/api/assets/highlight/AUTHORS.en.txt similarity index 100% rename from rdoc/assets/highlight/AUTHORS.en.txt rename to docs/api/assets/highlight/AUTHORS.en.txt diff --git a/rdoc/assets/highlight/AUTHORS.ru.txt b/docs/api/assets/highlight/AUTHORS.ru.txt similarity index 100% rename from rdoc/assets/highlight/AUTHORS.ru.txt rename to docs/api/assets/highlight/AUTHORS.ru.txt diff --git a/rdoc/assets/highlight/LICENSE b/docs/api/assets/highlight/LICENSE similarity index 100% rename from rdoc/assets/highlight/LICENSE rename to docs/api/assets/highlight/LICENSE diff --git a/rdoc/assets/highlight/export.html b/docs/api/assets/highlight/export.html similarity index 100% rename from rdoc/assets/highlight/export.html rename to docs/api/assets/highlight/export.html diff --git a/rdoc/assets/highlight/highlight.js b/docs/api/assets/highlight/highlight.js similarity index 100% rename from rdoc/assets/highlight/highlight.js rename to docs/api/assets/highlight/highlight.js diff --git a/rdoc/assets/highlight/highlight.pack.js b/docs/api/assets/highlight/highlight.pack.js similarity index 100% rename from rdoc/assets/highlight/highlight.pack.js rename to docs/api/assets/highlight/highlight.pack.js diff --git a/rdoc/assets/highlight/languages/1c.js b/docs/api/assets/highlight/languages/1c.js similarity index 100% rename from rdoc/assets/highlight/languages/1c.js rename to docs/api/assets/highlight/languages/1c.js diff --git a/rdoc/assets/highlight/languages/apache.js b/docs/api/assets/highlight/languages/apache.js similarity index 100% rename from rdoc/assets/highlight/languages/apache.js rename to docs/api/assets/highlight/languages/apache.js diff --git a/rdoc/assets/highlight/languages/avrasm.js b/docs/api/assets/highlight/languages/avrasm.js similarity index 100% rename from rdoc/assets/highlight/languages/avrasm.js rename to docs/api/assets/highlight/languages/avrasm.js diff --git a/rdoc/assets/highlight/languages/axapta.js b/docs/api/assets/highlight/languages/axapta.js similarity index 100% rename from rdoc/assets/highlight/languages/axapta.js rename to docs/api/assets/highlight/languages/axapta.js diff --git a/rdoc/assets/highlight/languages/bash.js b/docs/api/assets/highlight/languages/bash.js similarity index 100% rename from rdoc/assets/highlight/languages/bash.js rename to docs/api/assets/highlight/languages/bash.js diff --git a/rdoc/assets/highlight/languages/cpp.js b/docs/api/assets/highlight/languages/cpp.js similarity index 100% rename from rdoc/assets/highlight/languages/cpp.js rename to docs/api/assets/highlight/languages/cpp.js diff --git a/rdoc/assets/highlight/languages/cs.js b/docs/api/assets/highlight/languages/cs.js similarity index 100% rename from rdoc/assets/highlight/languages/cs.js rename to docs/api/assets/highlight/languages/cs.js diff --git a/rdoc/assets/highlight/languages/css.js b/docs/api/assets/highlight/languages/css.js similarity index 100% rename from rdoc/assets/highlight/languages/css.js rename to docs/api/assets/highlight/languages/css.js diff --git a/rdoc/assets/highlight/languages/delphi.js b/docs/api/assets/highlight/languages/delphi.js similarity index 100% rename from rdoc/assets/highlight/languages/delphi.js rename to docs/api/assets/highlight/languages/delphi.js diff --git a/rdoc/assets/highlight/languages/diff.js b/docs/api/assets/highlight/languages/diff.js similarity index 100% rename from rdoc/assets/highlight/languages/diff.js rename to docs/api/assets/highlight/languages/diff.js diff --git a/rdoc/assets/highlight/languages/django.js b/docs/api/assets/highlight/languages/django.js similarity index 100% rename from rdoc/assets/highlight/languages/django.js rename to docs/api/assets/highlight/languages/django.js diff --git a/rdoc/assets/highlight/languages/dos.js b/docs/api/assets/highlight/languages/dos.js similarity index 100% rename from rdoc/assets/highlight/languages/dos.js rename to docs/api/assets/highlight/languages/dos.js diff --git a/rdoc/assets/highlight/languages/html-xml.js b/docs/api/assets/highlight/languages/html-xml.js similarity index 100% rename from rdoc/assets/highlight/languages/html-xml.js rename to docs/api/assets/highlight/languages/html-xml.js diff --git a/rdoc/assets/highlight/languages/ini.js b/docs/api/assets/highlight/languages/ini.js similarity index 100% rename from rdoc/assets/highlight/languages/ini.js rename to docs/api/assets/highlight/languages/ini.js diff --git a/rdoc/assets/highlight/languages/java.js b/docs/api/assets/highlight/languages/java.js similarity index 100% rename from rdoc/assets/highlight/languages/java.js rename to docs/api/assets/highlight/languages/java.js diff --git a/rdoc/assets/highlight/languages/javascript.js b/docs/api/assets/highlight/languages/javascript.js similarity index 100% rename from rdoc/assets/highlight/languages/javascript.js rename to docs/api/assets/highlight/languages/javascript.js diff --git a/rdoc/assets/highlight/languages/lisp.js b/docs/api/assets/highlight/languages/lisp.js similarity index 100% rename from rdoc/assets/highlight/languages/lisp.js rename to docs/api/assets/highlight/languages/lisp.js diff --git a/rdoc/assets/highlight/languages/mel.js b/docs/api/assets/highlight/languages/mel.js similarity index 100% rename from rdoc/assets/highlight/languages/mel.js rename to docs/api/assets/highlight/languages/mel.js diff --git a/rdoc/assets/highlight/languages/parser3.js b/docs/api/assets/highlight/languages/parser3.js similarity index 100% rename from rdoc/assets/highlight/languages/parser3.js rename to docs/api/assets/highlight/languages/parser3.js diff --git a/rdoc/assets/highlight/languages/perl.js b/docs/api/assets/highlight/languages/perl.js similarity index 100% rename from rdoc/assets/highlight/languages/perl.js rename to docs/api/assets/highlight/languages/perl.js diff --git a/rdoc/assets/highlight/languages/php.js b/docs/api/assets/highlight/languages/php.js similarity index 100% rename from rdoc/assets/highlight/languages/php.js rename to docs/api/assets/highlight/languages/php.js diff --git a/rdoc/assets/highlight/languages/profile.js b/docs/api/assets/highlight/languages/profile.js similarity index 100% rename from rdoc/assets/highlight/languages/profile.js rename to docs/api/assets/highlight/languages/profile.js diff --git a/rdoc/assets/highlight/languages/python.js b/docs/api/assets/highlight/languages/python.js similarity index 100% rename from rdoc/assets/highlight/languages/python.js rename to docs/api/assets/highlight/languages/python.js diff --git a/rdoc/assets/highlight/languages/renderman.js b/docs/api/assets/highlight/languages/renderman.js similarity index 100% rename from rdoc/assets/highlight/languages/renderman.js rename to docs/api/assets/highlight/languages/renderman.js diff --git a/rdoc/assets/highlight/languages/ruby.js b/docs/api/assets/highlight/languages/ruby.js similarity index 100% rename from rdoc/assets/highlight/languages/ruby.js rename to docs/api/assets/highlight/languages/ruby.js diff --git a/rdoc/assets/highlight/languages/smalltalk.js b/docs/api/assets/highlight/languages/smalltalk.js similarity index 100% rename from rdoc/assets/highlight/languages/smalltalk.js rename to docs/api/assets/highlight/languages/smalltalk.js diff --git a/rdoc/assets/highlight/languages/sql.js b/docs/api/assets/highlight/languages/sql.js similarity index 100% rename from rdoc/assets/highlight/languages/sql.js rename to docs/api/assets/highlight/languages/sql.js diff --git a/rdoc/assets/highlight/languages/vbscript.js b/docs/api/assets/highlight/languages/vbscript.js similarity index 100% rename from rdoc/assets/highlight/languages/vbscript.js rename to docs/api/assets/highlight/languages/vbscript.js diff --git a/rdoc/assets/highlight/readme.eng.txt b/docs/api/assets/highlight/readme.eng.txt similarity index 100% rename from rdoc/assets/highlight/readme.eng.txt rename to docs/api/assets/highlight/readme.eng.txt diff --git a/rdoc/assets/highlight/readme.rus.txt b/docs/api/assets/highlight/readme.rus.txt similarity index 100% rename from rdoc/assets/highlight/readme.rus.txt rename to docs/api/assets/highlight/readme.rus.txt diff --git a/rdoc/assets/highlight/styles/ascetic.css b/docs/api/assets/highlight/styles/ascetic.css similarity index 100% rename from rdoc/assets/highlight/styles/ascetic.css rename to docs/api/assets/highlight/styles/ascetic.css diff --git a/rdoc/assets/highlight/styles/brown_paper.css b/docs/api/assets/highlight/styles/brown_paper.css similarity index 100% rename from rdoc/assets/highlight/styles/brown_paper.css rename to docs/api/assets/highlight/styles/brown_paper.css diff --git a/rdoc/assets/highlight/styles/brown_papersq.png b/docs/api/assets/highlight/styles/brown_papersq.png similarity index 100% rename from rdoc/assets/highlight/styles/brown_papersq.png rename to docs/api/assets/highlight/styles/brown_papersq.png diff --git a/rdoc/assets/highlight/styles/dark.css b/docs/api/assets/highlight/styles/dark.css similarity index 100% rename from rdoc/assets/highlight/styles/dark.css rename to docs/api/assets/highlight/styles/dark.css diff --git a/rdoc/assets/highlight/styles/default.css b/docs/api/assets/highlight/styles/default.css similarity index 100% rename from rdoc/assets/highlight/styles/default.css rename to docs/api/assets/highlight/styles/default.css diff --git a/rdoc/assets/highlight/styles/far.css b/docs/api/assets/highlight/styles/far.css similarity index 100% rename from rdoc/assets/highlight/styles/far.css rename to docs/api/assets/highlight/styles/far.css diff --git a/rdoc/assets/highlight/styles/github.css b/docs/api/assets/highlight/styles/github.css similarity index 100% rename from rdoc/assets/highlight/styles/github.css rename to docs/api/assets/highlight/styles/github.css diff --git a/rdoc/assets/highlight/styles/idea.css b/docs/api/assets/highlight/styles/idea.css similarity index 100% rename from rdoc/assets/highlight/styles/idea.css rename to docs/api/assets/highlight/styles/idea.css diff --git a/rdoc/assets/highlight/styles/ir_black.css b/docs/api/assets/highlight/styles/ir_black.css similarity index 100% rename from rdoc/assets/highlight/styles/ir_black.css rename to docs/api/assets/highlight/styles/ir_black.css diff --git a/rdoc/assets/highlight/styles/magula.css b/docs/api/assets/highlight/styles/magula.css similarity index 100% rename from rdoc/assets/highlight/styles/magula.css rename to docs/api/assets/highlight/styles/magula.css diff --git a/rdoc/assets/highlight/styles/rubylang.css b/docs/api/assets/highlight/styles/rubylang.css similarity index 100% rename from rdoc/assets/highlight/styles/rubylang.css rename to docs/api/assets/highlight/styles/rubylang.css diff --git a/rdoc/assets/highlight/styles/school_book.css b/docs/api/assets/highlight/styles/school_book.css similarity index 100% rename from rdoc/assets/highlight/styles/school_book.css rename to docs/api/assets/highlight/styles/school_book.css diff --git a/rdoc/assets/highlight/styles/school_book.png b/docs/api/assets/highlight/styles/school_book.png similarity index 100% rename from rdoc/assets/highlight/styles/school_book.png rename to docs/api/assets/highlight/styles/school_book.png diff --git a/rdoc/assets/highlight/styles/sunburst.css b/docs/api/assets/highlight/styles/sunburst.css similarity index 100% rename from rdoc/assets/highlight/styles/sunburst.css rename to docs/api/assets/highlight/styles/sunburst.css diff --git a/rdoc/assets/highlight/styles/vs.css b/docs/api/assets/highlight/styles/vs.css similarity index 100% rename from rdoc/assets/highlight/styles/vs.css rename to docs/api/assets/highlight/styles/vs.css diff --git a/rdoc/assets/highlight/styles/zenburn.css b/docs/api/assets/highlight/styles/zenburn.css similarity index 100% rename from rdoc/assets/highlight/styles/zenburn.css rename to docs/api/assets/highlight/styles/zenburn.css diff --git a/rdoc/assets/highlight/test.html b/docs/api/assets/highlight/test.html similarity index 100% rename from rdoc/assets/highlight/test.html rename to docs/api/assets/highlight/test.html diff --git a/rdoc/assets/highlight/wp_highlight.js.php b/docs/api/assets/highlight/wp_highlight.js.php similarity index 100% rename from rdoc/assets/highlight/wp_highlight.js.php rename to docs/api/assets/highlight/wp_highlight.js.php diff --git a/docs/api/assets/icon/alias.png b/docs/api/assets/icon/alias.png new file mode 100644 index 0000000000000000000000000000000000000000..0a59bea6fa43f38d1d4caf275c0d69220b4375b6 GIT binary patch literal 583 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!63?wyl`GbKJV{wqX6T`Z5GB1Igp8-B0uI=sZ zw7r_Ka{Su9Q75Q)pFXMMSw90b@BwBIHRSXF!qnEA7jOKYavuBWpcD{jyI|3CRw>{{>li3xIX zX(n&=eI?uqh1?g`uM%DI!+XU6=j5FxCC>2+79VimyJFQUoog@rdP5_pUiaR3@G-|9 zPx&P)^PjJLn3Pm{aN3#loIQmH9{zomdHY`B`h?>_8y2J|E%9O6p144A#*}9X#f+8$ zGlU%U4zL_jSZmBK!5F-+_1W!=1Hu=WE7rxt8dg_snH;^2uQcX2L)}rip7^sysz6^b Nc)I$ztaD0e0stAiCh!0N literal 0 HcmV?d00001 diff --git a/rdoc/assets/icon/attribute.png b/docs/api/assets/icon/attribute.png similarity index 100% rename from rdoc/assets/icon/attribute.png rename to docs/api/assets/icon/attribute.png diff --git a/rdoc/assets/icon/bug.png b/docs/api/assets/icon/bug.png similarity index 100% rename from rdoc/assets/icon/bug.png rename to docs/api/assets/icon/bug.png diff --git a/rdoc/assets/icon/bullet.png b/docs/api/assets/icon/bullet.png similarity index 100% rename from rdoc/assets/icon/bullet.png rename to docs/api/assets/icon/bullet.png diff --git a/rdoc/assets/icon/bullet_minus.png b/docs/api/assets/icon/bullet_minus.png similarity index 100% rename from rdoc/assets/icon/bullet_minus.png rename to docs/api/assets/icon/bullet_minus.png diff --git a/rdoc/assets/icon/bullet_plus.png b/docs/api/assets/icon/bullet_plus.png similarity index 100% rename from rdoc/assets/icon/bullet_plus.png rename to docs/api/assets/icon/bullet_plus.png diff --git a/rdoc/assets/icon/check.png b/docs/api/assets/icon/check.png similarity index 100% rename from rdoc/assets/icon/check.png rename to docs/api/assets/icon/check.png diff --git a/rdoc/assets/icon/class.png b/docs/api/assets/icon/class.png similarity index 100% rename from rdoc/assets/icon/class.png rename to docs/api/assets/icon/class.png diff --git a/rdoc/assets/icon/date.png b/docs/api/assets/icon/date.png similarity index 100% rename from rdoc/assets/icon/date.png rename to docs/api/assets/icon/date.png diff --git a/rdoc/assets/icon/file.png b/docs/api/assets/icon/file.png similarity index 100% rename from rdoc/assets/icon/file.png rename to docs/api/assets/icon/file.png diff --git a/rdoc/assets/icon/find.png b/docs/api/assets/icon/find.png similarity index 100% rename from rdoc/assets/icon/find.png rename to docs/api/assets/icon/find.png diff --git a/rdoc/assets/icon/fixme.png b/docs/api/assets/icon/fixme.png similarity index 100% rename from rdoc/assets/icon/fixme.png rename to docs/api/assets/icon/fixme.png diff --git a/rdoc/assets/icon/list.png b/docs/api/assets/icon/list.png similarity index 100% rename from rdoc/assets/icon/list.png rename to docs/api/assets/icon/list.png diff --git a/rdoc/assets/icon/loading.gif b/docs/api/assets/icon/loading.gif similarity index 100% rename from rdoc/assets/icon/loading.gif rename to docs/api/assets/icon/loading.gif diff --git a/docs/api/assets/icon/method.png b/docs/api/assets/icon/method.png new file mode 100644 index 0000000000000000000000000000000000000000..500bdb4cb2f24824cf263862ffc2850f70c9e685 GIT binary patch literal 582 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!63?wyl`GbKJV{wqX6T`Z5GB1IgKLI`=u6~t_ zwU0q$>Jw3g>y*<5sK+xac zKM@2bO`J4o^5n@=rc9YSb?QtIm^E|OtT}V%&7C_B2<9(XxM0D8MT-_KUc7k8k|j%* zE?u!=#mbc{SFc{ZX3d(lYu9eruwmoIjhi-Y+OlQK?mZx|fB*i~A1AH;IC;&diEBPh zTKi@4!9yT$^ytx(Cr_R`ckbfFi6Q2M7FK*2Lc=PYars;gHe=kN& z`o&y%VfvA8T#k+LLQd>65+*E^v|`|85zOcnSd^WZQ7f)E_r>R#VvWz(Px##!yUDMF0Q*%goJnkEV*8ta5;jqO`?jj;~sNoK$s?R&|a|W_w|On2V~zZ-$wJ zp0sg>n24XViJ!8Kqqdc*yO*oHo3FsI#nyX?m8G}FuD{Nyy2!7;&4P}Yu)oZSl%2}f z;Nj=&X_dEboWEUzp;mg8V2GwaSZs5gyiR0wkFd&!rM!Natagc*b%>U;$=a^M(y6@5 zevFrSaqt!MW5mbRZ5oX;ni^(#CyF{^XrU?z27!=1o9VjVBSgU9 zOOnPkspMmDDc$17gi`8aXp3TpU2pSC7=}*_cgG1>aLg(I?{!mV@*ra@Egth?vR`@| x?~tV>46s|-_M^4{cy(K+`l9r+KzRlJeE{kC9Q2%<1yle4002ovPDHLkV1lU01A literal 0 HcmV?d00001 diff --git a/rdoc/assets/icon/stat.png b/docs/api/assets/icon/stat.png similarity index 100% rename from rdoc/assets/icon/stat.png rename to docs/api/assets/icon/stat.png diff --git a/rdoc/assets/icon/tool.png b/docs/api/assets/icon/tool.png similarity index 100% rename from rdoc/assets/icon/tool.png rename to docs/api/assets/icon/tool.png diff --git a/rdoc/assets/icon/zoom.png b/docs/api/assets/icon/zoom.png similarity index 100% rename from rdoc/assets/icon/zoom.png rename to docs/api/assets/icon/zoom.png diff --git a/rdoc/assets/jquery.js b/docs/api/assets/jquery.js similarity index 100% rename from rdoc/assets/jquery.js rename to docs/api/assets/jquery.js diff --git a/rdoc/assets/main.js b/docs/api/assets/main.js similarity index 91% rename from rdoc/assets/main.js rename to docs/api/assets/main.js index 5a5206b..6a360ca 100644 --- a/rdoc/assets/main.js +++ b/docs/api/assets/main.js @@ -54,12 +54,12 @@ function hookDebuggingToggle() { function hookQuickSearch() { $('.quicksearch-field').each( function() { - var searchElems = $(this).parents('.section').find( 'li' ); + var searchElems = $(this).parents('.section').find('li'); var toggle = $(this).parents('.section').find('h3 .search-toggle'); // console.debug( "Toggle is: %o", toggle ); var qsbox = $(this).parents('form').get( 0 ); - $(this).quicksearch( this, searchElems, { + $(this).quicksearch(this, searchElems, { noSearchResultsIndicator: 'no-class-search-results', focusOnLoad: false }); @@ -105,9 +105,3 @@ function highlightClickTarget( event ) { }; }; -function hookHighlightSyntax() { - $('#documentation pre').wrapInner(''); - hljs.tabReplace = ' '; - hljs.initHighlightingOnLoad('ruby','cpp'); -}; - diff --git a/rdoc/assets/quicksearch.js b/docs/api/assets/quicksearch.js similarity index 100% rename from rdoc/assets/quicksearch.js rename to docs/api/assets/quicksearch.js diff --git a/rdoc/assets/rdoc.css b/docs/api/assets/rdoc.css similarity index 89% rename from rdoc/assets/rdoc.css rename to docs/api/assets/rdoc.css index 8452b99..2ca5a83 100644 --- a/rdoc/assets/rdoc.css +++ b/docs/api/assets/rdoc.css @@ -12,12 +12,13 @@ body { background: #efefef; + background: #ffffff; font: 14px "Helvetica Neue", Helvetica, Tahoma, sans-serif; padding: 0 40px 15px 40px; } #main { - width: 1024px; + max-width: 1080px; margin: 0 auto; } @@ -37,13 +38,14 @@ img { border: none; } h1 { font-size: 300%; text-shadow: rgba(135,145,135,0.65) 2px 2px 3px; - color: #FF226C; + color: black; } h2,h3,h4 { margin-top: 1.5em; } a { color: #FF226C; + color: #224; text-decoration: none; } @@ -51,8 +53,8 @@ a:hover { border-bottom: 1px dotted #FF226C; } -pre {#FF226C; - padding: 0.5em 0; +pre { + padding: 0.5em; border: 1px solid #ccc; } @@ -64,27 +66,25 @@ ul { margin-left: 20px; } +li p { + margin: 0; padding: 0; +} .head { width: auto; -moz-border-radius: 5px; -webkit-border-radius: 5px; - border-bottom: 0px solid #aaa; - border-left: 0px solid #aaa; - border-right: 0px solid #aaa; padding: 10px 10px; margin: 0 8px -0.5em 8px; } .head h1 { - color: #FF226C; color: #666; font-weight: bold; font-size: 18px; } .head h1 a { - color: #FF226C; font-weight: bold; } @@ -96,8 +96,8 @@ ul { .quicksearch-field { width: 98%; - background: #ddd; - border: 1px solid #aaa; + /* background: #ddd; */ + border: 1px solid #ccc; height: 1.5em; -webkit-border-radius: 4px; } @@ -107,7 +107,7 @@ ul { .missing-docs { font-size: 120%; - background: white url(images/fixme.png) no-repeat 4px center; + background: white url(icon/fixme.png) no-repeat 4px center; color: #ccc; line-height: 2em; border: 0px solid #d00; @@ -211,8 +211,15 @@ body.file p { #metadata { float: right; - width: 320px; + width: 330px; margin-top: 10px; + border-left: 0px solid #ccc; + padding-left: 12px; +} + +#documentation { + margin: 0 360px 5em 1em; + min-width: 340px; } /* @@ -234,10 +241,10 @@ body.file p { /* @group Metadata Section */ #metadata .section { - background-color: #dedede; + background-color: #fff; -moz-border-radius: 5px; -webkit-border-radius: 5px; - border: 1px solid #aaa; + border: 0 solid #ccc; margin: 0 8px 16px; font-size: 90%; overflow: hidden; @@ -246,13 +253,13 @@ body.file p { #metadata h3.section-header { margin: 0; padding: 2px 8px; - background: #ccc; + background: #fff; color: #666; -moz-border-radius-topleft: 4px; -moz-border-radius-topright: 4px; -webkit-border-top-left-radius: 4px; -webkit-border-top-right-radius: 4px; - border-bottom: 1px solid #aaa; + border-bottom: 1px solid #ccc; } #metadata ul, @@ -262,12 +269,10 @@ body.file p { list-style: none; } -/* #file-metadata ul { padding-left: 28px; - list-style-image: url(images/page.png); + list-style-image: url(icon/page.png); } -*/ dl.svninfo { color: #666; @@ -305,10 +310,10 @@ ul.link-list .type { */ #project-metadata .section { - border: 1px solid #aaa; + border: 0px solid #ccc; } #project-metadata h3.section-header { - border-bottom: 1px solid #aaa; + border-bottom: 1px solid #ccc; position: relative; } #project-metadata h3.section-header .search-toggle { @@ -319,9 +324,9 @@ ul.link-list .type { #project-metadata form { color: #777; - background: #ccc; + background: #ffffff; padding: 8px 8px 16px; - border-bottom: 1px solid #bbb; + border-bottom: 0px solid #ccc; } #project-metadata fieldset { border: 0; @@ -338,8 +343,10 @@ ul.link-list .type { .method-parent-aside { float: right; font-size: 0.7em; font-weight: bold; - padding: 0 0; - color: #999; + padding: 0 0 0 15px; + color: #aaa; + font-family: helvetica; + letter-spacing: -1px; } /* @end */ @@ -347,16 +354,10 @@ ul.link-list .type { /* @group Documentation Section */ - -#documentation { - margin: 0 360px 5em 1em; - min-width: 340px; -} - #documentation h1 { - margin: 10px 0 10px 0; - padding: 0.5em 0.5em 0.5em 0.5em; - border: 1px solid #bbb; + margin: 8px 0 4px -0.1em; + padding: 0.2em 0.1em 0.1em 0.1em; + border-bottom: 1px solid #bbb; -moz-border-radius: 5px; -webkit-border-radius: 5px; } @@ -410,12 +411,11 @@ ul.link-list .type { } #documentation h3.section-header { margin-top: 2em; - padding: 0.75em 0.5em 0.5em 0.5em; - background-color: #dedede; + padding: 0.75em 0.5em 0.25em 0.5em; + /* background-color: #dedede; */ color: #333; - color: #FF226C; font-size: 150%; - border: 1px solid #bbb; + border-bottom: 1px solid #bbb; -moz-border-radius: 3px; -webkit-border-radius: 3px; } @@ -510,7 +510,7 @@ ul.link-list .type { } #documentation .attribute-method-heading { - background: url(../ima/attribute.png) no-repeat left bottom; + background: url(icon/attribute.png) no-repeat left bottom; } #documentation #attribute-method-details .method-detail:hover { background-color: transparent; @@ -618,7 +618,7 @@ div.method-source-code pre { background: url(icon/plugin.png) no-repeat left top; } .file dt.scs-url { - background: url(icon/tool.png) no-repeat left top; + background: url(icon/wrench.png) no-repeat left top; } .file dl dd { @@ -632,23 +632,6 @@ div.method-source-code pre { .file #metadata dl dd ul li { } -.file h1, h2, h3, h4, h5 { - color: #FF226C; -} - -/* -.file h2 { - margin-top: 2em; - padding: 0.75em 0.5em 0.5em 0.5em; - color: #333; - font-size: 120%; - border: 1px solid #bbb; - -moz-border-radius: 3px; - -webkit-border-radius: 3px; - background: #dedede; -} - - /* .file h2 { margin-top: 2em; diff --git a/rdoc/assets/ruby.png b/docs/api/assets/ruby.png similarity index 100% rename from rdoc/assets/ruby.png rename to docs/api/assets/ruby.png diff --git a/docs/api/created.rid b/docs/api/created.rid new file mode 100644 index 0000000..0b33cbe --- /dev/null +++ b/docs/api/created.rid @@ -0,0 +1,13 @@ +Fri, 13 May 2011 11:25:51 -0400 +lib/dnote.rb Fri, 26 Nov 2010 16:38:50 -0500 +lib/dnote/string.rb Sun, 07 Feb 2010 11:16:58 -0500 +lib/plugins/redline/dnote.rb Wed, 04 May 2011 17:11:22 -0400 +lib/dnote/session.rb Sat, 27 Nov 2010 10:25:17 -0500 +lib/dnote/notes.rb Sat, 27 Nov 2010 10:27:18 -0500 +lib/dnote/version.rb Mon, 13 Dec 2010 04:33:21 -0500 +lib/dnote/note.rb Sat, 27 Nov 2010 10:48:05 -0500 +lib/plugins/rake/task.rb Fri, 19 Feb 2010 10:32:22 -0500 +LICENSE.txt Fri, 12 Nov 2010 23:40:07 -0500 +README.rdoc Sat, 27 Nov 2010 11:45:06 -0500 +lib/dnote/core_ext.rb Wed, 09 Jun 2010 09:03:04 -0400 +lib/dnote/format.rb Sat, 20 Feb 2010 07:16:24 -0500 diff --git a/docs/api/index.html b/docs/api/index.html new file mode 100644 index 0000000..c4bb9c8 --- /dev/null +++ b/docs/api/index.html @@ -0,0 +1,627 @@ + + + + + + + + "DNote" + + + + + + + + + + + + + + +
    + + +
    +

    +   + "DNote" +

    +
    + +
    +
    + + + +
    +

    Information

    + +
    + + +
    +

    Class Index + [+]

    +
    +
    + Quicksearch + +
    +
    + + + +
    + + +
    +

    Method Index + [+]

    +
    +
    + Quicksearch + +
    +
    + + +
    + +
    + +
    + +
    + [Validate] +
    + Generated with Newfish 0.2.0 +

    +
    +
    + + +
    + +

    D’Note

    + + +

    DESCRIPTION

    + +

    Extract development notes from source code and generate some nice output +formats for them.

    + +

    SYNOPSIS

    + +

    Note Structure

    + +

    DNote scans for the common note patterns used by +developers of many languages in the form of an all-caps labels followed by +a colon. To be more specific, for D’Note to recognize a note, it needs to +follow this simple set of rules:

    + +

    1) Notes start with an all-caps label punctuated with a colon, followed by +the note’s text.

    + +
    # LABEL: description ...
    + +

    2) Any note that requires more than one line must remain flush to the left +margin (the margin is set by the first line). This is done because RDoc +will mistake the note for a pre block if it is indented.

    + +
    # LABEL: description ...
    +# continue ...
    + +

    3) An alternative to the previous limitation is to indent the whole note, +making it a &lt;pre&gt; block when rendered by RDoc. Then +the text layout is free-form.

    + +
    # This is a description of something...
    +#
    +#   LABEL: description ...
    +#          continue ...
    + +

    That’s all there is to it, if I can convince the developers of RDoc to +recognize labels, we may eventually be able to relax the flush rule too, +which would be very nice.

    + +

    There is also a command-line option, --no-colon, which deactives +the need for a colon after the note label. However this often produces +false positives, so it’s use is discouraged.

    + +

    Generating Notes

    + +

    As you can see the commandline interface is pretty straight-forward.

    + +
    USAGE:
    +
    +  dnote [OPTIONS] path1 [path2 ...]
    +
    +OUTPUT FORMAT: (choose one)
    +    -f, --format NAME                select a format [text]
    +    -c, --custom FILE                use a custom ERB template
    +        --file                       shortcut for text/file format
    +        --list                       shortcut for text/list format
    +
    +OTHER OPTIONS:
    +    -l, --label LABEL                labels to collect
    +        --[no-]colon                 match labels with/without colon suffix
    +    -m, --marker MARK                alternative remark marker
    +    -u  --url TEMPLATE               url template for line entries (for HTML)
    +    -x, --exclude PATH               exclude file or directory
    +    -i, --ignore NAME                ignore based on any part of the pathname
    +    -t, --title TITLE                title to use in header
    +    -o, --output PATH                name of file or directory
    +    -n, --dryrun                     do not actually write to disk
    +        --debug                      debug mode
    +
    +COMMAND OPTIONS:
    +    -T, --templates                  list available format templates
    +    -h, --help                       show this help information
    + +

    The default path is */.rb and the default format is -f +rdoc. Here is an example of DNote’s current notes in RDoc format:

    + +
    = Development Notes
    +
    +== TODO
    +
    +=== file://lib/dnote/notes.rb
    +
    +* TODO: Add ability to read header notes. They often
    +have a outline format, rather then the single line. (19)
    +* TODO: Need good CSS file. (22)
    +* TODO: Need XSL? (24)
    +
    +=== file://plug/syckle/services/dnote.rb
    +
    +* TODO: Should this service be part of the +site+ cycle? (18)
    +
    +(4 TODOs)
    + +

    INSTALLATION

    + +

    The usual RubyGem’s command will do the trick.

    + +
    $ sudo gem install dnote
    + +

    COPYRIGHT

    + +

    Copyright © 2006 Thomas Sawyer

    + +

    Licensed under the Apache License, Version 2.0 (the “License”); you may +not use this file except in compliance with the License. You may obtain a +copy of the License at

    + +
    http://www.apache.org/licenses/LICENSE-2.0
    + +

    Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an “AS IS” BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License.

    + +
    + + +
    + + + diff --git a/docs/api/lib/dnote/core_ext_rb.html b/docs/api/lib/dnote/core_ext_rb.html new file mode 100644 index 0000000..39fb1b5 --- /dev/null +++ b/docs/api/lib/dnote/core_ext_rb.html @@ -0,0 +1,511 @@ + + + + + + + + File: core_ext.rb ["DNote"] + + + + + + + + + + + + + + + +
    + +
    +

    +   + "DNote"  + core_ext.rb +

    +
    + +
    +
    +

    File Stats

    +
    +
    Last Modified
    +
    Wed Jun 09 09:03:04 -0400 2010
    + + + + +
    +
    + +
    + + +
    +

    Information

    + +
    + + +
    +

    Class Index + [+]

    +
    +
    + Quicksearch + +
    +
    + + + +
    + + +
    +

    Method Index

    + +
    +
    + +
    + +
    + [Validate] +
    + Generated with Newfish 0.2.0 +

    +
    +
    + + + +
    + +
    + +
    + + + diff --git a/docs/api/lib/dnote/format_rb.html b/docs/api/lib/dnote/format_rb.html new file mode 100644 index 0000000..5533493 --- /dev/null +++ b/docs/api/lib/dnote/format_rb.html @@ -0,0 +1,526 @@ + + + + + + + + File: format.rb ["DNote"] + + + + + + + + + + + + + + + +
    + +
    +

    +   + "DNote"  + format.rb +

    +
    + +
    +
    +

    File Stats

    +
    +
    Last Modified
    +
    Sat Feb 20 07:16:24 -0500 2010
    + + +
    Requires
    +
    +
      + +
    • fileutils
    • + +
    • erb
    • + +
    • rexml/text
    • + +
    • dnote/string
    • + +
    +
    + + + +
    +
    + +
    + + +
    +

    Information

    + +
    + + +
    +

    Class Index + [+]

    +
    +
    + Quicksearch + +
    +
    + + + +
    + + +
    +

    Method Index

    + +
    +
    + +
    + +
    + [Validate] +
    + Generated with Newfish 0.2.0 +

    +
    +
    + + + +
    + +
    + +
    + + + diff --git a/rdoc/files/lib/dnote_rb.html b/docs/api/lib/dnote/note_rb.html similarity index 62% rename from rdoc/files/lib/dnote_rb.html rename to docs/api/lib/dnote/note_rb.html index 315ae27..16a6c0a 100644 --- a/rdoc/files/lib/dnote_rb.html +++ b/docs/api/lib/dnote/note_rb.html @@ -3,9 +3,9 @@ - + - File: dnote.rb [D'Note] + File: note.rb ["DNote"] @@ -19,13 +19,16 @@ @@ -36,8 +39,8 @@

      - D'Note  - dnote.rb + "DNote"  + note.rb

    @@ -46,18 +49,9 @@

    File Stats

    Last Modified
    -
    Tue Feb 16 18:06:30 -0500 2010
    +
    Sat Nov 27 10:48:05 -0500 2010
    -
    Requires
    -
    -
      - -
    • dnote/session
    • - -
    -
    -
    @@ -70,9 +64,9 @@

    File Stats

    Information

    @@ -93,27 +87,31 @@

    Class Index @@ -127,337 +125,355 @@

    Method Index

  • DNote::Session - ::main + ::main
  • - DNote::Format::ErbScope - ::new + DNote::Format + ::new
  • DNote::Note - ::new + ::new
  • - DNote::Format - ::new + DNote::Notes + ::new
  • - DNote::Notes - ::new + DNote::Session + ::new
  • - DNote::Session - ::new + DNote::Format::ErbScope + ::new
  • DNote::Note - #<=> + #<=>
  • DNote::Notes - #by_file + #by_file
  • DNote::Notes - #by_file_label + #by_file_label
  • DNote::Notes - #by_label + #by_label
  • DNote::Notes - #by_label_file + #by_label_file
  • - Syckle::Plugins::DNote - #clean + Redline::Plugins::DNote + #clean
  • - DNote::Notes - #counts + DNoteTask + #clean
  • - DNote::Format - #debug? + DNote::Note + #context +
  • + + +
  • + DNote::Notes + #counts
  • - Syckle::Plugins::DNote - #document + DNoteTask + #define
  • - DNote::Format - #dryrun? + DNoteTask + #document
  • - DNote::Notes - #each + Redline::Plugins::DNote + #document
  • DNote::Notes - #empty? + #each
  • - DNote::Format - #erb + DNote::Notes + #empty?
  • DNote::Session - #exclude= + #exclude=
  • - DNote::Session - #files + DNote::Note + #file_cache
  • - DNote::Format - #fu + DNote::Session + #files
  • DNote::Session - #glob + #glob
  • - DNote::Format::ErbScope - #h + Enumerable + #group_by
  • - DNote::Session - #ignore= + DNote::Notes + #guess_marker
  • - Xacto::String - #indent + DNote::Format::ErbScope + #h
  • DNote::Session - #initialize_defaults + #ignore= +
  • + + +
  • + Xacto::String + #indent
  • - Syckle::Plugins::DNote - #initialize_defaults + DNoteTask + #init
  • Xacto::String - #margin + #margin
  • DNote::Notes - #match + #match
  • DNote::Notes - #match_general + #match_general
  • DNote::Notes - #match_general_regex + #match_general_regex
  • DNote::Notes - #match_special + #match_special
  • DNote::Notes - #match_special_regex + #match_special_regex
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • - Syckle::Plugins::DNote - #output= + Redline::Plugins::DNote + #output=
  • DNote::Notes - #parse + #parse
  • - DNote::Format - #publish + DNote::Notes + #remark
  • DNote::Format - #render + #render
  • DNote::Format::ErbScope - #render + #render
  • DNote::Format - #render_custom + #render_custom
  • DNote::Format - #render_template + #render_template
  • - Syckle::Plugins::DNote - #reset + DNoteTask + #reset +
  • + + +
  • + Redline::Plugins::DNote + #reset
  • DNote::Session - #run + #run
  • Xacto::String - #tabto + #tabto
  • DNote::Note - #textline + #textline
  • DNote::Notes - #to_a + #to_a
  • DNote::Note - #to_h + #to_h
  • DNote::Notes - #to_h + #to_h
  • DNote::Note - #to_h_raw + #to_h_raw
  • DNote::Note - #to_json + #to_json
  • DNote::Note - #to_s + #to_s
  • DNote::Note - #to_str + #to_str
  • DNote::Note - #to_yaml + #to_yaml
  • - DNote::Format - #write + DNote::Note + #url
  • @@ -469,7 +485,7 @@

    Method Index

    [Validate]
    - Generated with WebRI Redfish 1.1 + Generated with Newfish 0.2.0

    diff --git a/rdoc/files/lib/dnote/notes_rb.html b/docs/api/lib/dnote/notes_rb.html similarity index 57% rename from rdoc/files/lib/dnote/notes_rb.html rename to docs/api/lib/dnote/notes_rb.html index f575ff1..2b6cd1c 100644 --- a/rdoc/files/lib/dnote/notes_rb.html +++ b/docs/api/lib/dnote/notes_rb.html @@ -3,29 +3,32 @@ - + - File: notes.rb [D'Note] + File: notes.rb ["DNote"] - + - - + + - - - - + + + + @@ -35,8 +38,8 @@

    -   - D'Note  +   + "DNote"  notes.rb

    @@ -46,7 +49,7 @@

    File Stats

    Last Modified
    -
    Thu Feb 18 10:25:48 -0500 2010
    +
    Sat Nov 27 10:27:18 -0500 2010
    Requires
    @@ -72,9 +75,9 @@

    File Stats

    Information

    @@ -82,7 +85,7 @@

    Information

    Class Index - [+]

    @@ -95,27 +98,31 @@

    Class Index @@ -129,337 +136,355 @@

    Method Index

  • DNote::Session - ::main + ::main
  • - DNote::Format::ErbScope - ::new + DNote::Format + ::new
  • DNote::Note - ::new + ::new
  • - DNote::Format - ::new + DNote::Notes + ::new
  • - DNote::Notes - ::new + DNote::Session + ::new
  • - DNote::Session - ::new + DNote::Format::ErbScope + ::new
  • DNote::Note - #<=> + #<=>
  • DNote::Notes - #by_file + #by_file
  • DNote::Notes - #by_file_label + #by_file_label
  • DNote::Notes - #by_label + #by_label
  • DNote::Notes - #by_label_file + #by_label_file
  • - Syckle::Plugins::DNote - #clean + Redline::Plugins::DNote + #clean
  • - DNote::Notes - #counts + DNoteTask + #clean
  • - DNote::Format - #debug? + DNote::Note + #context
  • - Syckle::Plugins::DNote - #document + DNote::Notes + #counts
  • - DNote::Format - #dryrun? + DNoteTask + #define
  • - DNote::Notes - #each + DNoteTask + #document +
  • + + +
  • + Redline::Plugins::DNote + #document
  • DNote::Notes - #empty? + #each
  • - DNote::Format - #erb + DNote::Notes + #empty?
  • DNote::Session - #exclude= + #exclude=
  • - DNote::Session - #files + DNote::Note + #file_cache
  • - DNote::Format - #fu + DNote::Session + #files
  • DNote::Session - #glob + #glob
  • - DNote::Format::ErbScope - #h + Enumerable + #group_by
  • - DNote::Session - #ignore= + DNote::Notes + #guess_marker
  • - Xacto::String - #indent + DNote::Format::ErbScope + #h
  • DNote::Session - #initialize_defaults + #ignore= +
  • + + +
  • + Xacto::String + #indent
  • - Syckle::Plugins::DNote - #initialize_defaults + DNoteTask + #init
  • Xacto::String - #margin + #margin
  • DNote::Notes - #match + #match
  • DNote::Notes - #match_general + #match_general
  • DNote::Notes - #match_general_regex + #match_general_regex
  • DNote::Notes - #match_special + #match_special
  • DNote::Notes - #match_special_regex + #match_special_regex
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • - Syckle::Plugins::DNote - #output= + Redline::Plugins::DNote + #output=
  • DNote::Notes - #parse + #parse
  • - DNote::Format - #publish + DNote::Notes + #remark
  • DNote::Format - #render + #render
  • DNote::Format::ErbScope - #render + #render
  • DNote::Format - #render_custom + #render_custom
  • DNote::Format - #render_template + #render_template
  • - Syckle::Plugins::DNote - #reset + DNoteTask + #reset +
  • + + +
  • + Redline::Plugins::DNote + #reset
  • DNote::Session - #run + #run
  • Xacto::String - #tabto + #tabto
  • DNote::Note - #textline + #textline
  • DNote::Notes - #to_a + #to_a
  • DNote::Note - #to_h + #to_h
  • DNote::Notes - #to_h + #to_h
  • DNote::Note - #to_h_raw + #to_h_raw
  • DNote::Note - #to_json + #to_json
  • DNote::Note - #to_s + #to_s
  • DNote::Note - #to_str + #to_str
  • DNote::Note - #to_yaml + #to_yaml
  • - DNote::Format - #write + DNote::Note + #url
  • @@ -469,9 +494,9 @@

    Method Index

    - [Validate] + [Validate]
    - Generated with WebRI Redfish 1.1 + Generated with Newfish 0.2.0

    diff --git a/rdoc/files/lib/plugins/syckle/dnote_rb.html b/docs/api/lib/dnote/session_rb.html similarity index 57% rename from rdoc/files/lib/plugins/syckle/dnote_rb.html rename to docs/api/lib/dnote/session_rb.html index 9af050d..43ec67e 100644 --- a/rdoc/files/lib/plugins/syckle/dnote_rb.html +++ b/docs/api/lib/dnote/session_rb.html @@ -3,29 +3,32 @@ - + - File: dnote.rb [D'Note] + File: session.rb ["DNote"] - + - - + + - - - - + + + + @@ -35,9 +38,9 @@

    -   - D'Note  - dnote.rb +   + "DNote"  + session.rb

    @@ -46,17 +49,21 @@

    File Stats

    Last Modified
    -
    Thu Feb 18 11:31:14 -0500 2010
    +
    Sat Nov 27 10:25:17 -0500 2010
    Requires
      -
    • dnote
    • +
    • dnote/core_ext
    • + +
    • dnote/notes
    • dnote/format
    • +
    • optparse
    • +
    @@ -72,9 +79,9 @@

    File Stats

    Information

    @@ -82,7 +89,7 @@

    Information

    Class Index - [+]

    @@ -95,27 +102,31 @@

    Class Index @@ -129,337 +140,355 @@

    Method Index

  • DNote::Session - ::main + ::main
  • - DNote::Format::ErbScope - ::new + DNote::Format + ::new
  • DNote::Note - ::new + ::new
  • - DNote::Format - ::new + DNote::Notes + ::new
  • - DNote::Notes - ::new + DNote::Session + ::new
  • - DNote::Session - ::new + DNote::Format::ErbScope + ::new
  • DNote::Note - #<=> + #<=>
  • DNote::Notes - #by_file + #by_file
  • DNote::Notes - #by_file_label + #by_file_label
  • DNote::Notes - #by_label + #by_label
  • DNote::Notes - #by_label_file + #by_label_file
  • - Syckle::Plugins::DNote - #clean + Redline::Plugins::DNote + #clean
  • - DNote::Notes - #counts + DNoteTask + #clean
  • - DNote::Format - #debug? + DNote::Note + #context
  • - Syckle::Plugins::DNote - #document + DNote::Notes + #counts
  • - DNote::Format - #dryrun? + DNoteTask + #define
  • - DNote::Notes - #each + DNoteTask + #document +
  • + + +
  • + Redline::Plugins::DNote + #document
  • DNote::Notes - #empty? + #each
  • - DNote::Format - #erb + DNote::Notes + #empty?
  • DNote::Session - #exclude= + #exclude=
  • - DNote::Session - #files + DNote::Note + #file_cache
  • - DNote::Format - #fu + DNote::Session + #files
  • DNote::Session - #glob + #glob
  • - DNote::Format::ErbScope - #h + Enumerable + #group_by
  • - DNote::Session - #ignore= + DNote::Notes + #guess_marker
  • - Xacto::String - #indent + DNote::Format::ErbScope + #h
  • DNote::Session - #initialize_defaults + #ignore=
  • - Syckle::Plugins::DNote - #initialize_defaults + Xacto::String + #indent +
  • + + +
  • + DNoteTask + #init
  • Xacto::String - #margin + #margin
  • DNote::Notes - #match + #match
  • DNote::Notes - #match_general + #match_general
  • DNote::Notes - #match_general_regex + #match_general_regex
  • DNote::Notes - #match_special + #match_special
  • DNote::Notes - #match_special_regex + #match_special_regex
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • - Syckle::Plugins::DNote - #output= + Redline::Plugins::DNote + #output=
  • DNote::Notes - #parse + #parse
  • - DNote::Format - #publish + DNote::Notes + #remark
  • DNote::Format - #render + #render
  • DNote::Format::ErbScope - #render + #render
  • DNote::Format - #render_custom + #render_custom
  • DNote::Format - #render_template + #render_template
  • - Syckle::Plugins::DNote - #reset + DNoteTask + #reset +
  • + + +
  • + Redline::Plugins::DNote + #reset
  • DNote::Session - #run + #run
  • Xacto::String - #tabto + #tabto
  • DNote::Note - #textline + #textline
  • DNote::Notes - #to_a + #to_a
  • DNote::Note - #to_h + #to_h
  • DNote::Notes - #to_h + #to_h
  • DNote::Note - #to_h_raw + #to_h_raw
  • DNote::Note - #to_json + #to_json
  • DNote::Note - #to_s + #to_s
  • DNote::Note - #to_str + #to_str
  • DNote::Note - #to_yaml + #to_yaml
  • - DNote::Format - #write + DNote::Note + #url
  • @@ -469,9 +498,9 @@

    Method Index

    - [Validate] + [Validate]
    - Generated with WebRI Redfish 1.1 + Generated with Newfish 0.2.0

    diff --git a/rdoc/files/lib/dnote/string_rb.html b/docs/api/lib/dnote/string_rb.html similarity index 57% rename from rdoc/files/lib/dnote/string_rb.html rename to docs/api/lib/dnote/string_rb.html index ce9ce42..a3ee389 100644 --- a/rdoc/files/lib/dnote/string_rb.html +++ b/docs/api/lib/dnote/string_rb.html @@ -3,29 +3,32 @@ - + - File: string.rb [D'Note] + File: string.rb ["DNote"] - + - - + + - - - - + + + + @@ -35,8 +38,8 @@

    -   - D'Note  +   + "DNote"  string.rb

    @@ -61,9 +64,9 @@

    File Stats

    Information

    @@ -71,7 +74,7 @@

    Information

    Class Index - [+]

    @@ -84,27 +87,31 @@

    Class Index @@ -118,337 +125,355 @@

    Method Index

  • DNote::Session - ::main + ::main
  • - DNote::Format::ErbScope - ::new + DNote::Format + ::new
  • DNote::Note - ::new + ::new
  • - DNote::Format - ::new + DNote::Notes + ::new
  • - DNote::Notes - ::new + DNote::Session + ::new
  • - DNote::Session - ::new + DNote::Format::ErbScope + ::new
  • DNote::Note - #<=> + #<=>
  • DNote::Notes - #by_file + #by_file
  • DNote::Notes - #by_file_label + #by_file_label
  • DNote::Notes - #by_label + #by_label
  • DNote::Notes - #by_label_file + #by_label_file
  • - Syckle::Plugins::DNote - #clean + Redline::Plugins::DNote + #clean
  • - DNote::Notes - #counts + DNoteTask + #clean
  • - DNote::Format - #debug? + DNote::Note + #context
  • - Syckle::Plugins::DNote - #document + DNote::Notes + #counts
  • - DNote::Format - #dryrun? + DNoteTask + #define
  • - DNote::Notes - #each + DNoteTask + #document +
  • + + +
  • + Redline::Plugins::DNote + #document
  • DNote::Notes - #empty? + #each
  • - DNote::Format - #erb + DNote::Notes + #empty?
  • DNote::Session - #exclude= + #exclude=
  • - DNote::Session - #files + DNote::Note + #file_cache
  • - DNote::Format - #fu + DNote::Session + #files
  • DNote::Session - #glob + #glob
  • - DNote::Format::ErbScope - #h + Enumerable + #group_by
  • - DNote::Session - #ignore= + DNote::Notes + #guess_marker
  • - Xacto::String - #indent + DNote::Format::ErbScope + #h
  • DNote::Session - #initialize_defaults + #ignore= +
  • + + +
  • + Xacto::String + #indent
  • - Syckle::Plugins::DNote - #initialize_defaults + DNoteTask + #init
  • Xacto::String - #margin + #margin
  • DNote::Notes - #match + #match
  • DNote::Notes - #match_general + #match_general
  • DNote::Notes - #match_general_regex + #match_general_regex
  • DNote::Notes - #match_special + #match_special
  • DNote::Notes - #match_special_regex + #match_special_regex
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • - Syckle::Plugins::DNote - #output= + Redline::Plugins::DNote + #output=
  • DNote::Notes - #parse + #parse
  • - DNote::Format - #publish + DNote::Notes + #remark
  • DNote::Format - #render + #render
  • DNote::Format::ErbScope - #render + #render
  • DNote::Format - #render_custom + #render_custom
  • DNote::Format - #render_template + #render_template
  • - Syckle::Plugins::DNote - #reset + DNoteTask + #reset +
  • + + +
  • + Redline::Plugins::DNote + #reset
  • DNote::Session - #run + #run
  • Xacto::String - #tabto + #tabto
  • DNote::Note - #textline + #textline
  • DNote::Notes - #to_a + #to_a
  • DNote::Note - #to_h + #to_h
  • DNote::Notes - #to_h + #to_h
  • DNote::Note - #to_h_raw + #to_h_raw
  • DNote::Note - #to_json + #to_json
  • DNote::Note - #to_s + #to_s
  • DNote::Note - #to_str + #to_str
  • DNote::Note - #to_yaml + #to_yaml
  • - DNote::Format - #write + DNote::Note + #url
  • @@ -458,9 +483,9 @@

    Method Index

    - [Validate] + [Validate]
    - Generated with WebRI Redfish 1.1 + Generated with Newfish 0.2.0

    diff --git a/docs/api/lib/dnote/version_rb.html b/docs/api/lib/dnote/version_rb.html new file mode 100644 index 0000000..5cf9f46 --- /dev/null +++ b/docs/api/lib/dnote/version_rb.html @@ -0,0 +1,511 @@ + + + + + + + + File: version.rb ["DNote"] + + + + + + + + + + + + + + + +
    + +
    +

    +   + "DNote"  + version.rb +

    +
    + +
    +
    +

    File Stats

    +
    +
    Last Modified
    +
    Mon Dec 13 04:33:21 -0500 2010
    + + + + +
    +
    + +
    + + +
    +

    Information

    + +
    + + +
    +

    Class Index + [+]

    + +
    + Quicksearch + +
    + + + + +
    + + +
    +

    Method Index

    + +
    +
    + +
    + +
    + [Validate] +
    + Generated with Newfish 0.2.0 +

    +
    +
    + + + +
    + +
    + +
    + + + diff --git a/rdoc/files/LICENSE.html b/docs/api/lib/dnote_rb.html similarity index 61% rename from rdoc/files/LICENSE.html rename to docs/api/lib/dnote_rb.html index e7f318f..4a1e495 100644 --- a/rdoc/files/LICENSE.html +++ b/docs/api/lib/dnote_rb.html @@ -3,9 +3,9 @@ - + - File: LICENSE [D'Note] + File: dnote.rb ["DNote"] @@ -19,13 +19,16 @@ @@ -36,8 +39,8 @@

      - D'Note  - LICENSE + "DNote"  + dnote.rb

    @@ -46,9 +49,20 @@

    File Stats

    Last Modified
    -
    Fri Oct 09 21:22:19 -0400 2009
    +
    Fri Nov 26 16:38:50 -0500 2010
    +
    Requires
    +
    +
      + +
    • dnote/version
    • + +
    • dnote/session
    • + +
    +
    +
    @@ -61,9 +75,9 @@

    File Stats

    Information

    @@ -84,27 +98,31 @@

    Class Index @@ -118,337 +136,355 @@

    Method Index

  • DNote::Session - ::main + ::main
  • - DNote::Format::ErbScope - ::new + DNote::Format + ::new
  • DNote::Note - ::new + ::new
  • - DNote::Format - ::new + DNote::Notes + ::new
  • - DNote::Notes - ::new + DNote::Session + ::new
  • - DNote::Session - ::new + DNote::Format::ErbScope + ::new
  • DNote::Note - #<=> + #<=>
  • DNote::Notes - #by_file + #by_file
  • DNote::Notes - #by_file_label + #by_file_label
  • DNote::Notes - #by_label + #by_label
  • DNote::Notes - #by_label_file + #by_label_file
  • - Syckle::Plugins::DNote - #clean + Redline::Plugins::DNote + #clean
  • - DNote::Notes - #counts + DNoteTask + #clean
  • - DNote::Format - #debug? + DNote::Note + #context +
  • + + +
  • + DNote::Notes + #counts
  • - Syckle::Plugins::DNote - #document + DNoteTask + #define
  • - DNote::Format - #dryrun? + DNoteTask + #document
  • - DNote::Notes - #each + Redline::Plugins::DNote + #document
  • DNote::Notes - #empty? + #each
  • - DNote::Format - #erb + DNote::Notes + #empty?
  • DNote::Session - #exclude= + #exclude=
  • - DNote::Session - #files + DNote::Note + #file_cache
  • - DNote::Format - #fu + DNote::Session + #files
  • DNote::Session - #glob + #glob
  • - DNote::Format::ErbScope - #h + Enumerable + #group_by
  • - DNote::Session - #ignore= + DNote::Notes + #guess_marker
  • - Xacto::String - #indent + DNote::Format::ErbScope + #h
  • DNote::Session - #initialize_defaults + #ignore=
  • - Syckle::Plugins::DNote - #initialize_defaults + Xacto::String + #indent +
  • + + +
  • + DNoteTask + #init
  • Xacto::String - #margin + #margin
  • DNote::Notes - #match + #match
  • DNote::Notes - #match_general + #match_general
  • DNote::Notes - #match_general_regex + #match_general_regex
  • DNote::Notes - #match_special + #match_special
  • DNote::Notes - #match_special_regex + #match_special_regex
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • - Syckle::Plugins::DNote - #output= + Redline::Plugins::DNote + #output=
  • DNote::Notes - #parse + #parse
  • - DNote::Format - #publish + DNote::Notes + #remark
  • DNote::Format - #render + #render
  • DNote::Format::ErbScope - #render + #render
  • DNote::Format - #render_custom + #render_custom
  • DNote::Format - #render_template + #render_template +
  • + + +
  • + DNoteTask + #reset
  • - Syckle::Plugins::DNote - #reset + Redline::Plugins::DNote + #reset
  • DNote::Session - #run + #run
  • Xacto::String - #tabto + #tabto
  • DNote::Note - #textline + #textline
  • DNote::Notes - #to_a + #to_a
  • DNote::Note - #to_h + #to_h
  • DNote::Notes - #to_h + #to_h
  • DNote::Note - #to_h_raw + #to_h_raw
  • DNote::Note - #to_json + #to_json
  • DNote::Note - #to_s + #to_s
  • DNote::Note - #to_str + #to_str
  • DNote::Note - #to_yaml + #to_yaml
  • - DNote::Format - #write + DNote::Note + #url
  • @@ -460,7 +496,7 @@

    Method Index

    [Validate]
    - Generated with WebRI Redfish 1.1 + Generated with Newfish 0.2.0

    @@ -477,35 +513,7 @@

    Method Index

    -->
    -

    -The MIT License -

    -

    -Copyright © 2009 Thomas Sawyer -

    -

    -Permission is hereby granted, free of charge, to any person obtaining a -copy of this software and associated documentation files (the -“Software”), to deal in the Software without restriction, -including without limitation the rights to use, copy, modify, merge, -publish, distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to the -following conditions: -

    -

    -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. -

    -

    -THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN -NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, -DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR -OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE -USE OR OTHER DEALINGS IN THE SOFTWARE. -

    - +
    diff --git a/rdoc/files/lib/dnote/format_rb.html b/docs/api/lib/plugins/rake/task_rb.html similarity index 61% rename from rdoc/files/lib/dnote/format_rb.html rename to docs/api/lib/plugins/rake/task_rb.html index cfb1f2b..bc53b44 100644 --- a/rdoc/files/lib/dnote/format_rb.html +++ b/docs/api/lib/plugins/rake/task_rb.html @@ -3,9 +3,9 @@ - + - File: format.rb [D'Note] + File: task.rb ["DNote"] @@ -19,13 +19,16 @@ @@ -36,8 +39,8 @@

      - D'Note  - format.rb + "DNote"  + task.rb

    @@ -46,20 +49,18 @@

    File Stats

    Last Modified
    -
    Thu Feb 18 08:13:30 -0500 2010
    +
    Fri Feb 19 10:32:22 -0500 2010
    Requires
      -
    • fileutils
    • - -
    • erb
    • +
    • rake/clean
    • -
    • rexml/text
    • +
    • dnote
    • -
    • dnote/string
    • +
    • dnote/format
    @@ -76,9 +77,9 @@

    File Stats

    Information

    @@ -99,27 +100,31 @@

    Class Index @@ -133,337 +138,355 @@

    Method Index

  • DNote::Session - ::main + ::main
  • - DNote::Format::ErbScope - ::new + DNote::Format + ::new
  • DNote::Note - ::new + ::new
  • - DNote::Format - ::new + DNote::Notes + ::new
  • - DNote::Notes - ::new + DNote::Session + ::new
  • - DNote::Session - ::new + DNote::Format::ErbScope + ::new
  • DNote::Note - #<=> + #<=>
  • DNote::Notes - #by_file + #by_file
  • DNote::Notes - #by_file_label + #by_file_label
  • DNote::Notes - #by_label + #by_label
  • DNote::Notes - #by_label_file + #by_label_file
  • - Syckle::Plugins::DNote - #clean + Redline::Plugins::DNote + #clean
  • - DNote::Notes - #counts + DNoteTask + #clean
  • - DNote::Format - #debug? + DNote::Note + #context
  • - Syckle::Plugins::DNote - #document + DNote::Notes + #counts
  • - DNote::Format - #dryrun? + DNoteTask + #define
  • - DNote::Notes - #each + DNoteTask + #document +
  • + + +
  • + Redline::Plugins::DNote + #document
  • DNote::Notes - #empty? + #each
  • - DNote::Format - #erb + DNote::Notes + #empty?
  • DNote::Session - #exclude= + #exclude=
  • - DNote::Session - #files + DNote::Note + #file_cache
  • - DNote::Format - #fu + DNote::Session + #files
  • DNote::Session - #glob + #glob
  • - DNote::Format::ErbScope - #h + Enumerable + #group_by
  • - DNote::Session - #ignore= + DNote::Notes + #guess_marker
  • - Xacto::String - #indent + DNote::Format::ErbScope + #h
  • DNote::Session - #initialize_defaults + #ignore=
  • - Syckle::Plugins::DNote - #initialize_defaults + Xacto::String + #indent +
  • + + +
  • + DNoteTask + #init
  • Xacto::String - #margin + #margin
  • DNote::Notes - #match + #match
  • DNote::Notes - #match_general + #match_general
  • DNote::Notes - #match_general_regex + #match_general_regex
  • DNote::Notes - #match_special + #match_special
  • DNote::Notes - #match_special_regex + #match_special_regex
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • - Syckle::Plugins::DNote - #output= + Redline::Plugins::DNote + #output=
  • DNote::Notes - #parse + #parse
  • - DNote::Format - #publish + DNote::Notes + #remark
  • DNote::Format - #render + #render
  • DNote::Format::ErbScope - #render + #render
  • DNote::Format - #render_custom + #render_custom
  • DNote::Format - #render_template + #render_template
  • - Syckle::Plugins::DNote - #reset + DNoteTask + #reset +
  • + + +
  • + Redline::Plugins::DNote + #reset
  • DNote::Session - #run + #run
  • Xacto::String - #tabto + #tabto
  • DNote::Note - #textline + #textline
  • DNote::Notes - #to_a + #to_a
  • DNote::Note - #to_h + #to_h
  • DNote::Notes - #to_h + #to_h
  • DNote::Note - #to_h_raw + #to_h_raw
  • DNote::Note - #to_json + #to_json
  • DNote::Note - #to_s + #to_s
  • DNote::Note - #to_str + #to_str
  • DNote::Note - #to_yaml + #to_yaml
  • - DNote::Format - #write + DNote::Note + #url
  • @@ -475,7 +498,7 @@

    Method Index

    [Validate]
    - Generated with WebRI Redfish 1.1 + Generated with Newfish 0.2.0

    @@ -493,6 +516,8 @@

    Method Index

    +

    Developmer’s Notes Rake Task

    +
    diff --git a/rdoc/files/lib/dnote/session_rb.html b/docs/api/lib/plugins/redline/dnote_rb.html similarity index 61% rename from rdoc/files/lib/dnote/session_rb.html rename to docs/api/lib/plugins/redline/dnote_rb.html index a7a56d4..839db3b 100644 --- a/rdoc/files/lib/dnote/session_rb.html +++ b/docs/api/lib/plugins/redline/dnote_rb.html @@ -3,9 +3,9 @@ - + - File: session.rb [D'Note] + File: dnote.rb ["DNote"] @@ -19,13 +19,16 @@ @@ -36,8 +39,8 @@ @@ -46,19 +49,17 @@

    File Stats

    Last Modified
    -
    Thu Feb 18 11:43:54 -0500 2010
    +
    Wed May 04 17:11:22 -0400 2011
    Requires
      -
    • dnote/notes
    • +
    • dnote
    • dnote/format
    • -
    • optparse
    • -
    @@ -74,9 +75,9 @@

    File Stats

    Information

    @@ -97,27 +98,31 @@

    Class Index @@ -131,337 +136,355 @@

    Method Index

  • DNote::Session - ::main + ::main
  • - DNote::Format::ErbScope - ::new + DNote::Format + ::new
  • DNote::Note - ::new + ::new
  • - DNote::Format - ::new + DNote::Notes + ::new
  • - DNote::Notes - ::new + DNote::Session + ::new
  • - DNote::Session - ::new + DNote::Format::ErbScope + ::new
  • DNote::Note - #<=> + #<=>
  • DNote::Notes - #by_file + #by_file
  • DNote::Notes - #by_file_label + #by_file_label
  • DNote::Notes - #by_label + #by_label
  • DNote::Notes - #by_label_file + #by_label_file
  • - Syckle::Plugins::DNote - #clean + Redline::Plugins::DNote + #clean
  • - DNote::Notes - #counts + DNoteTask + #clean
  • - DNote::Format - #debug? + DNote::Note + #context
  • - Syckle::Plugins::DNote - #document + DNote::Notes + #counts
  • - DNote::Format - #dryrun? + DNoteTask + #define
  • - DNote::Notes - #each + DNoteTask + #document +
  • + + +
  • + Redline::Plugins::DNote + #document
  • DNote::Notes - #empty? + #each
  • - DNote::Format - #erb + DNote::Notes + #empty?
  • DNote::Session - #exclude= + #exclude=
  • - DNote::Session - #files + DNote::Note + #file_cache
  • - DNote::Format - #fu + DNote::Session + #files
  • DNote::Session - #glob + #glob
  • - DNote::Format::ErbScope - #h + Enumerable + #group_by
  • - DNote::Session - #ignore= + DNote::Notes + #guess_marker
  • - Xacto::String - #indent + DNote::Format::ErbScope + #h
  • DNote::Session - #initialize_defaults + #ignore=
  • - Syckle::Plugins::DNote - #initialize_defaults + Xacto::String + #indent +
  • + + +
  • + DNoteTask + #init
  • Xacto::String - #margin + #margin
  • DNote::Notes - #match + #match
  • DNote::Notes - #match_general + #match_general
  • DNote::Notes - #match_general_regex + #match_general_regex
  • DNote::Notes - #match_special + #match_special
  • DNote::Notes - #match_special_regex + #match_special_regex
  • DNote::Format::ErbScope - #method_missing + #method_missing
  • DNote::Notes - #notes + #notes
  • - Syckle::Plugins::DNote - #output= + Redline::Plugins::DNote + #output=
  • DNote::Notes - #parse + #parse
  • - DNote::Format - #publish + DNote::Notes + #remark
  • DNote::Format - #render + #render
  • DNote::Format::ErbScope - #render + #render
  • DNote::Format - #render_custom + #render_custom
  • DNote::Format - #render_template + #render_template
  • - Syckle::Plugins::DNote - #reset + DNoteTask + #reset +
  • + + +
  • + Redline::Plugins::DNote + #reset
  • DNote::Session - #run + #run
  • Xacto::String - #tabto + #tabto
  • DNote::Note - #textline + #textline
  • DNote::Notes - #to_a + #to_a
  • DNote::Note - #to_h + #to_h
  • DNote::Notes - #to_h + #to_h
  • DNote::Note - #to_h_raw + #to_h_raw
  • DNote::Note - #to_json + #to_json
  • DNote::Note - #to_s + #to_s
  • DNote::Note - #to_str + #to_str
  • DNote::Note - #to_yaml + #to_yaml
  • - DNote::Format - #write + DNote::Note + #url
  • @@ -473,7 +496,7 @@

    Method Index

    [Validate]
    - Generated with WebRI Redfish 1.1 + Generated with Newfish 0.2.0

    diff --git a/index.html b/index.html index af9903e..bb0fafd 100644 --- a/index.html +++ b/index.html @@ -1,9 +1,11 @@ D'Note - + + + -