From: Uwe Stöhr Date: Wed, 5 Nov 2014 23:19:22 +0000 (+0100) Subject: PDF-comment.lyx: new example file X-Git-Tag: 2.1.3~96 X-Git-Url: https://git.lyx.org/gitweb/?a=commitdiff_plain;h=6cefd29d418ecdb3d36c2a4e35c7c584e4d7752c;p=features.git PDF-comment.lyx: new example file - backport from master, fixes #9310 --- diff --git a/lib/Makefile.am b/lib/Makefile.am index 942a1ad7b9..6e40fe074c 100644 --- a/lib/Makefile.am +++ b/lib/Makefile.am @@ -322,6 +322,7 @@ dist_examples_DATA = \ examples/modernCV.lyx \ examples/MultilingualCaptions.lyx \ examples/noweb2lyx.lyx \ + examples/PDF-comment.lyx \ examples/powerdot-example.lyx \ examples/recipebook.lyx \ examples/R-S-statements.lyx \ diff --git a/lib/examples/PDF-comment.lyx b/lib/examples/PDF-comment.lyx new file mode 100644 index 0000000000..a809c9006b --- /dev/null +++ b/lib/examples/PDF-comment.lyx @@ -0,0 +1,2097 @@ +#LyX 2.1 created this file. For more info see http://www.lyx.org/ +\lyxformat 474 +\begin_document +\begin_header +\textclass scrartcl +\begin_preamble +% to be able to use all color settings of pdfcomment +\usepackage[svgnames,rgb]{xcolor} + +% if pdflatex is used +\usepackage{ifpdf} +\ifpdf + +% set fonts for nicer pdf view +\IfFileExists{lmodern.sty} + {\usepackage{lmodern}}{} + +\fi % end if pdflatex is used +\end_preamble +\options BCOR8mm,pagesize +\use_default_options false +\begin_modules +pdfcomment +\end_modules +\maintain_unincluded_children false +\language english +\language_package default +\inputencoding auto +\fontencoding global +\font_roman default +\font_sans default +\font_typewriter default +\font_math auto +\font_default_family default +\use_non_tex_fonts false +\font_sc false +\font_osf false +\font_sf_scale 100 +\font_tt_scale 100 +\graphics default +\default_output_format default +\output_sync 0 +\bibtex_command bibtex +\index_command default +\paperfontsize 12 +\spacing single +\use_hyperref true +\pdf_title "Description of the module pdfcomment" +\pdf_author "Uwe Stöhr" +\pdf_subject "pdfcomment" +\pdf_keywords "LyX, PDF-comments, pdfcomment" +\pdf_bookmarks true +\pdf_bookmarksnumbered true +\pdf_bookmarksopen true +\pdf_bookmarksopenlevel 2 +\pdf_breaklinks false +\pdf_pdfborder false +\pdf_colorlinks true +\pdf_backref false +\pdf_pdfusetitle false +\pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false" +\papersize a4paper +\use_geometry false +\use_package amsmath 1 +\use_package amssymb 1 +\use_package cancel 0 +\use_package esint 1 +\use_package mathdots 1 +\use_package mathtools 1 +\use_package mhchem 1 +\use_package stackrel 0 +\use_package stmaryrd 0 +\use_package undertilde 0 +\cite_engine basic +\cite_engine_type default +\biblio_style plain +\use_bibtopic false +\use_indices false +\paperorientation portrait +\suppress_date true +\justification true +\use_refstyle 0 +\notefontcolor #0000ff +\index Index +\shortcut idx +\color #008000 +\end_index +\secnumdepth 3 +\tocdepth 2 +\paragraph_separation skip +\defskip medskip +\quotes_language english +\papercolumns 1 +\papersides 1 +\paperpagestyle default +\tracking_changes false +\output_changes false +\html_math_output 0 +\html_css_as_file 0 +\html_be_strict false +\end_header + +\begin_body + +\begin_layout Standard +\begin_inset Flex PDF-Comment-Setup +status open + +\begin_layout Plain Layout +color=yellow +\end_layout + +\end_inset + + +\begin_inset Note Note +status collapsed + +\begin_layout Plain Layout +This sets yellow as default color for new PDF comments, see sec. +\begin_inset space ~ +\end_inset + + +\begin_inset CommandInset ref +LatexCommand ref +reference "sub:PDF-Comment-setup" + +\end_inset + + for a description. +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Title +Description of the module pdfcomment +\end_layout + +\begin_layout Author +Uwe Stöhr +\end_layout + +\begin_layout Standard +The LaTeX-package +\series bold +pdfcomment +\series default + provides full access for PDF comments. + You can add normal comments as well as margin comments, underlining etc. + And you can also define a special layout for the comment which you can + use several times in the document. + This document is only a excerpt of the documentation of +\series bold +pdfcomment +\series default +, See its documentation for all information: +\begin_inset Newline newline +\end_inset + + +\begin_inset Flex URL +status open + +\begin_layout Plain Layout + +http://mirrors.ctan.org/macros/latex/contrib/pdfcomment/doc/pdfcomment.pdf +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Section +The different comments types +\end_layout + +\begin_layout Standard +The different comment types are inserted using the menu +\family sans +Insert\SpecialChar \menuseparator +Custom +\begin_inset space ~ +\end_inset + +Insets +\family default +. + You can select one of the following: +\end_layout + +\begin_layout Subsection +PDF-Annotation +\end_layout + +\begin_layout Standard +This is the standard PDF comment. + Here is an example: +\begin_inset Flex PDF-Annotation +status open + +\begin_layout Plain Layout +This is a simple PDF-Annotation. +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Standard +Like all PDF comment types you can add a lot of things to the option of + the inset. + To insert the options inset, set the cursor into the comment inset and + use the menu +\family sans +Insert\SpecialChar \menuseparator +PDF Comment Options +\family default +. +\end_layout + +\begin_layout Standard +\begin_inset Note Greyedout +status open + +\begin_layout Plain Layout + +\series bold +Note: +\series default + All braces and brackets in comment options must be inserted as TeX-code! +\end_layout + +\end_inset + + +\begin_inset Newline newline +\end_inset + + +\end_layout + +\begin_layout Standard +Here is an example PDF-Annotation where the author is set to +\begin_inset Quotes eld +\end_inset + +Daisy Duck +\begin_inset Quotes erd +\end_inset + +: +\begin_inset Flex PDF-Annotation +status open + +\begin_layout Plain Layout +\begin_inset Argument 1 +status collapsed + +\begin_layout Plain Layout +author= +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +{ +\end_layout + +\end_inset + +Daisy Duck +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +} +\end_layout + +\end_inset + +,color= +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +{ +\end_layout + +\end_inset + +0.234 0.867 0.211 +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +} +\end_layout + +\end_inset + +,voffset=8pt,opacity=0.5 +\end_layout + +\end_inset + +This is an annotation with a complex option. +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Standard +To avoid to write the same options like the author again and again, you + can define a so-called +\begin_inset Quotes eld +\end_inset + +avatar +\begin_inset Quotes erd +\end_inset + + for every person and/or comment layout. + See +\begin_inset CommandInset ref +LatexCommand ref +reference "sec:Avatars" + +\end_inset + + for further information. +\end_layout + +\begin_layout Standard +For a full list of possible options, please look at the +\series bold +pdfcomment +\series default + documentation. +\end_layout + +\begin_layout Subsection +PDF-Circle +\end_layout + +\begin_layout Standard +This will typeset a comment in form of a circle or ellipse. + Here is an example without any options: +\begin_inset Flex PDF-Circle +status open + +\begin_layout Plain Layout +a simple circle comment +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Standard +At the right side you see a large, elliptical comment as example of a PDF-Circle + with options. + +\begin_inset Flex PDF-Circle +status open + +\begin_layout Plain Layout +\begin_inset Argument 1 +status collapsed + +\begin_layout Plain Layout +id=1,color=blue,height=2.5cm,width=5.8cm,voffset=-2.8cm,hoffset=8cm,opacity=1.0,just +ification=right,icolor= +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +{ +\end_layout + +\end_inset + +yellow +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +} +\end_layout + +\end_inset + +,linewidth=12pt,borderstyle=dashed,dashstyle= +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +{ +\end_layout + +\end_inset + +10 5 +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +} +\end_layout + +\end_inset + + +\end_layout + +\end_inset + +a circle comment in form of a large ellipse +\end_layout + +\end_inset + + +\begin_inset Newline newline +\end_inset + + +\begin_inset Newline newline +\end_inset + + +\begin_inset Newline newline +\end_inset + + +\end_layout + +\begin_layout Subsection +PDF-Freetext +\end_layout + +\begin_layout Standard +This will typeset a comment in form of a freely positioned box. + By using the option +\series bold +type=callout +\series default + the box will have an additional so called callout line, to bind the box + to a certain element of the page. + With the option +\series bold +type=typewriter +\series default + you can write a comment everywhere on the page with a virtual ’typewriter’. + These PDF-Freetext annotations do have no frame and a transparent background + for ’overwriting’ arbitrary parts of the page. + Here is an example in form of a blue rectangle: +\begin_inset Flex PDF-Freetext +status open + +\begin_layout Plain Layout +\begin_inset Argument 1 +status collapsed + +\begin_layout Plain Layout +height=3cm,type=freetext,subject={freetext},width=4.5cm,voffset=-3.2cm,hoffset=-3.2 +cm,opacity=0.9,justification=right +\end_layout + +\end_inset + +This is also a comment, but it is a PDF-Freetext annotation. +\end_layout + +\end_inset + + +\begin_inset Newline newline +\end_inset + + +\begin_inset Newline newline +\end_inset + + +\begin_inset Newline newline +\end_inset + + +\begin_inset Newline newline +\end_inset + + +\end_layout + +\begin_layout Subsection +PDF-Line +\end_layout + +\begin_layout Standard +This will typeset a comment in form of a line, polyline or polygon. + Here is an example without any options: +\begin_inset Flex PDF-Line +status open + +\begin_layout Plain Layout +a simple PDF-Line comment +\end_layout + +\end_inset + + +\begin_inset Newline newline +\end_inset + + +\end_layout + +\begin_layout Standard +As you can see a PDF-Line comment without options is useless. +\end_layout + +\begin_layout Standard +The green arrow at the left side of this page is an example for a PDF-Line + comment with options. + +\begin_inset Flex PDF-Line +status open + +\begin_layout Plain Layout +\begin_inset Argument 1 +status collapsed + +\begin_layout Plain Layout +type=line,opacity=1,line= +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +{ +\end_layout + +\end_inset + +50 480 50 180 +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +} +\end_layout + +\end_inset + +,color=green,icolor=blue,caption=top,linebegin= +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +{ +\end_layout + +\end_inset + +/ROpenArrow +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +} +\end_layout + +\end_inset + +,lineend= +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +{ +\end_layout + +\end_inset + +/OpenArrow +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +} +\end_layout + +\end_inset + +,linewidth=2bp,captionhoffset=-5pt,captionvoffset=15pt +\end_layout + +\end_inset + +a PDF-Line comment with options +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Subsection +PDF-Margin +\end_layout + +\begin_layout Standard +This will typeset an annotation into the margin. + Right beside this text is an example without options: +\begin_inset Flex PDF-Margin +status open + +\begin_layout Plain Layout +a simple PDF-Margin comment +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Standard +The red margin note is an example for a PDF-Margin command with options. + +\begin_inset Flex PDF-Margin +status open + +\begin_layout Plain Layout +\begin_inset Argument 1 +status collapsed + +\begin_layout Plain Layout +icon=Note,color=red,open=true,hspace=100pt +\end_layout + +\end_inset + +a PDF-Margin comment with options +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Subsection +PDF-Markup +\end_layout + +\begin_layout Standard +This will typeset so called PDF text markup annotations over some text or + math. + Here is a markup without options: +\begin_inset Flex PDF-Markup +status open + +\begin_layout Plain Layout +simple PDF-Markup +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Standard +Possible types for the option +\series bold +markup +\series default + are: +\end_layout + +\begin_layout Description +Highlight The markup text will be highlighted: +\begin_inset Flex PDF-Markup +status open + +\begin_layout Plain Layout +\begin_inset Argument 1 +status open + +\begin_layout Plain Layout +id=1,markup=Highlight +\end_layout + +\end_inset + +Highlight PDF-Markup +\begin_inset Argument post:1 +status open + +\begin_layout Plain Layout +a comment +\end_layout + +\end_inset + + +\end_layout + +\end_inset + + +\begin_inset Note Note +status collapsed + +\begin_layout Plain Layout +see the next section for the description of the option +\series bold +id=1 +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Description +Underline The markup text will be underlined: +\begin_inset Flex PDF-Markup +status open + +\begin_layout Plain Layout +\begin_inset Argument 1 +status open + +\begin_layout Plain Layout +markup=Underline +\end_layout + +\end_inset + +Underlining PDF-Markup +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Description +Squiggly The markup text will be underlined with a wave: +\begin_inset Flex PDF-Markup +status open + +\begin_layout Plain Layout +\begin_inset Argument 1 +status open + +\begin_layout Plain Layout +markup=Squiggly +\end_layout + +\end_inset + +Underwave PDF-Markup +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Description +StrikeOut The markup text will be struck-out: +\begin_inset Flex PDF-Markup +status open + +\begin_layout Plain Layout +\begin_inset Argument 1 +status open + +\begin_layout Plain Layout +markup=StrikeOut +\end_layout + +\end_inset + +Striked-out PDF-Markup +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Standard +The text for the comment is inserted with the inset option +\family sans +Comment +\family default +. +\end_layout + +\begin_layout Standard +PDF-Markup has some limitations: +\end_layout + +\begin_layout Itemize +it is only suitable for text or inline math! +\end_layout + +\begin_layout Itemize +the markup text must not be longer than one paragraph +\end_layout + +\begin_layout Itemize +the markup annotation must not be longer than one page, otherwise the recognitio +n of the page break will fail +\end_layout + +\begin_layout Itemize +when using XeTeX you have to assure that the page dimensions are internally + output, e. +\begin_inset space \thinspace{} +\end_inset + +g. +\begin_inset space \space{} +\end_inset + +with the document class option +\series bold +pagesize +\series default + for the KOMA-Script classes, or the option +\series bold +pagesize +\series default + for the LaTeX-package +\series bold +typearea +\series default +. +\end_layout + +\begin_layout Subsection +PDF-Reply +\end_layout + +\begin_layout Standard +With a PDF-Reply you can compose replies to PDF comments. + The option +\series bold +replyto +\series default + provides a clear reference to the comment the reply refers to. +\end_layout + +\begin_layout Standard +As example see the reply to the Highlight PDF-Markup from the previous section. + +\begin_inset Flex PDF-Reply +status open + +\begin_layout Plain Layout +\begin_inset Argument 1 +status open + +\begin_layout Plain Layout +id=2,replyto=1,date=D:20101211161247+01'00' +\end_layout + +\end_inset + +This is a reply. +\end_layout + +\end_inset + + It appears in that PDF-Markup comment. + To be able to reference the PDF-Markup the option +\series bold +id=1 +\series default + was added to its options. + The PDF-Reply got the option +\series bold +replyto=1 +\series default +. +\end_layout + +\begin_layout Standard +You can also reply to replies by adding an +\series bold +id +\series default + option to the reply that should be replied to. + As example see the reply to the reply to the PDF-Markup. + +\begin_inset Flex PDF-Reply +status open + +\begin_layout Plain Layout +\begin_inset Argument 1 +status open + +\begin_layout Plain Layout +replyto=2,date=D:20101212095321+01'00' +\end_layout + +\end_inset + +Of course, you can reply to a reply. +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Standard +\begin_inset Note Greyedout +status open + +\begin_layout Plain Layout + +\series bold +Note: +\series default + Due to technical reasons PDF-Reply works only when using pdflatex. +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Standard +PDF-Reply has some further limitations: +\end_layout + +\begin_layout Itemize +It can not support page breaks. +\end_layout + +\begin_layout Itemize +The replies will only appear in the PDF annotations on the second page. + (Replies to comments without page break work smoothly.) +\end_layout + +\begin_layout Subsection +PDF-Sideline +\end_layout + +\begin_layout Standard +This will typeset a comment in form of identical markers on every side of + the page. + The yellow arrows besides this text is an example without any options: + +\begin_inset Flex PDF-Sideline +status open + +\begin_layout Plain Layout +a simple PDF-Sideline +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Standard +As you can see a PDF-Sideline comment without options is quite useless. + PDF-Sideline is useful if you want to highlight complete parts of a page. + The inset options define the layout of the marker while the normal content + of the inset is the text surrounded by the markers. + The content of the inset option +\family sans +Comment +\family default + will be printed along both markers. + Here is an example: +\end_layout + +\begin_layout Standard +\begin_inset Flex PDF-Sideline +status open + +\begin_layout Plain Layout +\begin_inset Argument 1 +status open + +\begin_layout Plain Layout +opacity=0.33,color=magenta,icolor=cyan,caption=inline,linebegin= +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +{ +\end_layout + +\end_inset + +/Butt +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +} +\end_layout + +\end_inset + +,lineend= +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +{ +\end_layout + +\end_inset + +/Square +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +} +\end_layout + +\end_inset + +,linewidth=3bp,linesep=0.7cm +\end_layout + +\end_inset + +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy + eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam + voluptua. + At vero eos et accusam et justo duo dolores et ea rebum. + Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor + sit amet. + Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy + eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam + voluptua. +\end_layout + +\begin_layout Plain Layout +At vero eos et accusam et justo duo dolores et ea rebum. + Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor + sit amet. + Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy + eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam + voluptua. + At vero eos et accusam et justo duo dolores et ea rebum. + Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor + sit amet. +\begin_inset Argument 2 +status open + +\begin_layout Plain Layout +Comment text +\end_layout + +\end_inset + + +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Standard +PDF-Sideline has some limitations: +\end_layout + +\begin_layout Itemize +the markup annotation should not be longer than one page, otherwise the + recognition of the page could fail +\end_layout + +\begin_layout Itemize +when using XeTeX you have to assure that the page dimensions are internally + output, e. +\begin_inset space \thinspace{} +\end_inset + +g. +\begin_inset space \space{} +\end_inset + +with the document class option +\series bold +pagesize +\series default + for the KOMA-Script classes, or the option +\series bold +pagesize +\series default + for the LaTeX-package +\series bold +typearea +\series default +. +\end_layout + +\begin_layout Subsection +PDF-Square +\end_layout + +\begin_layout Standard +This will typeset a rectangular box. + Here is an example without any options: +\begin_inset Flex PDF-Square +status open + +\begin_layout Plain Layout +a simple PDF-Square comment +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Standard +Below this text you see a rectangle comment with a curvy outline as example + of a PDF-Square with options. +\end_layout + +\begin_layout Standard +\begin_inset Flex PDF-Square +status open + +\begin_layout Plain Layout +\begin_inset Argument 1 +status collapsed + +\begin_layout Plain Layout +height=2cm,width=4.8cm,voffset=-2cm,hoffset=1cm,opacity=1.0,justification=right,ic +olor=CornflowerBlue,bse=cloudy,bsei=2.5,linewidth=8pt +\end_layout + +\end_inset + +A fancy PDF-Square comment +\end_layout + +\end_inset + + +\begin_inset Newline newline +\end_inset + + +\begin_inset Newline newline +\end_inset + + +\begin_inset Newline newline +\end_inset + + +\begin_inset Newline newline +\end_inset + + +\end_layout + +\begin_layout Subsection +PDF-Tooltip +\end_layout + +\begin_layout Standard +With this you can annotate any object with a tooltip. +\begin_inset Foot +status open + +\begin_layout Plain Layout +All objects that can be set into a TeX-box to measure its size. +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Standard +The PDF-Tooltip inset has a mandatory argument for the tooltip. + The object that should be annotated is set into the PDF-Tooltip inset, + the tooltip is written into the mandatory argument of the inset. + Here is an example of a word with a tooltip: +\begin_inset Flex PDF-Tooltip +status open + +\begin_layout Plain Layout +\begin_inset Argument post:1 +status open + +\begin_layout Plain Layout +This is a tooltip! +\end_layout + +\end_inset + + +\color red +words +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Standard +As the object for the tooltip can be almost anything, we can also use it + for chemical notations in math: +\begin_inset Flex PDF-Tooltip +status open + +\begin_layout Plain Layout +\begin_inset Argument post:1 +status open + +\begin_layout Plain Layout +Sulfuric acid +\end_layout + +\end_inset + + +\begin_inset Formula $\ce{H2SO4}$ +\end_inset + + +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Standard +The PDF-Tooltip inset has also an optional argument that is used to correct + the size of tooltips for math (if necessary) or to disable an annotation. + Here is an example with a mathstyle option: +\end_layout + +\begin_layout Standard +\begin_inset Flex PDF-Tooltip +status open + +\begin_layout Plain Layout +\begin_inset Argument 1 +status open + +\begin_layout Plain Layout +mathstyle= +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + + +\backslash + +\end_layout + +\end_inset + +displaystyle +\end_layout + +\end_inset + + +\begin_inset Argument post:1 +status open + +\begin_layout Plain Layout +little Gauß +\end_layout + +\end_inset + + +\begin_inset Formula $x^{2}+2xy+y^{2}\sum_{i=1}^{n}i=\frac{1}{2}n\cdot(n+1)$ +\end_inset + + +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Section +Comment definitions +\end_layout + +\begin_layout Standard +The package +\series bold +pdfcomment +\series default + provides the following environments to define or change PDF comments: +\end_layout + +\begin_layout Subsection +PDF-Comment setup +\begin_inset CommandInset label +LatexCommand label +name "sub:PDF-Comment-setup" + +\end_inset + + +\end_layout + +\begin_layout Standard +With this custom inset you can reset the global (document-wide) options + at any time. + For example the default color for new PDF comments is blue. + To get Adobe Reader's yellow colored notes for all comments in your document, + add the PDF comment setup inset to the beginning of your document and insert + there the option +\series bold +color=yellow +\series default +. + This was also done in this document. +\end_layout + +\begin_layout Standard +By using its optional option +\series bold +local +\series default + you can keep the reset local within a group enclosed by TeX-braces. + For example you want to reset the color only for two consecutive comments, + then enclose the PDF comment setup inset and the two comment insets in + TeX-braces. + Here is an example: +\end_layout + +\begin_layout Standard +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +{ +\end_layout + +\end_inset + + +\begin_inset Flex PDF-Comment-Setup +status open + +\begin_layout Plain Layout +\begin_inset Argument 1 +status open + +\begin_layout Plain Layout +local +\end_layout + +\end_inset + +color=Orange +\end_layout + +\end_inset + + +\begin_inset Flex PDF-Markup +status collapsed + +\begin_layout Plain Layout +PDF-Markup in orange +\end_layout + +\end_inset + + +\begin_inset space ~ +\end_inset + + +\begin_inset space ~ +\end_inset + + +\begin_inset space ~ +\end_inset + + +\begin_inset Flex PDF-Annotation +status collapsed + +\begin_layout Plain Layout +PDF-Annotation in orange +\end_layout + +\end_inset + + +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +} +\end_layout + +\end_inset + + +\begin_inset Flex PDF-Margin +status collapsed + +\begin_layout Plain Layout +default PDF-Margin comment +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Subsection +PDF Comment style +\end_layout + +\begin_layout Standard +This environment allows you to define a style for a PDF comment that can + be used by several comments. + Assuming you write a Math tutorial and want to add popup explanations in + the PDF for several expressions, then insert a PDF Comment style environment + before your first formula. + Name it for example +\series bold +MathPopup +\series default +, set the color to white with +\series bold +color=white +\series default + and highlight the whole formula with +\series bold +markup=Highlight +\series default +. +\end_layout + +\begin_layout Define PDF-Comment Style +\begin_inset Argument 1 +status open + +\begin_layout Plain Layout +MathPopup +\end_layout + +\end_inset + +color=white,markup=Highlight +\end_layout + +\begin_layout Standard +In the comments use the option +\series bold +style=MathPopup +\series default + to use your style. + Here is an example: +\end_layout + +\begin_layout Standard +\begin_inset Flex PDF-Markup +status open + +\begin_layout Plain Layout +\begin_inset Argument 1 +status open + +\begin_layout Plain Layout + +\family roman +\series medium +\shape up +\size normal +\emph off +\bar no +\strikeout off +\uuline off +\uwave off +\noun off +\color none +style= +\family default +\series default +\shape default +\size default +\emph default +\bar default +\strikeout default +\uuline default +\uwave default +\noun default +\color inherit +MathPopup +\end_layout + +\end_inset + + +\begin_inset Formula $P(E)$ +\end_inset + + +\begin_inset Argument post:1 +status open + +\begin_layout Plain Layout + +\family roman +\series medium +\shape up +\size normal +\emph off +\bar no +\strikeout off +\uuline off +\uwave off +\noun off +\color none +Probability of event E +\end_layout + +\end_inset + + +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Subsection +\begin_inset CommandInset label +LatexCommand label +name "sec:Avatars" + +\end_inset + +Avatars +\end_layout + +\begin_layout Standard +If you are for example reviewing a document, you need to add your name to + every of your comments. + In case you use a special layout of your annotations, you would have to + do a lot of copy-paste work. + But this can be avoided if you define for every person a special avatar. +\end_layout + +\begin_layout Standard +Assuming your name is +\begin_inset Quotes eld +\end_inset + +Oleg Testman +\begin_inset Quotes erd +\end_inset + + you can define an avatar for your using the environment Define +\begin_inset space ~ +\end_inset + +Avatar. + Its mandatory option is the name. + In your case, name it +\series bold +Oleg +\series default +. + Add behind the name of the avatar your name as author by writing +\series bold +author={Oleg Testman} +\series default +. +\begin_inset Newline newline +\end_inset + +You might use a special icon to see at the first look which comments were + made by you. + You therefore add behind the author-statement, separated by a comma, +\series bold +icon=Check +\series default + +\begin_inset Quotes erd +\end_inset + + to get a checkmark. +\begin_inset Foot +status open + +\begin_layout Plain Layout +For all possible icons, see the +\series bold +pdfcomment +\series default + manual. +\end_layout + +\end_inset + + the checkmark should have a green color so that you add +\series bold +color=lime +\series default + to the avatar definition. + Your whole definition reads now +\begin_inset Newline newline +\end_inset + + +\series bold +author={Oleg Testman},icon=Check,color=lime +\end_layout + +\begin_layout Define Avatar +\begin_inset Argument 1 +status open + +\begin_layout Plain Layout +Oleg +\end_layout + +\end_inset + +author={Oleg Testman},icon=Check,color=lime +\end_layout + +\begin_layout Standard +To use now your avatar for PDF comments you have two choices: +\end_layout + +\begin_layout Enumerate +You set up ALL PDF comments in the document using your avatar. + This is done by inserting the custom inset +\family sans +PDF +\begin_inset space ~ +\end_inset + +Comment-Setup +\family default + before the first PDF comment in your document. + Insert to this inset +\series bold +avatar=Oleg +\series default +. +\end_layout + +\begin_layout Enumerate +You add +\series bold +avatar=Oleg +\series default + to the options of a particular PDF comment. + The avatar will then only be used for this comment. +\end_layout + +\begin_layout Standard +Here is an example for the +\family sans +PDF +\begin_inset space ~ +\end_inset + +Comment-Setup +\family default + method: +\begin_inset Flex PDF-Comment-Setup +status open + +\begin_layout Plain Layout +avatar=Oleg +\end_layout + +\end_inset + + +\begin_inset Flex PDF-Annotation +status open + +\begin_layout Plain Layout +Oleg said: Wow, that's nice! +\end_layout + +\end_inset + + +\begin_inset Newline newline +\end_inset + +and here is another comment: +\begin_inset Flex PDF-Annotation +status open + +\begin_layout Plain Layout +Oleg also said: I hate to repeat myself. +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Define Avatar +\begin_inset Argument 1 +status open + +\begin_layout Plain Layout +Dolittle +\end_layout + +\end_inset + +color=NavyBlue,opacity=0.5,open=false,icon=Circle,author={Dr. + Dolittle} +\end_layout + +\begin_layout Standard +Here is an example where another avatar +\begin_inset Quotes eld +\end_inset + +Dolittle +\begin_inset Quotes erd +\end_inset + + is only used for this comment: +\begin_inset Flex PDF-Margin +status open + +\begin_layout Plain Layout +\begin_inset Argument 1 +status open + +\begin_layout Plain Layout +avatar=Dolittle +\end_layout + +\end_inset + +I am Dr. + Dolittle! Respect my authority! +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Section +List of PDF comments +\end_layout + +\begin_layout Standard +You can insert a list with all PDF comments using the environment List of + PDF comments. + By specifying options for it you can determine what parts of the comments + shpuld appear in the list. + Here is the list for this document where only the comments of a defined + author are printed: +\end_layout + +\begin_layout List of PDF Comments +\begin_inset Argument 1 +status open + +\begin_layout Plain Layout +liststyle= +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +{ +\end_layout + +\end_inset + +AuthorComment +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +} +\end_layout + +\end_inset + +, heading = +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +{ +\end_layout + +\end_inset + +List of PDF comments +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +} +\end_layout + +\end_inset + + +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Standard +You can also define your own style using the environment +\begin_inset Newline newline +\end_inset + + +\family sans +Define +\begin_inset space ~ +\end_inset + +PDF +\begin_inset space ~ +\end_inset + +Comment +\begin_inset space ~ +\end_inset + +List +\begin_inset space ~ +\end_inset + +Style +\begin_inset Newline newline +\end_inset + + +\family default +if you know enough about the tricky LaTeX internals. + With the environment +\begin_inset Newline newline +\end_inset + + +\family sans +Set +\begin_inset space ~ +\end_inset + +PDF +\begin_inset space ~ +\end_inset + +Comment +\begin_inset space ~ +\end_inset + +List +\begin_inset space ~ +\end_inset + +Style +\begin_inset Newline newline +\end_inset + + +\family default +you can set a list style in case it was changed before the list of comments. +\end_layout + +\begin_layout Define PDF-Comment List Style +\begin_inset Argument 1 +status open + +\begin_layout Plain Layout +MyStyle +\end_layout + +\end_inset + + +\backslash +makeatletter +\backslash +pc@lopt@author +\backslash + - +\backslash +pc@lopt@subject +\backslash + ( +\backslash +pc@lopt@deadline) +\backslash +makeatother +\end_layout + +\begin_layout Set PDF-Comment List Style +AuthorCommentDeadline +\end_layout + +\begin_layout Standard +\begin_inset Note Greyedout +status open + +\begin_layout Plain Layout + +\series bold +Note: +\series default + Only one list of comments can be printed in the PDF. +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Section +General Hints +\end_layout + +\begin_layout Itemize +To be able to use all kinds of colors and color definitions you must load + the LaTeX-package +\series bold +xcolor +\series default + in the document preamble this way: +\begin_inset Newline newline +\end_inset + + +\series bold + +\backslash +usepackage[svgnames,rgb]{xcolor} +\end_layout + +\begin_layout Itemize +If you have two consecutive PDF +\begin_inset space ~ +\end_inset + +comment insets, the will appear in the PDF one over each other: +\begin_inset Flex PDF-Comment-Setup +status open + +\begin_layout Plain Layout +avatar=Oleg +\end_layout + +\end_inset + + +\begin_inset Flex PDF-Annotation +status open + +\begin_layout Plain Layout +Oleg said: Wow, that's nice! +\end_layout + +\end_inset + + +\begin_inset Flex PDF-Annotation +status open + +\begin_layout Plain Layout +Oleg also said: I hate to repeat myself. +\end_layout + +\end_inset + + +\begin_inset Newline newline +\end_inset + +To avoid that separate them with whitespace like protected space: +\begin_inset Flex PDF-Annotation +status open + +\begin_layout Plain Layout +Oleg said: Wow, that's nice! +\end_layout + +\end_inset + + +\begin_inset space ~ +\end_inset + + +\begin_inset space ~ +\end_inset + + +\begin_inset space ~ +\end_inset + + +\begin_inset space ~ +\end_inset + + +\begin_inset space ~ +\end_inset + + +\begin_inset space ~ +\end_inset + + +\begin_inset space ~ +\end_inset + + +\begin_inset Flex PDF-Annotation +status open + +\begin_layout Plain Layout +Oleg also said: I hate to repeat myself. +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Itemize +You cannot use non-Latin characters in your comment or in the author name. + The reason is that PDFs use a special character encoding that is not compatible + with LaTeX. +\end_layout + +\end_body +\end_document diff --git a/status.21x b/status.21x index 6cc1f12665..477596c64f 100644 --- a/status.21x +++ b/status.21x @@ -33,7 +33,7 @@ What's new - Add support for the sectionbox and tcolorbox packages (part of bug 8714). -- Add support for PDF Annotations (via pdfcomment package) (bug 6975). +- Add support for PDF annotations (via pdfcomment package) (bug 6975). * TEX2LYX IMPROVEMENTS @@ -49,6 +49,7 @@ What's new * DOCUMENTATION AND LOCALIZATION +- New example file "PDF-comment.lyx" describing the support for PDF annotations. * BUILD/INSTALLATION