lyx_mirror/lib/layouts/stdinsets.inc

862 lines
20 KiB
PHP
Raw Normal View History

# Textclass definition file for LaTeX.
# Author : Martin vermeer <martin.vermeer@hut.fi>
# Inset layouts definition
#
# Detailed format description is available in the customization manual
2024-08-12 10:29:14 +00:00
Format 107
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
InheritFont false
Font
Size Small
EndFont
LabelFont
Color marginlabel
Size Small
EndFont
MultiPar true
NeedProtect true
HTMLStyle
2024-08-17 11:22:42 +00:00
div.marginal {
border: 2px solid black;
padding: 1ex;
margin: 1ex;
background-color: #F0F0F0;
float:right;
font-size: small;
font-weight: normal;
font-family: serif;
font-variant: normal;
font-style: normal;
}
EndHTMLStyle
AddToToc marginalnote
IsTocCaption true
DocBookTag para
End
InsetLayout Foot
LabelString Foot
LatexType Command
LatexName footnote
Counter footnote
InheritFont false
Font
Size FootnoteSize
EndFont
LabelFont
Color footlabel
Size Small
EndFont
MultiPar true
RefPrefix fn
HTMLLabel \arabic{footnote}
HTMLInnerTag div
HTMLStyle
2024-08-17 11:22:42 +00:00
span.foot_label {
vertical-align: super;
font-size: smaller;
font-weight: bold;
text-decoration: underline;
}
div.foot {
display: inline;
font-size: small;
font-weight: normal;
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
2024-08-17 11:22:42 +00:00
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: normal;
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
LatexType environment
LatexName comment
Requires verbatim
BgColor commentbg
InheritFont false
LabelFont
Color comment
Size Small
EndFont
MultiPar true
Introduce a wrapper class for odocstream to help ensuring that no blank lines may be inadvertently output. This is achieved by using two special iomanip-like variables (breakln and safebreakln) in the lyx:: namespace. When they are inserted in the stream, a newline is output only if not already at the beginning of a line. The difference between breakln and safebreakln is that, if needed, the former outputs '\n' and the latter "%\n". In future, the new class will also be used for counting the number of newlines issued. Even if the infractrure for doing that is already in place, the counting is essentially still done the old way. There are still places in the code where the functionality of the class could be used, most probably. ATM, it is used for InsetTabular, InsetListings, InsetFloat, and InsetText. The Comment and GreyedOut insets required a special treatment and a new InsetLayout parameter (Display) has been introduced. The default for Display is "true", meaning that the corresponding latex environment is of "display" type, i.e., it stands on its own, whereas "false" means that the contents appear inline with the text. The latter is the case for both Comment and GreyedOut insets. Mostly, the only visible effects on latex exports should be the disappearing of some redundant % chars and the appearing/disappearing of null {} latex groups after a comment or lyxgreyedout environments (they are related to the presence or absence of a space immediately after those environments), as well as the fact that math environments are now started on their own lines. As a last thing, only the latex code between \begin{document} and \end{document} goes through the new class, the preamble being directly output through odocstream, as usual. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@37360 a592a061-630c-0410-9148-cb99ea01b6c8
2011-01-29 02:41:13 +00:00
Display false
HTMLTag div
HTMLIsBlock true
HTMLStyle
2024-08-17 11:22:42 +00:00
div.note_comment {
display: none;
}
EndHTMLStyle
AddToToc note
IsTocCaption true
NeedCProtect true
End
InsetLayout Note:Note
LabelString Note
LatexType command
LatexName note
BgColor notebg
LabelFont
Color note
Size Small
EndFont
MultiPar true
# Not output for XHTML
AddToToc note
IsTocCaption true
End
InsetLayout Note:Greyedout
LabelString Greyedout
LatexType environment
LatexName lyxgreyedout
Requires color,lyxgreyedout
BgColor greyedoutbg
InheritFont false
Font
Size Normal
Color greyedouttext
EndFont
LabelFont
Color greyedout
Size Small
EndFont
MultiPar true
Introduce a wrapper class for odocstream to help ensuring that no blank lines may be inadvertently output. This is achieved by using two special iomanip-like variables (breakln and safebreakln) in the lyx:: namespace. When they are inserted in the stream, a newline is output only if not already at the beginning of a line. The difference between breakln and safebreakln is that, if needed, the former outputs '\n' and the latter "%\n". In future, the new class will also be used for counting the number of newlines issued. Even if the infractrure for doing that is already in place, the counting is essentially still done the old way. There are still places in the code where the functionality of the class could be used, most probably. ATM, it is used for InsetTabular, InsetListings, InsetFloat, and InsetText. The Comment and GreyedOut insets required a special treatment and a new InsetLayout parameter (Display) has been introduced. The default for Display is "true", meaning that the corresponding latex environment is of "display" type, i.e., it stands on its own, whereas "false" means that the contents appear inline with the text. The latter is the case for both Comment and GreyedOut insets. Mostly, the only visible effects on latex exports should be the disappearing of some redundant % chars and the appearing/disappearing of null {} latex groups after a comment or lyxgreyedout environments (they are related to the presence or absence of a space immediately after those environments), as well as the fact that math environments are now started on their own lines. As a last thing, only the latex code between \begin{document} and \end{document} goes through the new class, the preamble being directly output through odocstream, as usual. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@37360 a592a061-630c-0410-9148-cb99ea01b6c8
2011-01-29 02:41:13 +00:00
Display false
HTMLInnerTag div
HTMLStyle
2024-08-17 11:22:42 +00:00
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
LabelString ERT
LatexType none
Decoration minimalistic
Font
Color latex
Family typewriter
EndFont
LabelFont
Color latex
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
2024-08-17 11:22:42 +00:00
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: 0.5em 0.1em 0em 1em;
font-size: large;
font-weight: normal;
}
div.lyxtoc-3 { margin: 0.2em 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
2024-08-17 11:22:42 +00:00
\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
2024-08-17 11:22:42 +00:00
\renewcommand{\lstlistlistingname}{_(Listings[[List of Listings]])}
EndLangPreamble
FixedWidthPreambleEncoding true
2024-08-17 11:22:42 +00:00
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
2024-08-17 11:22:42 +00:00
\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
2024-08-17 11:22:42 +00:00
\renewcommand{\listoflistingscaption}{_(List of Listings)}
EndLangPreamble
FixedWidthPreambleEncoding false
2024-08-17 11:22:42 +00:00
HTMLTag h2
HTMLStyle
div.lyxtoc-flat {
margin: 0em 0em 0em 1em;
font-size: large;
font-weight: normal;
}
EndHTMLStyle
End
InsetLayout Include:Listings
2012-04-16 19:40:59 +00:00
BabelPreamble
2024-08-17 11:22:42 +00:00
\addto\captions$$lang{\renewcommand{\lstlistingname}{_(Listing)}}
2012-04-16 19:40:59 +00:00
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.
2012-04-16 19:40:59 +00:00
LangPreamble
2024-08-17 11:22:42 +00:00
\renewcommand{\lstlistingname}{_(Listing)}
2012-04-16 19:40:59 +00:00
EndLangPreamble
FixedWidthPreambleEncoding true
2012-04-16 19:40:59 +00:00
End
InsetLayout Listings
CopyStyle Include:Listings
LabelString Listings[[inset]]
LatexType none
Decoration minimalistic
InheritFont false
Font
Color foreground
Family typewriter
EndFont
LabelFont
Color black
Size Small
EndFont
BgColor listingsbg
MultiPar true
PassThru true
ParbreakIsNewline true
KeepEmpty true
FreeSpacing true
ForceLTR true
2018-04-28 00:13:07 +00:00
ForcePlain true
NeedCProtect true
RefPrefix lst
EditExternal true
2024-06-03 03:06:11 +00:00
HTMLTag code
DocBookTag programlisting
End
InsetLayout MintedListings
CopyStyle Listings
BabelPreamble
2024-08-17 11:22:42 +00:00
\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
2024-08-17 11:22:42 +00:00
\renewcommand{\listingscaption}{_(Listing)}
EndLangPreamble
FixedWidthPreambleEncoding false
End
InsetLayout Branch
Decoration classic
LabelFont
Color branchlabel
Size Small
EndFont
MultiPar true
InToc true
HTMLIsBlock false
AddToToc branch
IsTocCaption true
End
InsetLayout Index
LabelString Idx
Decoration classic
Font
Size Small
EndFont
LabelFont
Color indexlabel
Size Small
EndFont
MultiPar false
CustomPars false
ForcePlain true
ContentAsLabel true
EscapeChars \"@|!
InsertCotext 1
End
InsetLayout IndexMacro:see
LabelString See
Decoration classic
Font
Size Small
EndFont
LabelFont
Color indexlabel
Size Small
EndFont
MultiPar false
CustomPars false
ForcePlain true
End
InsetLayout IndexMacro:seealso
CopyStyle IndexMacro:see
LabelString "See also"
End
InsetLayout IndexMacro:sortkey
CopyStyle IndexMacro:see
LabelString "Sort as"
End
InsetLayout IndexMacro:subentry
CopyStyle IndexMacro:see
LabelString "Subentry"
End
InsetLayout Nomenclature
LabelString Nom
LatexType command
LatexName nomenclature
Decoration classic
Font
Size Small
EndFont
LabelFont
Color nomlabel
Size Small
EndFont
MultiPar false
CustomPars false
ForcePlain true
ContentAsLabel true
AddToToc nomencl
Argument 1
2024-08-17 11:22:42 +00:00
LabelString "Sort as"
Tooltip "Sort this entry as specified in the inset"
EndArgument
Argument post:1
2024-08-17 11:22:42 +00:00
LabelString "Description"
Tooltip "Description of the entry"
AutoInsert 1
Mandatory 1
EscapeChars %!@|
EndArgument
EscapeChars %!@|
InsertCotext 1
End
InsetLayout Nomenclature:nomentbl
CopyStyle Nomenclature
Argument post:2
LabelString "Unit"
Tooltip "Nomenclature unit"
AutoInsert 1
Mandatory 1
EndArgument
Argument post:3
2024-08-21 16:07:47 +00:00
LabelString "Note[[nomencl]]"
Tooltip "Nomenclature note"
AutoInsert 1
Mandatory 1
EndArgument
End
InsetLayout Box
InheritFont false
LabelFont
Color black
Size Small
EndFont
MultiPar true
DocBookWrapperTag sidebar
DocBookTag para
End
InsetLayout Box:Frameless
CopyStyle Box
HTMLStyle
2024-08-17 11:22:42 +00:00
div.Frameless { margin: 1em; }
EndHTMLStyle
DocBookWrapperTag sidebar
DocBookTag para
DocBookWrapperAttr role='frameless'
End
InsetLayout Box:Shaded
CopyStyle Box
BgColor shaded
HTMLStyle
2024-08-17 11:22:42 +00:00
div.Shaded {
background-color: gray;
padding: 0.5ex;
}
EndHTMLStyle
DocBookWrapperTag sidebar
DocBookTag para
DocBookWrapperAttr role='shaded'
End
InsetLayout Box:Boxed
CopyStyle Box
HTMLStyle
2024-08-17 11:22:42 +00:00
div.Boxed {
border: solid thick black;
padding: 0.5ex;
}
EndHTMLStyle
DocBookWrapperTag sidebar
DocBookTag para
DocBookWrapperAttr role='boxed'
End
InsetLayout Box:Framed
CopyStyle Box
HTMLStyle
2024-08-17 11:22:42 +00:00
div.Framed {
border: solid thick black;
padding: 0.5ex;
}
EndHTMLStyle
DocBookWrapperTag sidebar
DocBookTag para
DocBookWrapperAttr role='framed'
End
InsetLayout Box:ovalbox
CopyStyle Box
HTMLStyle
2024-08-17 11:22:42 +00:00
div.ovalbox {
border: groove medium black;
padding: 0.5ex;
}
EndHTMLStyle
DocBookWrapperTag sidebar
DocBookTag para
DocBookWrapperAttr role='ovalbox'
End
InsetLayout Box:Ovalbox
CopyStyle Box
HTMLStyle
2024-08-17 11:22:42 +00:00
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
2024-08-17 11:22:42 +00:00
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
2024-08-17 11:22:42 +00:00
div.Doublebox {
border: double thick black;
padding: 0.5ex;
}
EndHTMLStyle
DocBookWrapperTag sidebar
DocBookTag para
DocBookWrapperAttr role='doublebox'
End
InsetLayout Float
LaTeXType environment
InheritFont false
LabelFont
Color collapsible
Size Small
EndFont
MultiPar true
HTMLStyle
2024-08-17 11:22:42 +00:00
div.float {
border: 2px solid black;
text-align: center;
}
EndHTMLStyle
End
2017-03-19 23:12:30 +00:00
#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 collapsible
Size Small
EndFont
MultiPar true
RefPrefix wrap
HTMLStyle
2024-08-17 11:22:42 +00:00
div.wrap {
float: right;
border: 2px solid black;
padding: 1ex;
margin: 1ex;
}
EndHTMLStyle
End
InsetLayout "Flex:URL"
LyXType standard
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 urltext
EndFont
LabelFont
Family Typewriter
Color urllabel
Size Small
EndFont
HTMLIsBlock false
DocBookTag link
DocBookTagType inline
End
InsetLayout Argument
LabelString Argument
LabelFont
Color collapsible
Size Small
EndFont
MultiPar false
ForceLocalFontSwitch 1
End
InsetLayout Info
Decoration conglomerate
HTMLStyle
2024-08-17 11:22:42 +00:00
span.info { font-family: sans-serif; }
EndHTMLStyle
HTMLTag span
MultiPar false
SpellCheck false
End
InsetLayout Info:menu
CopyStyle Info
LatexType command
LatexName menuitem
Preamble
\providecommand{\menuitem}[1]{\textsf{#1}}
EndPreamble
Decoration conglomerate
Font
Family sans
EndFont
HTMLClass "info menu"
HTMLStyle
2024-08-17 11:22:42 +00:00
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
HTMLClass "info shortcut"
HTMLStyle
2024-08-17 11:22:42 +00:00
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
HTMLClass "info shortcut"
HTMLStyle
2024-08-17 11:22:42 +00:00
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
2024-08-17 11:22:42 +00:00
LabelString "Short Title|S"
Tooltip "The caption as it appears in the list of figures/tables"
InsertCotext 1
DocBookTag titleabbrev
DocBookArgumentAfterMainTag true
EndArgument
HTMLStyle
2024-08-17 11:22:42 +00:00
div.float-caption {
text-align: center;
border: 2px solid black;
padding: 1ex;
margin: 1ex;
}
EndHTMLStyle
HTMLClass "float-caption float-caption-standard"
End
InsetLayout Caption:Unnumbered
CopyStyle Caption:Standard
2014-02-26 06:57:57 +00:00
LabelString unlabelled
LatexName caption*
2014-02-26 06:57:57 +00:00
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
2017-12-01 09:10:06 +00:00
BabelPreamble
2024-08-17 11:22:42 +00:00
\addto\captions$$lang{%
\def\eqdeclaration#1{, _(see equation[[nomencl]])\nobreakspace(#1)}%
\def\pagedeclaration#1{, _(page[[nomencl]])\nobreakspace#1}%
\def\nomname{_(Nomenclature[[output]])}%
}
2017-12-01 09:10:06 +00:00
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
2024-08-17 11:22:42 +00:00
\def\eqdeclaration#1{, _(see equation[[nomencl]])\nobreakspace(#1)}
\def\pagedeclaration#1{, _(page[[nomencl]])\nobreakspace#1}
\def\nomname{_(Nomenclature[[output]])}
2017-12-01 09:10:06 +00:00
EndLangPreamble
HTMLTag h2
End
InsetLayout Tabular
InheritFont false
HTMLStyle
2024-08-17 11:22:42 +00:00
table {
border-collapse: collapse;
display: inline-block;
}
td {
padding: 0.5ex;
}
EndHTMLStyle
End