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