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