X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fexamples%2FPDF-comment.lyx;h=e68450cfa8b4f2ff7aa0ab7eb52f7542852758e8;hb=97dfacfffa0299005898ab1c26459a60c057c5bf;hp=bb28a27bfaeed2426a35c2f634848b868a77eefb;hpb=e73f61d300c421902a90d1500d2caae51b2edad8;p=lyx.git diff --git a/lib/examples/PDF-comment.lyx b/lib/examples/PDF-comment.lyx index bb28a27bfa..e68450cfa8 100644 --- a/lib/examples/PDF-comment.lyx +++ b/lib/examples/PDF-comment.lyx @@ -1,7 +1,9 @@ -#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 @@ -27,18 +29,18 @@ 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 @@ -124,7 +126,7 @@ This sets yellow as default color for new PDF comments, see sec. \begin_inset CommandInset ref LatexCommand ref -reference "sub:PDF-Comment-setup" +reference "subsec:PDF-Comment-setup" \end_inset @@ -145,7 +147,8 @@ Uwe Stöhr \end_layout \begin_layout Standard -The LaTeX package +The \SpecialChar LaTeX + package \series bold pdfcomment \series default @@ -182,7 +185,7 @@ The different comment types \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 @@ -218,7 +221,7 @@ Like for all PDF comment types you can add a lot of things to the option To insert the options inset, set the cursor into the comment inset and use the menu \family sans -Insert\SpecialChar \menuseparator +Insert\SpecialChar menuseparator PDF Comment Options \family default . @@ -233,7 +236,8 @@ status open \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 @@ -469,7 +473,7 @@ type=typewriter 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 @@ -632,7 +636,7 @@ PDF-Margin \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 @@ -646,7 +650,7 @@ a simple PDF-Margin comment \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 @@ -707,7 +711,16 @@ status open status open \begin_layout Plain Layout -id=1,markup=Highlight +\begin_inset Note Note +status open + +\begin_layout Plain Layout +id=1, +\end_layout + +\end_inset + +markup=Highlight \end_layout \end_inset @@ -809,6 +822,82 @@ Striked-out PDF-Markup \end_inset +\end_layout + +\begin_layout Description +mathpopup Formula parts will be highlighted. + +\series bold + +\series default + +\begin_inset Note Greyedout +status open + +\begin_layout Plain Layout + +\series bold +Note: +\series default + The PDF-Markup inset cannot be used for this option! +\end_layout + +\end_inset + + Instead the command +\series bold + +\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 + + +\series bold + +\backslash +pdfmarkupcomment[style=mathpopup] +\backslash +{formula part} +\begin_inset Formula $\to$ +\end_inset + + +\backslash +{ +\backslash +text +\begin_inset space \textvisiblespace{} +\end_inset + + +\begin_inset Newline newline +\end_inset + +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 Standard @@ -823,10 +912,6 @@ Comment 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 @@ -837,7 +922,8 @@ 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 +when using Xe\SpecialChar TeX + you have to assure that the page dimensions are internally output, e. \begin_inset space \thinspace{} \end_inset @@ -854,7 +940,8 @@ pagesize \series bold pagesize \series default - for the LaTeX-package + for the \SpecialChar LaTeX +-package \series bold typearea \series default @@ -865,6 +952,25 @@ typearea PDF-Reply \end_layout +\begin_layout Standard +\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 + + +\end_layout + \begin_layout Standard With a PDF-Reply you can compose replies to PDF comments. The option @@ -877,6 +983,10 @@ replyto \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 @@ -893,6 +1003,11 @@ id=2,replyto=1,date=D:20101211161247+01'00' This is a reply. \end_layout +\end_inset + + +\end_layout + \end_inset It appears in that PDF-Markup comment. @@ -916,6 +1031,10 @@ id 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_layout Plain Layout \begin_inset Flex PDF-Reply status open @@ -937,25 +1056,13 @@ Of course, you can reply to a reply. \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 only works when using pdflatex. -\end_layout - \end_inset \end_layout \begin_layout Standard -PDF-Reply has some further limitations: +PDF-Reply has limitations: \end_layout \begin_layout Itemize @@ -974,8 +1081,8 @@ PDF-Sideline \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: - + The yellow arrows besides this text are an example of a PDF-Sideline without + any options: \begin_inset Flex PDF-Sideline status open @@ -1007,7 +1114,7 @@ status open \begin_layout Plain Layout \begin_inset Argument 1 -status open +status collapsed \begin_layout Plain Layout opacity=0.33,color=magenta,icolor=cyan,caption=inline,linebegin= @@ -1102,12 +1209,13 @@ 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 +the comment 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 +when using Xe\SpecialChar TeX + you have to assure that the page dimensions are internally output, e. \begin_inset space \thinspace{} \end_inset @@ -1124,7 +1232,8 @@ pagesize \series bold pagesize \series default - for the LaTeX-package + for the \SpecialChar LaTeX +-package \series bold typearea \series default @@ -1204,7 +1313,8 @@ With this you can annotate any object with a tooltip. status open \begin_layout Plain Layout -All objects that can be set into a TeX-box to measure its size. +All objects that can be set into a \SpecialChar TeX +-box to measure its size. \end_layout \end_inset @@ -1215,8 +1325,8 @@ All objects that can be set into a TeX-box to measure its size. \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: + 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 @@ -1232,7 +1342,7 @@ This is a tooltip! \color red -words +word \end_layout \end_inset @@ -1241,8 +1351,8 @@ words \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: +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 @@ -1269,8 +1379,8 @@ Sulfuric acid \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. +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 @@ -1291,12 +1401,12 @@ status collapsed \backslash - +displaystyle \end_layout \end_inset -displaystyle + \end_layout \end_inset @@ -1312,7 +1422,7 @@ little Gauß \end_inset -\begin_inset Formula $x^{2}+2xy+y^{2}\sum_{i=1}^{n}i=\frac{1}{2}n\cdot(n+1)$ +\begin_inset Formula $\sum_{i=1}^{n}i=\frac{1}{2}n\cdot(n+1)$ \end_inset @@ -1339,7 +1449,7 @@ pdfcomment PDF-Comment setup \begin_inset CommandInset label LatexCommand label -name "sub:PDF-Comment-setup" +name "subsec:PDF-Comment-setup" \end_inset @@ -1365,10 +1475,12 @@ By using its optional option \series bold local \series default - you can keep the reset local within a group enclosed by TeX-braces. + 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 - TeX-braces. + \SpecialChar TeX +-braces. Here is an example: \end_layout @@ -1592,7 +1704,8 @@ 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. + But this can be avoided if you define for every comment author a special + avatar. \end_layout \begin_layout Standard @@ -1604,11 +1717,15 @@ Oleg Testman \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 @@ -1626,6 +1743,10 @@ author={Oleg Testman} 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 @@ -1679,7 +1800,7 @@ 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 @@ -1802,10 +1923,13 @@ 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. + should appear in the list. Here is the list for this document where only the comments of a defined author are printed: \end_layout @@ -1896,7 +2020,8 @@ Style \family default -if you know enough about the tricky LaTeX internals. +if you know enough about the tricky \SpecialChar LaTeX + internals. With the environment \begin_inset Newline newline \end_inset @@ -1925,7 +2050,7 @@ Style \family default -you can set a list style in case it was changed before the list of comments. +you can set a list style. \end_layout \begin_layout Define PDF-Comment List Style @@ -1982,7 +2107,8 @@ General Hints \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 @@ -2090,7 +2216,8 @@ Oleg also said: I hate to repeat myself. \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. + with \SpecialChar LaTeX +. \end_layout \end_body