lib/layouts/stdinsets.inc

   1 # Textclass definition file for LaTeX.
   2 # Author : Martin vermeer <martin.vermeer@hut.fi>
   3 # Inset layouts definition
   4 #
   5 # More detailled format description is available in the customization manual
   6 # FIXME: create the contents in the manual and put the link here.
   7 #
   8 #InsetLayout <string identifier used by LyX>
   9 #       LabelString           used for the inset decoration (either the inset button
  10 #                             or the text underneath the inset).
  11 #       LatexType             associated LateX type: command, environment, or none.
  12 #       LatexName             associated LateX command.
  13 #       BgColor               Color of the inset background within LyX.
  14 #                         FIXME: link to a doc file describing the different
  15 #                         color codes as defined in 'ColorCode.h'
  16 #       Font                  Nothing to put here, below are descriptions of the different
  17 #                         allowable adjustments for the font used to draw the text
  18 #                         appearing within the inset text. All these items are optional.
  19 #         Color               Color of text
  20 #         Size                Font size of the textallowed value: Small, Smaller, ...
  21 #                         FIXME defined in FontSize in FontEnums.h
  22 #         Family              FIXME defined in FontFamily in FontEnums.h
  23 #         Shape               FIXME defined in FontShape in FontEnums.h
  24 #         Series              FIXME defined in FontSeries in FontEnums.h
  25 #         Misc                FIXME defined in FontMisc in FontEnums.h
  26 #       EndFont               Nothing to put here, it's just a markup to indicate that we are
  27 #                         finished with the Font definition.
  28 #       LabelFont             Nothing to put here, below are descriptions of the different
  29 #                         allowable adjustments for the font used to draw the text
  30 #                         appearing within the inset decoration. All these items are
  31 #                         optional.
  32 #         Color               see definition above (in the Font node).
  33 #         Size                see definition above (in the Font node).
  34 #
  35 #       EndFont               Nothing to put here, it's just a markup to indicate that we are
  36 #                         finished with the LabelFont definition.
  37 #       MultiPar              Indicates that multiple paragraphs are allowed within the inset
  38 #                         or not. Defaults to false. Sets CustomPars, as well, to the same
  39 #                         value, and sets ForcePlain to the opposite value. If you want
  40 #                         those to be different, then, you must set them after you set
  41 #                         MultiPar.
  42 # CustomPars            Whether to allow the use of the Paragraph Settings dialog. Default is
  43 #                         false.
  44 # ForcePlain            Whether to force the PlainLayout. Default is true.
  45 #       Decoration:           Classic, Minimalistic, Conglomerate. Decoration styles
  46 #       PassThru              Do not do various LaTeX conversions, like the phrases
  47 #                               LaTeX, LyX, quote commands, etc.
  48 #       KeepEmpty             Do not delete empty paragraphs (?)
  49 #       FreeSpacing           Preserve multiple spaces etc.
  50 #       ForceLTR              Force the "latex" language, leading to Left-to-Right
  51 #                               (latin) output, e.g., in ERT or URL. A kludge.
  52 #       Requires              Require a given (supported) feature. Multiple features must
  53 #                         be comma-separated.
  54 #End
  55
  56 Format 11
  57
  58 Provides stdinsets 1
  59
  60 InsetLayout Marginal
  61         LabelString           margin
  62         LatexType             command
  63         LatexName             marginpar
  64         Font
  65           Color               foreground
  66           Size                Small
  67           Family              Roman
  68           Shape               Up
  69           Series              Medium
  70           Misc                No_Emph
  71           Misc                No_Noun
  72           Misc                No_Bar
  73         EndFont
  74         LabelFont
  75           Color               marginlabel
  76           Size                Small
  77         EndFont
  78         MultiPar              true
  79 End
  80
  81 InsetLayout Foot
  82         LabelString           foot
  83         LatexType             command
  84         LatexName             footnote
  85         Font
  86           Color               foreground
  87           Size                Small
  88           Family              Roman
  89           Shape               Up
  90           Series              Medium
  91           Misc                No_Emph
  92           Misc                No_Noun
  93           Misc                No_Bar
  94         EndFont
  95         LabelFont
  96           Color               footlabel
  97           Size                Small
  98         EndFont
  99         MultiPar              true
 100 End
 101
 102 InsetLayout Note:Comment
 103         LabelString           comment
 104         LatexType             environment
 105         LatexName             comment
 106         BgColor               commentbg
 107         LabelFont
 108           Color               comment
 109           Size                Small
 110         EndFont
 111         MultiPar              true
 112 End
 113
 114
 115 InsetLayout Note:Note
 116         LabelString           note
 117         LatexType             command
 118         LatexName             note
 119         BgColor               notebg
 120         LabelFont
 121           Color               note
 122           Size                Small
 123         EndFont
 124         MultiPar              true
 125 End
 126
 127 InsetLayout Note:Greyedout
 128         LabelString           greyedout
 129         LatexType             environment
 130         LatexName             lyxgreyedout
 131         BgColor               greyedoutbg
 132         LabelFont
 133           Color               greyedout
 134           Size                Small
 135         EndFont
 136         MultiPar              true
 137 End
 138
 139 InsetLayout ERT
 140         LabelString           ERT
 141         LatexType             none
 142         Decoration            minimalistic
 143         Font
 144           Color               latex
 145           Family              typewriter
 146         EndFont
 147         LabelFont
 148           Color               latex
 149           Size                Small
 150         EndFont
 151         MultiPar              true
 152         CustomPars            false
 153         ForcePlain            true
 154         PassThru              true
 155         KeepEmpty             true
 156         FreeSpacing           true
 157         ForceLTR              true
 158 End
 159
 160 InsetLayout Phantom:Phantom
 161         LatexType               command
 162         LatexName               phantom
 163         Decoration              minimalistic
 164         Font
 165           Color                 phantomtext
 166         EndFont
 167         MultiPar                false
 168         CustomPars              false
 169 End
 170
 171
 172 InsetLayout Phantom:HPhantom
 173         CopyStyle               Phantom:Phantom
 174         LatexName               hphantom
 175 End
 176
 177 InsetLayout Phantom:VPhantom
 178         CopyStyle               Phantom:Phantom
 179         LatexName               vphantom
 180 End
 181
 182 InsetLayout Listings
 183         LabelString           Listings
 184         LatexType             none
 185         Decoration            minimalistic
 186         Font
 187           Color               foreground
 188           Family              typewriter
 189         EndFont
 190         LabelFont
 191           Color               foreground
 192           Size                Small
 193         EndFont
 194         BgColor               listingsbg
 195         MultiPar              true
 196         PassThru              true
 197         KeepEmpty             true
 198         FreeSpacing           true
 199         ForceLTR              true
 200 End
 201
 202 InsetLayout Branch
 203         Decoration            classic
 204         LabelFont
 205           Color               branchlabel
 206           Size                Small
 207         EndFont
 208         MultiPar              true
 209 End
 210
 211 InsetLayout Index
 212         LabelString           Idx
 213         LatexType             command
 214         LatexName             index
 215         Decoration            classic
 216         Font
 217           Color               foreground
 218           Size                Small
 219           Family              Roman
 220           Shape               Up
 221           Series              Medium
 222           Misc                No_Emph
 223           Misc                No_Noun
 224           Misc                No_Bar
 225         EndFont
 226         LabelFont
 227           Color               indexlabel
 228           Size                Small
 229         EndFont
 230         MultiPar              false
 231 #       CustomPars            false
 232 #       ForcePlain            true
 233         NeedProtect           true
 234 End
 235
 236 InsetLayout Box
 237         LabelFont
 238           Color               foreground
 239           Size                Small
 240         EndFont
 241         MultiPar              true
 242 End
 243
 244 InsetLayout Box:Shaded
 245         BgColor               shaded
 246         LabelFont
 247           Color               foreground
 248           Size                Small
 249         EndFont
 250         MultiPar              true
 251 End
 252
 253 InsetLayout Float
 254         LabelFont
 255           Color               collapsable
 256           Size                Small
 257         EndFont
 258         MultiPar              true
 259 End
 260
 261 InsetLayout Wrap
 262         LabelFont
 263           Color               collapsable
 264           Size                Small
 265         EndFont
 266         MultiPar              true
 267 End
 268
 269 InsetLayout URL
 270         LyXType               standard
 271         LatexName             url
 272         LatexType             command
 273         Decoration            classic
 274         LabelString           URL
 275         PassThru              true
 276         ForceLTR              true
 277         Font
 278           Family              Typewriter
 279           Color               urltext
 280         EndFont
 281         LabelFont
 282           Family              Typewriter
 283           Color               urllabel
 284           Size                Small
 285         EndFont
 286         Requires              url
 287 End
 288
 289 InsetLayout OptArg
 290         LabelString           opt
 291         LabelFont
 292           Color               collapsable
 293           Size                Small
 294         EndFont
 295 #       MultiPar              false
 296 End
 297
 298 InsetLayout Info
 299         Decoration            conglomerate
 300 End
 301
 302 InsetLayout Info:menu
 303         LatexType             command
 304         LatexName             menuitem
 305         Preamble
 306           \providecommand{\menuitem}[1]{\textsf{#1}}
 307         EndPreamble
 308         Decoration            conglomerate
 309         Font
 310           Family              sans
 311         EndFont
 312 End
 313
 314 InsetLayout Info:shortcut
 315         LatexType             command
 316         LatexName             shortcut
 317         Preamble
 318           \providecommand{\shortcut}[1]{\mbox{\textsf{#1}}}
 319         EndPreamble
 320         Decoration            conglomerate
 321         Font
 322           Family              sans
 323         EndFont
 324 End
 325
 326 InsetLayout Info:shortcuts
 327         LatexType             command
 328         LatexName             shortcut
 329         Preamble
 330           \providecommand{\shortcut}[1]{\textsf{#1}}
 331         EndPreamble
 332         Decoration            conglomerate
 333         Font
 334           Family              sans
 335         EndFont
 336 End