lib/layouts/stdinsets.inc

   1 # Textclass definition file for LaTeX.
   2 # Author : Martin vermeer <martin.vermeer@hut.fi>
   3 # Inset layouts definition
   4 #
   5 # Detailed format description is available in the customization manual
   6
   7 Format 85
   8
   9 Provides stdinsets 1
  10
  11 OutlinerName marginalnote "Marginal notes"
  12 OutlinerName footnote     "Footnotes"
  13 OutlinerName note         "Notes"
  14 OutlinerName branch       "Branches"
  15 OutlinerName index        "Index Entries" #no AddToToc (built-in)
  16 OutlinerName listing      "Listings" #no AddToToc (built-in)
  17
  18 InsetLayout Marginal
  19         LabelString           margin
  20         LatexType             command
  21         LatexName             marginpar
  22         Font
  23           Size                Small
  24         EndFont
  25         LabelFont
  26           Color               marginlabel
  27           Size                Small
  28         EndFont
  29         MultiPar              true
  30         NeedProtect           true
  31         HTMLStyle
  32                 div.marginal {
  33                         border: 2px solid black;
  34                         padding: 1ex;
  35                         margin: 1ex;
  36                         background-color: #F0F0F0;
  37                         float:right;
  38                         font-size: small;
  39                         font-weight: medium;
  40                         font-family: serif;
  41                         font-variant: normal;
  42                         font-style: normal;
  43                 }
  44         EndHTMLStyle
  45         AddToToc              marginalnote
  46         IsTocCaption          true
  47         DocBookTag            para
  48 End
  49
  50 InsetLayout Foot
  51         LabelString           foot
  52         LatexType             Command
  53         LatexName             footnote
  54         Counter               footnote
  55         Font
  56           Size                Small
  57         EndFont
  58         LabelFont
  59           Color               footlabel
  60           Size                Small
  61         EndFont
  62         MultiPar              true
  63         RefPrefix             fn
  64         HTMLLabel             \arabic{footnote}
  65         HTMLInnerTag          div
  66         HTMLStyle
  67                 span.foot_label {
  68                         vertical-align: super;
  69                         font-size: smaller;
  70                         font-weight: bold;
  71                         text-decoration: underline;
  72                 }
  73                 div.foot {
  74                         display: inline;
  75                         font-size: small;
  76                         font-weight: medium;
  77                         font-family: serif;
  78                         font-variant: normal;
  79                         font-style: normal;
  80                 }
  81                 div.foot_inner { display: none; }
  82                 div.foot:hover div.foot_inner {
  83                         display: block;
  84                         border: 1px double black;
  85                         margin: 0em 1em;
  86                         padding: 1em;
  87                 }
  88         EndHTMLStyle
  89         AddToToc              footnote
  90         IsTocCaption          true
  91         DocBookTag            footnote
  92         DocBookTagType        inline
  93 End
  94
  95 InsetLayout Foot:InTitle
  96         CopyStyle             Foot
  97         LatexName             thanks
  98         NeedProtect           true
  99         Counter               thanks
 100         MultiPar              false
 101         HTMLLabel             \fnsymbol{thanks}
 102         HTMLInnerTag          span
 103         HTMLStyle
 104                 span.foot_intitle_label {
 105                         vertical-align: super;
 106                         font-size: smaller;
 107                         font-weight: bold;
 108                         text-decoration: underline;
 109                 }
 110                 span.foot_intitle {
 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                 span.foot_intitle_inner { display: none; }
 119                 span.foot_intitle:hover span.foot_intitle_inner {
 120                         display: block;
 121                         border: 1px double black;
 122                         margin: 0em 1em;
 123                         padding: 1em;
 124                 }
 125         EndHTMLStyle
 126 End
 127
 128 InsetLayout Foot:InFloatTable
 129         CopyStyle             Foot
 130         LatexName             tablefootnote
 131         Requires              tablefootnote
 132 End
 133
 134
 135 InsetLayout Note:Comment
 136         LabelString           Comment
 137         LatexType             environment
 138         LatexName             comment
 139         Requires              verbatim
 140         BgColor               commentbg
 141         LabelFont
 142           Color               comment
 143           Size                Small
 144         EndFont
 145         MultiPar              true
 146         Display               false
 147         HTMLTag               div
 148         HTMLIsBlock           true
 149         HTMLStyle
 150         div.note_comment {
 151                 display: none;
 152         }
 153         EndHTMLStyle
 154         AddToToc              note
 155         IsTocCaption          true
 156         NeedCProtect          true
 157 End
 158
 159
 160 InsetLayout Note:Note
 161         LabelString           Note
 162         LatexType             command
 163         LatexName             note
 164         BgColor               notebg
 165         LabelFont
 166           Color               note
 167           Size                Small
 168         EndFont
 169         MultiPar              true
 170         # Not output for XHTML
 171         AddToToc              note
 172         IsTocCaption          true
 173 End
 174
 175
 176 InsetLayout Note:Greyedout
 177         LabelString           Greyedout
 178         LatexType             environment
 179         LatexName             lyxgreyedout
 180         Requires              color,lyxgreyedout
 181         BgColor               greyedoutbg
 182         Font
 183           Color               greyedouttext
 184         EndFont
 185         LabelFont
 186           Color               greyedout
 187           Size                Small
 188         EndFont
 189         MultiPar              true
 190         Display               false
 191         HTMLInnerTag div
 192         HTMLStyle
 193                 div.note_greyedout {
 194                         display: inline;
 195                         color: #A0A0A0;
 196                         padding-left: 1ex;
 197                         padding-right: 1ex;
 198                 }
 199         EndHTMLStyle
 200         HTMLIsBlock           false
 201         AddToToc              note
 202         IsTocCaption          true
 203         NeedCProtect          true
 204 End
 205
 206 InsetLayout ERT
 207         LabelString           ERT
 208         LatexType             none
 209         Decoration            minimalistic
 210         Font
 211           Color               latex
 212           Family              typewriter
 213         EndFont
 214         LabelFont
 215           Color               latex
 216           Size                Small
 217         EndFont
 218         MultiPar              true
 219         CustomPars            false
 220         ForcePlain            true
 221         PassThru              true
 222         ParbreakIsNewline     true
 223         KeepEmpty             true
 224         FreeSpacing           true
 225         ForceLTR              true
 226         EditExternal          true
 227 End
 228
 229 InsetLayout Phantom
 230         Decoration            minimalistic
 231         Font
 232           Color               phantomtext
 233         EndFont
 234         MultiPar              false
 235         CustomPars            false
 236         ForcePlain            true
 237 End
 238
 239 InsetLayout IPADeco
 240         Decoration            minimalistic
 241         Font
 242           Color               foreground
 243         EndFont
 244         MultiPar              false
 245         CustomPars            false
 246         ForcePlain            true
 247 End
 248
 249 InsetLayout TOC
 250   HTMLTag h2
 251   HTMLStyle
 252     div.toc {
 253       margin: 2em 0em;
 254       border-style: solid;
 255       border-width: 2px 0px;
 256       padding: 1em 0em;
 257     }
 258     h2.tochead { font-size: x-large; font-weight: bold; }
 259     div.lyxtoc-0 {
 260       margin: 2em 0em 0em 0em;
 261       font-size: xx-large;
 262       font-weight: bold;
 263     }
 264     div.lyxtoc-1 {
 265       margin: 1em 0em 0em 0em;
 266       font-size: x-large;
 267       font-weight: bold;
 268     }
 269     div.lyxtoc-2 {
 270       margin: 0em 0.1em 0em 1em;
 271       font-size: large;
 272       font-weight: normal;
 273     }
 274     div.lyxtoc-3 { margin: 0em 0.1em 0em 0.5em; font-size: medium; }
 275     div.lyxtoc-4 { margin: 0em 0.1em 0em 0.5em; }
 276     div.lyxtoc-5 { margin: 0em 0.1em 0em 0.5em; }
 277     div.lyxtoc-6 { margin: 0em 0.1em 0em 0.5em; }
 278     a.tocentry {
 279       text-decoration: none;
 280       color: black;
 281     }
 282     a.tocentry:visited { color: black; }
 283   EndHTMLStyle
 284 End
 285
 286 InsetLayout TOC:Listings
 287         # We need the [[List of Listings]] context, since "Listings" is also
 288         # the name of the inset and translated differently.
 289         # "Listings[[List of Listings]]" is the name of the "List of listings"
 290         # ("Listings" is the predefined english name) in listings.sty, so it
 291         # must be used here as well.
 292         BabelPreamble
 293                 \addto\captions$$lang{\renewcommand{\lstlistlistingname}{_(Listings[[List of Listings]])}}
 294         EndBabelPreamble
 295         # The command does not need to be defined in LangPreamble, since
 296         # listings.sty does that already. However it needs to be redefined
 297         # in order to be used for non-english single-language documents.
 298         LangPreamble
 299                 \renewcommand{\lstlistlistingname}{_(Listings[[List of Listings]])}
 300         EndLangPreamble
 301         FixedWidthPreambleEncoding true
 302   HTMLTag h2
 303   HTMLStyle
 304     div.lyxtoc-flat {
 305       margin: 0em 0em 0em 1em;
 306       font-size: large;
 307       font-weight: normal;
 308     }
 309   EndHTMLStyle
 310 End
 311
 312 InsetLayout TOC:MintedListings
 313         # "List of Listings" is the name of the "List of listings"
 314         # in minted.sty so it must be used here as well.
 315         BabelPreamble
 316                 \addto\captions$$lang{\renewcommand{\listoflistingscaption}{_(List of Listings)}}
 317         EndBabelPreamble
 318         # The command does not need to be defined in LangPreamble, since
 319         # minted.sty does that already. However it needs to be redefined
 320         # in order to be used for non-english single-language documents.
 321         LangPreamble
 322                 \renewcommand{\listoflistingscaption}{_(List of Listings)}
 323         EndLangPreamble
 324         FixedWidthPreambleEncoding false
 325   HTMLTag h2
 326   HTMLStyle
 327     div.lyxtoc-flat {
 328       margin: 0em 0em 0em 1em;
 329       font-size: large;
 330       font-weight: normal;
 331     }
 332   EndHTMLStyle
 333 End
 334
 335 InsetLayout Include:Listings
 336         BabelPreamble
 337                 \addto\captions$$lang{\renewcommand{\lstlistingname}{_(Listing)}}
 338         EndBabelPreamble
 339         # The command does not need to be defined in LangPreamble, since
 340         # listings.sty does that already. However it needs to be redefined
 341         # in order to be used for non-english single-language documents.
 342         LangPreamble
 343                 \renewcommand{\lstlistingname}{_(Listing)}
 344         EndLangPreamble
 345         FixedWidthPreambleEncoding true
 346 End
 347
 348 InsetLayout Listings
 349         CopyStyle Include:Listings
 350         LabelString           Listings[[inset]]
 351         LatexType             none
 352         Decoration            minimalistic
 353         Font
 354           Color               foreground
 355           Family              typewriter
 356         EndFont
 357         LabelFont
 358           Color               foreground
 359           Size                Small
 360         EndFont
 361         BgColor               listingsbg
 362         MultiPar              true
 363         PassThru              true
 364         ParbreakIsNewline     true
 365         KeepEmpty             true
 366         FreeSpacing           true
 367         ForceLTR              true
 368         ForcePlain            true
 369         NeedCProtect          true
 370         RefPrefix             lst
 371         HTMLTag               pre
 372         HTMLStyle
 373                 div.float-listings {
 374                         border: 2px solid black;
 375                         padding: 1ex;
 376                         margin: 1ex;
 377                 }
 378                 div.listings-caption {
 379                         text-align: center;
 380                         border: 2px solid black;
 381                         padding: 1ex;
 382                         margin: 1ex;
 383         }
 384         EndHTMLStyle
 385         DocBookTag            programlisting
 386 End
 387
 388 InsetLayout MintedListings
 389         CopyStyle Listings
 390         BabelPreamble
 391                 \addto\captions$$lang{\renewcommand{\listingscaption}{_(Listing)}}
 392         EndBabelPreamble
 393         # The command does not need to be defined in LangPreamble, since
 394         # minted.sty does that already. However it needs to be redefined
 395         # in order to be used for non-english single-language documents.
 396         LangPreamble
 397                 \renewcommand{\listingscaption}{_(Listing)}
 398         EndLangPreamble
 399         FixedWidthPreambleEncoding false
 400 End
 401
 402 InsetLayout Branch
 403         Decoration            classic
 404         LabelFont
 405           Color               branchlabel
 406           Size                Small
 407         EndFont
 408         MultiPar              true
 409         InToc                 true
 410         HTMLIsBlock           false
 411         AddToToc              branch
 412         IsTocCaption          true
 413 End
 414
 415 InsetLayout Index
 416         LabelString           Idx
 417         Decoration            classic
 418         Font
 419           Size                Small
 420         EndFont
 421         LabelFont
 422           Color               indexlabel
 423           Size                Small
 424         EndFont
 425         MultiPar              false
 426         CustomPars            false
 427         ForcePlain            true
 428         ContentAsLabel        true
 429         PassThruChars         @|!
 430 End
 431
 432 InsetLayout Box
 433         LabelFont
 434           Color               foreground
 435           Size                Small
 436         EndFont
 437         MultiPar              true
 438         DocBookWrapperTag     sidebar
 439         DocBookTag            para
 440 End
 441
 442 InsetLayout Box:Frameless
 443         CopyStyle Box
 444         HTMLStyle
 445                 div.Frameless { margin: 1em; }
 446         EndHTMLStyle
 447         DocBookWrapperTag     sidebar
 448         DocBookTag            para
 449         DocBookWrapperAttr    role='frameless'
 450 End
 451
 452 InsetLayout Box:Shaded
 453         CopyStyle Box
 454         BgColor shaded
 455         HTMLStyle
 456                 div.Shaded {
 457                         background-color: gray;
 458                         padding: 0.5ex;
 459                 }
 460         EndHTMLStyle
 461         DocBookWrapperTag     sidebar
 462         DocBookTag            para
 463         DocBookWrapperAttr    role='shaded'
 464 End
 465
 466 InsetLayout Box:Boxed
 467         CopyStyle Box
 468         HTMLStyle
 469                 div.Boxed {
 470                         border: solid thick black;
 471                         padding: 0.5ex;
 472                 }
 473         EndHTMLStyle
 474         DocBookWrapperTag     sidebar
 475         DocBookTag            para
 476         DocBookWrapperAttr    role='boxed'
 477 End
 478
 479 InsetLayout Box:Framed
 480         CopyStyle Box
 481         HTMLStyle
 482                 div.Framed {
 483                         border: solid thick black;
 484                         padding: 0.5ex;
 485                 }
 486         EndHTMLStyle
 487         DocBookWrapperTag     sidebar
 488         DocBookTag            para
 489         DocBookWrapperAttr    role='framed'
 490 End
 491
 492 InsetLayout Box:ovalbox
 493         CopyStyle Box
 494         HTMLStyle
 495                 div.ovalbox {
 496                         border: groove medium black;
 497                         padding: 0.5ex;
 498                 }
 499         EndHTMLStyle
 500         DocBookWrapperTag     sidebar
 501         DocBookTag            para
 502         DocBookWrapperAttr    role='ovalbox'
 503 End
 504
 505 InsetLayout Box:Ovalbox
 506         CopyStyle Box
 507         HTMLStyle
 508                 div.Ovalbox {
 509                         border: ridge thick black;
 510                         padding: 0.5ex;
 511                 }
 512         EndHTMLStyle
 513         DocBookWrapperTag     sidebar
 514         DocBookTag            para
 515         DocBookWrapperAttr    role='ovalbox-var'
 516 End
 517
 518 InsetLayout Box:Shadowbox
 519         CopyStyle Box
 520         HTMLStyle
 521                 div.Shadowbox { border: solid gray medium; border-bottom: solid black 1ex; border-right: solid black 1ex; padding: 0.5ex; }
 522         EndHTMLStyle
 523         DocBookWrapperTag     sidebar
 524         DocBookTag            para
 525         DocBookWrapperAttr    role='shadowbox'
 526 End
 527
 528 InsetLayout Box:Doublebox
 529         CopyStyle Box
 530         HTMLStyle
 531                 div.Doublebox {
 532                         border: double thick black;
 533                         padding: 0.5ex;
 534                 }
 535         EndHTMLStyle
 536         DocBookWrapperTag     sidebar
 537         DocBookTag            para
 538         DocBookWrapperAttr    role='doublebox'
 539 End
 540
 541 InsetLayout Float
 542         LaTeXType             environment
 543         LabelFont
 544           Color               collapsible
 545           Size                Small
 546         EndFont
 547         MultiPar              true
 548         HTMLStyle
 549                 div.float {
 550                         border: 2px solid black;
 551                         text-align: center;
 552                 }
 553         EndHTMLStyle
 554 End
 555
 556 #InsetWrap requires these, independently of whether stdfloats.inc is included
 557 OutlinerName table        "Tables" #no AddToToc (built-in)
 558 OutlinerName figure       "Figures" #no AddToToc (built-in)
 559
 560 InsetLayout Wrap
 561         LabelFont
 562           Color               collapsible
 563           Size                Small
 564         EndFont
 565         MultiPar              true
 566         RefPrefix             wrap
 567         HTMLStyle
 568                 div.wrap {
 569                         float: right;
 570                         border: 2px solid black;
 571                         padding: 1ex;
 572                         margin: 1ex;
 573                 }
 574         EndHTMLStyle
 575 End
 576
 577 InsetLayout "Flex:URL"
 578         LyXType               standard
 579         Decoration            classic
 580         LabelString           URL
 581         ContentAsLabel        true
 582         LatexName             url
 583         LatexType             command
 584         Requires              url
 585         MultiPar              false
 586         CustomPars            false
 587         ForcePlain            true
 588         PassThru              true
 589         FreeSpacing           true
 590         ForceLTR              true
 591         NeedCProtect          true
 592         Font
 593           Family              Typewriter
 594           Color               urltext
 595         EndFont
 596         LabelFont
 597           Family              Typewriter
 598           Color               urllabel
 599           Size                Small
 600         EndFont
 601         HTMLIsBlock           false
 602         DocBookTag            link
 603 End
 604
 605 InsetLayout Argument
 606         LabelString           Argument
 607         LabelFont
 608           Color               collapsible
 609           Size                Small
 610         EndFont
 611         MultiPar              false
 612         ForceLocalFontSwitch  1
 613 End
 614
 615 InsetLayout Info
 616         Decoration            conglomerate
 617         HTMLStyle
 618                 span.info { font-family: sans-serif; }
 619         EndHTMLStyle
 620         HTMLTag               span
 621         MultiPar              false
 622 End
 623
 624 InsetLayout Info:menu
 625         CopyStyle             Info
 626         LatexType             command
 627         LatexName             menuitem
 628         Preamble
 629           \providecommand{\menuitem}[1]{\textsf{#1}}
 630         EndPreamble
 631         Decoration            conglomerate
 632         Font
 633           Family              sans
 634         EndFont
 635         HTMLAttr              "class='info menu'"
 636         HTMLStyle
 637                 span.menu { font-family: sans-serif; }
 638         EndHTMLStyle
 639         DocBookTag            guimenu
 640         DocBookTagType        inline
 641 End
 642
 643 InsetLayout Info:shortcut
 644         CopyStyle             Info
 645         LatexType             command
 646         LatexName             shortcut
 647         Preamble
 648           \providecommand{\shortcut}[1]{\mbox{\textsf{#1}}}
 649         EndPreamble
 650         Decoration            conglomerate
 651         Font
 652           Family              sans
 653         EndFont
 654         HTMLAttr              "class='info shortcut'"
 655         HTMLStyle
 656                 span.shortcut { font-family: sans-serif; }
 657         EndHTMLStyle
 658         DocBookWrapperTag     keycombo
 659         DocBookWrapperTagType inline
 660         DocBookTag            keycap
 661         DocBookTagType        inline
 662 End
 663
 664 InsetLayout Info:shortcuts
 665         CopyStyle             Info
 666         LatexType             command
 667         LatexName             shortcut
 668         Preamble
 669           \providecommand{\shortcut}[1]{\textsf{#1}}
 670         EndPreamble
 671         Decoration            conglomerate
 672         Font
 673           Family              sans
 674         EndFont
 675         HTMLAttr              "class='info shortcut'"
 676         HTMLStyle
 677                 span.shortcuts { font-family: sans-serif; }
 678         EndHTMLStyle
 679         DocBookWrapperTag     keycombo
 680         DocBookWrapperTagType inline
 681         DocBookTag            keycap
 682         DocBookTagType        inline
 683 End
 684
 685 InsetLayout Caption:Standard
 686         LabelString          standard
 687         LaTeXType            command
 688         LatexName            caption
 689         NeedProtect          1
 690         MultiPar             false
 691         Argument 1
 692                 LabelString   "Short Title|S"
 693                 Tooltip       "The caption as it appears in the list of figures/tables"
 694                 InsertCotext  1
 695         EndArgument
 696         HTMLStyle
 697                 div.float-caption {
 698                         text-align: center;
 699                         border: 2px solid black;
 700                         padding: 1ex;
 701                         margin: 1ex;
 702                 }
 703         EndHTMLStyle
 704         HTMLAttr "class='float-caption float-caption-standard'"
 705 End
 706
 707
 708 InsetLayout Caption:Unnumbered
 709         CopyStyle            Caption:Standard
 710         LabelString          unlabelled
 711         LatexName            caption*
 712         ResetArgs            1
 713 End
 714
 715
 716 InsetLayout Preview
 717         LabelString           Preview
 718         Decoration            minimalistic
 719         MultiPar              true
 720 End
 721
 722
 723 InsetLayout Script
 724         LatexType       command
 725         MultiPar        false
 726         ForcePlain      1
 727         CustomPars      0
 728         InToc           1
 729         HTMLIsBlock     0
 730 End
 731
 732
 733 InsetLayout Script:superscript
 734         CopyStyle       Script
 735         LaTeXName       textsuperscript
 736         HTMLTag         sup
 737 End
 738
 739
 740 InsetLayout Script:subscript
 741         CopyStyle       Script
 742         Requires        subscript
 743         LaTeXName       textsubscript
 744         HTMLTag         sub
 745 End
 746
 747
 748 InsetLayout PrintNomencl
 749         BabelPreamble
 750                 \addto\captions$$lang{%
 751                         \def\eqdeclaration#1{, _(see equation[[nomencl]])\nobreakspace(#1)}%
 752                         \def\pagedeclaration#1{, _(page[[nomencl]])\nobreakspace#1}%
 753                         \def\nomname{_(Nomenclature[[output]])}%
 754                 }
 755         EndBabelPreamble
 756         # The command is defined for several languages in nomencl.sty. However, we need to define
 757         # it anyway for the other, non suppported languages.
 758         LangPreamble
 759                 \def\eqdeclaration#1{, _(see equation[[nomencl]])\nobreakspace(#1)}
 760                 \def\pagedeclaration#1{, _(page[[nomencl]])\nobreakspace#1}
 761                 \def\nomname{_(Nomenclature[[output]])}
 762         EndLangPreamble
 763         HTMLTag h2
 764 End
 765
 766 InsetLayout Tabular
 767         HTMLStyle
 768                 table {
 769                         border-collapse: collapse;
 770                         display: inline-block;
 771                 }
 772                 td {
 773                         border: 1px solid black;
 774                         padding: 0.5ex;
 775                 }
 776         EndHTMLStyle
 777 End