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