lib/layouts/stdinsets.inc

   1 # Textclass definition file for LaTeX.
   2 # Author : Martin vermeer <martin.vermeer@hut.fi>
   3 # Inset layouts definition
   4 #
   5 # More detailled format description is available in the customization manual
   6 # FIXME: create the contents in the manual and put the link here.
   7 #
   8 #InsetLayout <string identifier used by LyX>
   9 #       LabelString           used for the inset decoration (either the inset button
  10 #                             or the text underneath the inset).
  11 #       LatexType             associated LateX type: command, environment, or none.
  12 #       LatexName             associated LateX command.
  13 #       BgColor               Color of the inset background within LyX.
  14 #                         FIXME: link to a doc file describing the different
  15 #                         color codes as defined in 'ColorCode.h'
  16 #       Font                  Nothing to put here, below are descriptions of the different
  17 #                         allowable adjustments for the font used to draw the text
  18 #                         appearing within the inset text. All these items are optional.
  19 #         Color               Color of text
  20 #         Size                Font size of the textallowed value: Small, Smaller, ...
  21 #                         FIXME defined in FontSize in FontEnums.h
  22 #         Family              FIXME defined in FontFamily in FontEnums.h
  23 #         Shape               FIXME defined in FontShape in FontEnums.h
  24 #         Series              FIXME defined in FontSeries in FontEnums.h
  25 #         Misc                FIXME defined in FontMisc in FontEnums.h
  26 #       EndFont               Nothing to put here, it's just a markup to indicate that we are
  27 #                         finished with the Font definition.
  28 #       LabelFont             Nothing to put here, below are descriptions of the different
  29 #                         allowable adjustments for the font used to draw the text
  30 #                         appearing within the inset decoration. All these items are
  31 #                         optional.
  32 #         Color               see definition above (in the Font node).
  33 #         Size                see definition above (in the Font node).
  34 #
  35 #       EndFont               Nothing to put here, it's just a markup to indicate that we are
  36 #                         finished with the LabelFont definition.
  37 #       MultiPar              Indicates that multiple paragraphs are allowed within the inset
  38 #                         or not. Defaults to false. Sets CustomPars, as well, to the same
  39 #                         value, and sets ForcePlain to the opposite value. If you want
  40 #                         those to be different, then, you must set them after you set
  41 #                         MultiPar.
  42 # CustomPars            Whether to allow the use of the Paragraph Settings dialog. Default is
  43 #                         false.
  44 # ForcePlain            Whether to force the PlainLayout. Default is true.
  45 #       Decoration:           Classic, Minimalistic, Conglomerate. Decoration styles
  46 #       PassThru              Do not do various LaTeX conversions, like the phrases
  47 #                               LaTeX, LyX, quote commands, etc.
  48 #       KeepEmpty             Do not delete empty paragraphs (?)
  49 #       FreeSpacing           Preserve multiple spaces etc.
  50 #       ForceLTR              Force the "latex" language, leading to Left-to-Right
  51 #                               (latin) output, e.g., in ERT or URL. A kludge.
  52 #       Requires              Require a given (supported) feature. Multiple features must
  53 #                         be comma-separated.
  54 #End
  55
  56 Format 16
  57
  58 Provides stdinsets 1
  59
  60 InsetLayout Marginal
  61         LabelString           margin
  62         LatexType             command
  63         LatexName             marginpar
  64         Font
  65           Color               foreground
  66           Size                Small
  67           Family              Roman
  68           Shape               Up
  69           Series              Medium
  70           Misc                No_Emph
  71           Misc                No_Noun
  72           Misc                No_Bar
  73         EndFont
  74         LabelFont
  75           Color               marginlabel
  76           Size                Small
  77         EndFont
  78         MultiPar              true
  79 End
  80
  81 InsetLayout Foot
  82         LabelString           foot
  83         LatexType             command
  84         LatexName             footnote
  85         Counter               footnote
  86         Font
  87           Color               foreground
  88           Size                Small
  89           Family              Roman
  90           Shape               Up
  91           Series              Medium
  92           Misc                No_Emph
  93           Misc                No_Noun
  94           Misc                No_Bar
  95         EndFont
  96         LabelFont
  97           Color               footlabel
  98           Size                Small
  99         EndFont
 100         MultiPar              true
 101         HTMLTag               span
 102         HTMLAttr              class='footwrapper'
 103         HTMLLabel             "<span class='notenum'>\arabic{footnote}</span>"
 104         HTMLInnerTag          span
 105         HTMLInnerAttr         class='footnote'
 106         HTMLStyle
 107                 span.notenum {
 108                         vertical-align: super;
 109                         font-size: smaller;
 110                 }
 111                 span.footnote {
 112                         display: none;
 113                 }
 114                 span.footwrapper:hover span.footnote {
 115                         display: block;
 116                         border: 1px double black;
 117                         margin: 0em 1em;
 118                         padding: 1em;
 119                 }
 120         EndHTMLStyle
 121 End
 122
 123 InsetLayout Note:Comment
 124         LabelString           comment
 125         LatexType             environment
 126         LatexName             comment
 127         BgColor               commentbg
 128         LabelFont
 129           Color               comment
 130           Size                Small
 131         EndFont
 132         MultiPar              true
 133         HTMLTag               !--
 134 End
 135
 136
 137 InsetLayout Note:Note
 138         LabelString           note
 139         LatexType             command
 140         LatexName             note
 141         BgColor               notebg
 142         LabelFont
 143           Color               note
 144           Size                Small
 145         EndFont
 146         MultiPar              true
 147 End
 148
 149 InsetLayout Note:Greyedout
 150         LabelString           greyedout
 151         LatexType             environment
 152         LatexName             lyxgreyedout
 153         BgColor               greyedoutbg
 154         LabelFont
 155           Color               greyedout
 156           Size                Small
 157         EndFont
 158         MultiPar              true
 159         HTMLTag               span
 160         HTMLAttr              class='notegrey'
 161         HTMLStyle
 162                 span.notegrey { color: gray; }
 163         EndHTMLStyle
 164 End
 165
 166 InsetLayout ERT
 167         LabelString           ERT
 168         LatexType             none
 169         Decoration            minimalistic
 170         Font
 171           Color               latex
 172           Family              typewriter
 173         EndFont
 174         LabelFont
 175           Color               latex
 176           Size                Small
 177         EndFont
 178         MultiPar              true
 179         CustomPars            false
 180         ForcePlain            true
 181         PassThru              true
 182         KeepEmpty             true
 183         FreeSpacing           true
 184         ForceLTR              true
 185 End
 186
 187 InsetLayout Phantom
 188         Decoration            minimalistic
 189         Font
 190           Color               phantomtext
 191         EndFont
 192         CustomPars            false
 193         ForcePlain            true
 194 End
 195
 196 InsetLayout Listings
 197         LabelString           Listings
 198         LatexType             none
 199         Decoration            minimalistic
 200         Font
 201           Color               foreground
 202           Family              typewriter
 203         EndFont
 204         LabelFont
 205           Color               foreground
 206           Size                Small
 207         EndFont
 208         BgColor               listingsbg
 209         MultiPar              true
 210         PassThru              true
 211         KeepEmpty             true
 212         FreeSpacing           true
 213         ForceLTR              true
 214 End
 215
 216 InsetLayout Branch
 217         Decoration            classic
 218         LabelFont
 219           Color               branchlabel
 220           Size                Small
 221         EndFont
 222         MultiPar              true
 223         InToc                 true
 224 End
 225
 226 InsetLayout Index
 227         LabelString           Idx
 228         LatexType             command
 229         LatexName             index
 230         Decoration            classic
 231         Font
 232           Color               foreground
 233           Size                Small
 234           Family              Roman
 235           Shape               Up
 236           Series              Medium
 237           Misc                No_Emph
 238           Misc                No_Noun
 239           Misc                No_Bar
 240         EndFont
 241         LabelFont
 242           Color               indexlabel
 243           Size                Small
 244         EndFont
 245         MultiPar              false
 246         CustomPars            false
 247         ForcePlain            true
 248         NeedProtect           true
 249 End
 250
 251 InsetLayout Box
 252         LabelFont
 253           Color               foreground
 254           Size                Small
 255         EndFont
 256         MultiPar              true
 257 End
 258
 259 InsetLayout Box:Shaded
 260         BgColor               shaded
 261         LabelFont
 262           Color               foreground
 263           Size                Small
 264         EndFont
 265         MultiPar              true
 266 End
 267
 268 InsetLayout Float
 269         LabelFont
 270           Color               collapsable
 271           Size                Small
 272         EndFont
 273         MultiPar              true
 274 End
 275
 276 InsetLayout Wrap
 277         LabelFont
 278           Color               collapsable
 279           Size                Small
 280         EndFont
 281         MultiPar              true
 282 End
 283
 284 InsetLayout URL
 285         LyXType               standard
 286         LatexName             url
 287         LatexType             command
 288         Decoration            classic
 289         LabelString           URL
 290         PassThru              true
 291         ForceLTR              true
 292         Font
 293           Family              Typewriter
 294           Color               urltext
 295         EndFont
 296         LabelFont
 297           Family              Typewriter
 298           Color               urllabel
 299           Size                Small
 300         EndFont
 301         Requires              url
 302 End
 303
 304 InsetLayout OptArg
 305         LabelString           opt
 306         LabelFont
 307           Color               collapsable
 308           Size                Small
 309         EndFont
 310         MultiPar              false
 311 End
 312
 313 InsetLayout Info
 314         Decoration            conglomerate
 315 End
 316
 317 InsetLayout Info:menu
 318         LatexType             command
 319         LatexName             menuitem
 320         Preamble
 321           \providecommand{\menuitem}[1]{\textsf{#1}}
 322         EndPreamble
 323         Decoration            conglomerate
 324         Font
 325           Family              sans
 326         EndFont
 327 End
 328
 329 InsetLayout Info:shortcut
 330         LatexType             command
 331         LatexName             shortcut
 332         Preamble
 333           \providecommand{\shortcut}[1]{\mbox{\textsf{#1}}}
 334         EndPreamble
 335         Decoration            conglomerate
 336         Font
 337           Family              sans
 338         EndFont
 339 End
 340
 341 InsetLayout Info:shortcuts
 342         LatexType             command
 343         LatexName             shortcut
 344         Preamble
 345           \providecommand{\shortcut}[1]{\textsf{#1}}
 346         EndPreamble
 347         Decoration            conglomerate
 348         Font
 349           Family              sans
 350         EndFont
 351 End
 352
 353 InsetLayout Box
 354         HTMLStyle
 355                 span.Frameless { font-family: sans-serif; }
 356         EndHTMLStyle
 357 End