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 End
 169
 170
 171 InsetLayout Phantom:HPhantom
 172         CopyStyle               Phantom:Phantom
 173         LatexName               hphantom
 174 End
 175
 176 InsetLayout Phantom:VPhantom
 177         CopyStyle               Phantom:Phantom
 178         LatexName               vphantom
 179 End
 180
 181 InsetLayout Listings
 182         LabelString           Listings
 183         LatexType             none
 184         Decoration            minimalistic
 185         Font
 186           Color               foreground
 187           Family              typewriter
 188         EndFont
 189         LabelFont
 190           Color               foreground
 191           Size                Small
 192         EndFont
 193         BgColor               listingsbg
 194         MultiPar              true
 195         PassThru              true
 196         KeepEmpty             true
 197         FreeSpacing           true
 198         ForceLTR              true
 199 End
 200
 201 InsetLayout Branch
 202         Decoration            classic
 203         LabelFont
 204           Color               branchlabel
 205           Size                Small
 206         EndFont
 207         MultiPar              true
 208 End
 209
 210 InsetLayout Index
 211         LabelString           Idx
 212         LatexType             command
 213         LatexName             index
 214         Decoration            classic
 215         Font
 216           Color               foreground
 217           Size                Small
 218           Family              Roman
 219           Shape               Up
 220           Series              Medium
 221           Misc                No_Emph
 222           Misc                No_Noun
 223           Misc                No_Bar
 224         EndFont
 225         LabelFont
 226           Color               indexlabel
 227           Size                Small
 228         EndFont
 229         MultiPar              false
 230 #       CustomPars            false
 231 #       ForcePlain            true
 232         NeedProtect           true
 233 End
 234
 235 InsetLayout Box
 236         LabelFont
 237           Color               foreground
 238           Size                Small
 239         EndFont
 240         MultiPar              true
 241 End
 242
 243 InsetLayout Box:Shaded
 244         BgColor               shaded
 245         LabelFont
 246           Color               foreground
 247           Size                Small
 248         EndFont
 249         MultiPar              true
 250 End
 251
 252 InsetLayout Float
 253         LabelFont
 254           Color               collapsable
 255           Size                Small
 256         EndFont
 257         MultiPar              true
 258 End
 259
 260 InsetLayout Wrap
 261         LabelFont
 262           Color               collapsable
 263           Size                Small
 264         EndFont
 265         MultiPar              true
 266 End
 267
 268 InsetLayout URL
 269         LyXType               standard
 270         LatexName             url
 271         LatexType             command
 272         Decoration            classic
 273         LabelString           URL
 274         PassThru              true
 275         ForceLTR              true
 276         Font
 277           Family              Typewriter
 278           Color               urltext
 279         EndFont
 280         LabelFont
 281           Family              Typewriter
 282           Color               urllabel
 283           Size                Small
 284         EndFont
 285         Requires              url
 286 End
 287
 288 InsetLayout OptArg
 289         LabelString           opt
 290         LabelFont
 291           Color               collapsable
 292           Size                Small
 293         EndFont
 294 #       MultiPar              false
 295 End
 296
 297 InsetLayout Info
 298         Decoration            conglomerate
 299 End
 300
 301 InsetLayout Info:menu
 302         LatexType             command
 303         LatexName             menuitem
 304         Preamble
 305           \providecommand{\menuitem}[1]{\textsf{#1}}
 306         EndPreamble
 307         Decoration            conglomerate
 308         Font
 309           Family              sans
 310         EndFont
 311 End
 312
 313 InsetLayout Info:shortcut
 314         LatexType             command
 315         LatexName             shortcut
 316         Preamble
 317           \providecommand{\shortcut}[1]{\mbox{\textsf{#1}}}
 318         EndPreamble
 319         Decoration            conglomerate
 320         Font
 321           Family              sans
 322         EndFont
 323 End
 324
 325 InsetLayout Info:shortcuts
 326         LatexType             command
 327         LatexName             shortcut
 328         Preamble
 329           \providecommand{\shortcut}[1]{\textsf{#1}}
 330         EndPreamble
 331         Decoration            conglomerate
 332         Font
 333           Family              sans
 334         EndFont
 335 End