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 IndexMacro:see
 435         LabelString           See
 436         Decoration            classic
 437         Font
 438           Size                Small
 439         EndFont
 440         LabelFont
 441           Color               indexlabel
 442           Size                Small
 443         EndFont
 444         MultiPar              false
 445         CustomPars            false
 446         ForcePlain            true
 447 End
 448
 449 InsetLayout IndexMacro:seealso
 450         CopyStyle             IndexMacro:see
 451         LabelString           "See also"
 452 End
 453
 454 InsetLayout IndexMacro:sortkey
 455         CopyStyle             IndexMacro:see
 456         LabelString           "Sort as"
 457 End
 458
 459 InsetLayout IndexMacro:subindex
 460         CopyStyle             IndexMacro:see
 461         LabelString           "Subindex"
 462 End
 463
 464 InsetLayout Box
 465         LabelFont
 466           Color               foreground
 467           Size                Small
 468         EndFont
 469         MultiPar              true
 470         DocBookWrapperTag     sidebar
 471         DocBookTag            para
 472 End
 473
 474 InsetLayout Box:Frameless
 475         CopyStyle Box
 476         HTMLStyle
 477                 div.Frameless { margin: 1em; }
 478         EndHTMLStyle
 479         DocBookWrapperTag     sidebar
 480         DocBookTag            para
 481         DocBookWrapperAttr    role='frameless'
 482 End
 483
 484 InsetLayout Box:Shaded
 485         CopyStyle Box
 486         BgColor shaded
 487         HTMLStyle
 488                 div.Shaded {
 489                         background-color: gray;
 490                         padding: 0.5ex;
 491                 }
 492         EndHTMLStyle
 493         DocBookWrapperTag     sidebar
 494         DocBookTag            para
 495         DocBookWrapperAttr    role='shaded'
 496 End
 497
 498 InsetLayout Box:Boxed
 499         CopyStyle Box
 500         HTMLStyle
 501                 div.Boxed {
 502                         border: solid thick black;
 503                         padding: 0.5ex;
 504                 }
 505         EndHTMLStyle
 506         DocBookWrapperTag     sidebar
 507         DocBookTag            para
 508         DocBookWrapperAttr    role='boxed'
 509 End
 510
 511 InsetLayout Box:Framed
 512         CopyStyle Box
 513         HTMLStyle
 514                 div.Framed {
 515                         border: solid thick black;
 516                         padding: 0.5ex;
 517                 }
 518         EndHTMLStyle
 519         DocBookWrapperTag     sidebar
 520         DocBookTag            para
 521         DocBookWrapperAttr    role='framed'
 522 End
 523
 524 InsetLayout Box:ovalbox
 525         CopyStyle Box
 526         HTMLStyle
 527                 div.ovalbox {
 528                         border: groove medium black;
 529                         padding: 0.5ex;
 530                 }
 531         EndHTMLStyle
 532         DocBookWrapperTag     sidebar
 533         DocBookTag            para
 534         DocBookWrapperAttr    role='ovalbox'
 535 End
 536
 537 InsetLayout Box:Ovalbox
 538         CopyStyle Box
 539         HTMLStyle
 540                 div.Ovalbox {
 541                         border: ridge thick black;
 542                         padding: 0.5ex;
 543                 }
 544         EndHTMLStyle
 545         DocBookWrapperTag     sidebar
 546         DocBookTag            para
 547         DocBookWrapperAttr    role='ovalbox-var'
 548 End
 549
 550 InsetLayout Box:Shadowbox
 551         CopyStyle Box
 552         HTMLStyle
 553                 div.Shadowbox { border: solid gray medium; border-bottom: solid black 1ex; border-right: solid black 1ex; padding: 0.5ex; }
 554         EndHTMLStyle
 555         DocBookWrapperTag     sidebar
 556         DocBookTag            para
 557         DocBookWrapperAttr    role='shadowbox'
 558 End
 559
 560 InsetLayout Box:Doublebox
 561         CopyStyle Box
 562         HTMLStyle
 563                 div.Doublebox {
 564                         border: double thick black;
 565                         padding: 0.5ex;
 566                 }
 567         EndHTMLStyle
 568         DocBookWrapperTag     sidebar
 569         DocBookTag            para
 570         DocBookWrapperAttr    role='doublebox'
 571 End
 572
 573 InsetLayout Float
 574         LaTeXType             environment
 575         LabelFont
 576           Color               collapsible
 577           Size                Small
 578         EndFont
 579         MultiPar              true
 580         HTMLStyle
 581                 div.float {
 582                         border: 2px solid black;
 583                         text-align: center;
 584                 }
 585         EndHTMLStyle
 586 End
 587
 588 #InsetWrap requires these, independently of whether stdfloats.inc is included
 589 OutlinerName table        "Tables" #no AddToToc (built-in)
 590 OutlinerName figure       "Figures" #no AddToToc (built-in)
 591
 592 InsetLayout Wrap
 593         LabelFont
 594           Color               collapsible
 595           Size                Small
 596         EndFont
 597         MultiPar              true
 598         RefPrefix             wrap
 599         HTMLStyle
 600                 div.wrap {
 601                         float: right;
 602                         border: 2px solid black;
 603                         padding: 1ex;
 604                         margin: 1ex;
 605                 }
 606         EndHTMLStyle
 607 End
 608
 609 InsetLayout "Flex:URL"
 610         LyXType               standard
 611         Decoration            classic
 612         LabelString           URL
 613         ContentAsLabel        true
 614         LatexName             url
 615         LatexType             command
 616         Requires              url
 617         MultiPar              false
 618         CustomPars            false
 619         ForcePlain            true
 620         PassThru              true
 621         FreeSpacing           true
 622         ForceLTR              true
 623         NeedCProtect          true
 624         Font
 625           Family              Typewriter
 626           Color               urltext
 627         EndFont
 628         LabelFont
 629           Family              Typewriter
 630           Color               urllabel
 631           Size                Small
 632         EndFont
 633         HTMLIsBlock           false
 634         DocBookTag            link
 635         DocBookTagType        inline
 636 End
 637
 638 InsetLayout Argument
 639         LabelString           Argument
 640         LabelFont
 641           Color               collapsible
 642           Size                Small
 643         EndFont
 644         MultiPar              false
 645         ForceLocalFontSwitch  1
 646 End
 647
 648 InsetLayout Info
 649         Decoration            conglomerate
 650         HTMLStyle
 651                 span.info { font-family: sans-serif; }
 652         EndHTMLStyle
 653         HTMLTag               span
 654         MultiPar              false
 655         SpellCheck            false
 656 End
 657
 658 InsetLayout Info:menu
 659         CopyStyle             Info
 660         LatexType             command
 661         LatexName             menuitem
 662         Preamble
 663           \providecommand{\menuitem}[1]{\textsf{#1}}
 664         EndPreamble
 665         Decoration            conglomerate
 666         Font
 667           Family              sans
 668         EndFont
 669         HTMLAttr              "class='info menu'"
 670         HTMLStyle
 671                 span.menu { font-family: sans-serif; }
 672         EndHTMLStyle
 673         DocBookTag            guimenu
 674         DocBookTagType        inline
 675 End
 676
 677 InsetLayout Info:shortcut
 678         CopyStyle             Info
 679         LatexType             command
 680         LatexName             shortcut
 681         Preamble
 682           \providecommand{\shortcut}[1]{\mbox{\textsf{#1}}}
 683         EndPreamble
 684         Decoration            conglomerate
 685         Font
 686           Family              sans
 687         EndFont
 688         HTMLAttr              "class='info shortcut'"
 689         HTMLStyle
 690                 span.shortcut { font-family: sans-serif; }
 691         EndHTMLStyle
 692         DocBookWrapperTag     keycombo
 693         DocBookWrapperTagType inline
 694         DocBookTag            keycap
 695         DocBookTagType        inline
 696 End
 697
 698 InsetLayout Info:shortcuts
 699         CopyStyle             Info
 700         LatexType             command
 701         LatexName             shortcut
 702         Preamble
 703           \providecommand{\shortcut}[1]{\textsf{#1}}
 704         EndPreamble
 705         Decoration            conglomerate
 706         Font
 707           Family              sans
 708         EndFont
 709         HTMLAttr              "class='info shortcut'"
 710         HTMLStyle
 711                 span.shortcuts { font-family: sans-serif; }
 712         EndHTMLStyle
 713         DocBookWrapperTag     keycombo
 714         DocBookWrapperTagType inline
 715         DocBookTag            keycap
 716         DocBookTagType        inline
 717 End
 718
 719 InsetLayout Caption:Standard
 720         LabelString          standard
 721         LaTeXType            command
 722         LatexName            caption
 723         NeedProtect          1
 724         MultiPar             false
 725         Argument 1
 726                 LabelString   "Short Title|S"
 727                 Tooltip       "The caption as it appears in the list of figures/tables"
 728                 InsertCotext  1
 729         DocBookTag    titleabbrev
 730         DocBookArgumentAfterMainTag  true
 731         EndArgument
 732         HTMLStyle
 733                 div.float-caption {
 734                         text-align: center;
 735                         border: 2px solid black;
 736                         padding: 1ex;
 737                         margin: 1ex;
 738                 }
 739         EndHTMLStyle
 740         HTMLAttr "class='float-caption float-caption-standard'"
 741 End
 742
 743
 744 InsetLayout Caption:Unnumbered
 745         CopyStyle            Caption:Standard
 746         LabelString          unlabelled
 747         LatexName            caption*
 748         ResetArgs            1
 749 End
 750
 751
 752 InsetLayout Preview
 753         LabelString           Preview
 754         Decoration            minimalistic
 755         MultiPar              true
 756 End
 757
 758
 759 InsetLayout Script
 760         LatexType       command
 761         MultiPar        false
 762         ForcePlain      1
 763         CustomPars      0
 764         InToc           1
 765         HTMLIsBlock     0
 766 End
 767
 768
 769 InsetLayout Script:superscript
 770         CopyStyle       Script
 771         LaTeXName       textsuperscript
 772         HTMLTag         sup
 773 End
 774
 775
 776 InsetLayout Script:subscript
 777         CopyStyle       Script
 778         Requires        subscript
 779         LaTeXName       textsubscript
 780         HTMLTag         sub
 781 End
 782
 783
 784 InsetLayout PrintNomencl
 785         BabelPreamble
 786                 \addto\captions$$lang{%
 787                         \def\eqdeclaration#1{, _(see equation[[nomencl]])\nobreakspace(#1)}%
 788                         \def\pagedeclaration#1{, _(page[[nomencl]])\nobreakspace#1}%
 789                         \def\nomname{_(Nomenclature[[output]])}%
 790                 }
 791         EndBabelPreamble
 792         # The command is defined for several languages in nomencl.sty. However, we need to define
 793         # it anyway for the other, non suppported languages.
 794         LangPreamble
 795                 \def\eqdeclaration#1{, _(see equation[[nomencl]])\nobreakspace(#1)}
 796                 \def\pagedeclaration#1{, _(page[[nomencl]])\nobreakspace#1}
 797                 \def\nomname{_(Nomenclature[[output]])}
 798         EndLangPreamble
 799         HTMLTag h2
 800 End
 801
 802 InsetLayout Tabular
 803         HTMLStyle
 804                 table {
 805                         border-collapse: collapse;
 806                         display: inline-block;
 807                 }
 808                 td {
 809                         padding: 0.5ex;
 810                 }
 811         EndHTMLStyle
 812 End