From 7f5e1082d1d66fe87deac0bce7f6909290b377f3 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Wed, 11 Dec 2013 18:51:32 +0530 Subject: [PATCH] More documentation --- manual/edit.rst | 65 ++++++++++++++++++++++++++++++++++++++++++- manual/images/sr.png | Bin 0 -> 12112 bytes 2 files changed, 64 insertions(+), 1 deletion(-) create mode 100644 manual/images/sr.png diff --git a/manual/edit.rst b/manual/edit.rst index 01e69c7103..c6f09e7f53 100644 --- a/manual/edit.rst +++ b/manual/edit.rst @@ -58,6 +58,7 @@ The Files Browser ------------------ .. image:: images/files_browser.png + :alt: The Files Browser :class: float-left-img The :guilabel:`Files Browser` gives you an overview of the various files inside @@ -120,7 +121,7 @@ Changing text file order ^^^^^^^^^^^^^^^^^^^^^^^^^^ You can re-arrange the order in which text (HTML) files are opened when reading -the book by simply dragging and dropping them int he Files browser. For the +the book by simply dragging and dropping them in the Files browser. For the technically inclined, this is called re-ordering the book spine. Marking the cover @@ -145,3 +146,65 @@ Deleteing files You can delete files by either right clicking on them or by selecting them and pressing the Delete key. + +Export/import of files +^^^^^^^^^^^^^^^^^^^^^^^^ + +You can export a file from inside the book to somewhere else on your computer. +This is useful if you want to work on the file in isolation, with specialised +tools. To do this, simply right click on the file and choose +:guilabel:`Export`. + +Once you are done working on the exported file, you can re-import it into the +book, by right clicking on the file again and choosing :guilabel:`Replace with +file...` which will allow you to replace the file in the book with +the previously exported file. + + +Search & Replace +------------------- + +Edit Book has a very powerful search and replace interface that allows you to +search and replace text in the current file, across all files and even in a +marked region of the current file. You can search using a normal search or +using regular expressions. To learn how to use regular expressions for advanced +searching, see :ref:`regexptutorial`. + +.. image:: images/sr.png + :alt: The Edit Book tool + :align: center + +Start the search and replace via the :guilabel:`Search->Find/replace` menu +entry (you must be editing an HTML or CSS file). + +Type the text you want to find into the Find box and its replacement into the +Replace box. You can the click the appropriate buttons to Find the next match, +replace the current match and replace all matches. + +Using the drop downs at the bottom of the box, you can have the search operate +over the current file, all text files, all style files or all files. You can +also choose the search mode to be a normal (string) search or a regular +expression search. + +You can count all the matches for a search expression via +:guilabel:`Search->Count all`. The count will run over whatever files/regions +you have selected in the dropdown box. + +You can also go to a specific line in the currently open editor via +:guilabel:`Search->Go to line`. + +.. note:: + Remember, to harness the full power of search and replace, you will + need to use regular expressions. See :ref:`regexptutorial`. + +Automated tools +------------------- + +Edit book has various tools to help with common tasks. These are +accessed via the :guilabel:`Tools` menu. + +Edit the Table of Contents +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +There is a dedicated tool to ease editing of the Table of Contents. Launch it +with :guilabel:`Tools->Edit Table of Contents`. diff --git a/manual/images/sr.png b/manual/images/sr.png new file mode 100644 index 0000000000000000000000000000000000000000..5b05c22b256b64014aee46621a68466bc831afdf GIT binary patch literal 12112 zcmbVy1yCH_+U6t#7=j0aySuwP3dNM~twJ z1BR3s+Iwd1`il}Vs2ChqEEje42;(Rdbc`|M~+aOcX!-FFeK<$S+(*ty}6;}^br_w zK-gmeeo%}MqROy{@@nONRK?b~FE1t~BF=(+)XOMhw!Q2s&L#dd>aT1}Oe*O(507gq zodCNah8rCgEi!M#B;-FaP!mg<{&5h90QAB8bEZak&*V?}O< ztk8MUr3o*Pb*&=fV!iWM z!=qX=%1$-}cXrm7BZ_0Z5&tTc9Fs%%>5Wb3c8w%@K1!AnmgkH3$3vbA9{F?&n|3|` zz!(XnDwE%RnQeY09V-2@@_lv$0-2orxlEC|n}D^s)cIIeA6fpPitdKFe4br`II&IC zAYXO+lchnI&!lKgp>ClD-N@>%(p;IpG>i1m1XWz-o&K7(-aJ_YR}K>*!0m4C8l7K% z0suZ*p3CGLRx2xllt59o2iwei=$7lM?>2p}kBe2_*AfjA5{?~bNK^fsi0Vv$=K72J z-f_vwQDH_hj?D#9eq>|{Blf{lrlub7<%X&({NhHpQdu&81qdwrfmd8y_^F`q=lkv0 zF-(crsp;3cP05VdK3PpW!iTG+|%&sIO-ncvu55 z3eVP_+__eMNTJ|H-L}Taa86f`$(INJ?Rq!ckJl36Izui>GU?OiGp8vn~K zCcS)EW>o0@t0XW^J}1RjR_VDWtUAQ&THUr>z(So#d6Xy32|d{CS3z}h7arc%r$=mJ zL7GYfg^Lbo`>E=?@TFh%o^usfdn*bX>&A)*Jd|MP)w#l~Aw%M2>Nc(DWY~LgAexay z`UA+g$hy*geO0Ho!)vC_^T} z=R$q`$1BamLV;4&v1hWTHQ2KZ`s(dg^7)ABMaC6a&#Q12e_zp;APZ?3feOyQINiz= z8E&l~7fvrxhI~6YDY~-^##Odrc1mIg0J!`XGzG=f1X}ET4xl+G;rNfx^s22a#T*tP zCtii%xB{KQ+fdH?2L+@MjFj`;Y;&qCsjFTpbzgN6DtwM^f^k)Im0nHK0S5%U)`rhTI)*O_3Skob)7;|e-<`G zfcDF{Vu|NW*N*}>fVsstEz5W&*PZ| z=%+((nb{w}D|hB{J7ew;&S)Sx&q=W~AxT48hspS}Q8O#?>KI8?HEekc`FQTtqG%XY zN*=<-v9qe+kyZCF7;e^8d5~7iec<#3ld_<_%YN?Q#qiN?se2RL=Oc{X@X zSCk>Qq#O9I5xc5Lx+XVIS)ly5sjRZlC(hbBOgFGvY@o+G?G;UBWr~er3;+(7*#vN53R@h}yzwx#6f2B{mA+>gKPjQlAQy)z&4RM^XFT{X>OF1my$LS){gf5V1>b%_nd8f7s+?HY z(MOGqpJY@JlWHGT1UFZwK>mE=A067*cTepZd5Bu#i#9-SfAip(d>T~H_!ZXr(fqA3 zPs%$9kOq4P_u{7>L1RQP_=>T5kHv5#B3d{lE)Jhqk<5)lC^KH(JEUNB^}5=#k>+ag zY-{W~@j$!zYRq~}Mh&@B%s@#bf zK_bE<(zE)6VV6UxGL6`ulBL-*Fj2f;XAGr1rR=bf`s`{U!#zHQdGH!Op0Yiv0At5w@YgDvjn(k}D;Ub?*{)?4jt z%UOmoE(1@`=_tq3J=Nyr!XLvxL!qk&?0_{deV z%CQECtnmK1n<2DFehh&AA9zvP5^+>7161mYS z%4iH)-MWjtk-H(~i!`qfULNdjzkhDm^k9Dg%ny{9E-UD0H5hlv} zYM7{~N(31h8{4PA0{~@v&K3yLNTf6>T$L;g@8Sw3jZ1#3&f+DTS*MeaEPtEk!TeEj zs~VC{>Q`F+rgzmCk*e%RZ~gwtQZtH-q^^tU-%;{PYS`#mlo+r?S~MAwVmV2}LrDY{ zjrZJjLwm-Sv5M@lUU~0oJQxG=QMzm9V@X}VgvzRCdYy??*t=pzQjhxi!N6dUp;h_3 zb^p6k`)Nc#;6eVpwW~{A0@en$hrH{97H$enbCnU2uccG`!DmIZAHG*_EBVeBYV*f) zT#^c@XuQ09)Dq8DM|UtwnBAE#f=sHn1fm8&m72~>mM6bMU=toO92lP`SNg%>_p3>n z{5Z&$f?GaEQqfvbbW+IQ4;$1a?ES{6+r}?%H6E-K2fM=YOV{`z(9o3QR z;Oc%RaVxQ}rO0qK2t1=e{4w2WwL+*&Eo>E4%^VHgxiBCIzt znU5yuYYcWjYX4w%y#%vppOcFj$Zg_Sxy(i77zsl4sA_X+r>zcdS{2#mNjT};m|pe5 znT~9`rQ;t)+hjU>_sZ}=Zq`TTD4ln^Ehwxx)=r;?d5Fcwfp)td&Ce_ZvuC00gKY%r zTQ$;6HGyh^pUrLK@n7ZQ$>>TY>(St7(A>X!bBKpwNDO|vy15R;T0O+Yc|K|B_kCgR z0g@MV!H`~<I>EqJ>+{emWS7EQUmJa_(G=_NG8*zE!4neduo~iAFNkrW!_5r({*3lf< zFYf4QXv8AEyH~GC%%U1Szh_+-YTtZYU;pOt+iXYLXlO%ziax3EdaNz3GbmUxsF&8y zm8JbwAO7aHCpoQGQZgvGJrvwPY3L||YpdXp0aQ;`Sc!@Ks9FfE(;<_m)z(Bc3?rw& z9LL9$_^PoZ#(devO z&_&$@hU$S=ZlD907t?E}3Z|G6`Yt2!FDnl0zcYj%0-nw@taBBup{=l4XckuKo0P6b zMd3B~l}+OQ)}UT%_3iy_`+^xFPfUYg!)*pQf=y;1v;90K!IMGPsv^kiAgS;%fJZ08cG~DTD=Wg+Yi}}aI zim95zT1YhVrIW@7Z=qxu>;+v<&Z%F#JWC<#qahX!rY!1M>NXgn>j+*WJ@UAz-r5j{ z*QGI+qNvRWH=~Op&*t!@tJg+~%Vn+{^(Qvy>^7&DV%779Ec8(pw}@aNx}SZUjLIqx z6IM(emwv~^ZX;p)IR^v>5X(0vAgsO&#pn^*KyB+tw0)R+N&UscB^Fe}@_U_~%gN^x zgoZ=+_tI1FZ-NQPjLJsF+GeV&iCstmxCKV~9`r zMxAzu`*|(c>30sw;U0N0o**we;#-}e{-O9Ks@GS7BJUFzGEyoxjLDB?A8j?RDybzY zKR9L?<+SW=&L1I#v;>94CZH=3)zp9D$;)c%2_28p`zv8bTSUvDj{PRbz_yvFHM?pD z20;IM1thOp&y~kNkV;9LY}1G72CaLU!%z@G&u&IY#NF8}!Ag|I1B>{HX|=CT_8ve8w<{;hQ%d zCo#U6)AnVUq(=hkV+l0Ntuex zkc7*kmTjZTId3v?;;5u^A=2u5J!FPY^p5v*3H8*dYxi`^uM?Bd{cax=%T**#z)`&> zM{kU}IC99Ifp+0|d5J|y^=>Jgv&0*56$-Wc zC~yvM%i7#YYi90mZFkK@Gt^k7ZB@&$_?i7%AdQAV_0(zkF%u}-U?0@hA>!RFSY~f@ zqGXJ}MjmO=5q~$_Qw#TSbI5xeoR*w#i(*}VSdbJDq#LEpmwR{hqDU|W{xK2Gh*s%^%l7C&H#qke3jLNbo*d(VyINPBuVnW+V*yny- zB=>i|mJ#x!*RK*W_8z%8i_3*;qzn;)8Ssv`q@kbXouE#Hk=j}zb}In9=UTl z`*6{%feybwo~KpUWF%PGgk56CwRDO)Oe0#XGdfnCu5`*9U!jw=4#f4Q$1o*ZA@4ii zL-0a?UWy0DgIvdfJ9J=HOThig{)9DX$>%lTfH{BCY5$QQQTFqa#oBjw`-vKraOWGl zobvk@5yJ0|>s3hxHr8;4i%AN&e(B8^ejPU4GC%6tuybrw*^kcj$T?V|%)zDH4X; z#w$u{&ejgKjuNkfVzr0ll&w$J6~e?uf&YSw?}0O(LCo6zqqKM)c)b{ZX_oUP zbKW>f001SyQg1*i1?n`-XMtAvlY?fGs(zWxu{qidxz%5~AHnzs^ywB`Zv_z%X(Nh8-B~{d$B0$d z5PAHOy~Q^3rVlX(Wb$jtv#7~{Qt?#MDm!DbiF0Is>%0L9utr8l_C1mZP`<(}!RNlU z)A$2>xd{GWa4|d{ioTMjg}Asl+;@Cr>1nj<>#-`5H!xkC{GHB$Ezg(0nTUbux8v$+ z0I^YUisOT~N7MV85aklJ+Dg(x$$jB5=&?URfdJ>1-0ysX zE|t9%j+Px3MhEdEBB#p{=j9qX&n*oJN%=+{EVNn=%P(yL45rSM80!f-WP0F;%lG0PeS{5G`~K9@l;brD8otYChZB)fpi%ch=`B+=@!YV^enBV|Lk1NJbCyhKBL z!$WQ>?F9uE94+|Inl&YtBoH3o9E3u&Xp?UqN;(f<@L#?H@Z}DVmwGV?28y`v%tF|E zI>aZHH)rWHXvK<5z|=L%5 zTBP=l`qcd<-!kfGjgyLxufTV!O%UE()Mhk9#n*SUuiIZj0!F8NWLX}WmCW99Ntu*BUJPz>FHuMs2=sm3Fc-&NHA|@J6c?}t= zzKLAjrpK=ChTm9F+B^B_7*gANUg1<#)SU28M>@ z8_3$&d`_dD<@K~v0A@Eksmm#7;VUX+`5V1OLi?5>LvnS~mBU5HBt&7iaCyqI^M|?( z^WBX?Bq@7(C=tMQ`CcjXEh}C_2hwggO-iJkd=wN+LZ%ZT?-8-wwVj-=`hQ98KHC%M zYOU#VaKSE7F!`OV9nczW(>mmEZ9_htSR=)IDyBD3#+5ge^wegt1xyX9$BS3O;6TGIu~OY z`<3cKT3ee&hSvv!mnzW1u47?n0Z7VYzMoy*`b9qSQD0aoM5^E`8C|&KG_H@|*>+De zhsUE+BcIZa2i>-AF4t!bptfq551vr5n%e=0n4Vz&B) ztj^N)z$4q{Yy)$o2c#ZI-Z${nVAUJUlfZlQ>*eseuy^SfE@^cQ$QQS|ecE(+QMl{a z@G5&lduGR$!4`4pEJ3UE=08|95_VH3I><@_C=d7ZqDsUsX7f^zmiAT|PAJy3frz0H zn`LiD){C|G6t6zcy zT3_-fI?V*ln1#6A>{>~Q#Pf~k79qm2%)Xp;+w!ZY0vh}35xH=z%AS2m? zc)2f&wi;IRjZrT{-`dzrIm8Xq4GZd%ga7 zAsA6U3%95T-{IF@m!W}LpKc`XS~h0d>P}Yo9B+3vpCAhCC`u8+}oS< zN&T8ft3%Q`$yGa;J)yj4{f&F1UN?ip+%mv&(xQC>-BwQh>(Tb9I70BRF3}yx_URp` z#4Fyd6=fHqW@?)28zT=UlJzsonV{4y`BTyxKjA1i`G93IU-68zlh>$kCuT=5H*^nA8ggL{IwsGqeD3&C*I&{1p%sL?feU#eAmrSS*jeYf5sCU|=}Z z=zjRI26RtDE!mm6#e(rW^1}oF%28cu%TP>*Q_P9^mpQ!BG|<#h;A+*{*;pbw%hs}>eVS< zFwK4q%gH!Z%GfIoDxzZnRW)Q*6B+jy!{51FuBst0Z|_$my>cG`4`K5(a&2K+KV==M^_f0QzR>$d-9PsG)+(U zSA={{012zBvTAMu#T1sT%CF4(N2k)eeU{E&$6K*8CWP|V0yU8kS$56(EFjx#tFM%b zz)pgpsTBBvi15-tcp~x;tF%PS@V=Pm6_H0Kb?}B&;ln-*l)V2qMC0NgGhh`EW}4;{ z9jN2Je?dD^rUM#2-{lXia(2>RGuZ0-qJ-iTmhwhd=ZE(LVJ?<}mI;^a6be7uSz+j?WYovOX&LFvY|13gA z443>WGI4$KlNAq>vL)8vZYDG7bNX=Mj2l$(qnX{@+xHSCbRV?Bv$m;Zz66EYJfvjO zPd7IxxcXk@z7D3VF+g-4Y2BjuX~diAK;LX$e^%mMxu<5Hr6@eAu!8|{+C^;1& z*IKU)Z5jOfrmBN&=egeYIGJ*OdR7QTPQ(Qur?TcYwOPAb8x4OfG=KS-6LYjBq0zQd z(nA3ZFSs@hPVSe8)Kg(D138JtDuY{7p{AaYM}@AHGa%t?h}2@4-NuJnV$p!d?P0C> zgao7@JYI)P?pK!S-}kEcA3lx_DL-YCaM27>|G1kyy0V-SL@cJZS(XrDT&2? zLw1`Y8s5dI^UAOIGp2ZNNlW{cIHr2g`h$jS-wc&12%}_AI}2@3yVg8p9*g#yw}rBL zk~`NWb4HuMCcsqBmQYnWaWuw;O9Jvg^r?`}Vy@EwoTb^SBYAmxVg08?W_{t3eNLlo zjSdO35bR@|Q^OUFG4o7aPQiN_eTP#3eXv|%amGs+BTvV!bdru-wNuI#^{4u754ZD; zqD~fbi-4$>21%8}1i|am)Eei}NlmDva9KIOQkKBy>`l@}FYzLsl)y~;V%0V8wdNjW zTs(gJnHr&izUc^2ooj1I{-vy|iF!&_B_Dkd6`LhSnRx3bcvs#Ot>|lZyP3D!hvoiG zdvXpFd`1Xnn)~F8aw8UN>Jvb67RFq$om?vR*#=i%k%K;dH*qYsN;9p=>utyw{&P3$ z=y^d+uAPnfnpT>CV2hY|oU1~=QLK`A#pMpxPJc@QFS}9QHS)eZ zU;Q556yT32YYArzKMuNsLZV668m!f{w6ttrD=i{6sXuzq-i>wUm&N43|HM3AsW09e zmh{YU)rm-cbxp<4?2Ciug|BZYe{Qkd#v#gDp}-eF(Y0+w$}UlnMjX-Y$EdAB`BBM0 zKp}`9H4M{a%|vXeWo^^wXnrn6EOi>k=nMJv@sj}9%JnEqKY6tC>A^EBy86bBMds`I zF%-w&ZM3N#37%=Z-bUm6M^cOTnuFKNy)c+|_b?i!J}WEx6m)AE?%!=`JZAq7OzDx^ z(C-cl&G(QlwMcEvtF!AYJGdUaw2U0qmNw_Pn*(wqe|GPaI?qU+(Z_2W@}{4ukM-Xf z9Md+e7P>BeV|b4ovEJx^fO*<{{)PvY^_H6vULk1~)m)?ZhdE(3aN}j%`gef0{#>{N zF7;`v31g$%rNu0k2mFefy2;7BId(r~shTJ`SoGzGW(mBJy=T)>8Y=@aWm0!B9Vd2+ zSB2WFuSa@G@*!O|VHg&V_XvbwqnpD@yH1t|&5<^3Gbd6}1d{>Y0{h8l$LsCe&V9>M z!e#M?2VO+3V@W?e&dI8$bj_;{!Q3M@m%kowq!|M`GgW^Opx(orn(-H-AcBky+W#$m zuAZGAG=yAI1TS<-2X=}VLUx)7smp4BbuC^>N;W|z#&2zLfg_vs!K%8?PMFdMdMt({@zo9N8aOX1 z`sgBkI-OhkgDm9Z4@`+KBZs`IZ?%JYpgto-!He`QOieA7km^ zvheMY@V5mMo4^+T()S@Y|5dy#T+>o59>`;fHZdOKG99Z7&{ktU2=(ooj|KAJL zznCN%%nrqoal3XM4OAE&sSSdQnTON4-B)9NjGDcs=t`&k)nV?j^~fYF(J+lH*%d*6 zNtXO3+Cab@n$B(JY3>|SS4ykERfrUYajfP1yzN+AW$43We6aIb#PszYTI$VyCrClF z`Pm_Wceick&^NCI74P)(@XKz)X8UQey&?k}g~ZO>!PW0)gU9!Yw$;jEtNL8*eyup< zwXVa>#Bxzlg>YYo2C$IAsBNSI#m?B@J)jb-xvw7l_D?3$86M=el|c|%VMzNa{SW0; z1*W_<2w6?CG8*AJaOgoweM~|yC<;z4+L7E9<>$CpRp44o-4dw}epDRGq- zup6BQlZARp-52@_DdGBolvMVZ_hm=7NIBW|M@TYL_!^3d8!m5e!mwMJBLR z$5zAQ`khn_h6E&>BTV-x&9ai-H`c*qW>jej$~Qf=)LYNh-k%(!Y_Fd`kgDN? zJSo5lI;01b{G<}~?njn?1Lq($sO<%Xw1#yttmDt)K77z;WBRd-|BkQ%ouah-adj#e z6G$G{Q-5VET>QeivAvNqoBk_T-7Yl#0%=a}-5))@QLjigV8!$#=B{v+^_b}~ux9{1 zTS0Z;SZ^Kyl`sj#8+0fyb9O=ezUE0#w_NKsjHX`gc*yIk%Ucj=u$yM75oVQgZb=`JMx5?+zw z_OE-`J2C6Q&$8C{PM;J@3or%vBV%ORRj9US^@YvjtZob$Q?ZU zN8-&pZ|LEi#Rg2U{Q$QEZhxxrV|;4^=)MAc?E2B){70Am&&k~XG28oJ6`o1)Oup)+ SJ_aZLi42lflB$w04*Fl(+K%V| literal 0 HcmV?d00001