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 25
  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         LabelFont
 164           Color               greyedout
 165           Size                Small
 166         EndFont
 167         MultiPar              true
 168         HTMLStyle
 169                 div.note_greyedout {
 170                         display: inline;
 171                         color: #A0A0A0;
 172                         padding-left: 1ex;
 173                         padding-right: 1ex;
 174                 }
 175         EndHTMLStyle
 176         HTMLIsBlock           false
 177 End
 178
 179 InsetLayout ERT
 180         LabelString           ERT
 181         LatexType             none
 182         Decoration            minimalistic
 183         Font
 184           Color               latex
 185           Family              typewriter
 186         EndFont
 187         LabelFont
 188           Color               latex
 189           Size                Small
 190         EndFont
 191         MultiPar              true
 192         CustomPars            false
 193         ForcePlain            true
 194         PassThru              true
 195         KeepEmpty             true
 196         FreeSpacing           true
 197         ForceLTR              true
 198 End
 199
 200 InsetLayout Phantom
 201         Decoration            minimalistic
 202         Font
 203           Color               phantomtext
 204         EndFont
 205         CustomPars            false
 206         ForcePlain            true
 207 End
 208
 209 InsetLayout Listings
 210         LabelString           Listings
 211         LatexType             none
 212         Decoration            minimalistic
 213         Font
 214           Color               foreground
 215           Family              typewriter
 216         EndFont
 217         LabelFont
 218           Color               foreground
 219           Size                Small
 220         EndFont
 221         BgColor               listingsbg
 222         MultiPar              true
 223         PassThru              true
 224         KeepEmpty             true
 225         FreeSpacing           true
 226         ForceLTR              true
 227         RefPrefix             lst
 228 End
 229
 230 InsetLayout Branch
 231         Decoration            classic
 232         LabelFont
 233           Color               branchlabel
 234           Size                Small
 235         EndFont
 236         MultiPar              true
 237         InToc                 true
 238         HTMLIsBlock           false
 239 End
 240
 241 InsetLayout Index
 242         LabelString           Idx
 243         Decoration            classic
 244         Font
 245           Size                Small
 246         EndFont
 247         LabelFont
 248           Color               indexlabel
 249           Size                Small
 250         EndFont
 251         MultiPar              false
 252         CustomPars            false
 253         ForcePlain            true
 254         ContentAsLabel        true
 255 End
 256
 257 InsetLayout Box
 258         LabelFont
 259           Color               foreground
 260           Size                Small
 261         EndFont
 262         MultiPar              true
 263         HTMLStyle
 264                 div.Frameless { font-family: sans-serif; }
 265         EndHTMLStyle
 266 End
 267
 268 InsetLayout Box:Shaded
 269         BgColor               shaded
 270         LabelFont
 271           Color               foreground
 272           Size                Small
 273         EndFont
 274         MultiPar              true
 275 End
 276
 277 InsetLayout Float
 278         LabelFont
 279           Color               collapsable
 280           Size                Small
 281         EndFont
 282         MultiPar              true
 283         HTMLStyle
 284                 div.float {
 285                         border: 2px solid black;
 286                         text-align: center;
 287                 }
 288         EndHTMLStyle
 289 End
 290
 291 InsetLayout Wrap
 292         LabelFont
 293           Color               collapsable
 294           Size                Small
 295         EndFont
 296         MultiPar              true
 297         RefPrefix             wrap
 298         HTMLStyle
 299                 div.wrap {
 300                         float: right;
 301                         border: 2px solid black;
 302                         padding: 1ex;
 303                         margin: 1ex;
 304                 }
 305         EndHTMLStyle
 306 End
 307
 308 InsetLayout URL
 309         LyXType               standard
 310         Decoration            classic
 311         LabelString           URL
 312         ContentAsLabel        true
 313         LatexName             url
 314         LatexType             command
 315         Requires              url
 316         MultiPar              false
 317         CustomPars            false
 318         ForcePlain            true
 319         PassThru              true
 320         FreeSpacing           true
 321         ForceLTR              true
 322         Font
 323           Family              Typewriter
 324           Color               urltext
 325         EndFont
 326         LabelFont
 327           Family              Typewriter
 328           Color               urllabel
 329           Size                Small
 330         EndFont
 331         HTMLIsBlock           false
 332 End
 333
 334 InsetLayout OptArg
 335         LabelString           opt
 336         LabelFont
 337           Color               collapsable
 338           Size                Small
 339         EndFont
 340         MultiPar              false
 341 End
 342
 343 InsetLayout Info
 344         Decoration            conglomerate
 345         HTMLStyle
 346                 span.info { font-family: sans-serif; }
 347         EndHTMLStyle
 348         HTMLTag            span
 349         MultiPar           false
 350 End
 351
 352 InsetLayout Info:menu
 353         CopyStyle             Info
 354         LatexType             command
 355         LatexName             menuitem
 356         Preamble
 357           \providecommand{\menuitem}[1]{\textsf{#1}}
 358         EndPreamble
 359         Decoration            conglomerate
 360         Font
 361           Family              sans
 362         EndFont
 363         HTMLAttr          "class='info menu'"
 364         HTMLStyle
 365                 span.menu { font-family: sans-serif; }
 366         EndHTMLStyle
 367 End
 368
 369 InsetLayout Info:shortcut
 370         CopyStyle             Info
 371         LatexType             command
 372         LatexName             shortcut
 373         Preamble
 374           \providecommand{\shortcut}[1]{\mbox{\textsf{#1}}}
 375         EndPreamble
 376         Decoration            conglomerate
 377         Font
 378           Family              sans
 379         EndFont
 380         HTMLAttr          "class='info shortcut'"
 381         HTMLStyle
 382                 span.shortcut { font-family: sans-serif; }
 383         EndHTMLStyle
 384 End
 385
 386 InsetLayout Info:shortcuts
 387         CopyStyle             Info
 388         LatexType             command
 389         LatexName             shortcut
 390         Preamble
 391           \providecommand{\shortcut}[1]{\textsf{#1}}
 392         EndPreamble
 393         Decoration            conglomerate
 394         Font
 395           Family              sans
 396         EndFont
 397         HTMLAttr          "class='info shortcut'"
 398         HTMLStyle
 399                 span.shortcuts { font-family: sans-serif; }
 400         EndHTMLStyle
 401 End
 402
 403 InsetLayout Caption
 404         HTMLStyle
 405                 div.float-caption {
 406                         text-align: center;
 407                         border: 2px solid black;
 408                         padding: 1ex;
 409                         margin: 1ex;
 410                 }
 411         EndHTMLStyle
 412 End
 413