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 26
  57
  58 Provides stdinsets 1
  59
  60 InsetLayout Marginal
  61         LabelString           margin
  62         LatexType             command
  63         LatexName             marginpar
  64         Font
  65           Size                Small
  66         EndFont
  67         LabelFont
  68           Color               marginlabel
  69           Size                Small
  70         EndFont
  71         MultiPar              true
  72         NeedProtect           true
  73         HTMLStyle
  74                 div.marginal {
  75                         border: 2px solid black;
  76                         padding: 1ex;
  77                         margin: 1ex;
  78                         background-color: #F0F0F0;
  79                         float:right;
  80                         font-size: small;
  81                         font-weight: medium;
  82                         font-family: serif;
  83                         font-variant: normal;
  84                         font-style: normal;
  85                 }
  86         EndHTMLStyle
  87 End
  88
  89 InsetLayout Foot
  90         LabelString           foot
  91         Counter               footnote
  92         Font
  93           Size                Small
  94         EndFont
  95         LabelFont
  96           Color               footlabel
  97           Size                Small
  98         EndFont
  99         MultiPar              true
 100         RefPrefix             fn
 101         HTMLLabel             \arabic{footnote}
 102         HTMLInnerTag          div
 103         HTMLStyle
 104                 span.foot_label {
 105                         vertical-align: super;
 106                         font-size: smaller;
 107                         font-weight: bold;
 108                         text-decoration: underline;
 109                 }
 110                 div.foot {
 111                         display: inline;
 112                         font-size: small;
 113                         font-weight: medium;
 114                         font-family: serif;
 115                         font-variant: normal;
 116                         font-style: normal;
 117                 }
 118                 div.foot_inner { display: none; }
 119                 div.foot:hover div.foot_inner {
 120                         display: block;
 121                         border: 1px double black;
 122                         margin: 0em 1em;
 123                         padding: 1em;
 124                 }
 125         EndHTMLStyle
 126 End
 127
 128 InsetLayout Note:Comment
 129         LabelString           comment
 130         LatexType             environment
 131         LatexName             comment
 132         BgColor               commentbg
 133         LabelFont
 134           Color               comment
 135           Size                Small
 136         EndFont
 137         MultiPar              true
 138         HTMLTag               !--
 139         HTMLIsBlock           false
 140 End
 141
 142
 143 InsetLayout Note:Note
 144         LabelString           note
 145         LatexType             command
 146         LatexName             note
 147         BgColor               notebg
 148         LabelFont
 149           Color               note
 150           Size                Small
 151         EndFont
 152         MultiPar              true
 153         HTMLIsBlock           false
 154 # FIXME HTML Need CSS
 155 End
 156
 157
 158 InsetLayout Note:Greyedout
 159         LabelString           greyedout
 160         LatexType             environment
 161         LatexName             lyxgreyedout
 162         BgColor               greyedoutbg
 163         Font
 164           Color               greyedouttext
 165         EndFont
 166         LabelFont
 167           Color               greyedout
 168           Size                Small
 169         EndFont
 170         MultiPar              true
 171         HTMLStyle
 172                 div.note_greyedout {
 173                         display: inline;
 174                         color: #A0A0A0;
 175                         padding-left: 1ex;
 176                         padding-right: 1ex;
 177                 }
 178         EndHTMLStyle
 179         HTMLIsBlock           false
 180 End
 181
 182 InsetLayout ERT
 183         LabelString           ERT
 184         LatexType             none
 185         Decoration            minimalistic
 186         Font
 187           Color               latex
 188           Family              typewriter
 189         EndFont
 190         LabelFont
 191           Color               latex
 192           Size                Small
 193         EndFont
 194         MultiPar              true
 195         CustomPars            false
 196         ForcePlain            true
 197         PassThru              true
 198         KeepEmpty             true
 199         FreeSpacing           true
 200         ForceLTR              true
 201 End
 202
 203 InsetLayout Phantom
 204         Decoration            minimalistic
 205         Font
 206           Color               phantomtext
 207         EndFont
 208         CustomPars            false
 209         ForcePlain            true
 210 End
 211
 212 InsetLayout Listings
 213         LabelString           Listings
 214         LatexType             none
 215         Decoration            minimalistic
 216         Font
 217           Color               foreground
 218           Family              typewriter
 219         EndFont
 220         LabelFont
 221           Color               foreground
 222           Size                Small
 223         EndFont
 224         BgColor               listingsbg
 225         MultiPar              true
 226         PassThru              true
 227         KeepEmpty             true
 228         FreeSpacing           true
 229         ForceLTR              true
 230         RefPrefix             lst
 231 End
 232
 233 InsetLayout Branch
 234         Decoration            classic
 235         LabelFont
 236           Color               branchlabel
 237           Size                Small
 238         EndFont
 239         MultiPar              true
 240         InToc                 true
 241         HTMLIsBlock           false
 242 End
 243
 244 InsetLayout Index
 245         LabelString           Idx
 246         Decoration            classic
 247         Font
 248           Size                Small
 249         EndFont
 250         LabelFont
 251           Color               indexlabel
 252           Size                Small
 253         EndFont
 254         MultiPar              false
 255         CustomPars            false
 256         ForcePlain            true
 257         ContentAsLabel        true
 258 End
 259
 260 InsetLayout Box
 261         LabelFont
 262           Color               foreground
 263           Size                Small
 264         EndFont
 265         MultiPar              true
 266         HTMLStyle
 267                 div.Frameless { font-family: sans-serif; }
 268         EndHTMLStyle
 269 End
 270
 271 InsetLayout Box:Shaded
 272         BgColor               shaded
 273         LabelFont
 274           Color               foreground
 275           Size                Small
 276         EndFont
 277         MultiPar              true
 278 End
 279
 280 InsetLayout Float
 281         LabelFont
 282           Color               collapsable
 283           Size                Small
 284         EndFont
 285         MultiPar              true
 286         HTMLStyle
 287                 div.float {
 288                         border: 2px solid black;
 289                         text-align: center;
 290                 }
 291         EndHTMLStyle
 292 End
 293
 294 InsetLayout Wrap
 295         LabelFont
 296           Color               collapsable
 297           Size                Small
 298         EndFont
 299         MultiPar              true
 300         RefPrefix             wrap
 301         HTMLStyle
 302                 div.wrap {
 303                         float: right;
 304                         border: 2px solid black;
 305                         padding: 1ex;
 306                         margin: 1ex;
 307                 }
 308         EndHTMLStyle
 309 End
 310
 311 InsetLayout URL
 312         LyXType               standard
 313         Decoration            classic
 314         LabelString           URL
 315         ContentAsLabel        true
 316         LatexName             url
 317         LatexType             command
 318         Requires              url
 319         MultiPar              false
 320         CustomPars            false
 321         ForcePlain            true
 322         PassThru              true
 323         FreeSpacing           true
 324         ForceLTR              true
 325         Font
 326           Family              Typewriter
 327           Color               urltext
 328         EndFont
 329         LabelFont
 330           Family              Typewriter
 331           Color               urllabel
 332           Size                Small
 333         EndFont
 334         HTMLIsBlock           false
 335 End
 336
 337 InsetLayout OptArg
 338         LabelString           opt
 339         LabelFont
 340           Color               collapsable
 341           Size                Small
 342         EndFont
 343         MultiPar              false
 344 End
 345
 346 InsetLayout Info
 347         Decoration            conglomerate
 348         HTMLStyle
 349                 span.info { font-family: sans-serif; }
 350         EndHTMLStyle
 351         HTMLTag            span
 352         MultiPar           false
 353 End
 354
 355 InsetLayout Info:menu
 356         CopyStyle             Info
 357         LatexType             command
 358         LatexName             menuitem
 359         Preamble
 360           \providecommand{\menuitem}[1]{\textsf{#1}}
 361         EndPreamble
 362         Decoration            conglomerate
 363         Font
 364           Family              sans
 365         EndFont
 366         HTMLAttr          "class='info menu'"
 367         HTMLStyle
 368                 span.menu { font-family: sans-serif; }
 369         EndHTMLStyle
 370 End
 371
 372 InsetLayout Info:shortcut
 373         CopyStyle             Info
 374         LatexType             command
 375         LatexName             shortcut
 376         Preamble
 377           \providecommand{\shortcut}[1]{\mbox{\textsf{#1}}}
 378         EndPreamble
 379         Decoration            conglomerate
 380         Font
 381           Family              sans
 382         EndFont
 383         HTMLAttr          "class='info shortcut'"
 384         HTMLStyle
 385                 span.shortcut { font-family: sans-serif; }
 386         EndHTMLStyle
 387 End
 388
 389 InsetLayout Info:shortcuts
 390         CopyStyle             Info
 391         LatexType             command
 392         LatexName             shortcut
 393         Preamble
 394           \providecommand{\shortcut}[1]{\textsf{#1}}
 395         EndPreamble
 396         Decoration            conglomerate
 397         Font
 398           Family              sans
 399         EndFont
 400         HTMLAttr          "class='info shortcut'"
 401         HTMLStyle
 402                 span.shortcuts { font-family: sans-serif; }
 403         EndHTMLStyle
 404 End
 405
 406 InsetLayout Caption
 407         HTMLStyle
 408                 div.float-caption {
 409                         text-align: center;
 410                         border: 2px solid black;
 411                         padding: 1ex;
 412                         margin: 1ex;
 413                 }
 414         EndHTMLStyle
 415 End
 416
 417
 418 InsetLayout Preview
 419         LabelString           Preview
 420         Decoration            minimalistic
 421         MultiPar              true
 422 End