-#LyX 2.1 created this file. For more info see http://www.lyx.org/
-\lyxformat 474
+#LyX 2.2 created this file. For more info see http://www.lyx.org/
+\lyxformat 506
\begin_document
\begin_header
+\save_transient_properties true
+\origin /systemlyxdir/examples/
\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 index=totoc,BCOR7.5mm,captions=tableheading
+\options BCOR8mm,pagesize
\use_default_options false
\begin_modules
pdfcomment
\language_package default
\inputencoding auto
\fontencoding global
-\font_roman default
-\font_sans default
-\font_typewriter default
-\font_math auto
+\font_roman "default" "default"
+\font_sans "default" "default"
+\font_typewriter "default" "default"
+\font_math "auto" "auto"
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
-\font_sf_scale 100
-\font_tt_scale 100
+\font_sf_scale 100 100
+\font_tt_scale 100 100
\graphics default
-\default_output_format default
+\default_output_format pdf2
\output_sync 0
\bibtex_command bibtex
\index_command default
\paperfontsize 12
\spacing single
\use_hyperref true
-\pdf_title "Description of the module pdfcomment"
+\pdf_title "Description of the module PDF Comments"
\pdf_author "Uwe Stöhr"
-\pdf_subject "pdfcomment"
-\pdf_keywords "LyX, PDF-comments, pdfcomment"
+\pdf_subject "PDF comments"
+\pdf_keywords "LyX, PDF comments, pdfcomment"
\pdf_bookmarks true
\pdf_bookmarksnumbered true
\pdf_bookmarksopen true
\use_package cancel 0
\use_package esint 1
\use_package mathdots 1
-\use_package mathtools 0
+\use_package mathtools 1
\use_package mhchem 1
\use_package stackrel 0
\use_package stmaryrd 0
status collapsed
\begin_layout Plain Layout
-Use yelow as default color for new PDF-comments, see sec.
+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"
+reference "subsec:PDF-Comment-setup"
\end_inset
- for a description.
+ for the description.
\end_layout
\end_inset
\end_layout
\begin_layout Title
-Description of the module pdfcomment
+Description of the module PDF Comments
\end_layout
\begin_layout Author
\end_layout
\begin_layout Standard
-The LaTeX-package
+The \SpecialChar 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 that you can use
- several times in the document.
+ provides full access for PDF comments.
+ You can add normal comments as well as margin comments, underlining etc..
+ You can also define a special layout for a 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:
+; see its documentation for all information:
\begin_inset Newline newline
\end_inset
\end_layout
\begin_layout Section
-The different comments types
+The different comment types
\end_layout
\begin_layout Standard
The different comment types are inserted using the menu
\family sans
-Insert\SpecialChar \menuseparator
+Insert\SpecialChar menuseparator
Custom
\begin_inset space ~
\end_inset
Insets
\family default
.
- You can choose between the following:
+ You can select one of the following:
\end_layout
\begin_layout Subsection
-PDF-Annotation
+PDF-Annotation
\end_layout
\begin_layout Standard
-This is the
-\begin_inset Quotes eld
-\end_inset
-
-normal
-\begin_inset Quotes erd
-\end_inset
-
- PDF-comment.
+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
+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.
+Like for 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-xxx
-\begin_inset space ~
-\end_inset
-
-options
-\family default
-, where
-\family sans
-xxx
+Insert\SpecialChar menuseparator
+PDF Comment Options
\family default
- stands for the type of the comment.
+.
\end_layout
\begin_layout Standard
\series bold
Note:
\series default
- all braces and brackets in comment options must be inserted as TeX-code!
+ All braces and brackets in comment options must be inserted as \SpecialChar TeX
+ code!
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-color=blue,height=2.5cm,width=5.8cm,voffset=-2.8cm,hoffset=8cm,opacity=1.0,justifica
-tion=right,icolor=
+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
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:
+ Here is an example in form of a yellow rectangle:
\begin_inset Flex PDF-Freetext
status open
\end_inset
-This is also a comment, but it's a PDF-Freetext annotation.
+This is also a comment, but it is a PDF-Freetext annotation.
\end_layout
\end_inset
\begin_layout Standard
This will typeset a comment in form of a line, polyline or polygon.
- Here is an example without any options:
+ Here is an example without any options:
\begin_inset Flex PDF-Line
status open
\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 Standard
This will typeset an annotation into the margin.
- Right beside this text is an example without options:
+ Right besides this text is an example without options:
\begin_inset Flex PDF-Margin
status open
\end_layout
\begin_layout Standard
-The red margin note is an example for a PDF-Margin command with options.
+The red margin note is an example for a PDF-Margin with options.
\begin_inset Flex PDF-Margin
status open
\begin_layout Plain Layout
\begin_inset Argument 1
-status open
+status collapsed
\begin_layout Plain Layout
icon=Note,color=red,open=true,hspace=100pt
\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
-PDF-Markup
+simple PDF-Markup
\end_layout
\end_inset
\end_layout
-\begin_layout Subsection
-PDF-Reply
+\begin_layout Standard
+Possible types for the option
+\series bold
+markup
+\series default
+ are:
\end_layout
-\begin_layout Standard
-\begin_inset Flex PDF-Reply
+\begin_layout Description
+Highlight The markup text will be highlighted:
+\begin_inset Flex PDF-Markup
status open
\begin_layout Plain Layout
-PDF-Reply
+\begin_inset Argument 1
+status open
+
+\begin_layout Plain Layout
+\begin_inset Note Note
+status open
+
+\begin_layout Plain Layout
+id=1,
\end_layout
\end_inset
-
+markup=Highlight
\end_layout
-\begin_layout Subsection
-PDF-Sideline
-\end_layout
+\end_inset
-\begin_layout Standard
-\begin_inset Flex PDF-Sideline
+Highlight PDF-Markup
+\begin_inset Argument post:1
status open
\begin_layout Plain Layout
-PDF-Sideline
+a comment
\end_layout
\end_inset
\end_layout
-\begin_layout Subsection
-PDF-Square
-\end_layout
+\end_inset
-\begin_layout Standard
-\begin_inset Flex PDF-Square
-status open
+
+\begin_inset Note Note
+status collapsed
\begin_layout Plain Layout
-PDF-Square
+see the next section for the description of the option
+\series bold
+id=1
\end_layout
\end_inset
\end_layout
-\begin_layout Subsection
-PDF-Tooltip
-\end_layout
+\begin_layout Description
+Underline The markup text will be underlined:
+\begin_inset Flex PDF-Markup
+status open
-\begin_layout Standard
-With this you can annotate any object with a tooltip
-\begin_inset Foot
+\begin_layout Plain Layout
+\begin_inset Argument 1
status open
\begin_layout Plain Layout
-All objects that can be set into a TeX-box to measure its size.
+markup=Underline
+\end_layout
+
+\end_inset
+
+Underlining PDF-Markup
\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
+\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 post:1
+\begin_inset Argument 1
status open
\begin_layout Plain Layout
-This is a tooltip!
+markup=Squiggly
\end_layout
\end_inset
-
-\color red
-words
+Underwave PDF-Markup
\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
+\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 post:1
+\begin_inset Argument 1
status open
\begin_layout Plain Layout
-Sulfuric acid
+markup=StrikeOut
\end_layout
\end_inset
-
-\begin_inset Formula $\ce{H2SO4}$
-\end_inset
-
-
+Striked-out PDF-Markup
\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 Description
+mathpopup Formula parts will be highlighted.
-\begin_layout Standard
-\begin_inset Flex PDF-Tooltip
-status open
+\series bold
+
+\series default
-\begin_layout Plain Layout
-\begin_inset Argument 1
+\begin_inset Note Greyedout
status open
\begin_layout Plain Layout
-mathstyle=
-\begin_inset ERT
-status collapsed
-\begin_layout Plain Layout
+\series bold
+Note:
+\series default
+ The PDF-Markup inset cannot be used for this option!
+\end_layout
+\end_inset
-\backslash
+ Instead the command
+\series bold
-\end_layout
+\backslash
+pdfmarkupcomment
+\series default
+ woll be used in a formula with this scheme:
+\begin_inset Newline newline
+\end_inset
+Command:
+\begin_inset Newline newline
\end_inset
-displaystyle
-\end_layout
+\series bold
+
+\backslash
+pdfmarkupcomment[style=mathpopup]
+\backslash
+{formula part}
+\begin_inset Formula $\to$
\end_inset
-\begin_inset Argument post:1
-status open
+\backslash
+{
+\backslash
+text
+\begin_inset space \textvisiblespace{}
+\end_inset
-\begin_layout Plain Layout
-little Gauß
-\end_layout
+\begin_inset Newline newline
\end_inset
-
-\begin_inset Formula $x^{2}+2xy+y^{2}\sum_{i=1}^{n}i=\frac{1}{2}n\cdot(n+1)$
+optional comment}
+\begin_inset Newline newline
\end_inset
+\series default
+Result:
\end_layout
+\begin_layout Standard
+\begin_inset Formula
+\[
+\pdfmarkupcomment[style=mathpopup]{\sum_{i=1}^{n}i=\frac{1}{2}n\cdot(n+1)}{\text{little Gauss}}
+\]
+
\end_inset
-
+
\end_layout
-\begin_layout Section
-Comment definitions
+\begin_layout Standard
+The text for the comment is inserted with the inset option
+\family sans
+Comment
+\family default
+.
\end_layout
\begin_layout Standard
-The package
-\series bold
-pdfcomment
-\series default
- provides the following environments to define or change PDF-comments:
+PDF-Markup has some limitations:
\end_layout
-\begin_layout Subsection
-PDF-Comment setup
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:PDF-Comment-setup"
+\begin_layout Itemize
+the markup text must not be longer than one paragraph
+\end_layout
-\end_inset
+\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 Xe\SpecialChar TeX
+ you have to assure that the page dimensions are internally
+ output, e.
+\begin_inset space \thinspace{}
+\end_inset
-\end_layout
+g.
+\begin_inset space \space{}
+\end_inset
-\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
+with the document class option
\series bold
-color=yellow
+pagesize
+\series default
+ for the KOMA-Script classes, or the option
+\series bold
+pagesize
+\series default
+ for the \SpecialChar LaTeX
+-package
+\series bold
+typearea
\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:
+\begin_layout Subsection
+PDF-Reply
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status collapsed
+\begin_inset Note Greyedout
+status open
\begin_layout Plain Layout
-{
+\series bold
+Attention:
+\series default
+ Due to technical limitations PDF-Reply only works when using pdflatex.
+ On some \SpecialChar LaTeX
+ installations it won't even work in general.
\end_layout
\end_inset
-\begin_inset Flex PDF-Comment-Setup
+\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 Note Note
+status open
+
+\begin_layout Plain Layout
+\begin_inset Flex PDF-Reply
status open
\begin_layout Plain Layout
status open
\begin_layout Plain Layout
-local
+id=2,replyto=1,date=D:20101211161247+01'00'
\end_layout
\end_inset
-color=Orange
+This is a reply.
\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 Flex PDF-Annotation
-status collapsed
-
-\begin_layout Plain Layout
-PDF-Annotation in orange
+ 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
-\end_inset
-
+\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 Note Note
+status open
-\begin_inset ERT
-status collapsed
+\begin_layout Plain Layout
+\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
-\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
+\begin_layout Standard
+PDF-Reply has limitations:
\end_layout
-\begin_layout Standard
-This environment allows you to define a style for a PDF-comment that can
- be used by several comments.
+\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 are an example of a PDF-Sideline 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 collapsed
+
+\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 comment should not be longer than one page, otherwise the recognition
+ of the page could fail
+\end_layout
+
+\begin_layout Itemize
+when using Xe\SpecialChar TeX
+ 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 \SpecialChar 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 \SpecialChar 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.
+ Here is as 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
+word
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Since a tooltip can be used for almost any object, one 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 option that is used to correct the size
+ of the tooltip 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
+displaystyle
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Argument post:1
+status open
+
+\begin_layout Plain Layout
+little Gauß
+\end_layout
+
+\end_inset
+
+
+\begin_inset Formula $\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 "subsec: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 \SpecialChar 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
+ \SpecialChar 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 einvironment
- before your fiirst formula.
- Name it
+ 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
\series bold
color=white
\series default
- and make the comment popup with
+ and highlight the whole formula with
\series bold
markup=Highlight
\series default
- (will pop up when the mouse is hovered over the formula).
+.
\end_layout
\begin_layout Define PDF-Comment Style
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.
+ But this can be avoided if you define for every comment author a special
+ avatar.
\end_layout
\begin_layout Standard
\begin_inset Quotes erd
\end_inset
- you can define an avatar for your using the environment Define
+ you can define an avatar for your name using the environment
+\family sans
+Define
\begin_inset space ~
\end_inset
-Avatar.
+Avatar
+\family default
+.
Its mandatory option is the name.
In your case, name it
\series bold
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,
+\begin_inset Quotes eld
+\end_inset
+
+
\series bold
icon=Check
\series default
\end_layout
\begin_layout Standard
-To use now your avatar for PDF-comments you have two choices:
+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.
+You set up that all PDF comments in the document use your avatar.
This is done by inserting the custom inset
\family sans
-PDF-Comment-Setup
+PDF
+\begin_inset space ~
+\end_inset
+
+Comment-Setup
\family default
- before the first PDF-comment in your document.
+ before the first PDF comment in your document.
Insert to this inset
\series bold
avatar=Oleg
\series bold
avatar=Oleg
\series default
- to the options of a particular PDF-comment.
+ 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-Comment-Setup
+PDF
+\begin_inset space ~
+\end_inset
+
+Comment-Setup
\family default
method:
\begin_inset Flex PDF-Comment-Setup
\end_layout
\begin_layout Section
-List of PDF-comments
+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.
+You can insert a list with all PDF comments using the environment
+\family sans
+List of PDF comments
+\family default
+.
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:
+ should 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_layout List of PDF Comments
\begin_inset Argument 1
status open
\begin_layout Plain Layout
-liststyle={AuthorComment}, heading ={List of PDF-comments}
+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
-\begin_layout Section
-General Hints
+\end_inset
+
+, heading =
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+{
\end_layout
-\begin_layout Define Avatar
+\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 \SpecialChar 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.
+\end_layout
+
+\begin_layout Define PDF-Comment List Style
\begin_inset Argument 1
status open
\begin_layout Plain Layout
-Cyrillic
+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
-color=Green,open=true,icon=Key,author={a}
+
+\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
+ the \SpecialChar LaTeX
+ package
\series bold
xcolor
\series default
\end_layout
\begin_layout Itemize
-If you have two consecutive PDF-comment insets, the will appear in the PDF
- one over each other:
+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
\end_layout
\begin_layout Itemize
-It you have non-Latin characters in your comment or in the author name ...
-\end_layout
-
-\begin_layout Standard
-Here is an example of a comment containing non-Latin characters:
-\begin_inset Flex PDF-Margin
-status open
-
-\begin_layout Plain Layout
-\begin_inset Argument 1
-status open
-
-\begin_layout Plain Layout
-avatar=Cyrillic
-\end_layout
-
-\end_inset
-
-Here is a text with Cyrillic letters: Александр Исаевич Солженицын got the
- nobel price in 1970.
-\end_layout
-
-\end_inset
-
-
+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 \SpecialChar LaTeX
+.
\end_layout
\end_body
projects / lyx.git / blobdiff