lib/layouts/pdfcomment.module

   1 #\DeclareLyXModule[datetime.sty,fmtcount.sty]{PDF Comments}
   2 #DescriptionBegin
   3 #Provides various kinds of annotations for the PDF output. The module uses
   4 #the pdfcomment package. Please consult the LyX example file PDF-comment.lyx
   5 #and the package documentation for details.
   6 #DescriptionEnd
   7 # Author: Juergen Spitzmueller <spitz@lyx.org>
   8 #         Uwe Stöhr <uwestoehr@lyx.org>
   9
  10 Format 54
  11
  12 #
  13 # helper commands
  14 #
  15
  16 # pdfcomment loads hyperref
  17 Provides hyperref 1
  18
  19 Style Define_Avatar
  20         Category                        PDF-comment
  21         LatexType                       Command
  22         Margin                          Dynamic
  23         LatexName                       defineavatar
  24         ParSkip                         0.4
  25         LabelType                       Static
  26         LabelSep                        M
  27         LabelString                     "PDF-comment avatar:"
  28         Argument 1
  29                 LabelString             "Name"
  30                 Tooltip                 "Name of the Avatar"
  31                 Mandatory               1
  32         EndArgument
  33         PassThru                        1
  34         LabelFont
  35           Color                         green
  36           Series                        Bold
  37         EndFont
  38         Requires                        pdfcomment
  39 End
  40
  41 Style Define_PDF-Comment_Style
  42         CopyStyle                       Define_Avatar
  43         LatexName                       definestyle
  44         LabelString                     "PDF-comment style:"
  45         Argument 1
  46                 LabelString             "Name"
  47                 Tooltip                 "Name of the style"
  48                 Mandatory               1
  49         EndArgument
  50 End
  51
  52 Style Define_PDF-Comment_List_Style
  53         CopyStyle                       Define_Avatar
  54         LatexName                       defineliststyle
  55         LabelString                     "Definition of PDF-comment list style:"
  56         Argument 1
  57                 LabelString             "Name"
  58                 Tooltip                 "Name of the list style"
  59                 Mandatory               1
  60         EndArgument
  61 End
  62
  63 Style Set_PDF-Comment_List_Style
  64         CopyStyle                       Define_Avatar
  65         LatexName                       setliststyle
  66         LabelString                     "PDF-comment list style:"
  67         ResetArgs                       1
  68 End
  69
  70 InsetLayout "Flex:PDF-Comment-Setup"
  71         LyXType                         custom
  72         LatexType                       command
  73         Decoration                      classic
  74         LabelString                     "PDF (Setup)"
  75         LatexName                       pdfcommentsetup
  76         LabelFont
  77           Color                         magenta
  78           Size                          Small
  79         EndFont
  80         MultiPar                        false
  81         Argument 1
  82           MenuString            "PDF-Comment setup options"
  83           LabelString           "Opts"
  84           ToolTip                       "Insert PDF-Comment setup options here (see the pdfcomment manual)"
  85         EndArgument
  86         Requires                        pdfcomment
  87 End
  88
  89 #
  90 # Annotation insets
  91 #
  92
  93 InsetLayout "Flex:PDF-Annotation"
  94         LyXType                         custom
  95         LatexType                       command
  96         Decoration                      classic
  97         LabelString                     PDF
  98         LatexName                       pdfcomment
  99         LabelFont
 100           Color                         magenta
 101           Size                          Small
 102         EndFont
 103         MultiPar                        false
 104         Argument 1
 105           MenuString            "PDFComment Options"
 106           LabelString           "Opts"
 107           ToolTip                       "Insert PDFComment options here (see pdfcomment manual)"
 108         EndArgument
 109         Requires                        pdfcomment
 110 End
 111
 112 InsetLayout "Flex:PDF-Margin"
 113         CopyStyle                       "Flex:PDF-Annotation"
 114         LabelString                     "PDF (Margin)"
 115         LatexName                       pdfmargincomment
 116         LabelFont
 117           Color                         green
 118           Size                          Small
 119         EndFont
 120 End
 121
 122 InsetLayout "Flex:PDF-Markup"
 123         CopyStyle                       "Flex:PDF-Margin"
 124         LabelString                     "PDF (Markup)"
 125         LatexName                       pdfmarkupcomment
 126         Argument post:1
 127           LabelString           "Comment"
 128           Mandatory                     1
 129           ToolTip                       "Insert the comment to the marked-up text here"
 130         EndArgument
 131 End
 132
 133 InsetLayout "Flex:PDF-Freetext"
 134         CopyStyle                       "Flex:PDF-Margin"
 135         LabelString                     "PDF (Freetext)"
 136         LatexName                       pdffreetextcomment
 137 End
 138
 139 InsetLayout "Flex:PDF-Square"
 140         CopyStyle                       "Flex:PDF-Margin"
 141         LabelString                     "PDF (Square)"
 142         LatexName                       pdfsquarecomment
 143 End
 144
 145 InsetLayout "Flex:PDF-Circle"
 146         CopyStyle                       "Flex:PDF-Margin"
 147         LabelString                     "PDF (Circle)"
 148         LatexName                       pdfcirclecomment
 149 End
 150
 151 InsetLayout "Flex:PDF-Line"
 152         CopyStyle                       "Flex:PDF-Margin"
 153         LabelString                     "PDF (Line)"
 154         LatexName                       pdflinecomment
 155 End
 156
 157 InsetLayout "Flex:PDF-Sideline"
 158         CopyStyle                       "Flex:PDF-Margin"
 159         LabelString                     "PDF (Sideline)"
 160         LatexType                       environment
 161         LatexName                       pdfsidelinecomment
 162         MultiPar                        true
 163         Argument 2
 164           LabelString           "Comment"
 165           Mandatory                     1
 166           ToolTip                       "Insert the comment here"
 167         EndArgument
 168 End
 169
 170 InsetLayout "Flex:PDF-Reply"
 171         CopyStyle                       "Flex:PDF-Margin"
 172         LabelString                     "PDF (Reply)"
 173         LatexName                       pdfreply
 174         LabelFont
 175           Color                         blue
 176           Size                          Small
 177         EndFont
 178 End
 179
 180 InsetLayout "Flex:PDF-Tooltip"
 181         CopyStyle                       "Flex:PDF-Markup"
 182         LabelString                     "PDF (Tooltip)"
 183         LatexName                       pdftooltip
 184         LabelFont
 185           Color                         red
 186           Size                          Small
 187         EndFont
 188         Argument post:1
 189           MenuString            "Tooltip Text"
 190           LabelString           "Tooltip"
 191           Mandatory                     1
 192           ToolTip                       "Insert the tooltip text here"
 193         EndArgument
 194 End
 195
 196 #
 197 # List of Annotations
 198 #
 199
 200 Style List_of_PDF_Comments
 201         KeepEmpty                       1
 202         LatexType                       Command
 203         LatexName                       listofpdfcomments
 204         Margin                          First_Dynamic
 205         NextNoIndent            1
 206         ParSkip                         0
 207         TopSep                          0
 208         BottomSep                       0.25
 209         ParSep                          0
 210         Align                           Center
 211         LabelType                       Static
 212         LabelBottomSep          0
 213         LeftMargin                      MMMMM
 214         LabelString                     "[List of PDF Comments]"
 215         LabelFont
 216             Family                      Sans
 217             Series                      Bold
 218             Size                        Large
 219             Color                       latex
 220         EndFont
 221         Argument 1
 222           LabelString           "Opts"
 223           MenuString            "List Options|s"
 224           Tooltip                       "Insert list options here (see pdfcomment manual)"
 225         EndArgument
 226         Requires                        pdfcomment
 227 End