lib/layouts/pdfcomment.module

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