lib/layouts/fixme.module

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