]> git.lyx.org Git - lyx.git/blobdiff - lib/examples/PDF-comment.lyx
toc bind: 'dialog-show' -> 'dialog-toggle' (#8388)
[lyx.git] / lib / examples / PDF-comment.lyx
index f1eb7f9c21b0f1d4558b7a0b3038103690d1370b..bb28a27bfaeed2426a35c2f634848b868a77eefb 100644 (file)
@@ -1,5 +1,5 @@
-#LyX 2.2 created this file. For more info see http://www.lyx.org/
-\lyxformat 479
+#LyX 2.1 created this file. For more info see http://www.lyx.org/
+\lyxformat 474
 \begin_document
 \begin_header
 \textclass scrartcl
@@ -17,7 +17,7 @@
 
 \fi % end if pdflatex is used
 \end_preamble
-\options index=totoc,BCOR7.5mm,captions=tableheading,pagesize
+\options BCOR8mm,pagesize
 \use_default_options false
 \begin_modules
 pdfcomment
@@ -45,10 +45,10 @@ pdfcomment
 \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
@@ -66,7 +66,7 @@ pdfcomment
 \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
@@ -117,7 +117,7 @@ color=yellow
 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
 
@@ -128,7 +128,7 @@ reference "sub:PDF-Comment-setup"
 
 \end_inset
 
- for a description.
+ for the description.
 \end_layout
 
 \end_inset
@@ -137,7 +137,7 @@ reference "sub:PDF-Comment-setup"
 \end_layout
 
 \begin_layout Title
-Description of the module pdfcomment
+Description of the module PDF Comments
 \end_layout
 
 \begin_layout Author
@@ -150,14 +150,14 @@ The LaTeX package
 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.
+ 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
 
@@ -176,7 +176,7 @@ http://mirrors.ctan.org/macros/latex/contrib/pdfcomment/doc/pdfcomment.pdf
 \end_layout
 
 \begin_layout Section
-The different comments types
+The different comment types
 \end_layout
 
 \begin_layout Standard
@@ -198,13 +198,13 @@ PDF-Annotation
 \end_layout
 
 \begin_layout Standard
-This is the standard 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
@@ -213,8 +213,8 @@ This is a simple PDF-Annotation
 \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
@@ -233,8 +233,7 @@ status open
 \series bold
 Note:
 \series default
- Literal TeX code, such as braces and brackets, must be inserted as TeX-code
- to the comment options.
+ All braces and brackets in comment options must be inserted as TeX code!
 \end_layout
 
 \end_inset
@@ -264,17 +263,51 @@ status open
 status collapsed
 
 \begin_layout Plain Layout
+author=
 \begin_inset ERT
-status open
+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
 
-author={Daisy Duck},color={0.234 0.867 0.211},voffset=8pt,opacity=0.5
+{
 \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
@@ -347,14 +380,47 @@ status open
 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 open
+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={yellow},linewidth=12pt,borderstyle=dashed,dashstyle={10
- 5}
+{
+\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
@@ -412,23 +478,13 @@ status open
 status collapsed
 
 \begin_layout Plain Layout
-\begin_inset ERT
-status open
-
-\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
 
-
-\end_layout
-
-\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
@@ -491,19 +547,73 @@ status open
 status collapsed
 
 \begin_layout Plain Layout
+type=line,opacity=1,line=
 \begin_inset ERT
-status open
+status collapsed
 
 \begin_layout Plain Layout
 
-type=line,opacity=1,line={50 480 50 180},color=green,icolor=blue,caption=top,lin
-ebegin={/ROpenArrow},lineend={/OpenArrow},linewidth=2bp,captionhoffset=-5pt,capt
-ionvoffset=15pt
+{
 \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
@@ -679,7 +789,7 @@ Underwave PDF-Markup
 \end_layout
 
 \begin_layout Description
-StrikeOut The markup text will be struck out: 
+StrikeOut The markup text will be struck-out: 
 \begin_inset Flex PDF-Markup
 status open
 
@@ -756,7 +866,7 @@ PDF-Reply
 \end_layout
 
 \begin_layout Standard
-With a PDF-Reply you can compose replies to PDF-comments.
+With a PDF-Reply you can compose replies to PDF comments.
  The option 
 \series bold
 replyto
@@ -836,7 +946,7 @@ status open
 \series bold
 Note:
 \series default
- Due to technical reasons PDF-Reply works only when using pdflatex.
+ Due to technical reasons PDF-Reply only works when using pdflatex.
 \end_layout
 
 \end_inset
@@ -1173,19 +1283,20 @@ status open
 status open
 
 \begin_layout Plain Layout
+mathstyle=
 \begin_inset ERT
-status open
+status collapsed
 
 \begin_layout Plain Layout
 
-mathstyle=
+
 \backslash
-displaystyle
+
 \end_layout
 
 \end_inset
 
-
+displaystyle
 \end_layout
 
 \end_inset
@@ -1221,7 +1332,7 @@ The package
 \series bold
 pdfcomment
 \series default
- provides the following environments to define or change PDF-comments:
+ provides the following environments to define or change PDF comments:
 \end_layout
 
 \begin_layout Subsection
@@ -1238,9 +1349,9 @@ name "sub:PDF-Comment-setup"
 \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.
+ 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
+ add the PDF comment setup inset to the beginning of your document and insert
  there the option 
 \series bold
 color=yellow
@@ -1256,7 +1367,7 @@ 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
+ then enclose the PDF comment setup inset and the two comment insets in
  TeX-braces.
  Here is an example:
 \end_layout
@@ -1348,14 +1459,14 @@ default PDF-Margin comment
 \end_layout
 
 \begin_layout Subsection
-PDF-Comment style
+PDF Comment style
 \end_layout
 
 \begin_layout Standard
-This environment allows you to define a style for a PDF-comment that can
+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
+ the PDF for several expressions, then insert a PDF Comment style environment
  before your first formula.
  Name it for example 
 \series bold
@@ -1564,16 +1675,20 @@ author={Oleg Testman},icon=Check,color=lime
 \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 ALL PDF comments in the document using 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
@@ -1586,14 +1701,18 @@ You add
 \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
@@ -1679,12 +1798,12 @@ I am Dr.
 \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 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
@@ -1698,7 +1817,7 @@ status open
 \begin_layout Plain Layout
 liststyle=
 \begin_inset ERT
-status open
+status collapsed
 
 \begin_layout Plain Layout
 
@@ -1709,7 +1828,7 @@ status open
 
 AuthorComment
 \begin_inset ERT
-status open
+status collapsed
 
 \begin_layout Plain Layout
 
@@ -1720,7 +1839,7 @@ status open
 
 , heading =
 \begin_inset ERT
-status open
+status collapsed
 
 \begin_layout Plain Layout
 
@@ -1729,9 +1848,9 @@ status open
 
 \end_inset
 
-List of PDF-comments
+List of PDF comments
 \begin_inset ERT
-status open
+status collapsed
 
 \begin_layout Plain Layout
 
@@ -1759,7 +1878,11 @@ Define
 \begin_inset space ~
 \end_inset
 
-PDF-Comment
+PDF
+\begin_inset space ~
+\end_inset
+
+Comment
 \begin_inset space ~
 \end_inset
 
@@ -1784,7 +1907,11 @@ Set
 \begin_inset space ~
 \end_inset
 
-PDF-Comment
+PDF
+\begin_inset space ~
+\end_inset
+
+Comment
 \begin_inset space ~
 \end_inset
 
@@ -1855,7 +1982,7 @@ General Hints
 
 \begin_layout Itemize
 To be able to use all kinds of colors and color definitions you must load
- the LaTeX-package 
+ the LaTeX package 
 \series bold
 xcolor
 \series default
@@ -1871,8 +1998,11 @@ usepackage[svgnames,rgb]{xcolor}
 \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