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 48
  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      typewriter
  39             Series      Medium
  40             Size        Small
  41             Color       latex
  42         EndFont
  43         Requires        fixme
  44 End
  45
  46 #
  47 # FIXME Notes (simple)
  48 #
  49
  50 InsetLayout Flex:Fixme_Note
  51         LyXType               custom
  52         LabelString           Fixme
  53         LatexType             command
  54         LatexName             fxnote
  55         Decoration            classic
  56         LabelFont
  57           Color               magenta
  58           Size                Small
  59         EndFont
  60         MultiPar              false
  61         Argument 1
  62           LabelString         "Options"
  63           MenuString          "Fixme Note Options|s"
  64           Tooltip             "Consult the fixme package documentation for options"
  65         EndArgument
  66         Requires              fixme
  67 End
  68
  69 InsetLayout Flex:Fixme_Warning
  70         CopyStyle             Flex:Fixme_Note
  71         LabelString           Warning
  72         LatexName             fxwarning
  73 End
  74
  75 InsetLayout Flex:Fixme_Error
  76         CopyStyle             Flex:Fixme_Note
  77         LabelString           Error
  78         LatexName             fxerror
  79 End
  80
  81 InsetLayout Flex:Fixme_Fatal
  82         CopyStyle             Flex:Fixme_Note
  83         LabelString           Fatal
  84         LatexName             fxfatal
  85 End
  86
  87
  88 #
  89 # FIXME Notes (targeted)
  90 #
  91
  92 InsetLayout Flex:Fixme_Note_(Targeted)
  93         CopyStyle             Flex:Fixme_Note
  94         LabelString           "Fixme (Targeted)"
  95         LatexName             fxnote*
  96         Argument 1
  97           LabelString         "Options"
  98           MenuString          "Fixme Note Options|s"
  99           Tooltip             "Consult the fixme package documentation for options"
 100         EndArgument
 101         Argument 2
 102           LabelString         "Note"
 103           Mandatory            1
 104           MenuString          "Fixme Note|x"
 105           Tooltip             "Insert the FIXME note here"
 106           AutoInsert          1
 107         EndArgument
 108 End
 109
 110 InsetLayout Flex:Fixme_Warning_(Targeted)
 111         CopyStyle             Flex:Fixme_Note_(Targeted)
 112         LabelString           "Warning (Targeted)"
 113         LatexName             fxwarning*
 114 End
 115
 116 InsetLayout Flex:Fixme_Error_(Targeted)
 117         CopyStyle             Flex:Fixme_Note_(Targeted)
 118         LabelString           "Error (Targeted)"
 119         LatexName             fxerror*
 120 End
 121
 122 InsetLayout Flex:Fixme_Fatal_(Targeted)
 123         CopyStyle             Flex:Fixme_Note_(Targeted)
 124         LabelString           "Fatal (Targeted)"
 125         LatexName             fxfatal*
 126 End
 127
 128
 129 #
 130 # FIXME Notes (multipar)
 131 #
 132
 133 InsetLayout Flex:Fixme_Note_(Multipar)
 134         CopyStyle             Flex:Fixme_Note
 135         LabelString           "Fixme (Multipar)"
 136         LatexName             anfxnote
 137         LatexType             environment
 138         Argument 1
 139           LabelString         "Options"
 140           MenuString          "Fixme Note Options|s"
 141           Tooltip             "Consult the fixme package documentation for options"
 142         EndArgument
 143         Argument 2
 144           LabelString         "Summary"
 145           Mandatory            1
 146           MenuString          "Fixme Summary"
 147           Tooltip             "Insert a summary of the FIXME note here"
 148           AutoInsert          1
 149         EndArgument
 150 End
 151
 152 InsetLayout Flex:Fixme_Warning_(Multipar)
 153         CopyStyle             Flex:Fixme_Note_(Multipar)
 154         LabelString           "Warning (Multipar)"
 155         LatexName             anfxwarning
 156 End
 157
 158 InsetLayout Flex:Fixme_Error_(Multipar)
 159         CopyStyle             Flex:Fixme_Note_(Multipar)
 160         LabelString           "Error (Multipar)"
 161         LatexName             anfxerror
 162 End
 163
 164 InsetLayout Flex:Fixme_Fatal_(Multipar)
 165         CopyStyle             Flex:Fixme_Note_(Multipar)
 166         LabelString           "Fatal (Multipar)"
 167         LatexName             anfxfatal
 168 End
 169
 170
 171 #
 172 # FIXME Notes (multipar targeted)
 173 #
 174
 175 InsetLayout Flex:Fixme_Note_(Multipar_Targeted)
 176         CopyStyle             Flex:Fixme_Note_(Multipar)
 177         LabelString           "Fixme (MP Targ.)"
 178         LatexName             anfxnote*
 179         Argument 1
 180           LabelString         "Options"
 181           MenuString          "Fixme Note Options|s"
 182           Tooltip             "Consult the fixme package documentation for options"
 183         EndArgument
 184         Argument 2
 185           LabelString         "Summary"
 186           Mandatory            1
 187           MenuString          "Fixme Summary"
 188           Tooltip             "Insert a summary of the FIXME note here"
 189           AutoInsert          1
 190         EndArgument
 191         Argument 3
 192           LabelString         "Annotated Text"
 193           Mandatory            1
 194           MenuString          "Annotated Text|x"
 195           Tooltip             "Insert the text to annotate here"
 196           AutoInsert          1
 197         EndArgument
 198 End
 199
 200 InsetLayout Flex:Fixme_Warning_(Multipar_Targeted)
 201         CopyStyle             Flex:Fixme_Note_(Multipar_Targeted)
 202         LabelString           "Warning (MP Targ.)"
 203         LatexName             anfxwarning*
 204 End
 205
 206 InsetLayout Flex:Fixme_Error_(Multipar_Targeted)
 207         CopyStyle             Flex:Fixme_Note_(Multipar_Targeted)
 208         LabelString           "Error (MP Targ.)"
 209         LatexName             anfxerror*
 210 End
 211
 212 InsetLayout Flex:Fixme_Fatal_(Multipar_Targeted)
 213         CopyStyle             Flex:Fixme_Note_(Multipar_Targeted)
 214         LabelString           "Fatal (MP Targ.)"
 215         LatexName             anfxfatal*
 216 End
 217
 218
 219 #
 220 # Backwards compatibility to user-provided
 221 # modules on the LyX wiki
 222 #
 223 # FIXME: uncomment these when #9000 is fixed.
 224
 225 #InsetLayout FxNote
 226 #       ObsoletedBy           Flex:Fixme_Note
 227 #End
 228 #
 229 #InsetLayout FxNote*
 230 #       ObsoletedBy           Flex:Fixme_Note_(Targeted)
 231 #End
 232 #
 233 #InsetLayout FxWarning
 234 #       ObsoletedBy           Flex:Fixme_Warning
 235 #End
 236 #
 237 #InsetLayout FxWarning*
 238 #       ObsoletedBy           Flex:Fixme_Warning_(Targeted)
 239 #End
 240 #
 241 #InsetLayout FxError
 242 #       ObsoletedBy           Flex:Fixme_Error
 243 #End
 244 #
 245 #InsetLayout FxError*
 246 #       ObsoletedBy           Flex:Fixme_Error_(Targeted)
 247 #End
 248 #
 249 #InsetLayout FxFatal
 250 #       ObsoletedBy           Flex:Fixme_Fatal
 251 #End
 252 #
 253 #InsetLayout FxFatal*
 254 #       ObsoletedBy           Flex:Fixme_Fatal_(Targeted)
 255 #End
 256