lib/layouts/fixme.module

   1 #\DeclareLyXModule[fixme.sty]{FiXme Notes}
   2 #\DeclareCategory{Annotation & Revision}
   3 #DescriptionBegin
   4 #Provides 'FiXme' (marginal) annotations for document revision purposes.
   5 #A list of annotations can be produced by using the 'List of FIXMEs' paragraph style.
   6 #The annotations are customizable via the LaTeX preamble. See the FiXme documentation for details.
   7 #NOTE: By default, the notes are only displayed in 'draft' mode (if the option 'draft'
   8 #has been inserted to Document > Settings > Document Class > Class Options > Custom).
   9 #To display them always, insert \fxsetup{draft} to Document > Settings > Preamble.
  10 #NOTE also that you need version 4 or later of the FiXme package for some features.
  11 #DescriptionEnd
  12 #
  13 # Authors: Mark Edgington <edgimar@gmail.com>
  14 #          Jürgen Spitzmüller <spitz@lyx.org>
  15
  16 Format 85
  17
  18 OutlinerName fixme "Fixme"
  19
  20 #
  21 # List of FIXMEs
  22 #
  23
  24 Style List_of_FIXMEs
  25         KeepEmpty       1
  26         LatexType       Command
  27         LatexName       listoffixmes
  28         Margin          First_Dynamic
  29         NextNoIndent    1
  30         ParSkip         0
  31         TopSep          0
  32         BottomSep       0.25
  33         ParSep          0
  34         Align           Center
  35         LabelType       Static
  36         LabelBottomSep  0
  37         LeftMargin      MMMMM
  38         LabelString     "[List of FIXMEs]"
  39
  40         LabelFont
  41             Family      Sans
  42             Series      Bold
  43             Size        Large
  44             Color       latex
  45         EndFont
  46
  47         Requires        fixme
  48 End
  49
  50 #
  51 # FIXME Notes (simple)
  52 #
  53
  54 InsetLayout Flex:Fixme_Note
  55         LyXType               custom
  56         LabelString           Fixme
  57         LatexType             command
  58         LatexName             fxnote
  59         Decoration            classic
  60         LabelFont
  61           Color               magenta
  62           Size                Small
  63         EndFont
  64         MultiPar              false
  65         AddToToc              fixme
  66         IsTocCaption          1
  67         Argument 1
  68           LabelString         "Options"
  69           MenuString          "Fixme Note Options|s"
  70           Tooltip             "Consult the fixme package documentation for options"
  71         EndArgument
  72         Requires              fixme
  73 End
  74
  75 InsetLayout Flex:Fixme_Warning
  76         CopyStyle             Flex:Fixme_Note
  77         LabelString           Warning
  78         LatexName             fxwarning
  79 End
  80
  81 InsetLayout Flex:Fixme_Error
  82         CopyStyle             Flex:Fixme_Note
  83         LabelString           Error
  84         LatexName             fxerror
  85 End
  86
  87 InsetLayout Flex:Fixme_Fatal
  88         CopyStyle             Flex:Fixme_Note
  89         LabelString           Fatal
  90         LatexName             fxfatal
  91 End
  92
  93
  94 #
  95 # FIXME Notes (targeted)
  96 #
  97
  98 InsetLayout Flex:Fixme_Note_(Targeted)
  99         CopyStyle             Flex:Fixme_Note
 100         LabelString           "Fixme (Targeted)"
 101         LatexName             fxnote*
 102         Argument 1
 103           LabelString         "Options"
 104           MenuString          "Fixme Note Options|s"
 105           Tooltip             "Consult the fixme package documentation for options"
 106         EndArgument
 107         Argument 2
 108           LabelString         "Note"
 109           Mandatory            1
 110           MenuString          "Fixme Note|x"
 111           IsTocCaption        1
 112           Tooltip             "Insert the FIXME note here"
 113           AutoInsert          1
 114         EndArgument
 115 End
 116
 117 InsetLayout Flex:Fixme_Warning_(Targeted)
 118         CopyStyle             Flex:Fixme_Note_(Targeted)
 119         LabelString           "Warning (Targeted)"
 120         LatexName             fxwarning*
 121 End
 122
 123 InsetLayout Flex:Fixme_Error_(Targeted)
 124         CopyStyle             Flex:Fixme_Note_(Targeted)
 125         LabelString           "Error (Targeted)"
 126         LatexName             fxerror*
 127 End
 128
 129 InsetLayout Flex:Fixme_Fatal_(Targeted)
 130         CopyStyle             Flex:Fixme_Note_(Targeted)
 131         LabelString           "Fatal (Targeted)"
 132         LatexName             fxfatal*
 133 End
 134
 135
 136 #
 137 # FIXME Notes (multipar)
 138 #
 139
 140 InsetLayout Flex:Fixme_Note_(Multipar)
 141         CopyStyle             Flex:Fixme_Note
 142         LabelString           "Fixme (Multipar)"
 143         LatexName             anfxnote
 144         LatexType             environment
 145         Argument 1
 146           LabelString         "Options"
 147           MenuString          "Fixme Note Options|s"
 148           Tooltip             "Consult the fixme package documentation for options"
 149         EndArgument
 150         Argument 2
 151           LabelString         "Summary"
 152           Mandatory            1
 153           IsTocCaption        1
 154           MenuString          "Fixme Summary"
 155           Tooltip             "Insert a summary of the FIXME note here"
 156           AutoInsert          1
 157         EndArgument
 158 End
 159
 160 InsetLayout Flex:Fixme_Warning_(Multipar)
 161         CopyStyle             Flex:Fixme_Note_(Multipar)
 162         LabelString           "Warning (Multipar)"
 163         LatexName             anfxwarning
 164 End
 165
 166 InsetLayout Flex:Fixme_Error_(Multipar)
 167         CopyStyle             Flex:Fixme_Note_(Multipar)
 168         LabelString           "Error (Multipar)"
 169         LatexName             anfxerror
 170 End
 171
 172 InsetLayout Flex:Fixme_Fatal_(Multipar)
 173         CopyStyle             Flex:Fixme_Note_(Multipar)
 174         LabelString           "Fatal (Multipar)"
 175         LatexName             anfxfatal
 176 End
 177
 178
 179 #
 180 # FIXME Notes (multipar targeted)
 181 #
 182
 183 InsetLayout Flex:Fixme_Note_(Multipar_Targeted)
 184         CopyStyle             Flex:Fixme_Note_(Multipar)
 185         LabelString           "Fixme (MP Targ.)"
 186         LatexName             anfxnote*
 187         Argument 1
 188           LabelString         "Options"
 189           MenuString          "Fixme Note Options|s"
 190           Tooltip             "Consult the fixme package documentation for options"
 191         EndArgument
 192         Argument 2
 193           LabelString         "Summary"
 194           IsTocCaption        1
 195           Mandatory            1
 196           MenuString          "Fixme Summary"
 197           Tooltip             "Insert a summary of the FIXME note here"
 198           AutoInsert          1
 199         EndArgument
 200         Argument 3
 201           LabelString         "Annotated Text"
 202           Mandatory            1
 203           MenuString          "Annotated Text|x"
 204           Tooltip             "Insert the text to annotate here"
 205           AutoInsert          1
 206         EndArgument
 207 End
 208
 209 InsetLayout Flex:Fixme_Warning_(Multipar_Targeted)
 210         CopyStyle             Flex:Fixme_Note_(Multipar_Targeted)
 211         LabelString           "Warning (MP Targ.)"
 212         LatexName             anfxwarning*
 213 End
 214
 215 InsetLayout Flex:Fixme_Error_(Multipar_Targeted)
 216         CopyStyle             Flex:Fixme_Note_(Multipar_Targeted)
 217         LabelString           "Error (MP Targ.)"
 218         LatexName             anfxerror*
 219 End
 220
 221 InsetLayout Flex:Fixme_Fatal_(Multipar_Targeted)
 222         CopyStyle             Flex:Fixme_Note_(Multipar_Targeted)
 223         LabelString           "Fatal (MP Targ.)"
 224         LatexName             anfxfatal*
 225 End
 226
 227
 228 #
 229 # Backwards compatibility to user-provided
 230 # modules on the LyX wiki
 231 #
 232
 233 InsetLayout Flex:FxNote
 234         ObsoletedBy           Flex:Fixme_Note
 235 End
 236
 237 InsetLayout Flex:FxNote*
 238         ObsoletedBy           Flex:Fixme_Note_(Targeted)
 239 End
 240
 241 InsetLayout Flex:FxWarning
 242         ObsoletedBy           Flex:Fixme_Warning
 243 End
 244
 245 InsetLayout Flex:FxWarning*
 246         ObsoletedBy           Flex:Fixme_Warning_(Targeted)
 247 End
 248
 249 InsetLayout Flex:FxError
 250         ObsoletedBy           Flex:Fixme_Error
 251 End
 252
 253 InsetLayout Flex:FxError*
 254         ObsoletedBy           Flex:Fixme_Error_(Targeted)
 255 End
 256
 257 InsetLayout Flex:FxFatal
 258         ObsoletedBy           Flex:Fixme_Fatal
 259 End
 260
 261 InsetLayout Flex:FxFatal*
 262         ObsoletedBy           Flex:Fixme_Fatal_(Targeted)
 263 End
 264