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 95
   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           Size                Normal
 184           Color               greyedouttext
 185         EndFont
 186         LabelFont
 187           Color               greyedout
 188           Size                Small
 189         EndFont
 190         MultiPar              true
 191         Display               false
 192         HTMLInnerTag div
 193         HTMLStyle
 194                 div.note_greyedout {
 195                         display: inline;
 196                         color: #A0A0A0;
 197                         padding-left: 1ex;
 198                         padding-right: 1ex;
 199                 }
 200         EndHTMLStyle
 201         HTMLIsBlock           false
 202         AddToToc              note
 203         IsTocCaption          true
 204         NeedCProtect          true
 205 End
 206
 207 InsetLayout ERT
 208         LabelString           ERT
 209         LatexType             none
 210         Decoration            minimalistic
 211         Font
 212           Color               latex
 213           Family              typewriter
 214         EndFont
 215         LabelFont
 216           Color               latex
 217           Size                Small
 218         EndFont
 219         MultiPar              true
 220         CustomPars            false
 221         ForcePlain            true
 222         PassThru              true
 223         ParbreakIsNewline     true
 224         KeepEmpty             true
 225         FreeSpacing           true
 226         ForceLTR              true
 227         EditExternal          true
 228 End
 229
 230 InsetLayout Phantom
 231         Decoration            minimalistic
 232         Font
 233           Color               phantomtext
 234         EndFont
 235         MultiPar              false
 236         CustomPars            false
 237         ForcePlain            true
 238 End
 239
 240 InsetLayout IPADeco
 241         Decoration            minimalistic
 242         Font
 243           Color               foreground
 244         EndFont
 245         MultiPar              false
 246         CustomPars            false
 247         ForcePlain            true
 248 End
 249
 250 InsetLayout TOC
 251   HTMLTag h2
 252   HTMLStyle
 253     div.toc {
 254       margin: 2em 0em;
 255       border-style: solid;
 256       border-width: 2px 0px;
 257       padding: 1em 0em;
 258     }
 259     h2.tochead { font-size: x-large; font-weight: bold; }
 260     div.lyxtoc-0 {
 261       margin: 2em 0em 0em 0em;
 262       font-size: xx-large;
 263       font-weight: bold;
 264     }
 265     div.lyxtoc-1 {
 266       margin: 1em 0em 0em 0em;
 267       font-size: x-large;
 268       font-weight: bold;
 269     }
 270     div.lyxtoc-2 {
 271       margin: 0.5em 0.1em 0em 1em;
 272       font-size: large;
 273       font-weight: normal;
 274     }
 275     div.lyxtoc-3 { margin: 0.2em 0.1em 0em 0.5em; font-size: medium; }
 276     div.lyxtoc-4 { margin: 0em 0.1em 0em 0.5em; }
 277     div.lyxtoc-5 { margin: 0em 0.1em 0em 0.5em; }
 278     div.lyxtoc-6 { margin: 0em 0.1em 0em 0.5em; }
 279     a.tocentry {
 280       text-decoration: none;
 281       color: black;
 282     }
 283     a.tocentry:visited { color: black; }
 284   EndHTMLStyle
 285 End
 286
 287 InsetLayout TOC:Listings
 288         # We need the [[List of Listings]] context, since "Listings" is also
 289         # the name of the inset and translated differently.
 290         # "Listings[[List of Listings]]" is the name of the "List of listings"
 291         # ("Listings" is the predefined english name) in listings.sty, so it
 292         # must be used here as well.
 293         BabelPreamble
 294                 \addto\captions$$lang{\renewcommand{\lstlistlistingname}{_(Listings[[List of Listings]])}}
 295         EndBabelPreamble
 296         # The command does not need to be defined in LangPreamble, since
 297         # listings.sty does that already. However it needs to be redefined
 298         # in order to be used for non-english single-language documents.
 299         LangPreamble
 300                 \renewcommand{\lstlistlistingname}{_(Listings[[List of Listings]])}
 301         EndLangPreamble
 302         FixedWidthPreambleEncoding true
 303   HTMLTag h2
 304   HTMLStyle
 305     div.lyxtoc-flat {
 306       margin: 0em 0em 0em 1em;
 307       font-size: large;
 308       font-weight: normal;
 309     }
 310   EndHTMLStyle
 311 End
 312
 313 InsetLayout TOC:MintedListings
 314         # "List of Listings" is the name of the "List of listings"
 315         # in minted.sty so it must be used here as well.
 316         BabelPreamble
 317                 \addto\captions$$lang{\renewcommand{\listoflistingscaption}{_(List of Listings)}}
 318         EndBabelPreamble
 319         # The command does not need to be defined in LangPreamble, since
 320         # minted.sty does that already. However it needs to be redefined
 321         # in order to be used for non-english single-language documents.
 322         LangPreamble
 323                 \renewcommand{\listoflistingscaption}{_(List of Listings)}
 324         EndLangPreamble
 325         FixedWidthPreambleEncoding false
 326   HTMLTag h2
 327   HTMLStyle
 328     div.lyxtoc-flat {
 329       margin: 0em 0em 0em 1em;
 330       font-size: large;
 331       font-weight: normal;
 332     }
 333   EndHTMLStyle
 334 End
 335
 336 InsetLayout Include:Listings
 337         BabelPreamble
 338                 \addto\captions$$lang{\renewcommand{\lstlistingname}{_(Listing)}}
 339         EndBabelPreamble
 340         # The command does not need to be defined in LangPreamble, since
 341         # listings.sty does that already. However it needs to be redefined
 342         # in order to be used for non-english single-language documents.
 343         LangPreamble
 344                 \renewcommand{\lstlistingname}{_(Listing)}
 345         EndLangPreamble
 346         FixedWidthPreambleEncoding true
 347 End
 348
 349 InsetLayout Listings
 350         CopyStyle Include:Listings
 351         LabelString           Listings[[inset]]
 352         LatexType             none
 353         Decoration            minimalistic
 354         Font
 355           Color               foreground
 356           Family              typewriter
 357         EndFont
 358         LabelFont
 359           Color               foreground
 360           Size                Small
 361         EndFont
 362         BgColor               listingsbg
 363         MultiPar              true
 364         PassThru              true
 365         ParbreakIsNewline     true
 366         KeepEmpty             true
 367         FreeSpacing           true
 368         ForceLTR              true
 369         ForcePlain            true
 370         NeedCProtect          true
 371         RefPrefix             lst
 372         EditExternal          true
 373         HTMLTag               pre
 374         HTMLStyle
 375                 div.float-listings {
 376                         border: 2px solid black;
 377                         padding: 1ex;
 378                         margin: 1ex;
 379                 }
 380                 div.listings-caption {
 381                         text-align: center;
 382                         border: 2px solid black;
 383                         padding: 1ex;
 384                         margin: 1ex;
 385         }
 386         EndHTMLStyle
 387         DocBookTag            programlisting
 388 End
 389
 390 InsetLayout MintedListings
 391         CopyStyle Listings
 392         BabelPreamble
 393                 \addto\captions$$lang{\renewcommand{\listingscaption}{_(Listing)}}
 394         EndBabelPreamble
 395         # The command does not need to be defined in LangPreamble, since
 396         # minted.sty does that already. However it needs to be redefined
 397         # in order to be used for non-english single-language documents.
 398         LangPreamble
 399                 \renewcommand{\listingscaption}{_(Listing)}
 400         EndLangPreamble
 401         FixedWidthPreambleEncoding false
 402 End
 403
 404 InsetLayout Branch
 405         Decoration            classic
 406         LabelFont
 407           Color               branchlabel
 408           Size                Small
 409         EndFont
 410         MultiPar              true
 411         InToc                 true
 412         HTMLIsBlock           false
 413         AddToToc              branch
 414         IsTocCaption          true
 415 End
 416
 417 InsetLayout Index
 418         LabelString           Idx
 419         Decoration            classic
 420         Font
 421           Size                Small
 422         EndFont
 423         LabelFont
 424           Color               indexlabel
 425           Size                Small
 426         EndFont
 427         MultiPar              false
 428         CustomPars            false
 429         ForcePlain            true
 430         ContentAsLabel        true
 431         PassThruChars         @|!
 432 End
 433
 434 InsetLayout Box
 435         LabelFont
 436           Color               foreground
 437           Size                Small
 438         EndFont
 439         MultiPar              true
 440         DocBookWrapperTag     sidebar
 441         DocBookTag            para
 442 End
 443
 444 InsetLayout Box:Frameless
 445         CopyStyle Box
 446         HTMLStyle
 447                 div.Frameless { margin: 1em; }
 448         EndHTMLStyle
 449         DocBookWrapperTag     sidebar
 450         DocBookTag            para
 451         DocBookWrapperAttr    role='frameless'
 452 End
 453
 454 InsetLayout Box:Shaded
 455         CopyStyle Box
 456         BgColor shaded
 457         HTMLStyle
 458                 div.Shaded {
 459                         background-color: gray;
 460                         padding: 0.5ex;
 461                 }
 462         EndHTMLStyle
 463         DocBookWrapperTag     sidebar
 464         DocBookTag            para
 465         DocBookWrapperAttr    role='shaded'
 466 End
 467
 468 InsetLayout Box:Boxed
 469         CopyStyle Box
 470         HTMLStyle
 471                 div.Boxed {
 472                         border: solid thick black;
 473                         padding: 0.5ex;
 474                 }
 475         EndHTMLStyle
 476         DocBookWrapperTag     sidebar
 477         DocBookTag            para
 478         DocBookWrapperAttr    role='boxed'
 479 End
 480
 481 InsetLayout Box:Framed
 482         CopyStyle Box
 483         HTMLStyle
 484                 div.Framed {
 485                         border: solid thick black;
 486                         padding: 0.5ex;
 487                 }
 488         EndHTMLStyle
 489         DocBookWrapperTag     sidebar
 490         DocBookTag            para
 491         DocBookWrapperAttr    role='framed'
 492 End
 493
 494 InsetLayout Box:ovalbox
 495         CopyStyle Box
 496         HTMLStyle
 497                 div.ovalbox {
 498                         border: groove medium black;
 499                         padding: 0.5ex;
 500                 }
 501         EndHTMLStyle
 502         DocBookWrapperTag     sidebar
 503         DocBookTag            para
 504         DocBookWrapperAttr    role='ovalbox'
 505 End
 506
 507 InsetLayout Box:Ovalbox
 508         CopyStyle Box
 509         HTMLStyle
 510                 div.Ovalbox {
 511                         border: ridge thick black;
 512                         padding: 0.5ex;
 513                 }
 514         EndHTMLStyle
 515         DocBookWrapperTag     sidebar
 516         DocBookTag            para
 517         DocBookWrapperAttr    role='ovalbox-var'
 518 End
 519
 520 InsetLayout Box:Shadowbox
 521         CopyStyle Box
 522         HTMLStyle
 523                 div.Shadowbox { border: solid gray medium; border-bottom: solid black 1ex; border-right: solid black 1ex; padding: 0.5ex; }
 524         EndHTMLStyle
 525         DocBookWrapperTag     sidebar
 526         DocBookTag            para
 527         DocBookWrapperAttr    role='shadowbox'
 528 End
 529
 530 InsetLayout Box:Doublebox
 531         CopyStyle Box
 532         HTMLStyle
 533                 div.Doublebox {
 534                         border: double thick black;
 535                         padding: 0.5ex;
 536                 }
 537         EndHTMLStyle
 538         DocBookWrapperTag     sidebar
 539         DocBookTag            para
 540         DocBookWrapperAttr    role='doublebox'
 541 End
 542
 543 InsetLayout Float
 544         LaTeXType             environment
 545         LabelFont
 546           Color               collapsible
 547           Size                Small
 548         EndFont
 549         MultiPar              true
 550         HTMLStyle
 551                 div.float {
 552                         border: 2px solid black;
 553                         text-align: center;
 554                 }
 555         EndHTMLStyle
 556 End
 557
 558 #InsetWrap requires these, independently of whether stdfloats.inc is included
 559 OutlinerName table        "Tables" #no AddToToc (built-in)
 560 OutlinerName figure       "Figures" #no AddToToc (built-in)
 561
 562 InsetLayout Wrap
 563         LabelFont
 564           Color               collapsible
 565           Size                Small
 566         EndFont
 567         MultiPar              true
 568         RefPrefix             wrap
 569         HTMLStyle
 570                 div.wrap {
 571                         float: right;
 572                         border: 2px solid black;
 573                         padding: 1ex;
 574                         margin: 1ex;
 575                 }
 576         EndHTMLStyle
 577 End
 578
 579 InsetLayout "Flex:URL"
 580         LyXType               standard
 581         Decoration            classic
 582         LabelString           URL
 583         ContentAsLabel        true
 584         LatexName             url
 585         LatexType             command
 586         Requires              url
 587         MultiPar              false
 588         CustomPars            false
 589         ForcePlain            true
 590         PassThru              true
 591         FreeSpacing           true
 592         ForceLTR              true
 593         NeedCProtect          true
 594         Font
 595           Family              Typewriter
 596           Color               urltext
 597         EndFont
 598         LabelFont
 599           Family              Typewriter
 600           Color               urllabel
 601           Size                Small
 602         EndFont
 603         HTMLIsBlock           false
 604         DocBookTag            link
 605         DocBookTagType        inline
 606 End
 607
 608 InsetLayout Argument
 609         LabelString           Argument
 610         LabelFont
 611           Color               collapsible
 612           Size                Small
 613         EndFont
 614         MultiPar              false
 615         ForceLocalFontSwitch  1
 616 End
 617
 618 InsetLayout Info
 619         Decoration            conglomerate
 620         HTMLStyle
 621                 span.info { font-family: sans-serif; }
 622         EndHTMLStyle
 623         HTMLTag               span
 624         MultiPar              false
 625 End
 626
 627 InsetLayout Info:menu
 628         CopyStyle             Info
 629         LatexType             command
 630         LatexName             menuitem
 631         Preamble
 632           \providecommand{\menuitem}[1]{\textsf{#1}}
 633         EndPreamble
 634         Decoration            conglomerate
 635         Font
 636           Family              sans
 637         EndFont
 638         HTMLAttr              "class='info menu'"
 639         HTMLStyle
 640                 span.menu { font-family: sans-serif; }
 641         EndHTMLStyle
 642         DocBookTag            guimenu
 643         DocBookTagType        inline
 644 End
 645
 646 InsetLayout Info:shortcut
 647         CopyStyle             Info
 648         LatexType             command
 649         LatexName             shortcut
 650         Preamble
 651           \providecommand{\shortcut}[1]{\mbox{\textsf{#1}}}
 652         EndPreamble
 653         Decoration            conglomerate
 654         Font
 655           Family              sans
 656         EndFont
 657         HTMLAttr              "class='info shortcut'"
 658         HTMLStyle
 659                 span.shortcut { font-family: sans-serif; }
 660         EndHTMLStyle
 661         DocBookWrapperTag     keycombo
 662         DocBookWrapperTagType inline
 663         DocBookTag            keycap
 664         DocBookTagType        inline
 665 End
 666
 667 InsetLayout Info:shortcuts
 668         CopyStyle             Info
 669         LatexType             command
 670         LatexName             shortcut
 671         Preamble
 672           \providecommand{\shortcut}[1]{\textsf{#1}}
 673         EndPreamble
 674         Decoration            conglomerate
 675         Font
 676           Family              sans
 677         EndFont
 678         HTMLAttr              "class='info shortcut'"
 679         HTMLStyle
 680                 span.shortcuts { font-family: sans-serif; }
 681         EndHTMLStyle
 682         DocBookWrapperTag     keycombo
 683         DocBookWrapperTagType inline
 684         DocBookTag            keycap
 685         DocBookTagType        inline
 686 End
 687
 688 InsetLayout Caption:Standard
 689         LabelString          standard
 690         LaTeXType            command
 691         LatexName            caption
 692         NeedProtect          1
 693         MultiPar             false
 694         Argument 1
 695                 LabelString   "Short Title|S"
 696                 Tooltip       "The caption as it appears in the list of figures/tables"
 697                 InsertCotext  1
 698         DocBookTag    titleabbrev
 699         DocBookArgumentAfterMainTag  true
 700         EndArgument
 701         HTMLStyle
 702                 div.float-caption {
 703                         text-align: center;
 704                         border: 2px solid black;
 705                         padding: 1ex;
 706                         margin: 1ex;
 707                 }
 708         EndHTMLStyle
 709         HTMLAttr "class='float-caption float-caption-standard'"
 710 End
 711
 712
 713 InsetLayout Caption:Unnumbered
 714         CopyStyle            Caption:Standard
 715         LabelString          unlabelled
 716         LatexName            caption*
 717         ResetArgs            1
 718 End
 719
 720
 721 InsetLayout Preview
 722         LabelString           Preview
 723         Decoration            minimalistic
 724         MultiPar              true
 725 End
 726
 727
 728 InsetLayout Script
 729         LatexType       command
 730         MultiPar        false
 731         ForcePlain      1
 732         CustomPars      0
 733         InToc           1
 734         HTMLIsBlock     0
 735 End
 736
 737
 738 InsetLayout Script:superscript
 739         CopyStyle       Script
 740         LaTeXName       textsuperscript
 741         HTMLTag         sup
 742 End
 743
 744
 745 InsetLayout Script:subscript
 746         CopyStyle       Script
 747         Requires        subscript
 748         LaTeXName       textsubscript
 749         HTMLTag         sub
 750 End
 751
 752
 753 InsetLayout PrintNomencl
 754         BabelPreamble
 755                 \addto\captions$$lang{%
 756                         \def\eqdeclaration#1{, _(see equation[[nomencl]])\nobreakspace(#1)}%
 757                         \def\pagedeclaration#1{, _(page[[nomencl]])\nobreakspace#1}%
 758                         \def\nomname{_(Nomenclature[[output]])}%
 759                 }
 760         EndBabelPreamble
 761         # The command is defined for several languages in nomencl.sty. However, we need to define
 762         # it anyway for the other, non suppported languages.
 763         LangPreamble
 764                 \def\eqdeclaration#1{, _(see equation[[nomencl]])\nobreakspace(#1)}
 765                 \def\pagedeclaration#1{, _(page[[nomencl]])\nobreakspace#1}
 766                 \def\nomname{_(Nomenclature[[output]])}
 767         EndLangPreamble
 768         HTMLTag h2
 769 End
 770
 771 InsetLayout Tabular
 772         HTMLStyle
 773                 table {
 774                         border-collapse: collapse;
 775                         display: inline-block;
 776                 }
 777                 td {
 778                         border: 1px solid black;
 779                         padding: 0.5ex;
 780                 }
 781         EndHTMLStyle
 782 End