lib/layouts/todonotes.module

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