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