From 452f7705a7ef0e64572da2a2c44e79b6a449f550 Mon Sep 17 00:00:00 2001 From: Yuri Chornoivan Date: Sat, 21 Sep 2013 19:07:37 +0300 Subject: [PATCH] Add some documentation about usage of Okular annotating tools REVIEW: 112569 --- doc/index.docbook | 249 +++++++++++++++++++++++++++++++- doc/tool-ellipse-okular.png | Bin 0 -> 1100 bytes doc/tool-highlighter-okular.png | Bin 0 -> 1536 bytes doc/tool-ink-okular.png | Bin 0 -> 1710 bytes doc/tool-line-okular.png | Bin 0 -> 849 bytes doc/tool-note-inline-okular.png | Bin 0 -> 803 bytes doc/tool-note-okular.png | Bin 0 -> 973 bytes doc/tool-polygon-okular.png | Bin 0 -> 664 bytes doc/tool-stamp-okular.png | Bin 0 -> 1074 bytes doc/tool-underline-okular.png | Bin 0 -> 629 bytes 10 files changed, 243 insertions(+), 6 deletions(-) create mode 100644 doc/tool-ellipse-okular.png create mode 100644 doc/tool-highlighter-okular.png create mode 100644 doc/tool-ink-okular.png create mode 100644 doc/tool-line-okular.png create mode 100644 doc/tool-note-inline-okular.png create mode 100644 doc/tool-note-okular.png create mode 100644 doc/tool-polygon-okular.png create mode 100644 doc/tool-stamp-okular.png create mode 100644 doc/tool-underline-okular.png diff --git a/doc/index.docbook b/doc/index.docbook index 70b9364ce..1f2236e5f 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -488,7 +488,249 @@ Context menu actions like Rename Bookmarks etc.) its buttons or use keyboard shortcuts (keys from 1 to 9) to start constructing that annotation. - The contents of the annotating toolbar can be configured using the Annotations page of &okular; configuration dialog. This page can be opened with &RMB; clicking on the annotating toolbar then choosing Configure Annotations... from the context menu. + The annotating toolbar helps you to make annotations with drawings, shapes, and text messages. You can use the annotating toolbar to mark up a document (⪚ add lines, ellipses, polygons, stamps, highlights, underlines &etc;). The table below describes exactly what the default set of annotating toolbar buttons does. + + + + + + + Button + + + Tool Name + + + Description + + + + + + + + + + + + + + + + + Pop-up Note + + + + + To draw multiline note. The note will can be viewed by double clicking on an icon in the document. + + + Click on the tool button, then click on the place in the document where the pop-up note should be added. Enter the text of pop-up note then click on the Close this note button in the top right corner of the pop-up window. + + + + + + + + + + + + + + + + Inline Note + + + + + To draw inline note. The note will be shown inline as is. + + + Click on the tool button, then click with the &LMB; and hold to place the top-left corner of the note, then drag to place the bottom-right one. Enter the text of the note then click on the OK to save the note, Cancel to cancel note entering or Clear to clear the note. + + + + + + + + + + + + + + + + Freehand Line + + + + + To draw free-form lines. + + + Click on the tool button, then click with the &LMB; and hold to place the start of the line, then drag to draw the line. + + + + + + + + + + + + + + + + Highlighter + + + + + To highlight text in the document with some given background color. + + + Click on the tool button, then click with the &LMB; and hold to place the beginning of the highlighted text snippet, then drag to highlight it. + + + + + + + + + + + + + + + + Straight Line + + + + + To mark with a line. + + + Click on the tool button, then click with the &LMB; to place the starting point of the line, then drag to place of the ending point of the line should be and click once more. + + + + + + + + + + + + + + + + Polygon + + + + + To draw a closed plane figure from three or more segments. The corresponding note can be viewed by double clicking inside the polygon. + + + Click on the tool button, then click with the &LMB; to place the first vertex of the polygon, then drag to place of the second vertex. Proceed until you draw the whole polygon up to the first vertex. Click twice if you want to add some note to the polygon. Enter the text of the note then click on the OK to save the note, Cancel to cancel note entering or Clear to clear the note. + + + + + + + + + + + + + + + + Stamp + + + + + To mark the text or image with some predefined shape. + + + Click on the tool button then click with the &LMB; to place the stamp. + + + A single click just places a square stamp (useful for icons). + To add a rectangular stamp you can click with the &LMB; and hold to place the top-left point, then drag to place the bottom-right one. + + + + + + + + + + + + + + + + Underline + + + + + To underline some text. + + + Click on the tool button, then click with the &LMB; and hold to place the beginning of the underlined text snippet, then drag to underline it. + + + + + + + + + + + + + + + + Ellipse + + + + + To draw an ellipse around some chosen area. + + + Click on the tool button, then click with the &LMB; and hold to place the top-left corner of the circumscribed rectangular for the ellipse, then drag to place the bottom-right one. + + + + + + + + The contents of the annotating toolbar can be configured using the Annotations page of &okular; configuration dialog. This page can be opened with &RMB; clicking on the annotating toolbar then choosing Configure Annotations... from the context menu. With a single &LMB; click on an annotation tool button you can use a tool once. @@ -516,11 +758,6 @@ Context menu actions like Rename Bookmarks etc.) Annotations page in &okular;s configuration dialog. The Annotations page can also be used to configure the content of the annotating toolbar. - - Using stamps a single click just places a square stamp (useful for icons). - To add a rectangular stamp you can click with the &LMB; and hold to place the top-left point, - then drag to place the bottom-right one. - Removing annotations diff --git a/doc/tool-ellipse-okular.png b/doc/tool-ellipse-okular.png new file mode 100644 index 0000000000000000000000000000000000000000..82d1d18a81bc3ac441e3769a56c3ae342b3a051a GIT binary patch literal 1100 zcmV-S1he~zP)G0qo^3@an7i_Wu9>_x}Eg_VW|%=MnAaIPmLV^Y3-_@l*2cEbr+D?dCA>>a_Xy z+}zyE%*@Zy(nRa#2jJR4?C8Pr@c8)n`}_O+{QUIv^!)$-p7`}0?&y#A^ycQ~=jZ3x z*x0tVwqVD^B&?_}u&k`;=C!r8uCA`^?Chqdrp3j@t*x#2{{Dpa@&fGTvHAD@{{Fqa zy>gTO+v8br1v$M1E^70Gq=GXlDIx$Eoe%+1X!y0sL^!_WEm$jHc!j*imO z(zLX+xVX5dr>BAT@@4ezrKP32ySrelsvEqwC+p_U+uE$Gtir;=udlDq&(EWyqvYh| zzWVqD?B=-o`0noR^8EZX;oLs(>gVzC_V)I-+1L>6=XUk+9Pa29?&ps8^Wy#dWb^L? z?B&?}`#|yR8SdzS_VT^@_;mI0YxMB;{{Ff8_%!h9UGwhV{rtbbzvANJ%=`MH`1X4B z@jdbDhxYTX`S;-c{Gy_w-QC^C$H$!^7z4=(@VP@bK`ku&|Mlk-omZ z)6>(`)YReO;pyq=E>Pc400008bW%=J04^y3$vOi)WLmQ}0004}NklJq~>XLt$YfBn8GMre@|AmR8m_ws!W`4#pfDj!wePE(is# zrf%*Yo?hNQzJC60#sPsK2|?kYU?eMaLxe-aT*Emy!hsk9B7`H66huYG#G(a2oNzpn zf&}42^bq1tN=`v2NEMbvSCA$xoDNfv!I7Djox|a(3v__1D~E2bLtZ{dfp8(*ilX9@ z(z0^hipmV@s%pEinyT6i4vsqEdbomyyvC;Hmew{0-`e)74u_h~u5Oc_Ug18t0#(=k z2@{1UO?Ktb)8o(%x8>-cGIg5pbkw+rnjt)MmITy+v**kemKR5htaQd zvD0r?yDw&vYpY(hJFj++gZ18hRr}kqq{;9D+6Q&F=$X0(9y;8wO)ymtP6Ys|AbGd^ S)qm;$0000u*za9L6ywDnX+VMTDYUw(izVos7#A1@Vre;N7S}{R7k&zEBBD^o22oC~Cx@37I%h z$AGa57m>@>ZQWSAd$)C6VRLPFv4ghT+OyMs{PtJ2#4Nz3f^R&@lbxNc`#jJ0_kB*M z0RO3CSH@*lis*_l1JP*Ia=8?V3|D1kWo3(jE5{6Q87_S!OzVMl4Aef%v2W&`{BZTO zS(nRzg0~c}hEvO-|6_0@(U^Ok?d@e#re1ObBU*^o;>WJqoTB(7O>j?nZCE6|H$C!SYo0ynR*fB{MJ*9>!i6gJ(g{yKwqJfg8~5 zj|e=O+O5-@K74eF;hcdmFaqd6^dG|qJWjl&nNU3wJa2(3Ti~}5Zh1i9X;`*g?|SF{ zDYuO+VTd`z)ZA{Q;-rb1`c%$_=F#s@AjEtES|S5ON%Ab25Ge#lObqE6_=1^)xf_ia z8R2~*R4KTpbeTYxL-!j{c>{XmT(s6T3|5$E*|n4x9x|=_OASxC6FBWzNJC391;vY~ zu1#Zq$s&pmW#aCi&%UB8e$HPk_Y26$&E}Z-c6qjlpLQ>y)BPMen?>LAhbJFTnZQrq z3tj7=Jqf*j8WHmi1kFb5xmo!8yIHkr)$+d>7>>?S@PkJ($@wvxrnY36MzR9b)TQ$6 zclU6-JcHf)7PDj5GWB;c(|h)3$&{9$@hU!#1#j6>fv*T5n0x@!pAj0{>#^z4^O z{^14~Z$M)m8fzKW*K+XJr_p#y?w_K*c`f1SlY}BqqOm3>xsT}yG)DCj{hsxbJOx~m z{P*XfJx!8dL#Q@^K>0$vCF!_o3IN6#7}o-?*E{KjQ)73n6!?qaNRZ@H3DqPJtW3sR zoQ|`4FTjKhOn%!1u9CagLx(92w+g&Gfu54vN8uMX5TTq1l_HC%T2w<6o2X9IAZilX zMXjPXQMbU`I>1yt6gaon6i zy*(ucRVuAa=d;Z#31|jY$I@d)oCoGh@>tcL5qN4md7Ux7aK&k~SLFjt+(0a`#cHDD za3=W$iz&0D6C5$97t^l1rLj7y8gAbv^*d~cFI@L4;7B|-_9RK3jHkpj4jzq0(RH0j zByxTOmXq(GML(j~w~=sU6MX|48DWz=+l0@*L4JN9ReMv;+!#;Z{W3UB@v#d$U|uNj zbb;?4gM>mM0)YU2zn`I@Av8@>X8ukK)WY?aXT`tOet$NeyiSr^jq!ymOo_o&$}?xq z;PH4=o%{Ry)$hSzP#Ka*{5=EhB?3M*x^QV@$%E!Z^^&od?Nm^Q!$C(!2c4arxZQ4g zdwcQueB-7tX#*|07Na+3f@6WeRdN~o0^IwPDBbrJHk*xxh6e0*yE5T&x#;TZQl|R) z`jmkS9zkq0M~@y=Zb!#twOUmY+rj(r{WguWzuiQr;wnPcc-6WJ=27&+<5XBSP+jvm zwz^yzo62ZyZN=$y#y+e5UpO4TcnjLv+Q`YtQ6D^U;sg~H6>Q(W9eZs#o+H9oUS1xBg@tMg zhYlT5>38njiGOf2?M((kZL9HD-^GsiZY1ZEo7wW|e7@dlRPeIO$Ed9Of)1BiE!((j zA_l~5>xmJOV7+R zyd2o`T;At@b`kJDg|e0|Fn%rY9iITN*IU0(aC_z&mM>qf5(2*K6Tkv2r_0H~n>$J9 z3uk@V<2N2kdgwoD}eFlJC2@g;Vy8Xy;Q%vOQ0P`3VvSLy2r%%}@UEu=*Pb z@G#FTHYOQhjCKa8rxz`q6wypBpOZx!ALGU;V;AJY`Ey*GOC)Xb_kw&Gr-#GY)3S!Z z!e4bPO8ViCrGROM7~>Z5Ky-9+g;vxwkxc{VspTx6atZ?{{Gyv{I2Z+>e{z6VjnDE} zw~G9`hotj8<|j!R3L~m@4FMM)yR#_n2S4?d@IQy-_Z;Iw<6+b-@#vf>Xr_|ozJ5Lx z?cHR#Cx3UPQt3{m!Xf`I(Le_MRMR|J#s2OPQfsM_KnL0QVH& z>p(SU(2r!&MF|7cV4)qQpe|QZ~=ahZ;vBF zDV%ucS<^c?U{T4~g>zB3K*B4ZrlhMB;Qj&{=d-EiGzF$NxnfS>jQTZMM1`ozdqR#} zl_%9le#xegs}yoMY6q=BGWICbDt5Q763*B8A@?Joyu2KXWt8e08m@k(M&FS~ySs=l z+!s*SC2{O*6#DrTIgW4Dy~g&N0kUve)4O=Xx>`Dq6m8!j3Kv!xKw9T3bW_G0Q(sSj zTCJw3sfmh;3W|%1sjsic<#N%}(?dZ)0R@-y(bbf4`hx@!uS$;EdyZ&PxIkX)Q`)W~ zQWP#sA3$Q=HeXV8oMQ$HUawce|0`&0l>aa>F(F6HX0rjvy{V}w`SZ5z4tu+vSDZ`o zIO|%%1i4bU9W6pg)e2HucFOxh-j?nZuFoZ7m`lg*8kFby6~KK~ukAK_jqBy8iP)uc zNp1>cSF1`CZY}wpdGva9R5{ZrcO;?_sJMF^oiho;d>VH5fHd+z0wSA2IcZaFxESOm zBV!MeMQ)t;7T|Wf(d+f{ z!^$%tOWEJw&)bdfu(5F&n;M?rnf6DC>3rlAD{0$z;M{Fi=}tOHNJ>wH4K)mum}jHb|hSfXeso-+HNxIUlk_vRd= z&c6Vq9IdUbIGs+~+S-)YAk)y!L=e;QeO}N%%;wUk$!<76Zu9GW*!~9jx8o=tJ1W~= z<&`n}MK4-_Z$5@~v#BH*mr-Piqttqg5&?y@%qHB<`E~32X1&EF9E<=wm;kTRThFvS z#Ks+g+epyMgoFtRdcFh`4o30f`TE}lEXeXN;Qs>t4Ru3{Q!vMs(EtDd07*qoM6N<$ Eg5l6mCjbBd literal 0 HcmV?d00001 diff --git a/doc/tool-line-okular.png b/doc/tool-line-okular.png new file mode 100644 index 0000000000000000000000000000000000000000..e4f2d825126cf7cbead10cd022e56576d7106048 GIT binary patch literal 849 zcmV-X1FrmuP)U36 zv9YMAsI#-P^78Wh{QSJUyw=v%{r&yu=;;6V&;QsH`uh6a-QDHo<^T84{?`-!*&zA( z`OePH@$vDwxw-4>>&?y0*Vos`$jFY4jDESyRx#f z$;rw4`}?e{tj58or?(XjI@9+Nh(DczF^zYXA z`1tnr_W$?M|JW42zrX+Z($2Cc;=?KS@z|oGqQbtV$E_-$kUr$#$-=_I+1c5{!^5<+ zw7zSGXN_|ziQwHEx_F5SgS^w>z)!At(&NAlK4 z;mAqp&q?mnN%-4H|KUgf>V5y;I{)Z)9&`Ms00008bW%=J04^y3$vOi)WLmQ}0003z zNklQ5m7;5F>wiD zVPQ!rX&EF1vU2hYib~2Vs%k3g8mgMI99r7aI>=V&%IoPH7-||Bo0yvE$(mchp z?t!Af)5}}K$I{Z*&%r++FvvPMB-8=b1bz3g@Q6smD9z}Y*tmGj;Dp2^ITQuSx+ylP z9J&^1_URcMnKmjMDOrZt9GQ*cK1>DKIZ$~_1qgW@3M_L|Ec5aU3UQ_fgCfV`lG3vB z3ZF_-+j0|31yNPiHMMp1nyL+rAx-62Ot5KgX>Duo=Fw*E00t9L9O*ns7#&O= bWcdOBU<_1~D-3!700000NkvXXu0mjfe>&%V literal 0 HcmV?d00001 diff --git a/doc/tool-note-inline-okular.png b/doc/tool-note-inline-okular.png new file mode 100644 index 0000000000000000000000000000000000000000..235d0a44606f8d6c1139d24c8ee01fc41bae4515 GIT binary patch literal 803 zcmV+;1Kj+HP)^5v1#$$#I}hUwjm&AEp1=8@OK ziQ?DA&AE~K`ug47-R0%wrKP3X+S>g5{Qdp?`T6;+t*y?^&hhc_xw*OP>+8+U&BevV z*Vos`$jFY4jDESyRx#f$;rw4`}^G7+^npu#>U3N z!oshwug}lVqobqbqN2yg z$Dp8~+1c5{!^5$$vFPaNy1KgX@bIv(u#u6GzP`TG)6>+{)Y#bA;o;%w>FI7-nb-gT z00?waPE!CbDFMkk13hF~vo-(#0W3*GK~#7FVju_@@c<@fpaK>=fRzoXfCCR;rsmsi&i zKvJNo#mlR$qpPRS&o6JFY-nU`B4;XZhGvDig{76XjjfWMmA!+ble4vw1hN7bWVgA( z7;Xp!?jG0xC-DL0$>HS%-J@}Ou z_;CbPl;Kq1Tj`ZqRh^qz6H!}NpP7NFAU(FcAt@L3I44mZGK+G?V3d$ hodqQX9XU7^003wcRNtPPOpyQp002ovPDHLkV1gj&#-0EG literal 0 HcmV?d00001 diff --git a/doc/tool-note-okular.png b/doc/tool-note-okular.png new file mode 100644 index 0000000000000000000000000000000000000000..b0dd4635c679b6d6788f1d0c53ed5ad6eb19d749 GIT binary patch literal 973 zcmV;;12X)HP)U36v9YMAsMW)U(#L-0+KRrka=EZ?vZ-syzj@x% zg~+~mys~l1zh^e4u{QUg9yu8-d*8Tnc+{uj3#C+DvfY{A~&BJ@y&Vu6Bh`+US z(Z+qnyLQvaf5f_W=;-M1+9>y&CS=>*T~4oj*gDBw6w*u zcH!2C(8Yb=)rQW_&bzz2va+(QtgNS}r^3R*$hCOEw{*L)aJQ~*-O`2b?(XmJ@AUNa z+Q*B{x{le$i@(3W;^N|>qN2yg$Dp8~zSGmw)YR1B z;o<4&>5#)dBme*a6m(KfQvfb00m(W8J(qZPHN?ZbsLZ^)bnD0Jo&W#=i%CR5RCocD z$~6*zFc1L1;0{f23GRXa|Bkd5W{zR&C7%?8s)?W@3{wP(u>OZQ0c^+hU`R8W4@3S6 z0SrYc3q`2vhPAZo86Cz+7Lj>bxBWQzb@OKihDNH!5OEWP0#gk$a|;5g$KOe-ROX{{Yp%Acx?fkkGL3h{&kuFo*(?7`P(? zR8?bv5NJgl$o%*OhyoEL1wl>@iJnQxQGp>&DXAWDmHv%@@da)AmI zMe_2^EksOxfQ~RNfH}UfsIU;~i{g?}!!jSA@(M*gxymY4x11c;!0O literal 0 HcmV?d00001 diff --git a/doc/tool-polygon-okular.png b/doc/tool-polygon-okular.png new file mode 100644 index 0000000000000000000000000000000000000000..9df96ca123022193a9127a49cc102e64aaacc389 GIT binary patch literal 664 zcmV;J0%!e+P)>p z-QDHo<@x#f&d$#9@$tF2x$Eoe&CSi%*Vo9%$c~PVw6wIixVWdMr@Onmva+(t$;qs& ztir;=udlDq&(EWyqvYh|?(XjI@9zg(uq<@E_xk+&{r+{)ZyXb>FMcC8{{amH1n#Z;Be3oq|Ndd%KenDKHQ$bcUT0Wv yy=QE^yz*~8L;-ylK9HkmMEv{;gw#*_KfyOLw?b@p?lzbJ0000U36v9YMAsI#-Pyu7^D*4F*~{pjfE@9*!w zzrUB3mbSIDxVX3Z`T6zt_-?e{MxNH(>hs;*-R0%w&d$#F_xJVo_H?z~KAF+dCpX=rNGYyx8iyySuWovdPKGtgNiU!oshwug}lV zqobqb;Ogq?;^N|-o}QADlA)oYlarI3ot?|e%axUt%F4>3qN2yg$Dp8~+1c5{!^4=E zn2?Z=k&%&>mX`4F@UXD3zP`Tc>FMq5?bFlK)YR1B;o;ui-iU~ZhK7cNgM*EYjf#qj zmzS4ALqms$hm@3*dU|>|I5>fUf#ToX;^5um;NIln-{j)o<>TPy>gea|>F4a~=+kOD@b2yK@9y#N@AC2Q^YZcZ^YZlb z^Y!%eF}6C)0005qNkl62q_R05*88VXBQLU=MtB|R3IrOEh8%@ub`-;psb>(Dv6;$O ztBC_0pr*zzZmH^^=;-L^UhIm(-pYnP!oKXLKm~sO0U{6u z8V-R$!CZnNsye=*!eOdD;SrIlKm}3JV0lXh1|hW=BNKi#Q8j)E34ReH1^yT@4M!1? z*f@~1WjuCA0_74CK`u>7#;HIgB{eNQBQpz|0wW(W5s-GrY)4C=H^oh3#Q7a^#9-3l zxq0~og~66Zg?Spq+9eDOnx%H3W#y5f6`qy4#-Td=RT4%LMxuGuH45TtT-mh@3?cfa z@(#Xrs*3eB!VRJP{G~;rjZLAs#<@BsTqY`|3=BriA}!)}64Gj-t&K4v{QPZI?H!$6 zt?aE{o$cK{(wL5H@9pcaV+Vm4?+FtpVfQ9G0uYRDY9xEWCQq3XeM^#A|> literal 0 HcmV?d00001 diff --git a/doc/tool-underline-okular.png b/doc/tool-underline-okular.png new file mode 100644 index 0000000000000000000000000000000000000000..a14282d1f2236f9ebbadfde1387b78e7a2652e09 GIT binary patch literal 629 zcmV-*0*d{KP)s_5wG-QC^g<>meT{rUO%&d$#9 z@$tF2x$Eoe&CSi%*Vo9%$c~PVw6wI=*4DVVxTmM5ySuxxva-p^$*iob!otF@udmO~ z&!eNGSz20JTU%RPTwGXKSc-~@zrVlk?(X8^;-aFW$H&K@prF~=*~7!b z@bK`ku&|Mlk-omZ)6>(`)YReO;pyq=Poz!W00008bW%=J04^y3$vOi)WLmQ}0002| zNklulvhzzQ`b-w*5t*sLP<+oM@v^nOGifwh;{U^I8vX+-sIyj zFjP|JP!KfY;80ND5HyxIF-1{eW^N&8DJW=V%_q%mBWr8NZO?~lf|7}Yqmuxqv%H$U z3%9GhotwLd2#Nwv9WN~}OBrt+9UmVZUoAf!FJFIp$EILFpdg1y5I;@@%E1OMA)y{F zVV2?Q`Yvji3Y={MBu(ri