lib/external_templates

   1 #
   2 # file external_templates
   3 # This file is part of LyX, the document processor.
   4 # Licence details can be found in the file COPYING.
   5 #
   6 # author Asger Alstrup Nielsen
   7 # author Angus Leeming
   8 # author Johnathan Burchill
   9 #
  10 # Full author contact details are available in file CREDITS.
  11
  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
  17
  18 PreambleDef WarnNotFound
  19         %% Print a warning encased in an fbox.
  20         \def\lyxstripprefix#1>{}
  21         \newcommand{\warnNotFound}[1]{%
  22                 \def\lyxtempfilename{#1}%
  23                 \fbox{Could not find
  24                         \ttfamily\expandafter\lyxstripprefix\meaning\lyxtempfilename!}%
  25                 \typeout{Could not find \lyxtempfilename!}%
  26         }
  27 PreambleDefEnd
  28
  29
  30 PreambleDef InputOrWarn
  31         %% Input the file if it exists, using \input, else print a warning
  32         \newcommand{\inputOrWarn}[1]{%
  33                 \IfFileExists{#1}{\input{#1}}{\warnNotFound{#1}}}
  34 PreambleDefEnd
  35
  36
  37 Template RasterImage
  38         # By default, InsetExternal is displayed as a grey button
  39         # containing this text.
  40         GuiName "Bitmap: $$AbsOrRelPathParent$$Basename"
  41         # This text is used in the External dialog.
  42         # Provide enough information to explain to the user just
  43         # what the template can provide him with.
  44         HelpText
  45                 A bitmap file.
  46         HelpTextEnd
  47         # ANY file type can be displayed as a RasterImage.
  48         # Specifically, LyX will attempt to interrogate the file itself
  49         # in order to deduce its format.
  50         InputFormat "*"
  51         # Globbing pattern used when browsing for a Raster image file.
  52         FileFilter "*.{gif,png,jpg,bmp,pbm,ppm,tga,tif,xpm,xbm}"
  53         # Set to "true" if the file represented by the template
  54         # must be generated by LyX.
  55         AutomaticProduction true
  56         # LyX has hard-coded support for these transformations
  57         Transform Rotate
  58         Transform Resize
  59         Transform Clip
  60         Transform Extra
  61         Format LaTeX
  62                 TransformOption Rotate RotationLatexOption
  63                 TransformOption Resize ResizeLatexOption
  64                 TransformOption Clip   ClipLatexOption
  65                 TransformOption Extra  ExtraOption
  66                 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
  67                 # This string is what is output to the LaTeX file.
  68                 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
  69                 UpdateFormat eps
  70                 UpdateResult "$$AbsPath$$Basename.eps"
  71                 Requirement "graphicx"
  72                 ReferencedFile latex "$$AbsPath$$Basename.eps"
  73                 ReferencedFile dvi   "$$AbsPath$$Basename.eps"
  74         FormatEnd
  75         Format PDFLaTeX
  76                 TransformOption Rotate RotationLatexOption
  77                 TransformOption Resize ResizeLatexOption
  78                 TransformOption Clip   ClipLatexOption
  79                 TransformOption Extra  ExtraOption
  80                 Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
  81                 Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
  82                 UpdateFormat png
  83                 UpdateResult "$$AbsPath$$Basename.png"
  84                 Requirement "graphicx"
  85                 ReferencedFile pdflatex "$$AbsPath$$Basename.png"
  86         FormatEnd
  87         Format Ascii
  88                 Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
  89                 UpdateFormat asciiimage
  90                 UpdateResult "$$AbsPath$$Basename.asc"
  91         FormatEnd
  92         Format DocBook
  93                 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
  94                 UpdateFormat eps
  95                 UpdateResult "$$AbsPath$$Basename.eps"
  96                 ReferencedFile docbook     "$$AbsPath$$Basename.eps"
  97                 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
  98         FormatEnd
  99         Format LinuxDoc
 100                 Product "[Bitmap: $$FName]"
 101         FormatEnd
 102 TemplateEnd
 103
 104
 105 Template XFig
 106         GuiName "XFig: $$AbsOrRelPathParent$$Basename"
 107         HelpText
 108                 An XFig figure.
 109         HelpTextEnd
 110         InputFormat fig
 111         FileFilter "*.fig"
 112         AutomaticProduction true
 113         Transform Rotate
 114         Transform Resize
 115         Format LaTeX
 116                 TransformCommand Rotate RotationLatexCommand
 117                 TransformCommand Resize ResizeLatexCommand
 118                 Product "$$RotateFront$$ResizeFront\\input{$$AbsOrRelPathMaster$$Basename.pstex_t}$$ResizeBack$$RotateBack"
 119                 UpdateFormat pstex
 120                 UpdateResult "$$AbsPath$$Basename.pstex_t"
 121                 Requirement "graphicx"
 122                 # Preamble WarnNotFound
 123                 # Preamble InputOrWarn
 124                 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
 125                 ReferencedFile latex "$$AbsPath$$Basename.eps"
 126                 ReferencedFile dvi   "$$AbsPath$$Basename.eps"
 127         FormatEnd
 128         Format PDFLaTeX
 129                 TransformCommand Rotate RotationLatexCommand
 130                 TransformCommand Resize ResizeLatexCommand
 131                 Product "$$RotateFront$$ResizeFront\\input{$$AbsOrRelPathMaster$$Basename.pdftex_t}$$ResizeBack$$RotateBack"
 132                 UpdateFormat pdftex
 133                 UpdateResult "$$AbsPath$$Basename.pdftex_t"
 134                 Requirement "graphicx"
 135                 # Preamble WarnNotFound
 136                 # Preamble InputOrWarn
 137                 ReferencedFile pdflatex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
 138                 ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
 139         FormatEnd
 140         Format Ascii
 141                 Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
 142                 UpdateFormat asciixfig
 143                 UpdateResult "$$AbsPath$$Basename.asc"
 144         FormatEnd
 145         Format DocBook
 146                 Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
 147                 UpdateFormat eps
 148                 UpdateResult "$$AbsPath$$Basename.eps"
 149                 ReferencedFile docbook     "$$AbsPath$$Basename.eps"
 150                 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
 151         FormatEnd
 152         Format LinuxDoc
 153                 Product "[XFig: $$FName]"
 154         FormatEnd
 155 TemplateEnd
 156
 157
 158 Template ChessDiagram
 159         GuiName "Chess: $$AbsOrRelPathParent$$Basename"
 160         HelpText
 161                 A chess position diagram.
 162                 This template will use XBoard to edit the position.
 163                 Use the 'File->Save Position' in XBoard to save
 164                 the position that you want to display.
 165                 Make sure to give it a '.fen' extension
 166                 and remember to type in a relative path
 167                 to the LyX document location.
 168                 Within XBoard, use 'Edit->Edit Position'
 169                 to enable general editing of the board.
 170                 You might also check out the
 171                 'Options->Test legality' option, and
 172                 remember to middle and right click to
 173                 insert new material in the board.
 174                 In order for this to work, you have to
 175                 put the bundled lyxskak.sty in a place
 176                 that TeX will find it, and you will need
 177                 to install the skak package from CTAN.
 178         HelpTextEnd
 179         InputFormat fen
 180         FileFilter "*.fen"
 181         AutomaticProduction true
 182         Format LaTeX
 183                 Product "\\loadgame{$$AbsOrRelPathMaster$$Basename}\\showboard"
 184                 Requirement "chess"
 185                 ReferencedFile latex "$$AbsPath$$Basename$$Extension"
 186         FormatEnd
 187         Format PDFLaTeX
 188                 Product "\\loadgame{$$AbsOrRelPathMaster$$Basename}\\showboard"
 189                 Requirement "chess"
 190                 ReferencedFile pdflatex "$$AbsPath$$Basename$$Extension"
 191         FormatEnd
 192         Format Ascii
 193                 Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
 194                 UpdateFormat asciichess
 195                 UpdateResult "$$AbsPath$$Basename.asc"
 196         FormatEnd
 197         Format DocBook
 198                 Product "[Chess: $$AbsOrRelPathMaster$$Basename]"
 199         FormatEnd
 200         Format LinuxDoc
 201                 Product "[Chess: $$FName]"
 202         FormatEnd
 203 TemplateEnd
 204
 205
 206 Template Date
 207         GuiName "Date"
 208         HelpText
 209                 Today's date.
 210                 Read 'info date' for more information.
 211         HelpTextEnd
 212         InputFormat date
 213         FileFilter "*"
 214         AutomaticProduction true
 215         Format LaTeX
 216                 Product "$$Contents(\"$$Tempname\")"
 217                 UpdateFormat dateout
 218                 UpdateResult "$$Tempname"
 219         FormatEnd
 220         Format PDFLaTeX
 221                 Product "$$Contents(\"$$Tempname\")"
 222                 UpdateFormat dateout
 223                 UpdateResult "$$Tempname"
 224         FormatEnd
 225         Format Ascii
 226                 Product "$$Contents(\"$$Tempname\")"
 227                 UpdateFormat dateout
 228                 UpdateResult "$$Tempname"
 229         FormatEnd
 230         Format DocBook
 231                 Product "$$Contents(\"$$Tempname\")"
 232                 UpdateFormat dateout
 233                 UpdateResult "$$Tempname"
 234         FormatEnd
 235         Format LinuxDoc
 236                 Product "$$Contents(\"$$Tempname\")"
 237                 UpdateFormat dateout
 238                 UpdateResult "$$Tempname"
 239         FormatEnd
 240 TemplateEnd