2 # file external_templates
3 # This file is part of LyX, the document processor.
4 # Licence details can be found in the file COPYING.
6 # author Asger Alstrup Nielsen
8 # author Johnathan Burchill
10 # Full author contact details are available in file CREDITS.
12 # This file contains the definitions of those External Templates that are
13 # part of the official LyX distribution.
14 # Feel free to create your own External Templates, storing them in
15 # .lyx/external_templates
16 # Note that a user-defined external_templates file would replace this
17 # definition. Thus, if you would like to keep the external templates defined
18 # in this file, please copy this file and add on futher external templates
19 # to the end. For more information, see http://www.lyx.org/trac/ticket/3983.
22 PreambleDef WarnNotFound
23 %% Print a warning encased in an fbox.
24 \def\lyxstripprefix#1>{}
25 \newcommand{\warnNotFound}[1]{%
26 \def\lyxtempfilename{#1}%
28 \ttfamily\expandafter\lyxstripprefix\meaning\lyxtempfilename!}%
29 \typeout{Could not find \lyxtempfilename!}%
34 PreambleDef InputOrWarn
35 %% Input the file if it exists, using \input, else print a warning
36 \newcommand{\inputOrWarn}[1]{%
37 \IfFileExists{#1}{\input{#1}}{\warnNotFound{#1}}}
40 Template GnumericSpreadsheet
43 A spreadsheet made with Gnumeric, LibreOffice, OpenOffice or Excel.
44 It imports as a multi-page table, so any length
45 is ok. Excessive width could be a problem.
46 The gnumeric software is necessary for conversion,
47 both for gnumeric and excel files.
49 InputFormat "gnumeric"
50 FileFilter "*.{gnumeric,ods,xls}"
51 AutomaticProduction true
53 Product "\\def\\inputGnumericTable{}\\input{$$AbsOrRelPathMaster$$Basename.tex}"
55 UpdateResult "$$AbsPath$$Basename.tex"
58 Requirement "longtable"
60 Requirement "multirow"
63 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.tex"
66 Product "\\def\\inputGnumericTable{}\\input{$$AbsOrRelPathMaster$$Basename.tex}"
68 UpdateResult "$$AbsPath$$Basename.tex"
71 Requirement "longtable"
73 Requirement "multirow"
76 ReferencedFile pdflatex "$$AbsOrRelPathMaster$$Basename.tex"
81 # By default, InsetExternal is displayed as a grey button
82 # containing this text.
83 GuiName "Raster image"
84 # This text is used in the External dialog.
85 # Provide enough information to explain to the user just
86 # what the template can provide him with.
89 Use this template to include bitmap images of any kind.
91 # ANY file type can be displayed as a RasterImage.
92 # Specifically, LyX will attempt to interrogate the file itself
93 # in order to deduce its format.
95 # Globbing pattern used when browsing for a Raster image file.
96 FileFilter "*.{gif,png,jpg,bmp,pbm,ppm,tga,tif,xpm,xbm}"
97 # Set to "true" if the file represented by the template
98 # must be generated by LyX.
99 AutomaticProduction true
100 # LyX has hard-coded support for these transformations
105 # LyX preview options:
106 # Off: LyX will not attempt to show this material on screen.
107 # Graphics: LyX will attempt to show this material as-is or via a
108 # conversion to a showable format.
109 # InstantPreview: LyX will attempt to use the 'instant preview'
110 # mechanism in order to show this material.
113 TransformOption Rotate RotationLatexOption
114 TransformOption Resize ResizeLatexOption
115 TransformOption Clip ClipLatexOption
116 TransformOption Extra ExtraOption
117 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
118 # This string is what is output to the LaTeX file.
119 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
121 UpdateResult "$$AbsPath$$Basename.eps"
122 Requirement "graphicx"
123 ReferencedFile latex "$$AbsPath$$Basename.eps"
124 ReferencedFile dvi "$$AbsPath$$Basename.eps"
127 TransformOption Rotate RotationLatexOption
128 TransformOption Resize ResizeLatexOption
129 TransformOption Clip ClipLatexOption
130 TransformOption Extra ExtraOption
131 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
132 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
133 UpdateFormat "$$pngOrjpg"
134 UpdateResult "$$AbsPath$$Basename.$$pngOrjpg"
135 Requirement "graphicx"
136 ReferencedFile pdflatex "$$AbsPath$$Basename.$$pngOrjpg"
139 Product "[RasterImage: $$FName]"
142 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
144 UpdateResult "$$AbsPath$$Basename.eps"
145 ReferencedFile docbook "$$AbsPath$$Basename.eps"
146 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
150 Template VectorGraphics
151 GuiName "Vector graphics"
153 A vector graphics file.
154 Use this template to include vector graphics of any kind.
155 LyX will try to retain the vector properties of the image for
157 Note that specialized templates exist for Xfig figures and Dia diagrams.
158 The specialized templates allow to automatically use the document font in
159 the figures, which is not possible with this general template.
161 # ANY file type can be displayed as a VectorGraphics.
162 # Specifically, LyX will attempt to interrogate the file itself
163 # in order to deduce its format.
165 # Globbing pattern used when browsing for a vector graphics file.
166 # xfig, dia, fen and ly are exlcuded, since we have specialized templates
167 FileFilter "*.{agr,dot,emf,eps,odg,obj,sxd,svg,svgz,tgo,pdf,wmf}"
168 AutomaticProduction true
169 # LyX has hard-coded support for these transformations
176 TransformOption Rotate RotationLatexOption
177 TransformOption Resize ResizeLatexOption
178 TransformOption Clip ClipLatexOption
179 TransformOption Extra ExtraOption
180 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
181 # This string is what is output to the LaTeX file.
182 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
184 UpdateResult "$$AbsPath$$Basename.eps"
185 Requirement "graphicx"
186 ReferencedFile latex "$$AbsPath$$Basename.eps"
187 ReferencedFile dvi "$$AbsPath$$Basename.eps"
190 TransformOption Rotate RotationLatexOption
191 TransformOption Resize ResizeLatexOption
192 TransformOption Clip ClipLatexOption
193 TransformOption Extra ExtraOption
194 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
195 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
197 UpdateResult "$$AbsPath$$Basename.pdf"
198 Requirement "graphicx"
199 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
202 Product "[VectorGraphics: $$FName]"
205 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
207 UpdateResult "$$AbsPath$$Basename.eps"
208 ReferencedFile docbook "$$AbsPath$$Basename.eps"
209 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
212 Product "<img src=\"$$AbsOrRelPathMaster$$Basename.svg\" />"
214 UpdateResult "$$AbsPath$$Basename.svg"
215 ReferencedFile xhtml "$$AbsPath$$Basename.svg"
220 GuiName "Xfig figure"
226 AutomaticProduction true
229 Preview InstantPreview
231 TransformCommand Rotate RotationLatexCommand
232 TransformCommand Resize ResizeLatexCommand
233 Product "$$RotateFront$$ResizeFront\\input{$$AbsOrRelPathMaster$$Basename.pstex_t}$$ResizeBack$$RotateBack"
235 UpdateResult "$$AbsPath$$Basename.pstex_t"
237 Requirement "graphicx"
238 # Preamble WarnNotFound
239 # Preamble InputOrWarn
240 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
241 ReferencedFile latex "$$AbsPath$$Basename.eps"
242 ReferencedFile dvi "$$AbsPath$$Basename.eps"
245 TransformCommand Rotate RotationLatexCommand
246 TransformCommand Resize ResizeLatexCommand
247 Product "$$RotateFront$$ResizeFront\\input{$$AbsOrRelPathMaster$$Basename.pdftex_t}$$ResizeBack$$RotateBack"
249 UpdateResult "$$AbsPath$$Basename.pdftex_t"
251 Requirement "graphicx"
252 # Preamble WarnNotFound
253 # Preamble InputOrWarn
254 ReferencedFile pdflatex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
255 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
258 Product "[XFig: $$FName]"
261 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
263 UpdateResult "$$AbsPath$$Basename.eps"
264 ReferencedFile docbook "$$AbsPath$$Basename.eps"
265 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
268 Product "<img src=\"$$AbsOrRelPathMaster$$Basename.svg\" />"
270 UpdateResult "$$AbsPath$$Basename.svg"
271 ReferencedFile xhtml "$$AbsPath$$Basename.svg"
276 Template ChessDiagram
277 GuiName "Chess diagram"
279 A chess position diagram.
280 This template will use XBoard to edit the position.
281 Use the 'File->Save Position' in XBoard to save
282 the position that you want to display.
283 Make sure to give it a '.fen' extension
284 and remember to type in a relative path
285 to the LyX document location.
286 Within XBoard, use 'Edit->Edit Position'
287 to enable general editing of the board.
288 You might also check out the
289 'Options->Test legality' option, and
290 remember to middle and right click to
291 insert new material in the board.
292 In order for this to work, you have to
293 put the bundled lyxskak.sty in a place
294 that TeX will find it, and you will need
295 to install the skak package from CTAN.
299 AutomaticProduction true
300 Preview InstantPreview
302 Product "\\loadgame{$$AbsOrRelPathMaster$$Basename}\\showboard"
305 UpdateResult "$$AbsPath$$Basename$$Extension"
306 ReferencedFile latex "$$AbsPath$$Basename$$Extension"
309 Product "\\loadgame{$$AbsOrRelPathMaster$$Basename}\\showboard"
312 UpdateResult "$$AbsPath$$Basename$$Extension"
313 ReferencedFile pdflatex "$$AbsPath$$Basename$$Extension"
316 Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
317 UpdateFormat asciichess
318 UpdateResult "$$AbsPath$$Basename.asc"
321 Product "[Chess: $$AbsOrRelPathMaster$$Basename]"
324 Product "<pre>$$Contents(\"$$AbsPath$$Basename.asc\")</pre>"
325 UpdateFormat asciichess
326 UpdateResult "$$AbsPath$$Basename.asc"
332 GuiName "Lilypond typeset music"
334 Sheet music typeset by GNU LilyPond,
335 converted to .pdf or .eps for inclusion
336 Using .eps requires at least lilypond 2.6
337 Using .pdf requires at least lilypond 2.9
339 InputFormat "lilypond"
341 AutomaticProduction true
346 Preview InstantPreview
348 TransformOption Rotate RotationLatexOption
349 TransformOption Resize ResizeLatexOption
350 TransformOption Clip ClipLatexOption
351 TransformOption Extra ExtraOption
352 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
353 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
355 UpdateResult "$$AbsPath$$Basename.eps"
356 Requirement "graphicx"
357 ReferencedFile latex "$$AbsPath$$Basename.eps"
358 ReferencedFile dvi "$$AbsPath$$Basename.eps"
361 TransformOption Rotate RotationLatexOption
362 TransformOption Resize ResizeLatexOption
363 TransformOption Clip ClipLatexOption
364 TransformOption Extra ExtraOption
365 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
366 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
368 UpdateResult "$$AbsPath$$Basename.pdf"
369 Requirement "graphicx"
370 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
373 Product "[LilyPond: $$FName]"
376 Product "[LilyPond: $$FName]"
379 Product "<img src=\"$$AbsOrRelPathMaster$$Basename.png\" />"
381 UpdateResult "$$AbsPath$$Basename.png"
382 ReferencedFile xhtml "$$AbsPath$$Basename.png"
389 Includes PDF documents, using the 'pdfpages' package.
390 To include multiple pages, use the 'pages'-option,
391 which must be inserted to 'Options'.
393 * pages={x-y} (for a range of pages)
394 * pages={x,y,z} (for specific pages)
395 * pages=- (to include all pages)
396 * pages=last-1 (to include all pages in reverse order)
397 With the option 'noautoscale' the PDF pages are
398 inserted in their original size.
399 Read the documentation of the pdfpages package
400 for further options and details.
404 AutomaticProduction true
410 TransformOption Rotate RotationLatexOption
411 TransformOption Resize ResizeLatexOption
412 TransformOption Extra ExtraOption
413 Option Arg "[$$Extra,$$Rotate,$$Resize]"
414 Product "\\includepdf$$Arg{$$AbsOrRelPathMaster$$Basename}"
416 UpdateResult "$$AbsPath$$Basename.pdf"
417 Requirement "pdfpages"
418 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
421 Product "[PDFPages: $$FName]"
424 Product "[PDFPages: $$FName]"
427 Product "[PDFPages: $$FName]"
433 GuiName "Dia diagram"
439 AutomaticProduction true
440 # LyX has hard-coded support for these transformations
445 Preview InstantPreview
447 TransformOption Rotate RotationLatexOption
448 TransformOption Resize ResizeLatexOption
449 TransformOption Clip ClipLatexOption
450 TransformOption Extra ExtraOption
451 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
452 # This string is what is output to the LaTeX file.
453 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
455 UpdateResult "$$AbsPath$$Basename.eps"
456 Requirement "graphicx"
457 ReferencedFile latex "$$AbsPath$$Basename.eps"
458 ReferencedFile dvi "$$AbsPath$$Basename.eps"
461 TransformOption Rotate RotationLatexOption
462 TransformOption Resize ResizeLatexOption
463 TransformOption Clip ClipLatexOption
464 TransformOption Extra ExtraOption
465 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
466 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
468 UpdateResult "$$AbsPath$$Basename.pdf"
469 Requirement "graphicx"
470 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
473 Product "[Dia: $$FName]"
476 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
478 UpdateResult "$$AbsPath$$Basename.eps"
479 ReferencedFile docbook "$$AbsPath$$Basename.eps"
480 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
483 Product "<img src=\"$$AbsOrRelPathMaster$$Basename.svg\" />"
485 UpdateResult "$$AbsPath$$Basename.svg"
486 ReferencedFile xhtml "$$AbsPath$$Basename.svg"