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