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 72
  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         NeedMBoxProtect         1
 127         Argument post:1
 128           LabelString           "Comment"
 129           Mandatory             1
 130           ToolTip               "Insert the comment to the marked-up text here"
 131         EndArgument
 132 End
 133
 134 InsetLayout "Flex:PDF-Freetext"
 135         CopyStyle               "Flex:PDF-Margin"
 136         LabelString             "PDF (Freetext)"
 137         LatexName               pdffreetextcomment
 138 End
 139
 140 InsetLayout "Flex:PDF-Square"
 141         CopyStyle               "Flex:PDF-Margin"
 142         LabelString             "PDF (Square)"
 143         LatexName               pdfsquarecomment
 144 End
 145
 146 InsetLayout "Flex:PDF-Circle"
 147         CopyStyle               "Flex:PDF-Margin"
 148         LabelString             "PDF (Circle)"
 149         LatexName               pdfcirclecomment
 150 End
 151
 152 InsetLayout "Flex:PDF-Line"
 153         CopyStyle               "Flex:PDF-Margin"
 154         LabelString             "PDF (Line)"
 155         LatexName               pdflinecomment
 156 End
 157
 158 InsetLayout "Flex:PDF-Sideline"
 159         CopyStyle               "Flex:PDF-Margin"
 160         LabelString             "PDF (Sideline)"
 161         LatexType               environment
 162         LatexName               pdfsidelinecomment
 163         MultiPar                true
 164         Argument 2
 165           LabelString           "Comment"
 166           Mandatory             1
 167           ToolTip               "Insert the comment here"
 168         EndArgument
 169 End
 170
 171 InsetLayout "Flex:PDF-Reply"
 172         CopyStyle               "Flex:PDF-Margin"
 173         LabelString             "PDF (Reply)"
 174         LatexName               pdfreply
 175         LabelFont
 176           Color                 blue
 177           Size                  Small
 178         EndFont
 179 End
 180
 181 InsetLayout "Flex:PDF-Tooltip"
 182         CopyStyle               "Flex:PDF-Markup"
 183         LabelString             "PDF (Tooltip)"
 184         LatexName               pdftooltip
 185         NeedMBoxProtect         0
 186         LabelFont
 187           Color                 red
 188           Size                  Small
 189         EndFont
 190         Argument post:1
 191           MenuString            "Tooltip Text"
 192           LabelString           "Tooltip"
 193           Mandatory             1
 194           ToolTip               "Insert the tooltip text here"
 195         EndArgument
 196 End
 197
 198 #
 199 # List of Annotations
 200 #
 201
 202 Style List_of_PDF_Comments
 203         KeepEmpty               1
 204         LatexType               Command
 205         LatexName               listofpdfcomments
 206         Margin                  First_Dynamic
 207         NextNoIndent            1
 208         ParSkip                 0
 209         TopSep                  0
 210         BottomSep               0.25
 211         ParSep                  0
 212         Align                   Center
 213         LabelType               Static
 214         LabelBottomSep          0
 215         LeftMargin              MMMMM
 216         LabelString             "[List of PDF Comments]"
 217         LabelFont
 218           Family                Sans
 219           Series                Bold
 220           Size                  Large
 221           Color                 latex
 222         EndFont
 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