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