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