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