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         NeedProtect           true
  80         HTMLTag               span
  81         HTMLAttr              class='marginal'
  82         HTMLStyle
  83                 span.marginal {
  84                         border: 2px solid black;
  85                         padding: 1ex;
  86                         margin: 1ex;
  87                         background-color: #F0F0F0;
  88                         float:right;
  89                 }
  90         EndHTMLStyle
  91 End
  92
  93 InsetLayout Foot
  94         LabelString           foot
  95         Counter               footnote
  96         Font
  97           Color               foreground
  98           Size                Small
  99           Family              Roman
 100           Shape               Up
 101           Series              Medium
 102           Misc                No_Emph
 103           Misc                No_Noun
 104           Misc                No_Bar
 105         EndFont
 106         LabelFont
 107           Color               footlabel
 108           Size                Small
 109         EndFont
 110         MultiPar              true
 111         HTMLTag               span
 112         HTMLAttr              class='footwrapper'
 113         HTMLLabel             "<span class='notenum'>\arabic{footnote}</span>"
 114         HTMLInnerTag          span
 115         HTMLInnerAttr         class='footnote'
 116         HTMLStyle
 117                 span.notenum {
 118                         vertical-align: super;
 119                         font-size: smaller;
 120                 }
 121                 span.footnote {
 122                         display: none;
 123                         font-size: medium;
 124                         font-weight: normal;
 125                         font-style: normal;
 126                         font-variant: normal;
 127                 }
 128                 span.footwrapper:hover span.footnote {
 129                         display: block;
 130                         border: 1px double black;
 131                         margin: 0em 1em;
 132                         padding: 1em;
 133                 }
 134         EndHTMLStyle
 135 End
 136
 137 InsetLayout Note:Comment
 138         LabelString           comment
 139         LatexType             environment
 140         LatexName             comment
 141         BgColor               commentbg
 142         LabelFont
 143           Color               comment
 144           Size                Small
 145         EndFont
 146         MultiPar              true
 147         HTMLTag               !--
 148 End
 149
 150
 151 InsetLayout Note:Note
 152         LabelString           note
 153         LatexType             command
 154         LatexName             note
 155         BgColor               notebg
 156         LabelFont
 157           Color               note
 158           Size                Small
 159         EndFont
 160         MultiPar              true
 161 End
 162
 163 InsetLayout Note:Greyedout
 164         LabelString           greyedout
 165         LatexType             environment
 166         LatexName             lyxgreyedout
 167         BgColor               greyedoutbg
 168         LabelFont
 169           Color               greyedout
 170           Size                Small
 171         EndFont
 172         MultiPar              true
 173         HTMLTag               span
 174         HTMLAttr              class='notegrey'
 175         HTMLStyle
 176                 span.notegrey { color: gray; }
 177         EndHTMLStyle
 178 End
 179
 180 InsetLayout ERT
 181         LabelString           ERT
 182         LatexType             none
 183         Decoration            minimalistic
 184         Font
 185           Color               latex
 186           Family              typewriter
 187         EndFont
 188         LabelFont
 189           Color               latex
 190           Size                Small
 191         EndFont
 192         MultiPar              true
 193         CustomPars            false
 194         ForcePlain            true
 195         PassThru              true
 196         KeepEmpty             true
 197         FreeSpacing           true
 198         ForceLTR              true
 199 End
 200
 201 InsetLayout Phantom
 202         Decoration            minimalistic
 203         Font
 204           Color               phantomtext
 205         EndFont
 206         CustomPars            false
 207         ForcePlain            true
 208 End
 209
 210 InsetLayout Listings
 211         LabelString           Listings
 212         LatexType             none
 213         Decoration            minimalistic
 214         Font
 215           Color               foreground
 216           Family              typewriter
 217         EndFont
 218         LabelFont
 219           Color               foreground
 220           Size                Small
 221         EndFont
 222         BgColor               listingsbg
 223         MultiPar              true
 224         PassThru              true
 225         KeepEmpty             true
 226         FreeSpacing           true
 227         ForceLTR              true
 228 End
 229
 230 InsetLayout Branch
 231         Decoration            classic
 232         LabelFont
 233           Color               branchlabel
 234           Size                Small
 235         EndFont
 236         MultiPar              true
 237         InToc                 true
 238 End
 239
 240 InsetLayout Index
 241         LabelString           Idx
 242         Decoration            classic
 243         Font
 244           Color               foreground
 245           Size                Small
 246           Family              Roman
 247           Shape               Up
 248           Series              Medium
 249           Misc                No_Emph
 250           Misc                No_Noun
 251           Misc                No_Bar
 252         EndFont
 253         LabelFont
 254           Color               indexlabel
 255           Size                Small
 256         EndFont
 257         MultiPar              false
 258         CustomPars            false
 259         ForcePlain            true
 260 End
 261
 262 InsetLayout Box
 263         LabelFont
 264           Color               foreground
 265           Size                Small
 266         EndFont
 267         MultiPar              true
 268 End
 269
 270 InsetLayout Box:Shaded
 271         BgColor               shaded
 272         LabelFont
 273           Color               foreground
 274           Size                Small
 275         EndFont
 276         MultiPar              true
 277 End
 278
 279 InsetLayout Float
 280         LabelFont
 281           Color               collapsable
 282           Size                Small
 283         EndFont
 284         MultiPar              true
 285 End
 286
 287 InsetLayout Wrap
 288         LabelFont
 289           Color               collapsable
 290           Size                Small
 291         EndFont
 292         MultiPar              true
 293         HTMLStyle
 294                 span.wrap {
 295                         float: right;
 296                         width: 40%;
 297                         border: 2px solid black;
 298                         padding: 1ex;
 299                         margin: 1ex;
 300                 }
 301         EndHTMLStyle
 302 End
 303
 304 InsetLayout URL
 305         LyXType               standard
 306         Decoration            classic
 307         LabelString           URL
 308         LatexName             url
 309         LatexType             command
 310         Requires              url
 311         MultiPar              false
 312         CustomPars            false
 313         ForcePlain            true
 314         PassThru              true
 315         FreeSpacing           true
 316         ForceLTR              true
 317         Font
 318           Family              Typewriter
 319           Color               urltext
 320         EndFont
 321         LabelFont
 322           Family              Typewriter
 323           Color               urllabel
 324           Size                Small
 325         EndFont
 326 End
 327
 328 InsetLayout OptArg
 329         LabelString           opt
 330         LabelFont
 331           Color               collapsable
 332           Size                Small
 333         EndFont
 334         MultiPar              false
 335 End
 336
 337 InsetLayout Info
 338         Decoration            conglomerate
 339         HTMLTag           span
 340         HTMLAttr          class='info'
 341         HTMLStyle
 342                 span.info { font-family: sans-serif; }
 343         EndHTMLStyle
 344 End
 345
 346 InsetLayout Info:menu
 347         LatexType             command
 348         LatexName             menuitem
 349         Preamble
 350           \providecommand{\menuitem}[1]{\textsf{#1}}
 351         EndPreamble
 352         Decoration            conglomerate
 353         Font
 354           Family              sans
 355         EndFont
 356         HTMLTag           span
 357         HTMLAttr          "class='info menu'"
 358         HTMLStyle
 359                 span.menu { font-family: sans-serif; }
 360         EndHTMLStyle
 361 End
 362
 363 InsetLayout Info:shortcut
 364         LatexType             command
 365         LatexName             shortcut
 366         Preamble
 367           \providecommand{\shortcut}[1]{\mbox{\textsf{#1}}}
 368         EndPreamble
 369         Decoration            conglomerate
 370         Font
 371           Family              sans
 372         EndFont
 373         HTMLTag           span
 374         HTMLAttr          "class='info shortcut'"
 375         HTMLStyle
 376                 span.shortcut { font-family: sans-serif; }
 377         EndHTMLStyle
 378 End
 379
 380 InsetLayout Info:shortcuts
 381         LatexType             command
 382         LatexName             shortcut
 383         Preamble
 384           \providecommand{\shortcut}[1]{\textsf{#1}}
 385         EndPreamble
 386         Decoration            conglomerate
 387         Font
 388           Family              sans
 389         EndFont
 390         HTMLTag           span
 391         HTMLAttr          "class='info shortcut'"
 392         HTMLStyle
 393                 span.shortcut { font-family: sans-serif; }
 394         EndHTMLStyle
 395 End
 396
 397 InsetLayout Box
 398         HTMLStyle
 399                 span.Frameless { font-family: sans-serif; }
 400         EndHTMLStyle
 401 End