lib/layouts/pdfcomment.module

   1 #\DeclareLyXModule{PDF Comments}
   2 #DescriptionBegin
   3 #Provides various kinds of annotations for the PDF output. The module uses
   4 #the pdfcomment package. Please consult the package documentation for details.
   5 #DescriptionEnd
   6 # Author: Juergen Spitzmueller <spitz@lyx.org>
   7 #         Uwe Stöhr <uwestoehr@lyx.org>
   8
   9 Format 49
  10
  11 #
  12 # helper commands
  13 #
  14
  15 # pdfcomment loads hyperref
  16 Provides hyperref 1
  17
  18 Style Define_Avatar
  19         Category                PDF-comment
  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         Requires                pdfcomment
  38 End
  39
  40 Style Define_PDF-Comment_Style
  41         CopyStyle               Define_Avatar
  42         LatexName               definestyle
  43         LabelString             "PDF-comment style:"
  44         Argument 1
  45                 LabelString     "Name"
  46                 Tooltip         "Name of the style"
  47                 Mandatory       1
  48         EndArgument
  49 End
  50
  51 Style Define_PDF-Comment_List_Style
  52         CopyStyle               Define_Avatar
  53         LatexName               defineliststyle
  54         LabelString             "Definition of PDF-comment list style:"
  55         Argument 1
  56                 LabelString     "Name"
  57                 Tooltip         "Name of the list style"
  58                 Mandatory       1
  59         EndArgument
  60 End
  61
  62 Style Set_PDF-Comment_List_Style
  63         CopyStyle               Define_Avatar
  64         LatexName               setliststyle
  65         LabelString             "PDF-comment list style:"
  66         ResetArgs               1
  67 End
  68
  69 InsetLayout "Flex:PDF-Comment-Setup"
  70         LyXType               custom
  71         LatexType             command
  72         Decoration            classic
  73         LabelString           "PDF (Setup)"
  74         LatexName             pdfcommentsetup
  75         LabelFont
  76           Color               magenta
  77           Size                Small
  78         EndFont
  79         MultiPar              false
  80         Argument 1
  81           MenuString          "PDF-Comment setup options"
  82           LabelString         "Opts"
  83           ToolTip             "Insert PDF-Comment setup options here (see the pdfcomment manual)"
  84         EndArgument
  85         Requires              pdfcomment
  86 End
  87
  88 #
  89 # Annotation insets
  90 #
  91
  92 InsetLayout "Flex:PDF-Annotation"
  93         LyXType               custom
  94         LatexType             command
  95         Decoration            classic
  96         LabelString           PDF
  97         LatexName             pdfcomment
  98         LabelFont
  99           Color               magenta
 100           Size                Small
 101         EndFont
 102         MultiPar              false
 103         Argument 1
 104           MenuString          "PDFComment Options"
 105           LabelString         "Opts"
 106           ToolTip             "Insert PDFComment options here (see pdfcomment manual)"
 107         EndArgument
 108         Requires              pdfcomment
 109 End
 110
 111 InsetLayout "Flex:PDF-Margin"
 112         CopyStyle             "Flex:PDF-Annotation"
 113         LabelString           "PDF (Margin)"
 114         LatexName             pdfmargincomment
 115         LabelFont
 116           Color               green
 117           Size                Small
 118         EndFont
 119 End
 120
 121 InsetLayout "Flex:PDF-Markup"
 122         CopyStyle             "Flex:PDF-Margin"
 123         LabelString           "PDF (Markup)"
 124         LatexName             pdfmarkupcomment
 125         Argument post:1
 126           LabelString         "Comment"
 127           Mandatory           1
 128           ToolTip             "Insert the comment to the marked-up text here"
 129         EndArgument
 130 End
 131
 132 InsetLayout "Flex:PDF-Freetext"
 133         CopyStyle             "Flex:PDF-Margin"
 134         LabelString           "PDF (Freetext)"
 135         LatexName             pdffreetextcomment
 136 End
 137
 138 InsetLayout "Flex:PDF-Square"
 139         CopyStyle             "Flex:PDF-Margin"
 140         LabelString           "PDF (Square)"
 141         LatexName             pdfsquarecomment
 142 End
 143
 144 InsetLayout "Flex:PDF-Circle"
 145         CopyStyle             "Flex:PDF-Margin"
 146         LabelString           "PDF (Circle)"
 147         LatexName             pdfcirclecomment
 148 End
 149
 150 InsetLayout "Flex:PDF-Line"
 151         CopyStyle             "Flex:PDF-Margin"
 152         LabelString           "PDF (Line)"
 153         LatexName             pdflinecomment
 154 End
 155
 156 InsetLayout "Flex:PDF-Sideline"
 157         CopyStyle             "Flex:PDF-Margin"
 158         LabelString           "PDF (Sideline)"
 159         LatexType             environment
 160         LatexName             pdfsidelinecomment
 161         MultiPar              true
 162         Argument 2
 163           LabelString         "Comment"
 164           Mandatory           1
 165           ToolTip             "Insert the comment here"
 166         EndArgument
 167 End
 168
 169 InsetLayout "Flex:PDF-Reply"
 170         CopyStyle             "Flex:PDF-Margin"
 171         LabelString           "PDF (Reply)"
 172         LatexName             pdfreply
 173         LabelFont
 174           Color               blue
 175           Size                Small
 176         EndFont
 177 End
 178
 179 InsetLayout "Flex:PDF-Tooltip"
 180         CopyStyle             "Flex:PDF-Markup"
 181         LabelString           "PDF (Tooltip)"
 182         LatexName             pdftooltip
 183         LabelFont
 184           Color               red
 185           Size                Small
 186         EndFont
 187         Argument post:1
 188           MenuString          "Tooltip Text"
 189           LabelString         "Tooltip"
 190           Mandatory           1
 191           ToolTip             "Insert the tooltip text here"
 192         EndArgument
 193 End
 194
 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
 216         LabelFont
 217             Family      typewriter
 218             Series      Medium
 219             Size        Small
 220             Color       latex
 221         EndFont
 222
 223         Argument 1
 224           LabelString   "Opts"
 225           MenuString    "List Options|s"
 226           Tooltip       "Insert list options here (see pdfcomment manual)"
 227         EndArgument
 228         Requires        pdfcomment
 229 End