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"
79 Product "[Spreadsheet: $$FName]"
82 Product "[Spreadsheet: $$FName]"
85 Product "$$Contents(\"$$AbsPath$$Basename.html\")</p>"
86 UpdateFormat html_table
87 UpdateResult "$$AbsPath$$Basename.html"
92 # By default, InsetExternal is displayed as a grey button
93 # containing this text.
94 GuiName "Raster image"
95 # This text is used in the External dialog.
96 # Provide enough information to explain to the user just
97 # what the template can provide him with.
100 Use this template to include bitmap images of any kind.
102 # ANY file type can be displayed as a RasterImage.
103 # Specifically, LyX will attempt to interrogate the file itself
104 # in order to deduce its format.
106 # Globbing pattern used when browsing for a Raster image file.
107 FileFilter "*.{gif,png,jpg,bmp,pbm,ppm,tga,tif,xpm,xbm}"
108 # Set to "true" if the file represented by the template
109 # must be generated by LyX.
110 AutomaticProduction true
111 # LyX has hard-coded support for these transformations
116 # LyX preview options:
117 # Off: LyX will not attempt to show this material on screen.
118 # Graphics: LyX will attempt to show this material as-is or via a
119 # conversion to a showable format.
120 # InstantPreview: LyX will attempt to use the 'instant preview'
121 # mechanism in order to show this material.
124 TransformOption Rotate RotationLatexOption
125 TransformOption Resize ResizeLatexOption
126 TransformOption Clip ClipLatexOption
127 TransformOption Extra ExtraOption
128 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
129 # This string is what is output to the LaTeX file.
130 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
132 UpdateResult "$$AbsPath$$Basename.eps"
133 Requirement "graphicx"
134 ReferencedFile latex "$$AbsPath$$Basename.eps"
135 ReferencedFile dvi "$$AbsPath$$Basename.eps"
138 TransformOption Rotate RotationLatexOption
139 TransformOption Resize ResizeLatexOption
140 TransformOption Clip ClipLatexOption
141 TransformOption Extra ExtraOption
142 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
143 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
144 UpdateFormat "$$pngOrjpg"
145 UpdateResult "$$AbsPath$$Basename.$$pngOrjpg"
146 Requirement "graphicx"
147 ReferencedFile pdflatex "$$AbsPath$$Basename.$$pngOrjpg"
150 Product "[RasterImage: $$FName]"
153 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
155 UpdateResult "$$AbsPath$$Basename.eps"
156 ReferencedFile docbook "$$AbsPath$$Basename.eps"
157 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
160 Product "<img src=\"$$AbsOrRelPathMaster$$Basename.png\" />"
162 UpdateResult "$$AbsPath$$Basename.png"
163 ReferencedFile xhtml "$$AbsPath$$Basename.png"
167 Template VectorGraphics
168 GuiName "Vector graphics"
170 A vector graphics file.
171 Use this template to include vector graphics of any kind.
172 LyX will try to retain the vector properties of the image for
174 Note that specialized templates exist for Xfig figures and Dia diagrams.
175 The specialized templates allow to automatically use the document font in
176 the figures, which is not possible with this general template.
178 # ANY file type can be displayed as a VectorGraphics.
179 # Specifically, LyX will attempt to interrogate the file itself
180 # in order to deduce its format.
182 # Globbing pattern used when browsing for a vector graphics file.
183 # xfig, dia, fen and ly are exlcuded, since we have specialized templates
184 FileFilter "*.{agr,dot,emf,eps,odg,obj,sxd,svg,svgz,tgo,pdf,wmf}"
185 AutomaticProduction true
186 # LyX has hard-coded support for these transformations
193 TransformOption Rotate RotationLatexOption
194 TransformOption Resize ResizeLatexOption
195 TransformOption Clip ClipLatexOption
196 TransformOption Extra ExtraOption
197 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
198 # This string is what is output to the LaTeX file.
199 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
201 UpdateResult "$$AbsPath$$Basename.eps"
202 Requirement "graphicx"
203 ReferencedFile latex "$$AbsPath$$Basename.eps"
204 ReferencedFile dvi "$$AbsPath$$Basename.eps"
207 TransformOption Rotate RotationLatexOption
208 TransformOption Resize ResizeLatexOption
209 TransformOption Clip ClipLatexOption
210 TransformOption Extra ExtraOption
211 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
212 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
214 UpdateResult "$$AbsPath$$Basename.pdf"
215 Requirement "graphicx"
216 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
219 Product "[VectorGraphics: $$FName]"
222 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
224 UpdateResult "$$AbsPath$$Basename.eps"
225 ReferencedFile docbook "$$AbsPath$$Basename.eps"
226 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
229 Product "<img src=\"$$AbsOrRelPathMaster$$Basename.svg\" />"
231 UpdateResult "$$AbsPath$$Basename.svg"
232 ReferencedFile xhtml "$$AbsPath$$Basename.svg"
237 GuiName "Xfig figure"
243 AutomaticProduction true
246 Preview InstantPreview
248 TransformCommand Rotate RotationLatexCommand
249 TransformCommand Resize ResizeLatexCommand
250 Product "$$RotateFront$$ResizeFront\\input{$$AbsOrRelPathMaster$$Basename.pstex_t}$$ResizeBack$$RotateBack"
252 UpdateResult "$$AbsPath$$Basename.pstex_t"
254 Requirement "graphicx"
255 # Preamble WarnNotFound
256 # Preamble InputOrWarn
257 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
258 ReferencedFile latex "$$AbsPath$$Basename.eps"
259 ReferencedFile dvi "$$AbsPath$$Basename.eps"
262 TransformCommand Rotate RotationLatexCommand
263 TransformCommand Resize ResizeLatexCommand
264 Product "$$RotateFront$$ResizeFront\\input{$$AbsOrRelPathMaster$$Basename.pdftex_t}$$ResizeBack$$RotateBack"
266 UpdateResult "$$AbsPath$$Basename.pdftex_t"
268 Requirement "graphicx"
269 # Preamble WarnNotFound
270 # Preamble InputOrWarn
271 ReferencedFile pdflatex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
272 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
275 Product "[XFig: $$FName]"
278 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
280 UpdateResult "$$AbsPath$$Basename.eps"
281 ReferencedFile docbook "$$AbsPath$$Basename.eps"
282 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
285 Product "<img src=\"$$AbsOrRelPathMaster$$Basename.svg\" />"
287 UpdateResult "$$AbsPath$$Basename.svg"
288 ReferencedFile xhtml "$$AbsPath$$Basename.svg"
293 Template ChessDiagram
294 GuiName "Chess diagram"
296 A chess position diagram.
297 This template will use XBoard to edit the position.
298 Use the 'File->Save Position' in XBoard to save
299 the position that you want to display.
300 Make sure to give it a '.fen' extension
301 and remember to type in a relative path
302 to the LyX document location.
303 Within XBoard, use 'Edit->Edit Position'
304 to enable general editing of the board.
305 You might also check out the
306 'Options->Test legality' option, and
307 remember to middle and right click to
308 insert new material in the board.
309 In order for this to work, you have to
310 put the bundled lyxskak.sty in a place
311 that TeX will find it, and you will need
312 to install the skak package from CTAN.
316 AutomaticProduction true
317 Preview InstantPreview
319 Product "\\loadgame{$$AbsOrRelPathMaster$$Basename}\\showboard"
322 UpdateResult "$$AbsPath$$Basename$$Extension"
323 ReferencedFile latex "$$AbsPath$$Basename$$Extension"
326 Product "\\loadgame{$$AbsOrRelPathMaster$$Basename}\\showboard"
329 UpdateResult "$$AbsPath$$Basename$$Extension"
330 ReferencedFile pdflatex "$$AbsPath$$Basename$$Extension"
333 Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
334 UpdateFormat asciichess
335 UpdateResult "$$AbsPath$$Basename.asc"
338 Product "[Chess: $$AbsOrRelPathMaster$$Basename]"
341 Product "<pre>$$Contents(\"$$AbsPath$$Basename.asc\")</pre>"
342 UpdateFormat asciichess
343 UpdateResult "$$AbsPath$$Basename.asc"
349 GuiName "Lilypond typeset music"
351 Sheet music typeset by GNU LilyPond,
352 converted to .pdf or .eps for inclusion
353 Using .eps requires at least lilypond 2.6
354 Using .pdf requires at least lilypond 2.9
356 InputFormat "lilypond"
358 AutomaticProduction true
363 Preview InstantPreview
365 TransformOption Rotate RotationLatexOption
366 TransformOption Resize ResizeLatexOption
367 TransformOption Clip ClipLatexOption
368 TransformOption Extra ExtraOption
369 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
370 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
372 UpdateResult "$$AbsPath$$Basename.eps"
373 Requirement "graphicx"
374 ReferencedFile latex "$$AbsPath$$Basename.eps"
375 ReferencedFile dvi "$$AbsPath$$Basename.eps"
378 TransformOption Rotate RotationLatexOption
379 TransformOption Resize ResizeLatexOption
380 TransformOption Clip ClipLatexOption
381 TransformOption Extra ExtraOption
382 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
383 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
385 UpdateResult "$$AbsPath$$Basename.pdf"
386 Requirement "graphicx"
387 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
390 Product "[LilyPond: $$FName]"
393 Product "[LilyPond: $$FName]"
396 Product "<img src=\"$$AbsOrRelPathMaster$$Basename.png\" />"
398 UpdateResult "$$AbsPath$$Basename.png"
399 ReferencedFile xhtml "$$AbsPath$$Basename.png"
406 Includes PDF documents, using the 'pdfpages' package.
407 To include multiple pages, use the 'pages'-option,
408 which must be inserted to 'Options'.
410 * pages={x-y} (for a range of pages)
411 * pages={x,y,z} (for specific pages)
412 * pages=- (to include all pages)
413 * pages=last-1 (to include all pages in reverse order)
414 With the option 'noautoscale' the PDF pages are
415 inserted in their original size.
416 Read the documentation of the pdfpages package
417 for further options and details.
421 AutomaticProduction true
427 TransformOption Rotate RotationLatexOption
428 TransformOption Resize ResizeLatexOption
429 TransformOption Extra ExtraOption
430 Option Arg "[$$Extra,$$Rotate,$$Resize]"
431 Product "\\includepdf$$Arg{$$AbsOrRelPathMaster$$Basename}"
433 UpdateResult "$$AbsPath$$Basename.pdf"
434 Requirement "pdfpages"
435 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
438 Product "[PDFPages: $$FName]"
441 Product "[PDFPages: $$FName]"
444 Product "[PDFPages: $$FName]"
450 GuiName "Dia diagram"
456 AutomaticProduction true
457 # LyX has hard-coded support for these transformations
462 Preview InstantPreview
464 TransformOption Rotate RotationLatexOption
465 TransformOption Resize ResizeLatexOption
466 TransformOption Clip ClipLatexOption
467 TransformOption Extra ExtraOption
468 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
469 # This string is what is output to the LaTeX file.
470 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
472 UpdateResult "$$AbsPath$$Basename.eps"
473 Requirement "graphicx"
474 ReferencedFile latex "$$AbsPath$$Basename.eps"
475 ReferencedFile dvi "$$AbsPath$$Basename.eps"
478 TransformOption Rotate RotationLatexOption
479 TransformOption Resize ResizeLatexOption
480 TransformOption Clip ClipLatexOption
481 TransformOption Extra ExtraOption
482 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
483 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
485 UpdateResult "$$AbsPath$$Basename.pdf"
486 Requirement "graphicx"
487 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
490 Product "[Dia: $$FName]"
493 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
495 UpdateResult "$$AbsPath$$Basename.eps"
496 ReferencedFile docbook "$$AbsPath$$Basename.eps"
497 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
500 Product "<img src=\"$$AbsOrRelPathMaster$$Basename.svg\" />"
502 UpdateResult "$$AbsPath$$Basename.svg"
503 ReferencedFile xhtml "$$AbsPath$$Basename.svg"