lib/layouts/todonotes.module

   1 #\DeclareLyXModule[todonotes.sty]{TODO Notes}
   2 #DescriptionBegin
   3 #Provides custom insets to insert TODO items in your document
   4 #(using the todonotes package). In order to generate a 'List of TODOs',
   5 #the module provides a paragraph style. Passing 'final' as document class
   6 #option suppresses the output of TODO notes.
   7 #DescriptionEnd
   8
   9 # Authors: Stephen <stephen4mailinglists@googlemail.com>
  10 #          Jürgen Spitzmüller <spitz@lyx.org>
  11
  12 Format 68
  13
  14 OutlinerName todonotes "TODO"
  15
  16 PackageOptions todonotes obeyFinal
  17
  18 #
  19 # List of TODOs
  20 #
  21
  22 Style List_of_TODOs
  23         KeepEmpty       1
  24         LatexType       Command
  25         LatexName       listoftodos
  26         Margin          First_Dynamic
  27         NextNoIndent    1
  28         ParSkip         0
  29         TopSep          0
  30         BottomSep       0.25
  31         ParSep          0
  32         Align           Center
  33         LabelType       Static
  34         LabelBottomSep  0
  35         LeftMargin      MMMMM
  36         LabelString     "[List of TODOs]"
  37
  38         LabelFont
  39             Family      Sans
  40             Series      Bold
  41             Size        Large
  42             Color       latex
  43         EndFont
  44
  45         Argument 1
  46                 LabelString     "Heading"
  47                 MenuString      "List of TODOs Heading|s"
  48                 Tooltip         "Enter a custom header for the List of TODOs here"
  49         EndArgument
  50         Requires        todonotes
  51 End
  52
  53
  54 #
  55 # TODO Notes
  56 #
  57
  58 InsetLayout Flex:TODO_Note_(Margin)
  59         LyxType         custom
  60         LabelString     "TODO (Margin)"
  61         Decoration      classic
  62         BgColor         orange
  63         Font
  64             Color       black
  65             Family      Typewriter
  66         EndFont
  67         LabelFont
  68             Color       brown
  69             Family      Sans
  70             Size        Small
  71         EndFont
  72         MultiPar        true
  73         LatexType       command
  74         LatexName       todo
  75         AddToToc      todonotes
  76         IsTocCaption  1
  77         Argument 1
  78                 LabelString     "Options"
  79                 MenuString      "TODO Note Options|s"
  80                 Tooltip         "See the todonotes manual for possible options"
  81         EndArgument
  82         Requires        todonotes
  83 End
  84
  85
  86 InsetLayout Flex:TODO_Note_(inline)
  87         CopyStyle       Flex:TODO_Note_(Margin)
  88         LabelString     "TODO (Inline)"
  89         Argument 1
  90                 LabelString     "Options"
  91                 MenuString      "TODO Note Options|s"
  92                 PresetArg       inline
  93         EndArgument
  94 End
  95
  96
  97 #
  98 # Specific Notes
  99 #
 100
 101 InsetLayout Flex:Missing_Figure
 102         CopyStyle       Flex:TODO_Note_(Margin)
 103         LabelString     "Missing Figure"
 104         MultiPar        false
 105         LatexName       missingfigure
 106         Argument 1
 107                 LabelString     "Options"
 108                 MenuString      "Missing Figure Note Options|s"
 109                 Tooltip         "See the todonotes manual for possible options"
 110         EndArgument
 111 End
 112
 113
 114 #
 115 # Backwards compatibility to user-provided
 116 # modules on the LyX wiki
 117 #
 118
 119 InsetLayout Flex:TODO
 120         ObsoletedBy           Flex:TODO_Note_(Margin)
 121 End
 122
 123 InsetLayout Flex:Todo[Inline]
 124         ObsoletedBy           Flex:TODO_Note_(inline)
 125 End
 126
 127 InsetLayout Flex:Todo[margin]
 128         ObsoletedBy           Flex:TODO_Note_(Margin)
 129 End
 130
 131 InsetLayout Flex:MissingFigure
 132         ObsoletedBy           Flex:Missing_Figure
 133 End
 134