]> git.lyx.org Git - lyx.git/blob - lib/layouts/stdinsets.inc
stdinset.inc: Some more documentation from Martin.
[lyx.git] / 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 
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. FIXME: what is the default?
39 #       Decoration:           Classic, Minimalistic, Conglomerate. Decoration styles\r
40 #       PassThru              Do not do various LaTeX conversions, like the phrases\r
41 #                             LaTeX, LyX, quote commands, etc.\r
42 #       KeepEmpty             Do not delete empty paragraphs (?)\r
43 #       FreeSpacing           Preserve multiple spaces etc.\r
44 #       ForceLTR              Force the "latex" language, leading to Left-to-Right\r
45 #                            (latin) output, e.g., in ERT or URL. A kludge.\r
46 #End
47
48 Format 5
49
50 InsetLayout Marginal
51         LabelString           margin
52         LatexType             command
53         LatexName             marginpar
54         Font
55           Color               foreground
56           Size                Small
57           Family              Roman
58           Shape               Up
59           Series              Medium
60           Misc                No_Emph
61           Misc                No_Noun
62           Misc                No_Bar
63         EndFont
64         LabelFont
65           Color               Red
66           Size                Small
67         EndFont
68         MultiPar              true
69 End
70
71 InsetLayout Foot
72         LabelString           foot
73         LatexType             command
74         LatexName             footnote
75         Font
76           Color               foreground
77           Size                Small
78           Family              Roman
79           Shape               Up
80           Series              Medium
81           Misc                No_Emph
82           Misc                No_Noun
83           Misc                No_Bar
84         EndFont
85         LabelFont
86           Color               Green
87           Size                Small
88         EndFont
89         MultiPar              true
90 End
91
92 InsetLayout Note:Comment
93         LabelString           comment
94         LatexType             environment
95         LatexName             comment
96         BgColor               commentbg
97         LabelFont
98           Color               comment
99           Size                Small
100         EndFont
101         MultiPar              true
102 End
103
104
105 InsetLayout Note:Note
106         LabelString           note
107         LatexType             command
108         LatexName             note
109         BgColor               notebg
110         LabelFont
111           Color               note
112           Size                Small
113         EndFont
114         MultiPar              true
115 End
116
117 InsetLayout Note:Greyedout
118         LabelString           greyedout
119         LatexType             environment
120         LatexName             lyxgreyedout
121         BgColor               greyedoutbg
122         LabelFont
123           Color               greyedout
124           Size                Small
125         EndFont
126         MultiPar              true
127 End
128
129 InsetLayout ERT
130         LabelString           ERT
131         LatexType             none
132         Decoration            minimalistic
133         Font
134           Color               latex
135           Family              typewriter
136         EndFont
137         LabelFont
138           Color               latex
139           Size                Small
140         EndFont
141         MultiPar              true
142         PassThru              true
143         KeepEmpty             true
144         FreeSpacing           true
145         ForceLTR              true
146 End
147
148 InsetLayout Listings
149         LabelString           Listings
150         LatexType             none
151         Decoration            minimalistic
152         Font
153           Color               foreground
154           Family              typewriter
155         EndFont
156         LabelFont
157           Color               foreground
158           Size                Small
159         EndFont
160         MultiPar              true
161         PassThru              true
162         KeepEmpty             true
163         FreeSpacing           true
164 End
165
166 InsetLayout Branch
167         Decoration            minimalistic
168         LabelFont
169           Color               Red
170           Size                Small
171         EndFont
172         MultiPar              true
173 End
174
175 InsetLayout Index
176         LabelString           Idx
177         LatexType             command
178         LatexName             index
179         Decoration            minimalistic
180         Font
181           Color               Green
182           Size                Small
183           Family              Roman
184           Shape               Up
185           Series              Medium
186           Misc                No_Emph
187           Misc                No_Noun
188           Misc                No_Bar
189         EndFont
190         LabelFont
191           Color               Green
192           Size                Small
193         EndFont
194         MultiPar              false
195         NeedProtect           true
196 End
197
198 InsetLayout Box
199         LabelFont
200           Color               foreground
201           Size                Small
202         EndFont
203         MultiPar              true
204 End
205
206 InsetLayout Box:Shaded
207         BgColor               shaded
208         LabelFont
209           Color               foreground
210           Size                Small
211         EndFont
212         MultiPar              true
213 End
214
215 InsetLayout figure
216         LabelString           Figure
217         LabelFont
218           Color               collapsable
219           Size                Small
220         EndFont
221         MultiPar              true
222 End
223
224 InsetLayout table
225         LabelString           Table
226         LabelFont
227           Color               collapsable
228           Size                Small
229         EndFont
230         MultiPar              true
231 End
232
233 InsetLayout URL
234         LyXType               standard
235         LatexName             url
236         LatexType             command
237         Decoration            minimalistic
238         LabelString           URL
239         PassThru              true
240         ForceLTR              true
241         Font
242           Family              Typewriter
243           Color               Blue
244         EndFont
245         LabelFont
246           Family              Typewriter
247           Color               Blue
248           Size                Small
249         EndFont
250         Preamble
251           \usepackage{url}
252         EndPreamble
253 End
254
255 InsetLayout OptArg
256         LabelString           opt
257         LabelFont
258           Color               collapsable
259           Size                Small
260         EndFont
261         MultiPar              false
262 End