]> git.lyx.org Git - lyx.git/blob - lib/examples/PDF-comment.lyx
PDF-comment.lyx: describe a further feature
[lyx.git] / lib / examples / PDF-comment.lyx
1 #LyX 2.1 created this file. For more info see http://www.lyx.org/
2 \lyxformat 474
3 \begin_document
4 \begin_header
5 \textclass scrartcl
6 \begin_preamble
7 % to be able to use all color settings of pdfcomment
8 \usepackage[svgnames,rgb]{xcolor}
9
10 % if pdflatex is used
11 \usepackage{ifpdf}
12 \ifpdf
13
14 % set fonts for nicer pdf view
15 \IfFileExists{lmodern.sty}
16  {\usepackage{lmodern}}{}
17
18 \fi % end if pdflatex is used
19 \end_preamble
20 \options BCOR8mm,pagesize
21 \use_default_options false
22 \begin_modules
23 pdfcomment
24 \end_modules
25 \maintain_unincluded_children false
26 \language english
27 \language_package default
28 \inputencoding auto
29 \fontencoding global
30 \font_roman default
31 \font_sans default
32 \font_typewriter default
33 \font_math auto
34 \font_default_family default
35 \use_non_tex_fonts false
36 \font_sc false
37 \font_osf false
38 \font_sf_scale 100
39 \font_tt_scale 100
40 \graphics default
41 \default_output_format default
42 \output_sync 0
43 \bibtex_command bibtex
44 \index_command default
45 \paperfontsize 12
46 \spacing single
47 \use_hyperref true
48 \pdf_title "Description of the module PDF Comments"
49 \pdf_author "Uwe Stöhr"
50 \pdf_subject "PDF comments"
51 \pdf_keywords "LyX, PDF comments, pdfcomment"
52 \pdf_bookmarks true
53 \pdf_bookmarksnumbered true
54 \pdf_bookmarksopen true
55 \pdf_bookmarksopenlevel 2
56 \pdf_breaklinks false
57 \pdf_pdfborder false
58 \pdf_colorlinks true
59 \pdf_backref false
60 \pdf_pdfusetitle false
61 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
62 \papersize a4paper
63 \use_geometry false
64 \use_package amsmath 1
65 \use_package amssymb 1
66 \use_package cancel 0
67 \use_package esint 1
68 \use_package mathdots 1
69 \use_package mathtools 1
70 \use_package mhchem 1
71 \use_package stackrel 0
72 \use_package stmaryrd 0
73 \use_package undertilde 0
74 \cite_engine basic
75 \cite_engine_type default
76 \biblio_style plain
77 \use_bibtopic false
78 \use_indices false
79 \paperorientation portrait
80 \suppress_date true
81 \justification true
82 \use_refstyle 0
83 \notefontcolor #0000ff
84 \index Index
85 \shortcut idx
86 \color #008000
87 \end_index
88 \secnumdepth 3
89 \tocdepth 2
90 \paragraph_separation skip
91 \defskip medskip
92 \quotes_language english
93 \papercolumns 1
94 \papersides 1
95 \paperpagestyle default
96 \tracking_changes false
97 \output_changes false
98 \html_math_output 0
99 \html_css_as_file 0
100 \html_be_strict false
101 \end_header
102
103 \begin_body
104
105 \begin_layout Standard
106 \begin_inset Flex PDF-Comment-Setup
107 status open
108
109 \begin_layout Plain Layout
110 color=yellow
111 \end_layout
112
113 \end_inset
114
115
116 \begin_inset Note Note
117 status collapsed
118
119 \begin_layout Plain Layout
120 This sets yellow as default color for new PDF comments, see sec.
121 \begin_inset space ~
122 \end_inset
123
124
125 \begin_inset CommandInset ref
126 LatexCommand ref
127 reference "sub:PDF-Comment-setup"
128
129 \end_inset
130
131  for the description.
132 \end_layout
133
134 \end_inset
135
136
137 \end_layout
138
139 \begin_layout Title
140 Description of the module PDF Comments
141 \end_layout
142
143 \begin_layout Author
144 Uwe Stöhr
145 \end_layout
146
147 \begin_layout Standard
148 The LaTeX package 
149 \series bold
150 pdfcomment
151 \series default
152  provides full access for PDF comments.
153  You can add normal comments as well as margin comments, underlining etc..
154  You can also define a special layout for a comment which you can use several
155  times in the document.
156  This document is only a excerpt of the documentation of 
157 \series bold
158 pdfcomment
159 \series default
160 ; see its documentation for all information:
161 \begin_inset Newline newline
162 \end_inset
163
164
165 \begin_inset Flex URL
166 status open
167
168 \begin_layout Plain Layout
169
170 http://mirrors.ctan.org/macros/latex/contrib/pdfcomment/doc/pdfcomment.pdf
171 \end_layout
172
173 \end_inset
174
175
176 \end_layout
177
178 \begin_layout Section
179 The different comment types
180 \end_layout
181
182 \begin_layout Standard
183 The different comment types are inserted using the menu 
184 \family sans
185 Insert\SpecialChar \menuseparator
186 Custom
187 \begin_inset space ~
188 \end_inset
189
190 Insets
191 \family default
192 .
193  You can select one of the following:
194 \end_layout
195
196 \begin_layout Subsection
197 PDF-Annotation
198 \end_layout
199
200 \begin_layout Standard
201 This is the standard PDF comment.
202  Here is an example: 
203 \begin_inset Flex PDF-Annotation
204 status open
205
206 \begin_layout Plain Layout
207 This is a simple PDF-Annotation.
208 \end_layout
209
210 \end_inset
211
212
213 \end_layout
214
215 \begin_layout Standard
216 Like for all PDF comment types you can add a lot of things to the option
217  of the inset.
218  To insert the options inset, set the cursor into the comment inset and
219  use the menu 
220 \family sans
221 Insert\SpecialChar \menuseparator
222 PDF Comment Options
223 \family default
224 .
225 \end_layout
226
227 \begin_layout Standard
228 \begin_inset Note Greyedout
229 status open
230
231 \begin_layout Plain Layout
232
233 \series bold
234 Note:
235 \series default
236  All braces and brackets in comment options must be inserted as TeX code!
237 \end_layout
238
239 \end_inset
240
241
242 \begin_inset Newline newline
243 \end_inset
244
245
246 \end_layout
247
248 \begin_layout Standard
249 Here is an example PDF-Annotation where the author is set to 
250 \begin_inset Quotes eld
251 \end_inset
252
253 Daisy Duck
254 \begin_inset Quotes erd
255 \end_inset
256
257
258 \begin_inset Flex PDF-Annotation
259 status open
260
261 \begin_layout Plain Layout
262 \begin_inset Argument 1
263 status collapsed
264
265 \begin_layout Plain Layout
266 author=
267 \begin_inset ERT
268 status collapsed
269
270 \begin_layout Plain Layout
271
272 {
273 \end_layout
274
275 \end_inset
276
277 Daisy Duck
278 \begin_inset ERT
279 status collapsed
280
281 \begin_layout Plain Layout
282
283 }
284 \end_layout
285
286 \end_inset
287
288 ,color=
289 \begin_inset ERT
290 status collapsed
291
292 \begin_layout Plain Layout
293
294 {
295 \end_layout
296
297 \end_inset
298
299 0.234 0.867 0.211
300 \begin_inset ERT
301 status collapsed
302
303 \begin_layout Plain Layout
304
305 }
306 \end_layout
307
308 \end_inset
309
310 ,voffset=8pt,opacity=0.5
311 \end_layout
312
313 \end_inset
314
315 This is an annotation with a complex option.
316 \end_layout
317
318 \end_inset
319
320
321 \end_layout
322
323 \begin_layout Standard
324 To avoid to write the same options like the author again and again, you
325  can define a so-called 
326 \begin_inset Quotes eld
327 \end_inset
328
329 avatar
330 \begin_inset Quotes erd
331 \end_inset
332
333  for every person and/or comment layout.
334  See 
335 \begin_inset CommandInset ref
336 LatexCommand ref
337 reference "sec:Avatars"
338
339 \end_inset
340
341  for further information.
342 \end_layout
343
344 \begin_layout Standard
345 For a full list of possible options, please look at the 
346 \series bold
347 pdfcomment
348 \series default
349  documentation.
350 \end_layout
351
352 \begin_layout Subsection
353 PDF-Circle
354 \end_layout
355
356 \begin_layout Standard
357 This will typeset a comment in form of a circle or ellipse.
358  Here is an example without any options: 
359 \begin_inset Flex PDF-Circle
360 status open
361
362 \begin_layout Plain Layout
363 a simple circle comment
364 \end_layout
365
366 \end_inset
367
368
369 \end_layout
370
371 \begin_layout Standard
372 At the right side you see a large, elliptical comment as example of a PDF-Circle
373  with options.
374  
375 \begin_inset Flex PDF-Circle
376 status open
377
378 \begin_layout Plain Layout
379 \begin_inset Argument 1
380 status collapsed
381
382 \begin_layout Plain Layout
383 id=1,color=blue,height=2.5cm,width=5.8cm,voffset=-2.8cm,hoffset=8cm,opacity=1.0,just
384 ification=right,icolor=
385 \begin_inset ERT
386 status collapsed
387
388 \begin_layout Plain Layout
389
390 {
391 \end_layout
392
393 \end_inset
394
395 yellow
396 \begin_inset ERT
397 status collapsed
398
399 \begin_layout Plain Layout
400
401 }
402 \end_layout
403
404 \end_inset
405
406 ,linewidth=12pt,borderstyle=dashed,dashstyle=
407 \begin_inset ERT
408 status collapsed
409
410 \begin_layout Plain Layout
411
412 {
413 \end_layout
414
415 \end_inset
416
417 10 5
418 \begin_inset ERT
419 status collapsed
420
421 \begin_layout Plain Layout
422
423 }
424 \end_layout
425
426 \end_inset
427
428
429 \end_layout
430
431 \end_inset
432
433 a circle comment in form of a large ellipse
434 \end_layout
435
436 \end_inset
437
438
439 \begin_inset Newline newline
440 \end_inset
441
442
443 \begin_inset Newline newline
444 \end_inset
445
446
447 \begin_inset Newline newline
448 \end_inset
449
450
451 \end_layout
452
453 \begin_layout Subsection
454 PDF-Freetext
455 \end_layout
456
457 \begin_layout Standard
458 This will typeset a comment in form of a freely positioned box.
459  By using the option 
460 \series bold
461 type=callout
462 \series default
463  the box will have an additional so called callout line, to bind the box
464  to a certain element of the page.
465  With the option 
466 \series bold
467 type=typewriter
468 \series default
469  you can write a comment everywhere on the page with a virtual ’typewriter’.
470  These PDF-Freetext annotations do have no frame and a transparent background
471  for ’overwriting’ arbitrary parts of the page.
472  Here is an example in form of a yellow rectangle:
473 \begin_inset Flex PDF-Freetext
474 status open
475
476 \begin_layout Plain Layout
477 \begin_inset Argument 1
478 status collapsed
479
480 \begin_layout Plain Layout
481 height=3cm,type=freetext,subject={freetext},width=4.5cm,voffset=-3.2cm,hoffset=-3.2
482 cm,opacity=0.9,justification=right
483 \end_layout
484
485 \end_inset
486
487 This is also a comment, but it is a PDF-Freetext annotation.
488 \end_layout
489
490 \end_inset
491
492
493 \begin_inset Newline newline
494 \end_inset
495
496
497 \begin_inset Newline newline
498 \end_inset
499
500
501 \begin_inset Newline newline
502 \end_inset
503
504
505 \begin_inset Newline newline
506 \end_inset
507
508
509 \end_layout
510
511 \begin_layout Subsection
512 PDF-Line
513 \end_layout
514
515 \begin_layout Standard
516 This will typeset a comment in form of a line, polyline or polygon.
517  Here is an example without any options: 
518 \begin_inset Flex PDF-Line
519 status open
520
521 \begin_layout Plain Layout
522 a simple PDF-Line comment
523 \end_layout
524
525 \end_inset
526
527
528 \begin_inset Newline newline
529 \end_inset
530
531
532 \end_layout
533
534 \begin_layout Standard
535 As you can see a PDF-Line comment without options is useless.
536 \end_layout
537
538 \begin_layout Standard
539 The green arrow at the left side of this page is an example for a PDF-Line
540  comment with options.
541  
542 \begin_inset Flex PDF-Line
543 status open
544
545 \begin_layout Plain Layout
546 \begin_inset Argument 1
547 status collapsed
548
549 \begin_layout Plain Layout
550 type=line,opacity=1,line=
551 \begin_inset ERT
552 status collapsed
553
554 \begin_layout Plain Layout
555
556 {
557 \end_layout
558
559 \end_inset
560
561 50 480 50 180
562 \begin_inset ERT
563 status collapsed
564
565 \begin_layout Plain Layout
566
567 }
568 \end_layout
569
570 \end_inset
571
572 ,color=green,icolor=blue,caption=top,linebegin=
573 \begin_inset ERT
574 status collapsed
575
576 \begin_layout Plain Layout
577
578 {
579 \end_layout
580
581 \end_inset
582
583 /ROpenArrow
584 \begin_inset ERT
585 status collapsed
586
587 \begin_layout Plain Layout
588
589 }
590 \end_layout
591
592 \end_inset
593
594 ,lineend=
595 \begin_inset ERT
596 status collapsed
597
598 \begin_layout Plain Layout
599
600 {
601 \end_layout
602
603 \end_inset
604
605 /OpenArrow
606 \begin_inset ERT
607 status collapsed
608
609 \begin_layout Plain Layout
610
611 }
612 \end_layout
613
614 \end_inset
615
616 ,linewidth=2bp,captionhoffset=-5pt,captionvoffset=15pt
617 \end_layout
618
619 \end_inset
620
621 a PDF-Line comment with options
622 \end_layout
623
624 \end_inset
625
626
627 \end_layout
628
629 \begin_layout Subsection
630 PDF-Margin
631 \end_layout
632
633 \begin_layout Standard
634 This will typeset an annotation into the margin.
635  Right besides this text is an example without options: 
636 \begin_inset Flex PDF-Margin
637 status open
638
639 \begin_layout Plain Layout
640 a simple PDF-Margin comment
641 \end_layout
642
643 \end_inset
644
645
646 \end_layout
647
648 \begin_layout Standard
649 The red margin note is an example for a PDF-Margin with options.
650  
651 \begin_inset Flex PDF-Margin
652 status open
653
654 \begin_layout Plain Layout
655 \begin_inset Argument 1
656 status collapsed
657
658 \begin_layout Plain Layout
659 icon=Note,color=red,open=true,hspace=100pt
660 \end_layout
661
662 \end_inset
663
664 a PDF-Margin comment with options
665 \end_layout
666
667 \end_inset
668
669
670 \end_layout
671
672 \begin_layout Subsection
673 PDF-Markup
674 \end_layout
675
676 \begin_layout Standard
677 This will typeset so called PDF text markup annotations over some text or
678  math.
679  Here is a markup without options: 
680 \begin_inset Flex PDF-Markup
681 status open
682
683 \begin_layout Plain Layout
684 simple PDF-Markup
685 \end_layout
686
687 \end_inset
688
689
690 \end_layout
691
692 \begin_layout Standard
693 Possible types for the option 
694 \series bold
695 markup
696 \series default
697  are:
698 \end_layout
699
700 \begin_layout Description
701 Highlight The markup text will be highlighted: 
702 \begin_inset Flex PDF-Markup
703 status open
704
705 \begin_layout Plain Layout
706 \begin_inset Argument 1
707 status open
708
709 \begin_layout Plain Layout
710 id=1,markup=Highlight
711 \end_layout
712
713 \end_inset
714
715 Highlight PDF-Markup
716 \begin_inset Argument post:1
717 status open
718
719 \begin_layout Plain Layout
720 a comment
721 \end_layout
722
723 \end_inset
724
725
726 \end_layout
727
728 \end_inset
729
730
731 \begin_inset Note Note
732 status collapsed
733
734 \begin_layout Plain Layout
735 see the next section for the description of the option 
736 \series bold
737 id=1
738 \end_layout
739
740 \end_inset
741
742
743 \end_layout
744
745 \begin_layout Description
746 Underline The markup text will be underlined: 
747 \begin_inset Flex PDF-Markup
748 status open
749
750 \begin_layout Plain Layout
751 \begin_inset Argument 1
752 status open
753
754 \begin_layout Plain Layout
755 markup=Underline
756 \end_layout
757
758 \end_inset
759
760 Underlining PDF-Markup
761 \end_layout
762
763 \end_inset
764
765
766 \end_layout
767
768 \begin_layout Description
769 Squiggly The markup text will be underlined with a wave: 
770 \begin_inset Flex PDF-Markup
771 status open
772
773 \begin_layout Plain Layout
774 \begin_inset Argument 1
775 status open
776
777 \begin_layout Plain Layout
778 markup=Squiggly
779 \end_layout
780
781 \end_inset
782
783 Underwave PDF-Markup
784 \end_layout
785
786 \end_inset
787
788
789 \end_layout
790
791 \begin_layout Description
792 StrikeOut The markup text will be struck-out: 
793 \begin_inset Flex PDF-Markup
794 status open
795
796 \begin_layout Plain Layout
797 \begin_inset Argument 1
798 status open
799
800 \begin_layout Plain Layout
801 markup=StrikeOut
802 \end_layout
803
804 \end_inset
805
806 Striked-out PDF-Markup
807 \end_layout
808
809 \end_inset
810
811
812 \end_layout
813
814 \begin_layout Description
815 mathpopup Formula parts will be highlighted.
816
817 \series bold
818  
819 \series default
820
821 \begin_inset Note Greyedout
822 status open
823
824 \begin_layout Plain Layout
825
826 \series bold
827 Note:
828 \series default
829  The PDF-Markup inset cannot be used for this option!
830 \end_layout
831
832 \end_inset
833
834  Instead the command 
835 \series bold
836
837 \backslash
838 pdfmarkupcomment
839 \series default
840  woll be used in a formula with this scheme:
841 \begin_inset Newline newline
842 \end_inset
843
844 Command:
845 \begin_inset Newline newline
846 \end_inset
847
848
849 \series bold
850
851 \backslash
852 pdfmarkupcomment[style=mathpopup]
853 \backslash
854 {formula part}
855 \begin_inset Formula $\to$
856 \end_inset
857
858
859 \backslash
860 {
861 \backslash
862 text
863 \begin_inset space \textvisiblespace{}
864 \end_inset
865
866
867 \begin_inset Newline newline
868 \end_inset
869
870 optional comment}
871 \begin_inset Newline newline
872 \end_inset
873
874
875 \series default
876 Result:
877 \end_layout
878
879 \begin_layout Standard
880 \begin_inset Formula 
881 \[
882 \pdfmarkupcomment[style=mathpopup]{\sum_{i=1}^{n}i=\frac{1}{2}n\cdot(n+1)}{\text{little Gauss}}
883 \]
884
885 \end_inset
886
887
888 \end_layout
889
890 \begin_layout Standard
891 The text for the comment is inserted with the inset option 
892 \family sans
893 Comment
894 \family default
895 .
896 \end_layout
897
898 \begin_layout Standard
899 PDF-Markup has some limitations:
900 \end_layout
901
902 \begin_layout Itemize
903 the markup text must not be longer than one paragraph
904 \end_layout
905
906 \begin_layout Itemize
907 the markup annotation must not be longer than one page, otherwise the recognitio
908 n of the page break will fail
909 \end_layout
910
911 \begin_layout Itemize
912 when using XeTeX you have to assure that the page dimensions are internally
913  output, e.
914 \begin_inset space \thinspace{}
915 \end_inset
916
917 g.
918 \begin_inset space \space{}
919 \end_inset
920
921 with the document class option 
922 \series bold
923 pagesize
924 \series default
925  for the KOMA-Script classes, or the option 
926 \series bold
927 pagesize
928 \series default
929  for the LaTeX-package 
930 \series bold
931 typearea
932 \series default
933 .
934 \end_layout
935
936 \begin_layout Subsection
937 PDF-Reply
938 \end_layout
939
940 \begin_layout Standard
941 With a PDF-Reply you can compose replies to PDF comments.
942  The option 
943 \series bold
944 replyto
945 \series default
946  provides a clear reference to the comment the reply refers to.
947 \end_layout
948
949 \begin_layout Standard
950 As example see the reply to the Highlight PDF-Markup from the previous section.
951  
952 \begin_inset Flex PDF-Reply
953 status open
954
955 \begin_layout Plain Layout
956 \begin_inset Argument 1
957 status open
958
959 \begin_layout Plain Layout
960 id=2,replyto=1,date=D:20101211161247+01'00'
961 \end_layout
962
963 \end_inset
964
965 This is a reply.
966 \end_layout
967
968 \end_inset
969
970  It appears in that PDF-Markup comment.
971  To be able to reference the PDF-Markup the option 
972 \series bold
973 id=1
974 \series default
975  was added to its options.
976  The PDF-Reply got the option 
977 \series bold
978 replyto=1
979 \series default
980 .
981 \end_layout
982
983 \begin_layout Standard
984 You can also reply to replies by adding an 
985 \series bold
986 id
987 \series default
988  option to the reply that should be replied to.
989  As example see the reply to the reply to the PDF-Markup.
990  
991 \begin_inset Flex PDF-Reply
992 status open
993
994 \begin_layout Plain Layout
995 \begin_inset Argument 1
996 status open
997
998 \begin_layout Plain Layout
999 replyto=2,date=D:20101212095321+01'00'
1000 \end_layout
1001
1002 \end_inset
1003
1004 Of course, you can reply to a reply.
1005 \end_layout
1006
1007 \end_inset
1008
1009
1010 \end_layout
1011
1012 \begin_layout Standard
1013 \begin_inset Note Greyedout
1014 status open
1015
1016 \begin_layout Plain Layout
1017
1018 \series bold
1019 Note:
1020 \series default
1021  Due to technical reasons PDF-Reply only works when using pdflatex.
1022 \end_layout
1023
1024 \end_inset
1025
1026
1027 \end_layout
1028
1029 \begin_layout Standard
1030 PDF-Reply has some further limitations:
1031 \end_layout
1032
1033 \begin_layout Itemize
1034 It can not support page breaks.
1035 \end_layout
1036
1037 \begin_layout Itemize
1038 The replies will only appear in the PDF annotations on the second page.
1039  (Replies to comments without page break work smoothly.)
1040 \end_layout
1041
1042 \begin_layout Subsection
1043 PDF-Sideline
1044 \end_layout
1045
1046 \begin_layout Standard
1047 This will typeset a comment in form of identical markers on every side of
1048  the page.
1049  The yellow arrows besides this text are an example of a PDF-Sideline without
1050  any options: 
1051 \begin_inset Flex PDF-Sideline
1052 status open
1053
1054 \begin_layout Plain Layout
1055 a simple PDF-Sideline
1056 \end_layout
1057
1058 \end_inset
1059
1060
1061 \end_layout
1062
1063 \begin_layout Standard
1064 As you can see a PDF-Sideline comment without options is quite useless.
1065  PDF-Sideline is useful if you want to highlight complete parts of a page.
1066  The inset options define the layout of the marker while the normal content
1067  of the inset is the text surrounded by the markers.
1068  The content of the inset option 
1069 \family sans
1070 Comment
1071 \family default
1072  will be printed along both markers.
1073  Here is an example:
1074 \end_layout
1075
1076 \begin_layout Standard
1077 \begin_inset Flex PDF-Sideline
1078 status open
1079
1080 \begin_layout Plain Layout
1081 \begin_inset Argument 1
1082 status collapsed
1083
1084 \begin_layout Plain Layout
1085 opacity=0.33,color=magenta,icolor=cyan,caption=inline,linebegin=
1086 \begin_inset ERT
1087 status collapsed
1088
1089 \begin_layout Plain Layout
1090
1091 {
1092 \end_layout
1093
1094 \end_inset
1095
1096 /Butt
1097 \begin_inset ERT
1098 status collapsed
1099
1100 \begin_layout Plain Layout
1101
1102 }
1103 \end_layout
1104
1105 \end_inset
1106
1107 ,lineend=
1108 \begin_inset ERT
1109 status collapsed
1110
1111 \begin_layout Plain Layout
1112
1113 {
1114 \end_layout
1115
1116 \end_inset
1117
1118 /Square
1119 \begin_inset ERT
1120 status collapsed
1121
1122 \begin_layout Plain Layout
1123
1124 }
1125 \end_layout
1126
1127 \end_inset
1128
1129 ,linewidth=3bp,linesep=0.7cm
1130 \end_layout
1131
1132 \end_inset
1133
1134 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
1135  eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
1136  voluptua.
1137  At vero eos et accusam et justo duo dolores et ea rebum.
1138  Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
1139  sit amet.
1140  Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
1141  eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
1142  voluptua.
1143 \end_layout
1144
1145 \begin_layout Plain Layout
1146 At vero eos et accusam et justo duo dolores et ea rebum.
1147  Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
1148  sit amet.
1149  Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
1150  eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
1151  voluptua.
1152  At vero eos et accusam et justo duo dolores et ea rebum.
1153  Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
1154  sit amet.
1155 \begin_inset Argument 2
1156 status open
1157
1158 \begin_layout Plain Layout
1159 Comment text
1160 \end_layout
1161
1162 \end_inset
1163
1164
1165 \end_layout
1166
1167 \end_inset
1168
1169
1170 \end_layout
1171
1172 \begin_layout Standard
1173 PDF-Sideline has some limitations:
1174 \end_layout
1175
1176 \begin_layout Itemize
1177 the comment should not be longer than one page, otherwise the recognition
1178  of the page could fail
1179 \end_layout
1180
1181 \begin_layout Itemize
1182 when using XeTeX you have to assure that the page dimensions are internally
1183  output, e.
1184 \begin_inset space \thinspace{}
1185 \end_inset
1186
1187 g.
1188 \begin_inset space \space{}
1189 \end_inset
1190
1191 with the document class option 
1192 \series bold
1193 pagesize
1194 \series default
1195  for the KOMA-Script classes, or the option 
1196 \series bold
1197 pagesize
1198 \series default
1199  for the LaTeX-package 
1200 \series bold
1201 typearea
1202 \series default
1203 .
1204 \end_layout
1205
1206 \begin_layout Subsection
1207 PDF-Square
1208 \end_layout
1209
1210 \begin_layout Standard
1211 This will typeset a rectangular box.
1212  Here is an example without any options: 
1213 \begin_inset Flex PDF-Square
1214 status open
1215
1216 \begin_layout Plain Layout
1217 a simple PDF-Square comment
1218 \end_layout
1219
1220 \end_inset
1221
1222
1223 \end_layout
1224
1225 \begin_layout Standard
1226 Below this text you see a rectangle comment with a curvy outline as example
1227  of a PDF-Square with options.
1228 \end_layout
1229
1230 \begin_layout Standard
1231 \begin_inset Flex PDF-Square
1232 status open
1233
1234 \begin_layout Plain Layout
1235 \begin_inset Argument 1
1236 status collapsed
1237
1238 \begin_layout Plain Layout
1239 height=2cm,width=4.8cm,voffset=-2cm,hoffset=1cm,opacity=1.0,justification=right,ic
1240 olor=CornflowerBlue,bse=cloudy,bsei=2.5,linewidth=8pt
1241 \end_layout
1242
1243 \end_inset
1244
1245 A fancy PDF-Square comment
1246 \end_layout
1247
1248 \end_inset
1249
1250
1251 \begin_inset Newline newline
1252 \end_inset
1253
1254
1255 \begin_inset Newline newline
1256 \end_inset
1257
1258
1259 \begin_inset Newline newline
1260 \end_inset
1261
1262
1263 \begin_inset Newline newline
1264 \end_inset
1265
1266
1267 \end_layout
1268
1269 \begin_layout Subsection
1270 PDF-Tooltip
1271 \end_layout
1272
1273 \begin_layout Standard
1274 With this you can annotate any object with a tooltip.
1275 \begin_inset Foot
1276 status open
1277
1278 \begin_layout Plain Layout
1279 All objects that can be set into a TeX-box to measure its size.
1280 \end_layout
1281
1282 \end_inset
1283
1284
1285 \end_layout
1286
1287 \begin_layout Standard
1288 The PDF-Tooltip inset has a mandatory argument for the tooltip.
1289  The object that should be annotated is set into the PDF-Tooltip inset,
1290  the tooltip is written into the mandatory argument.
1291  Here is as example of a word with a tooltip: 
1292 \begin_inset Flex PDF-Tooltip
1293 status open
1294
1295 \begin_layout Plain Layout
1296 \begin_inset Argument post:1
1297 status open
1298
1299 \begin_layout Plain Layout
1300 This is a tooltip!
1301 \end_layout
1302
1303 \end_inset
1304
1305
1306 \color red
1307 word
1308 \end_layout
1309
1310 \end_inset
1311
1312
1313 \end_layout
1314
1315 \begin_layout Standard
1316 Since a tooltip can be used for almost any object, one can also use it for
1317  chemical notations in math: 
1318 \begin_inset Flex PDF-Tooltip
1319 status open
1320
1321 \begin_layout Plain Layout
1322 \begin_inset Argument post:1
1323 status open
1324
1325 \begin_layout Plain Layout
1326 Sulfuric acid
1327 \end_layout
1328
1329 \end_inset
1330
1331
1332 \begin_inset Formula $\ce{H2SO4}$
1333 \end_inset
1334
1335
1336 \end_layout
1337
1338 \end_inset
1339
1340
1341 \end_layout
1342
1343 \begin_layout Standard
1344 The PDF-Tooltip inset has also an option that is used to correct the size
1345  of the tooltip for math (if necessary) or to disable an annotation.
1346  Here is an example with a mathstyle option:
1347 \end_layout
1348
1349 \begin_layout Standard
1350 \begin_inset Flex PDF-Tooltip
1351 status open
1352
1353 \begin_layout Plain Layout
1354 \begin_inset Argument 1
1355 status open
1356
1357 \begin_layout Plain Layout
1358 mathstyle=
1359 \begin_inset ERT
1360 status collapsed
1361
1362 \begin_layout Plain Layout
1363
1364
1365 \backslash
1366
1367 \end_layout
1368
1369 \end_inset
1370
1371 displaystyle
1372 \end_layout
1373
1374 \end_inset
1375
1376
1377 \begin_inset Argument post:1
1378 status open
1379
1380 \begin_layout Plain Layout
1381 little Gauß
1382 \end_layout
1383
1384 \end_inset
1385
1386
1387 \begin_inset Formula $\sum_{i=1}^{n}i=\frac{1}{2}n\cdot(n+1)$
1388 \end_inset
1389
1390
1391 \end_layout
1392
1393 \end_inset
1394
1395  
1396 \end_layout
1397
1398 \begin_layout Section
1399 Comment definitions
1400 \end_layout
1401
1402 \begin_layout Standard
1403 The package 
1404 \series bold
1405 pdfcomment
1406 \series default
1407  provides the following environments to define or change PDF comments:
1408 \end_layout
1409
1410 \begin_layout Subsection
1411 PDF-Comment setup
1412 \begin_inset CommandInset label
1413 LatexCommand label
1414 name "sub:PDF-Comment-setup"
1415
1416 \end_inset
1417
1418
1419 \end_layout
1420
1421 \begin_layout Standard
1422 With this custom inset you can reset the global (document-wide) options
1423  at any time.
1424  For example the default color for new PDF comments is blue.
1425  To get Adobe Reader's yellow colored notes for all comments in your document,
1426  add the PDF comment setup inset to the beginning of your document and insert
1427  there the option 
1428 \series bold
1429 color=yellow
1430 \series default
1431 .
1432  This was also done in this document.
1433 \end_layout
1434
1435 \begin_layout Standard
1436 By using its optional option 
1437 \series bold
1438 local
1439 \series default
1440  you can keep the reset local within a group enclosed by TeX-braces.
1441  For example you want to reset the color only for two consecutive comments,
1442  then enclose the PDF comment setup inset and the two comment insets in
1443  TeX-braces.
1444  Here is an example:
1445 \end_layout
1446
1447 \begin_layout Standard
1448 \begin_inset ERT
1449 status collapsed
1450
1451 \begin_layout Plain Layout
1452
1453 {
1454 \end_layout
1455
1456 \end_inset
1457
1458
1459 \begin_inset Flex PDF-Comment-Setup
1460 status open
1461
1462 \begin_layout Plain Layout
1463 \begin_inset Argument 1
1464 status open
1465
1466 \begin_layout Plain Layout
1467 local
1468 \end_layout
1469
1470 \end_inset
1471
1472 color=Orange
1473 \end_layout
1474
1475 \end_inset
1476
1477
1478 \begin_inset Flex PDF-Markup
1479 status collapsed
1480
1481 \begin_layout Plain Layout
1482 PDF-Markup in orange
1483 \end_layout
1484
1485 \end_inset
1486
1487
1488 \begin_inset space ~
1489 \end_inset
1490
1491
1492 \begin_inset space ~
1493 \end_inset
1494
1495
1496 \begin_inset space ~
1497 \end_inset
1498
1499
1500 \begin_inset Flex PDF-Annotation
1501 status collapsed
1502
1503 \begin_layout Plain Layout
1504 PDF-Annotation in orange
1505 \end_layout
1506
1507 \end_inset
1508
1509
1510 \begin_inset ERT
1511 status collapsed
1512
1513 \begin_layout Plain Layout
1514
1515 }
1516 \end_layout
1517
1518 \end_inset
1519
1520
1521 \begin_inset Flex PDF-Margin
1522 status collapsed
1523
1524 \begin_layout Plain Layout
1525 default PDF-Margin comment
1526 \end_layout
1527
1528 \end_inset
1529
1530
1531 \end_layout
1532
1533 \begin_layout Subsection
1534 PDF Comment style
1535 \end_layout
1536
1537 \begin_layout Standard
1538 This environment allows you to define a style for a PDF comment that can
1539  be used by several comments.
1540  Assuming you write a Math tutorial and want to add popup explanations in
1541  the PDF for several expressions, then insert a PDF Comment style environment
1542  before your first formula.
1543  Name it for example 
1544 \series bold
1545 MathPopup
1546 \series default
1547 , set the color to white with 
1548 \series bold
1549 color=white
1550 \series default
1551  and highlight the whole formula with 
1552 \series bold
1553 markup=Highlight
1554 \series default
1555 .
1556 \end_layout
1557
1558 \begin_layout Define PDF-Comment Style
1559
1560 \begin_inset Argument 1
1561 status open
1562
1563 \begin_layout Plain Layout
1564 MathPopup
1565 \end_layout
1566
1567 \end_inset
1568
1569 color=white,markup=Highlight
1570 \end_layout
1571
1572 \begin_layout Standard
1573 In the comments use the option 
1574 \series bold
1575 style=MathPopup
1576 \series default
1577  to use your style.
1578  Here is an example:
1579 \end_layout
1580
1581 \begin_layout Standard
1582 \begin_inset Flex PDF-Markup
1583 status open
1584
1585 \begin_layout Plain Layout
1586 \begin_inset Argument 1
1587 status open
1588
1589 \begin_layout Plain Layout
1590
1591 \family roman
1592 \series medium
1593 \shape up
1594 \size normal
1595 \emph off
1596 \bar no
1597 \strikeout off
1598 \uuline off
1599 \uwave off
1600 \noun off
1601 \color none
1602 style=
1603 \family default
1604 \series default
1605 \shape default
1606 \size default
1607 \emph default
1608 \bar default
1609 \strikeout default
1610 \uuline default
1611 \uwave default
1612 \noun default
1613 \color inherit
1614 MathPopup
1615 \end_layout
1616
1617 \end_inset
1618
1619
1620 \begin_inset Formula $P(E)$
1621 \end_inset
1622
1623
1624 \begin_inset Argument post:1
1625 status open
1626
1627 \begin_layout Plain Layout
1628
1629 \family roman
1630 \series medium
1631 \shape up
1632 \size normal
1633 \emph off
1634 \bar no
1635 \strikeout off
1636 \uuline off
1637 \uwave off
1638 \noun off
1639 \color none
1640 Probability of event E
1641 \end_layout
1642
1643 \end_inset
1644
1645
1646 \end_layout
1647
1648 \end_inset
1649
1650
1651 \end_layout
1652
1653 \begin_layout Subsection
1654 \begin_inset CommandInset label
1655 LatexCommand label
1656 name "sec:Avatars"
1657
1658 \end_inset
1659
1660 Avatars
1661 \end_layout
1662
1663 \begin_layout Standard
1664 If you are for example reviewing a document, you need to add your name to
1665  every of your comments.
1666  In case you use a special layout of your annotations, you would have to
1667  do a lot of copy-paste work.
1668  But this can be avoided if you define for every person a special avatar.
1669 \end_layout
1670
1671 \begin_layout Standard
1672 Assuming your name is 
1673 \begin_inset Quotes eld
1674 \end_inset
1675
1676 Oleg Testman
1677 \begin_inset Quotes erd
1678 \end_inset
1679
1680  you can define an avatar for your using the environment Define
1681 \begin_inset space ~
1682 \end_inset
1683
1684 Avatar.
1685  Its mandatory option is the name.
1686  In your case, name it 
1687 \series bold
1688 Oleg
1689 \series default
1690 .
1691  Add behind the name of the avatar your name as author by writing 
1692 \series bold
1693 author={Oleg Testman}
1694 \series default
1695 .
1696 \begin_inset Newline newline
1697 \end_inset
1698
1699 You might use a special icon to see at the first look which comments were
1700  made by you.
1701  You therefore add behind the author-statement, separated by a comma, 
1702 \begin_inset Quotes eld
1703 \end_inset
1704
1705
1706 \series bold
1707 icon=Check
1708 \series default
1709
1710 \begin_inset Quotes erd
1711 \end_inset
1712
1713  to get a checkmark.
1714 \begin_inset Foot
1715 status open
1716
1717 \begin_layout Plain Layout
1718 For all possible icons, see the 
1719 \series bold
1720 pdfcomment
1721 \series default
1722  manual.
1723 \end_layout
1724
1725 \end_inset
1726
1727  the checkmark should have a green color so that you add 
1728 \series bold
1729 color=lime
1730 \series default
1731  to the avatar definition.
1732  Your whole definition reads now
1733 \begin_inset Newline newline
1734 \end_inset
1735
1736
1737 \series bold
1738 author={Oleg Testman},icon=Check,color=lime
1739 \end_layout
1740
1741 \begin_layout Define Avatar
1742
1743 \begin_inset Argument 1
1744 status open
1745
1746 \begin_layout Plain Layout
1747 Oleg
1748 \end_layout
1749
1750 \end_inset
1751
1752 author={Oleg Testman},icon=Check,color=lime
1753 \end_layout
1754
1755 \begin_layout Standard
1756 To use now your avatar for PDF comments you have two choices:
1757 \end_layout
1758
1759 \begin_layout Enumerate
1760 You set up ALL PDF comments in the document using your avatar.
1761  This is done by inserting the custom inset 
1762 \family sans
1763 PDF
1764 \begin_inset space ~
1765 \end_inset
1766
1767 Comment-Setup
1768 \family default
1769  before the first PDF comment in your document.
1770  Insert to this inset 
1771 \series bold
1772 avatar=Oleg
1773 \series default
1774 .
1775 \end_layout
1776
1777 \begin_layout Enumerate
1778 You add 
1779 \series bold
1780 avatar=Oleg
1781 \series default
1782  to the options of a particular PDF comment.
1783  The avatar will then only be used for this comment.
1784 \end_layout
1785
1786 \begin_layout Standard
1787 Here is an example for the 
1788 \family sans
1789 PDF
1790 \begin_inset space ~
1791 \end_inset
1792
1793 Comment-Setup
1794 \family default
1795  method:
1796 \begin_inset Flex PDF-Comment-Setup
1797 status open
1798
1799 \begin_layout Plain Layout
1800 avatar=Oleg
1801 \end_layout
1802
1803 \end_inset
1804
1805
1806 \begin_inset Flex PDF-Annotation
1807 status open
1808
1809 \begin_layout Plain Layout
1810 Oleg said: Wow, that's nice!
1811 \end_layout
1812
1813 \end_inset
1814
1815
1816 \begin_inset Newline newline
1817 \end_inset
1818
1819 and here is another comment:
1820 \begin_inset Flex PDF-Annotation
1821 status open
1822
1823 \begin_layout Plain Layout
1824 Oleg also said: I hate to repeat myself.
1825 \end_layout
1826
1827 \end_inset
1828
1829
1830 \end_layout
1831
1832 \begin_layout Define Avatar
1833
1834 \begin_inset Argument 1
1835 status open
1836
1837 \begin_layout Plain Layout
1838 Dolittle
1839 \end_layout
1840
1841 \end_inset
1842
1843 color=NavyBlue,opacity=0.5,open=false,icon=Circle,author={Dr.
1844  Dolittle}
1845 \end_layout
1846
1847 \begin_layout Standard
1848 Here is an example where another avatar 
1849 \begin_inset Quotes eld
1850 \end_inset
1851
1852 Dolittle
1853 \begin_inset Quotes erd
1854 \end_inset
1855
1856  is only used for this comment:
1857 \begin_inset Flex PDF-Margin
1858 status open
1859
1860 \begin_layout Plain Layout
1861 \begin_inset Argument 1
1862 status open
1863
1864 \begin_layout Plain Layout
1865 avatar=Dolittle
1866 \end_layout
1867
1868 \end_inset
1869
1870 I am Dr.
1871  Dolittle! Respect my authority!
1872 \end_layout
1873
1874 \end_inset
1875
1876
1877 \end_layout
1878
1879 \begin_layout Section
1880 List of PDF comments
1881 \end_layout
1882
1883 \begin_layout Standard
1884 You can insert a list with all PDF comments using the environment List of
1885  PDF comments.
1886  By specifying options for it you can determine what parts of the comments
1887  shpuld appear in the list.
1888  Here is the list for this document where only the comments of a defined
1889  author are printed:
1890 \end_layout
1891
1892 \begin_layout List of PDF Comments
1893 \begin_inset Argument 1
1894 status open
1895
1896 \begin_layout Plain Layout
1897 liststyle=
1898 \begin_inset ERT
1899 status collapsed
1900
1901 \begin_layout Plain Layout
1902
1903 {
1904 \end_layout
1905
1906 \end_inset
1907
1908 AuthorComment
1909 \begin_inset ERT
1910 status collapsed
1911
1912 \begin_layout Plain Layout
1913
1914 }
1915 \end_layout
1916
1917 \end_inset
1918
1919 , heading =
1920 \begin_inset ERT
1921 status collapsed
1922
1923 \begin_layout Plain Layout
1924
1925 {
1926 \end_layout
1927
1928 \end_inset
1929
1930 List of PDF comments
1931 \begin_inset ERT
1932 status collapsed
1933
1934 \begin_layout Plain Layout
1935
1936 }
1937 \end_layout
1938
1939 \end_inset
1940
1941
1942 \end_layout
1943
1944 \end_inset
1945
1946
1947 \end_layout
1948
1949 \begin_layout Standard
1950 You can also define your own style using the environment
1951 \begin_inset Newline newline
1952 \end_inset
1953
1954
1955 \family sans
1956 Define
1957 \begin_inset space ~
1958 \end_inset
1959
1960 PDF
1961 \begin_inset space ~
1962 \end_inset
1963
1964 Comment
1965 \begin_inset space ~
1966 \end_inset
1967
1968 List
1969 \begin_inset space ~
1970 \end_inset
1971
1972 Style
1973 \begin_inset Newline newline
1974 \end_inset
1975
1976
1977 \family default
1978 if you know enough about the tricky LaTeX internals.
1979  With the environment
1980 \begin_inset Newline newline
1981 \end_inset
1982
1983
1984 \family sans
1985 Set
1986 \begin_inset space ~
1987 \end_inset
1988
1989 PDF
1990 \begin_inset space ~
1991 \end_inset
1992
1993 Comment
1994 \begin_inset space ~
1995 \end_inset
1996
1997 List
1998 \begin_inset space ~
1999 \end_inset
2000
2001 Style
2002 \begin_inset Newline newline
2003 \end_inset
2004
2005
2006 \family default
2007 you can set a list style in case it was changed before the list of comments.
2008 \end_layout
2009
2010 \begin_layout Define PDF-Comment List Style
2011
2012 \begin_inset Argument 1
2013 status open
2014
2015 \begin_layout Plain Layout
2016 MyStyle
2017 \end_layout
2018
2019 \end_inset
2020
2021
2022 \backslash
2023 makeatletter
2024 \backslash
2025 pc@lopt@author
2026 \backslash
2027  - 
2028 \backslash
2029 pc@lopt@subject
2030 \backslash
2031  (
2032 \backslash
2033 pc@lopt@deadline)
2034 \backslash
2035 makeatother
2036 \end_layout
2037
2038 \begin_layout Set PDF-Comment List Style
2039
2040 AuthorCommentDeadline
2041 \end_layout
2042
2043 \begin_layout Standard
2044 \begin_inset Note Greyedout
2045 status open
2046
2047 \begin_layout Plain Layout
2048
2049 \series bold
2050 Note:
2051 \series default
2052  Only one list of comments can be printed in the PDF.
2053 \end_layout
2054
2055 \end_inset
2056
2057
2058 \end_layout
2059
2060 \begin_layout Section
2061 General Hints
2062 \end_layout
2063
2064 \begin_layout Itemize
2065 To be able to use all kinds of colors and color definitions you must load
2066  the LaTeX package 
2067 \series bold
2068 xcolor
2069 \series default
2070  in the document preamble this way:
2071 \begin_inset Newline newline
2072 \end_inset
2073
2074
2075 \series bold
2076
2077 \backslash
2078 usepackage[svgnames,rgb]{xcolor}
2079 \end_layout
2080
2081 \begin_layout Itemize
2082 If you have two consecutive PDF
2083 \begin_inset space ~
2084 \end_inset
2085
2086 comment insets, the will appear in the PDF one over each other:
2087 \begin_inset Flex PDF-Comment-Setup
2088 status open
2089
2090 \begin_layout Plain Layout
2091 avatar=Oleg
2092 \end_layout
2093
2094 \end_inset
2095
2096
2097 \begin_inset Flex PDF-Annotation
2098 status open
2099
2100 \begin_layout Plain Layout
2101 Oleg said: Wow, that's nice!
2102 \end_layout
2103
2104 \end_inset
2105
2106
2107 \begin_inset Flex PDF-Annotation
2108 status open
2109
2110 \begin_layout Plain Layout
2111 Oleg also said: I hate to repeat myself.
2112 \end_layout
2113
2114 \end_inset
2115
2116
2117 \begin_inset Newline newline
2118 \end_inset
2119
2120 To avoid that separate them with whitespace like protected space:
2121 \begin_inset Flex PDF-Annotation
2122 status open
2123
2124 \begin_layout Plain Layout
2125 Oleg said: Wow, that's nice!
2126 \end_layout
2127
2128 \end_inset
2129
2130
2131 \begin_inset space ~
2132 \end_inset
2133
2134
2135 \begin_inset space ~
2136 \end_inset
2137
2138
2139 \begin_inset space ~
2140 \end_inset
2141
2142
2143 \begin_inset space ~
2144 \end_inset
2145
2146
2147 \begin_inset space ~
2148 \end_inset
2149
2150
2151 \begin_inset space ~
2152 \end_inset
2153
2154
2155 \begin_inset space ~
2156 \end_inset
2157
2158
2159 \begin_inset Flex PDF-Annotation
2160 status open
2161
2162 \begin_layout Plain Layout
2163 Oleg also said: I hate to repeat myself.
2164 \end_layout
2165
2166 \end_inset
2167
2168
2169 \end_layout
2170
2171 \begin_layout Itemize
2172 You cannot use non-Latin characters in your comment or in the author name.
2173  The reason is that PDFs use a special character encoding that is not compatible
2174  with LaTeX.
2175 \end_layout
2176
2177 \end_body
2178 \end_document