# Author : Martin vermeer <martin.vermeer@hut.fi>
# Inset layouts definition
#
-# More detailled format description is available in the customization manual
-# FIXME: create the contents in the manual and put the link here.
-#
-#InsetLayout <string identifier used by LyX>
-# LabelString used for the inset decoration (either the inset button
-# or the text underneath the inset).
-# LatexType associated LateX type: command, environment, or none.
-# LatexName associated LateX command.
-# BgColor Color of the inset background within LyX.
-# FIXME: link to a doc file describing the different
-# color codes as defined in 'ColorCode.h'
-# Font Nothing to put here, below are descriptions of the different
-# allowable adjustments for the font used to draw the text
-# appearing within the inset text. All these items are optional.
-# Color Color of text
-# Size Font size of the textallowed value: Small, Smaller, ...
-# FIXME defined in FontSize in FontEnums.h
-# Family FIXME defined in FontFamily in FontEnums.h
-# Shape FIXME defined in FontShape in FontEnums.h
-# Series FIXME defined in FontSeries in FontEnums.h
-# Misc FIXME defined in FontMisc in FontEnums.h
-# EndFont Nothing to put here, it's just a markup to indicate that we are
-# finished with the Font definition.
-# LabelFont Nothing to put here, below are descriptions of the different
-# allowable adjustments for the font used to draw the text
-# appearing within the inset decoration. All these items are
-# optional.
-# Color see definition above (in the Font node).
-# Size see definition above (in the Font node).
-#
-# EndFont Nothing to put here, it's just a markup to indicate that we are
-# finished with the LabelFont definition.
-# MultiPar Indicates that multiple paragraphs are allowed within the inset
-# or not. FIXME: what is the default?
-# Decoration: Classic, Minimalistic, Conglomerate. Decoration styles
-# PassThru Do not do various LaTeX conversions, like the phrases
-# LaTeX, LyX, quote commands, etc.
-# KeepEmpty Do not delete empty paragraphs (?)
-# FreeSpacing Preserve multiple spaces etc.
-# ForceLTR Force the "latex" language, leading to Left-to-Right
-# (latin) output, e.g., in ERT or URL. A kludge.
-# Requires Require a given (supported) feature. Multiple features must
-# be comma-separated.
-#End
-
-Format 6
+# Detailed format description is available in the customization manual
+
+Format 89
Provides stdinsets 1
+OutlinerName marginalnote "Marginal notes"
+OutlinerName footnote "Footnotes"
+OutlinerName note "Notes"
+OutlinerName branch "Branches"
+OutlinerName index "Index Entries" #no AddToToc (built-in)
+OutlinerName listing "Listings" #no AddToToc (built-in)
+
InsetLayout Marginal
LabelString margin
LatexType command
LatexName marginpar
Font
- Color foreground
Size Small
- Family Roman
- Shape Up
- Series Medium
- Misc No_Emph
- Misc No_Noun
- Misc No_Bar
EndFont
LabelFont
- Color Red
+ Color marginlabel
Size Small
EndFont
MultiPar true
+ NeedProtect true
+ HTMLStyle
+ div.marginal {
+ border: 2px solid black;
+ padding: 1ex;
+ margin: 1ex;
+ background-color: #F0F0F0;
+ float:right;
+ font-size: small;
+ font-weight: medium;
+ font-family: serif;
+ font-variant: normal;
+ font-style: normal;
+ }
+ EndHTMLStyle
+ AddToToc marginalnote
+ IsTocCaption true
+ DocBookTag para
End
InsetLayout Foot
LabelString foot
- LatexType command
+ LatexType Command
LatexName footnote
+ Counter footnote
Font
- Color foreground
Size Small
- Family Roman
- Shape Up
- Series Medium
- Misc No_Emph
- Misc No_Noun
- Misc No_Bar
EndFont
LabelFont
- Color Green
+ Color footlabel
Size Small
EndFont
MultiPar true
+ RefPrefix fn
+ HTMLLabel \arabic{footnote}
+ HTMLInnerTag div
+ HTMLStyle
+ span.foot_label {
+ vertical-align: super;
+ font-size: smaller;
+ font-weight: bold;
+ text-decoration: underline;
+ }
+ div.foot {
+ display: inline;
+ font-size: small;
+ font-weight: medium;
+ font-family: serif;
+ font-variant: normal;
+ font-style: normal;
+ }
+ div.foot_inner { display: none; }
+ div.foot:hover div.foot_inner {
+ display: block;
+ border: 1px double black;
+ margin: 0em 1em;
+ padding: 1em;
+ }
+ EndHTMLStyle
+ AddToToc footnote
+ IsTocCaption true
+ DocBookTag footnote
+ DocBookTagType inline
End
+InsetLayout Foot:InTitle
+ CopyStyle Foot
+ LatexName thanks
+ NeedProtect true
+ Counter thanks
+ MultiPar false
+ HTMLLabel \fnsymbol{thanks}
+ HTMLInnerTag span
+ HTMLStyle
+ span.foot_intitle_label {
+ vertical-align: super;
+ font-size: smaller;
+ font-weight: bold;
+ text-decoration: underline;
+ }
+ span.foot_intitle {
+ display: inline;
+ font-size: small;
+ font-weight: medium;
+ font-family: serif;
+ font-variant: normal;
+ font-style: normal;
+ }
+ span.foot_intitle_inner { display: none; }
+ span.foot_intitle:hover span.foot_intitle_inner {
+ display: block;
+ border: 1px double black;
+ margin: 0em 1em;
+ padding: 1em;
+ }
+ EndHTMLStyle
+End
+
+InsetLayout Foot:InFloatTable
+ CopyStyle Foot
+ LatexName tablefootnote
+ Requires tablefootnote
+End
+
+
InsetLayout Note:Comment
- LabelString comment
+ LabelString Comment
LatexType environment
LatexName comment
+ Requires verbatim
BgColor commentbg
LabelFont
Color comment
Size Small
EndFont
MultiPar true
+ Display false
+ HTMLTag div
+ HTMLIsBlock true
+ HTMLStyle
+ div.note_comment {
+ display: none;
+ }
+ EndHTMLStyle
+ AddToToc note
+ IsTocCaption true
+ NeedCProtect true
End
InsetLayout Note:Note
- LabelString note
+ LabelString Note
LatexType command
LatexName note
BgColor notebg
Size Small
EndFont
MultiPar true
+ # Not output for XHTML
+ AddToToc note
+ IsTocCaption true
End
+
InsetLayout Note:Greyedout
- LabelString greyedout
+ LabelString Greyedout
LatexType environment
LatexName lyxgreyedout
+ Requires color,lyxgreyedout
BgColor greyedoutbg
+ Font
+ Color greyedouttext
+ EndFont
LabelFont
Color greyedout
Size Small
EndFont
MultiPar true
+ Display false
+ HTMLInnerTag div
+ HTMLStyle
+ div.note_greyedout {
+ display: inline;
+ color: #A0A0A0;
+ padding-left: 1ex;
+ padding-right: 1ex;
+ }
+ EndHTMLStyle
+ HTMLIsBlock false
+ AddToToc note
+ IsTocCaption true
+ NeedCProtect true
End
InsetLayout ERT
Size Small
EndFont
MultiPar true
+ CustomPars false
+ ForcePlain true
PassThru true
+ ParbreakIsNewline true
KeepEmpty true
FreeSpacing true
ForceLTR true
+ EditExternal true
+End
+
+InsetLayout Phantom
+ Decoration minimalistic
+ Font
+ Color phantomtext
+ EndFont
+ MultiPar false
+ CustomPars false
+ ForcePlain true
+End
+
+InsetLayout IPADeco
+ Decoration minimalistic
+ Font
+ Color foreground
+ EndFont
+ MultiPar false
+ CustomPars false
+ ForcePlain true
+End
+
+InsetLayout TOC
+ HTMLTag h2
+ HTMLStyle
+ div.toc {
+ margin: 2em 0em;
+ border-style: solid;
+ border-width: 2px 0px;
+ padding: 1em 0em;
+ }
+ h2.tochead { font-size: x-large; font-weight: bold; }
+ div.lyxtoc-0 {
+ margin: 2em 0em 0em 0em;
+ font-size: xx-large;
+ font-weight: bold;
+ }
+ div.lyxtoc-1 {
+ margin: 1em 0em 0em 0em;
+ font-size: x-large;
+ font-weight: bold;
+ }
+ div.lyxtoc-2 {
+ margin: 0em 0.1em 0em 1em;
+ font-size: large;
+ font-weight: normal;
+ }
+ div.lyxtoc-3 { margin: 0em 0.1em 0em 0.5em; font-size: medium; }
+ div.lyxtoc-4 { margin: 0em 0.1em 0em 0.5em; }
+ div.lyxtoc-5 { margin: 0em 0.1em 0em 0.5em; }
+ div.lyxtoc-6 { margin: 0em 0.1em 0em 0.5em; }
+ a.tocentry {
+ text-decoration: none;
+ color: black;
+ }
+ a.tocentry:visited { color: black; }
+ EndHTMLStyle
+End
+
+InsetLayout TOC:Listings
+ # We need the [[List of Listings]] context, since "Listings" is also
+ # the name of the inset and translated differently.
+ # "Listings[[List of Listings]]" is the name of the "List of listings"
+ # ("Listings" is the predefined english name) in listings.sty, so it
+ # must be used here as well.
+ BabelPreamble
+ \addto\captions$$lang{\renewcommand{\lstlistlistingname}{_(Listings[[List of Listings]])}}
+ EndBabelPreamble
+ # The command does not need to be defined in LangPreamble, since
+ # listings.sty does that already. However it needs to be redefined
+ # in order to be used for non-english single-language documents.
+ LangPreamble
+ \renewcommand{\lstlistlistingname}{_(Listings[[List of Listings]])}
+ EndLangPreamble
+ FixedWidthPreambleEncoding true
+ HTMLTag h2
+ HTMLStyle
+ div.lyxtoc-flat {
+ margin: 0em 0em 0em 1em;
+ font-size: large;
+ font-weight: normal;
+ }
+ EndHTMLStyle
+End
+
+InsetLayout TOC:MintedListings
+ # "List of Listings" is the name of the "List of listings"
+ # in minted.sty so it must be used here as well.
+ BabelPreamble
+ \addto\captions$$lang{\renewcommand{\listoflistingscaption}{_(List of Listings)}}
+ EndBabelPreamble
+ # The command does not need to be defined in LangPreamble, since
+ # minted.sty does that already. However it needs to be redefined
+ # in order to be used for non-english single-language documents.
+ LangPreamble
+ \renewcommand{\listoflistingscaption}{_(List of Listings)}
+ EndLangPreamble
+ FixedWidthPreambleEncoding false
+ HTMLTag h2
+ HTMLStyle
+ div.lyxtoc-flat {
+ margin: 0em 0em 0em 1em;
+ font-size: large;
+ font-weight: normal;
+ }
+ EndHTMLStyle
+End
+
+InsetLayout Include:Listings
+ BabelPreamble
+ \addto\captions$$lang{\renewcommand{\lstlistingname}{_(Listing)}}
+ EndBabelPreamble
+ # The command does not need to be defined in LangPreamble, since
+ # listings.sty does that already. However it needs to be redefined
+ # in order to be used for non-english single-language documents.
+ LangPreamble
+ \renewcommand{\lstlistingname}{_(Listing)}
+ EndLangPreamble
+ FixedWidthPreambleEncoding true
End
InsetLayout Listings
- LabelString Listings
+ CopyStyle Include:Listings
+ LabelString Listings[[inset]]
LatexType none
- Decoration classic
+ Decoration minimalistic
Font
Color foreground
Family typewriter
Color foreground
Size Small
EndFont
+ BgColor listingsbg
MultiPar true
PassThru true
+ ParbreakIsNewline true
KeepEmpty true
FreeSpacing true
+ ForceLTR true
+ ForcePlain true
+ NeedCProtect true
+ RefPrefix lst
+ EditExternal true
+ HTMLTag pre
+ HTMLStyle
+ div.float-listings {
+ border: 2px solid black;
+ padding: 1ex;
+ margin: 1ex;
+ }
+ div.listings-caption {
+ text-align: center;
+ border: 2px solid black;
+ padding: 1ex;
+ margin: 1ex;
+ }
+ EndHTMLStyle
+ DocBookTag programlisting
+End
+
+InsetLayout MintedListings
+ CopyStyle Listings
+ BabelPreamble
+ \addto\captions$$lang{\renewcommand{\listingscaption}{_(Listing)}}
+ EndBabelPreamble
+ # The command does not need to be defined in LangPreamble, since
+ # minted.sty does that already. However it needs to be redefined
+ # in order to be used for non-english single-language documents.
+ LangPreamble
+ \renewcommand{\listingscaption}{_(Listing)}
+ EndLangPreamble
+ FixedWidthPreambleEncoding false
End
InsetLayout Branch
Decoration classic
LabelFont
- Color Red
+ Color branchlabel
Size Small
EndFont
MultiPar true
+ InToc true
+ HTMLIsBlock false
+ AddToToc branch
+ IsTocCaption true
End
InsetLayout Index
LabelString Idx
- LatexType command
- LatexName index
Decoration classic
Font
- Color Green
Size Small
- Family Roman
- Shape Up
- Series Medium
- Misc No_Emph
- Misc No_Noun
- Misc No_Bar
EndFont
LabelFont
- Color Green
+ Color indexlabel
Size Small
EndFont
MultiPar false
- NeedProtect true
+ CustomPars false
+ ForcePlain true
+ ContentAsLabel true
+ PassThruChars @|!
End
InsetLayout Box
Size Small
EndFont
MultiPar true
+ DocBookWrapperTag sidebar
+ DocBookTag para
+End
+
+InsetLayout Box:Frameless
+ CopyStyle Box
+ HTMLStyle
+ div.Frameless { margin: 1em; }
+ EndHTMLStyle
+ DocBookWrapperTag sidebar
+ DocBookTag para
+ DocBookWrapperAttr role='frameless'
End
InsetLayout Box:Shaded
- BgColor shaded
- LabelFont
- Color foreground
- Size Small
- EndFont
- MultiPar true
+ CopyStyle Box
+ BgColor shaded
+ HTMLStyle
+ div.Shaded {
+ background-color: gray;
+ padding: 0.5ex;
+ }
+ EndHTMLStyle
+ DocBookWrapperTag sidebar
+ DocBookTag para
+ DocBookWrapperAttr role='shaded'
+End
+
+InsetLayout Box:Boxed
+ CopyStyle Box
+ HTMLStyle
+ div.Boxed {
+ border: solid thick black;
+ padding: 0.5ex;
+ }
+ EndHTMLStyle
+ DocBookWrapperTag sidebar
+ DocBookTag para
+ DocBookWrapperAttr role='boxed'
+End
+
+InsetLayout Box:Framed
+ CopyStyle Box
+ HTMLStyle
+ div.Framed {
+ border: solid thick black;
+ padding: 0.5ex;
+ }
+ EndHTMLStyle
+ DocBookWrapperTag sidebar
+ DocBookTag para
+ DocBookWrapperAttr role='framed'
End
-InsetLayout figure
- LabelString Figure
+InsetLayout Box:ovalbox
+ CopyStyle Box
+ HTMLStyle
+ div.ovalbox {
+ border: groove medium black;
+ padding: 0.5ex;
+ }
+ EndHTMLStyle
+ DocBookWrapperTag sidebar
+ DocBookTag para
+ DocBookWrapperAttr role='ovalbox'
+End
+
+InsetLayout Box:Ovalbox
+ CopyStyle Box
+ HTMLStyle
+ div.Ovalbox {
+ border: ridge thick black;
+ padding: 0.5ex;
+ }
+ EndHTMLStyle
+ DocBookWrapperTag sidebar
+ DocBookTag para
+ DocBookWrapperAttr role='ovalbox-var'
+End
+
+InsetLayout Box:Shadowbox
+ CopyStyle Box
+ HTMLStyle
+ div.Shadowbox { border: solid gray medium; border-bottom: solid black 1ex; border-right: solid black 1ex; padding: 0.5ex; }
+ EndHTMLStyle
+ DocBookWrapperTag sidebar
+ DocBookTag para
+ DocBookWrapperAttr role='shadowbox'
+End
+
+InsetLayout Box:Doublebox
+ CopyStyle Box
+ HTMLStyle
+ div.Doublebox {
+ border: double thick black;
+ padding: 0.5ex;
+ }
+ EndHTMLStyle
+ DocBookWrapperTag sidebar
+ DocBookTag para
+ DocBookWrapperAttr role='doublebox'
+End
+
+InsetLayout Float
+ LaTeXType environment
LabelFont
- Color collapsable
+ Color collapsible
Size Small
EndFont
MultiPar true
+ HTMLStyle
+ div.float {
+ border: 2px solid black;
+ text-align: center;
+ }
+ EndHTMLStyle
End
-InsetLayout table
- LabelString Table
+#InsetWrap requires these, independently of whether stdfloats.inc is included
+OutlinerName table "Tables" #no AddToToc (built-in)
+OutlinerName figure "Figures" #no AddToToc (built-in)
+
+InsetLayout Wrap
LabelFont
- Color collapsable
+ Color collapsible
Size Small
EndFont
MultiPar true
+ RefPrefix wrap
+ HTMLStyle
+ div.wrap {
+ float: right;
+ border: 2px solid black;
+ padding: 1ex;
+ margin: 1ex;
+ }
+ EndHTMLStyle
End
-InsetLayout URL
+InsetLayout "Flex:URL"
LyXType standard
- LatexName url
- LatexType command
Decoration classic
LabelString URL
+ ContentAsLabel true
+ LatexName url
+ LatexType command
+ Requires url
+ MultiPar false
+ CustomPars false
+ ForcePlain true
PassThru true
+ FreeSpacing true
ForceLTR true
+ NeedCProtect true
Font
Family Typewriter
- Color Blue
+ Color urltext
EndFont
LabelFont
Family Typewriter
- Color Blue
+ Color urllabel
Size Small
EndFont
- Requires url
+ HTMLIsBlock false
+ DocBookTag link
+ DocBookTagType inline
End
-InsetLayout OptArg
- LabelString opt
+InsetLayout Argument
+ LabelString Argument
LabelFont
- Color collapsable
+ Color collapsible
Size Small
EndFont
MultiPar false
+ ForceLocalFontSwitch 1
+End
+
+InsetLayout Info
+ Decoration conglomerate
+ HTMLStyle
+ span.info { font-family: sans-serif; }
+ EndHTMLStyle
+ HTMLTag span
+ MultiPar false
+End
+
+InsetLayout Info:menu
+ CopyStyle Info
+ LatexType command
+ LatexName menuitem
+ Preamble
+ \providecommand{\menuitem}[1]{\textsf{#1}}
+ EndPreamble
+ Decoration conglomerate
+ Font
+ Family sans
+ EndFont
+ HTMLAttr "class='info menu'"
+ HTMLStyle
+ span.menu { font-family: sans-serif; }
+ EndHTMLStyle
+ DocBookTag guimenu
+ DocBookTagType inline
+End
+
+InsetLayout Info:shortcut
+ CopyStyle Info
+ LatexType command
+ LatexName shortcut
+ Preamble
+ \providecommand{\shortcut}[1]{\mbox{\textsf{#1}}}
+ EndPreamble
+ Decoration conglomerate
+ Font
+ Family sans
+ EndFont
+ HTMLAttr "class='info shortcut'"
+ HTMLStyle
+ span.shortcut { font-family: sans-serif; }
+ EndHTMLStyle
+ DocBookWrapperTag keycombo
+ DocBookWrapperTagType inline
+ DocBookTag keycap
+ DocBookTagType inline
+End
+
+InsetLayout Info:shortcuts
+ CopyStyle Info
+ LatexType command
+ LatexName shortcut
+ Preamble
+ \providecommand{\shortcut}[1]{\textsf{#1}}
+ EndPreamble
+ Decoration conglomerate
+ Font
+ Family sans
+ EndFont
+ HTMLAttr "class='info shortcut'"
+ HTMLStyle
+ span.shortcuts { font-family: sans-serif; }
+ EndHTMLStyle
+ DocBookWrapperTag keycombo
+ DocBookWrapperTagType inline
+ DocBookTag keycap
+ DocBookTagType inline
+End
+
+InsetLayout Caption:Standard
+ LabelString standard
+ LaTeXType command
+ LatexName caption
+ NeedProtect 1
+ MultiPar false
+ Argument 1
+ LabelString "Short Title|S"
+ Tooltip "The caption as it appears in the list of figures/tables"
+ InsertCotext 1
+ EndArgument
+ HTMLStyle
+ div.float-caption {
+ text-align: center;
+ border: 2px solid black;
+ padding: 1ex;
+ margin: 1ex;
+ }
+ EndHTMLStyle
+ HTMLAttr "class='float-caption float-caption-standard'"
+End
+
+
+InsetLayout Caption:Unnumbered
+ CopyStyle Caption:Standard
+ LabelString unlabelled
+ LatexName caption*
+ ResetArgs 1
+End
+
+
+InsetLayout Preview
+ LabelString Preview
+ Decoration minimalistic
+ MultiPar true
+End
+
+
+InsetLayout Script
+ LatexType command
+ MultiPar false
+ ForcePlain 1
+ CustomPars 0
+ InToc 1
+ HTMLIsBlock 0
+End
+
+
+InsetLayout Script:superscript
+ CopyStyle Script
+ LaTeXName textsuperscript
+ HTMLTag sup
+End
+
+
+InsetLayout Script:subscript
+ CopyStyle Script
+ Requires subscript
+ LaTeXName textsubscript
+ HTMLTag sub
+End
+
+
+InsetLayout PrintNomencl
+ BabelPreamble
+ \addto\captions$$lang{%
+ \def\eqdeclaration#1{, _(see equation[[nomencl]])\nobreakspace(#1)}%
+ \def\pagedeclaration#1{, _(page[[nomencl]])\nobreakspace#1}%
+ \def\nomname{_(Nomenclature[[output]])}%
+ }
+ EndBabelPreamble
+ # The command is defined for several languages in nomencl.sty. However, we need to define
+ # it anyway for the other, non suppported languages.
+ LangPreamble
+ \def\eqdeclaration#1{, _(see equation[[nomencl]])\nobreakspace(#1)}
+ \def\pagedeclaration#1{, _(page[[nomencl]])\nobreakspace#1}
+ \def\nomname{_(Nomenclature[[output]])}
+ EndLangPreamble
+ HTMLTag h2
+End
+
+InsetLayout Tabular
+ HTMLStyle
+ table {
+ border-collapse: collapse;
+ display: inline-block;
+ }
+ td {
+ border: 1px solid black;
+ padding: 0.5ex;
+ }
+ EndHTMLStyle
End