lib/layouts/pdfcomment.module

   1 #\DeclareLyXModule[datetime.sty,fmtcount.sty]{PDF Comments}
   2 #\DeclareCategory{Annotations}
   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 72
  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         Argument 1
 106           MenuString            "PDFComment Options"
 107           LabelString           "Opts"
 108           ToolTip               "Insert PDFComment options here (see pdfcomment manual)"
 109         EndArgument
 110         Requires                pdfcomment
 111 End
 112
 113 InsetLayout "Flex:PDF-Margin"
 114         CopyStyle               "Flex:PDF-Annotation"
 115         LabelString             "PDF (Margin)"
 116         LatexName               pdfmargincomment
 117         LabelFont
 118           Color                 green
 119           Size                  Small
 120         EndFont
 121 End
 122
 123 InsetLayout "Flex:PDF-Markup"
 124         CopyStyle               "Flex:PDF-Margin"
 125         LabelString             "PDF (Markup)"
 126         LatexName               pdfmarkupcomment
 127         NeedMBoxProtect         1
 128         Argument post:1
 129           LabelString           "Comment"
 130           Mandatory             1
 131           ToolTip               "Insert the comment to the marked-up text here"
 132         EndArgument
 133 End
 134
 135 InsetLayout "Flex:PDF-Freetext"
 136         CopyStyle               "Flex:PDF-Margin"
 137         LabelString             "PDF (Freetext)"
 138         LatexName               pdffreetextcomment
 139 End
 140
 141 InsetLayout "Flex:PDF-Square"
 142         CopyStyle               "Flex:PDF-Margin"
 143         LabelString             "PDF (Square)"
 144         LatexName               pdfsquarecomment
 145 End
 146
 147 InsetLayout "Flex:PDF-Circle"
 148         CopyStyle               "Flex:PDF-Margin"
 149         LabelString             "PDF (Circle)"
 150         LatexName               pdfcirclecomment
 151 End
 152
 153 InsetLayout "Flex:PDF-Line"
 154         CopyStyle               "Flex:PDF-Margin"
 155         LabelString             "PDF (Line)"
 156         LatexName               pdflinecomment
 157 End
 158
 159 InsetLayout "Flex:PDF-Sideline"
 160         CopyStyle               "Flex:PDF-Margin"
 161         LabelString             "PDF (Sideline)"
 162         LatexType               environment
 163         LatexName               pdfsidelinecomment
 164         MultiPar                true
 165         Argument 2
 166           LabelString           "Comment"
 167           Mandatory             1
 168           ToolTip               "Insert the comment here"
 169         EndArgument
 170 End
 171
 172 InsetLayout "Flex:PDF-Reply"
 173         CopyStyle               "Flex:PDF-Margin"
 174         LabelString             "PDF (Reply)"
 175         LatexName               pdfreply
 176         LabelFont
 177           Color                 blue
 178           Size                  Small
 179         EndFont
 180 End
 181
 182 InsetLayout "Flex:PDF-Tooltip"
 183         CopyStyle               "Flex:PDF-Markup"
 184         LabelString             "PDF (Tooltip)"
 185         LatexName               pdftooltip
 186         NeedMBoxProtect         0
 187         LabelFont
 188           Color                 red
 189           Size                  Small
 190         EndFont
 191         Argument post:1
 192           MenuString            "Tooltip Text"
 193           LabelString           "Tooltip"
 194           Mandatory             1
 195           ToolTip               "Insert the tooltip text here"
 196         EndArgument
 197 End
 198
 199 #
 200 # List of Annotations
 201 #
 202
 203 Style List_of_PDF_Comments
 204         KeepEmpty               1
 205         LatexType               Command
 206         LatexName               listofpdfcomments
 207         Margin                  First_Dynamic
 208         NextNoIndent            1
 209         ParSkip                 0
 210         TopSep                  0
 211         BottomSep               0.25
 212         ParSep                  0
 213         Align                   Center
 214         LabelType               Static
 215         LabelBottomSep          0
 216         LeftMargin              MMMMM
 217         LabelString             "[List of PDF Comments]"
 218         LabelFont
 219           Family                Sans
 220           Series                Bold
 221           Size                  Large
 222           Color                 latex
 223         EndFont
 224         Argument 1
 225           LabelString           "Opts"
 226           MenuString            "List Options|s"
 227           Tooltip               "Insert list options here (see pdfcomment manual)"
 228         EndArgument
 229         Requires                pdfcomment
 230 End