]> git.lyx.org Git - lyx.git/blobdiff - lib/external_templates
PDF-comment.lyx: description of the pdfcomment module
[lyx.git] / lib / external_templates
index fc79017581c0780c7d5b90b9a86f46ad20fe441e..b01daea34b52104fc01b72cef242f3006dd325d2 100644 (file)
@@ -33,29 +33,90 @@ PreambleDef InputOrWarn
                \IfFileExists{#1}{\input{#1}}{\warnNotFound{#1}}}
 PreambleDefEnd
 
+Template GnumericSpreadsheet
+       GuiName "Spreadsheet"
+       HelpText
+               A spreadsheet made with Gnumeric, LibreOffice, OpenOffice or Excel.
+               It imports as a long table, so any length
+               is ok. Excessive width could be a problem.
+               The gnumeric software is necessary for conversion,
+               both for gnumeric and excel files.
+       HelpTextEnd
+       InputFormat "gnumeric"
+       FileFilter "*.{gnumeric,ods,xls}"
+       AutomaticProduction true
+       Format LaTeX
+               Product "\\def\\inputGnumericTable{}\\input{$$AbsOrRelPathMaster$$Basename.tex}"
+               UpdateFormat latex
+               UpdateResult "$$AbsPath$$Basename.tex"
+               Requirement "color"
+               Requirement "array"
+               Requirement "longtable"
+               Requirement "calc"
+               Requirement "multirow"
+               Requirement "hhline"
+               Requirement "ifthen"
+               ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.tex"
+               FormatEnd
+       Format PDFLaTeX
+               Product "\\def\\inputGnumericTable{}\\input{$$AbsOrRelPathMaster$$Basename.tex}"
+               UpdateFormat latex
+               UpdateResult "$$AbsPath$$Basename.tex"
+               Requirement "color"
+               Requirement "array"
+               Requirement "longtable"
+               Requirement "calc"
+               Requirement "multirow"
+               Requirement "hhline"
+               Requirement "ifthen"
+               ReferencedFile pdflatex "$$AbsOrRelPathMaster$$Basename.tex"
+       FormatEnd
+TemplateEnd
 
 Template RasterImage
-       GuiName "Bitmap: $$AbsOrRelPathParent$$Basename"
+       # By default, InsetExternal is displayed as a grey button
+       # containing this text.
+       GuiName "Raster image"
+       # This text is used in the External dialog.
+       # Provide enough information to explain to the user just
+       # what the template can provide him with.
        HelpText
                A bitmap file.
        HelpTextEnd
+       # ANY file type can be displayed as a RasterImage.
+       # Specifically, LyX will attempt to interrogate the file itself
+       # in order to deduce its format.
        InputFormat "*"
+       # Globbing pattern used when browsing for a Raster image file.
        FileFilter "*.{gif,png,jpg,bmp,pbm,ppm,tga,tif,xpm,xbm}"
+       # Set to "true" if the file represented by the template
+       # must be generated by LyX.
        AutomaticProduction true
+       # LyX has hard-coded support for these transformations
        Transform Rotate
        Transform Resize
        Transform Clip
        Transform Extra
+       # LyX preview options:
+       # Off: LyX will not attempt to show this material on screen.
+       # Graphics: LyX will attempt to show this material as-is or via a
+       #           conversion to a showable format.
+       # InstantPreview: LyX will attempt to use the 'instant preview'
+       #                 mechanism in order to show this material.
+       Preview Graphics
        Format LaTeX
                TransformOption Rotate RotationLatexOption
                TransformOption Resize ResizeLatexOption
                TransformOption Clip   ClipLatexOption
                TransformOption Extra  ExtraOption
                Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
+               # This string is what is output to the LaTeX file.
                Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
                UpdateFormat eps
                UpdateResult "$$AbsPath$$Basename.eps"
                Requirement "graphicx"
+               ReferencedFile latex "$$AbsPath$$Basename.eps"
+               ReferencedFile dvi   "$$AbsPath$$Basename.eps"
        FormatEnd
        Format PDFLaTeX
                TransformOption Rotate RotationLatexOption
@@ -67,6 +128,7 @@ Template RasterImage
                UpdateFormat png
                UpdateResult "$$AbsPath$$Basename.png"
                Requirement "graphicx"
+               ReferencedFile pdflatex "$$AbsPath$$Basename.png"
        FormatEnd
        Format Ascii
                Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
@@ -77,32 +139,36 @@ Template RasterImage
                Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
                UpdateFormat eps
                UpdateResult "$$AbsPath$$Basename.eps"
-       FormatEnd
-       Format LinuxDoc
-               Product "[Bitmap: $$FName]"
+               ReferencedFile docbook     "$$AbsPath$$Basename.eps"
+               ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
        FormatEnd
 TemplateEnd
 
 
 Template XFig
-       GuiName "XFig: $$AbsOrRelPathParent$$Basename"
+       GuiName "Xfig figure"
        HelpText
-               An XFig figure.
+               An Xfig figure.
        HelpTextEnd
        InputFormat fig
        FileFilter "*.fig"
        AutomaticProduction true
        Transform Rotate
        Transform Resize
+       Preview InstantPreview
        Format LaTeX
                TransformCommand Rotate RotationLatexCommand
                TransformCommand Resize ResizeLatexCommand
                Product "$$RotateFront$$ResizeFront\\input{$$AbsOrRelPathMaster$$Basename.pstex_t}$$ResizeBack$$RotateBack"
                UpdateFormat pstex
                UpdateResult "$$AbsPath$$Basename.pstex_t"
+               Requirement "color"
                Requirement "graphicx"
                # Preamble WarnNotFound
                # Preamble InputOrWarn
+               ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
+               ReferencedFile latex "$$AbsPath$$Basename.eps"
+               ReferencedFile dvi   "$$AbsPath$$Basename.eps"
        FormatEnd
        Format PDFLaTeX
                TransformCommand Rotate RotationLatexCommand
@@ -110,9 +176,12 @@ Template XFig
                Product "$$RotateFront$$ResizeFront\\input{$$AbsOrRelPathMaster$$Basename.pdftex_t}$$ResizeBack$$RotateBack"
                UpdateFormat pdftex
                UpdateResult "$$AbsPath$$Basename.pdftex_t"
+               Requirement "color"
                Requirement "graphicx"
                # Preamble WarnNotFound
                # Preamble InputOrWarn
+               ReferencedFile pdflatex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
+               ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
        FormatEnd
        Format Ascii
                Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
@@ -123,15 +192,14 @@ Template XFig
                Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
                UpdateFormat eps
                UpdateResult "$$AbsPath$$Basename.eps"
-       FormatEnd
-       Format LinuxDoc
-               Product "[XFig: $$FName]"
+               ReferencedFile docbook     "$$AbsPath$$Basename.eps"
+               ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
        FormatEnd
 TemplateEnd
 
 
 Template ChessDiagram
-       GuiName "Chess: $$AbsOrRelPathParent$$Basename"
+       GuiName "Chess diagram"
        HelpText
                A chess position diagram.
                This template will use XBoard to edit the position.
@@ -154,9 +222,20 @@ Template ChessDiagram
        InputFormat fen
        FileFilter "*.fen"
        AutomaticProduction true
+       Preview InstantPreview
        Format LaTeX
                Product "\\loadgame{$$AbsOrRelPathMaster$$Basename}\\showboard"
                Requirement "chess"
+               UpdateFormat fen
+               UpdateResult "$$AbsPath$$Basename$$Extension"
+               ReferencedFile latex "$$AbsPath$$Basename$$Extension"
+       FormatEnd
+       Format PDFLaTeX
+               Product "\\loadgame{$$AbsOrRelPathMaster$$Basename}\\showboard"
+               Requirement "chess"
+               UpdateFormat fen
+               UpdateResult "$$AbsPath$$Basename$$Extension"
+               ReferencedFile pdflatex "$$AbsPath$$Basename$$Extension"
        FormatEnd
        Format Ascii
                Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
@@ -166,8 +245,97 @@ Template ChessDiagram
        Format DocBook
                Product "[Chess: $$AbsOrRelPathMaster$$Basename]"
        FormatEnd
-       Format LinuxDoc
-               Product "[Chess: $$FName]"
+TemplateEnd
+
+
+Template LilyPond
+       GuiName "Lilypond typeset music"
+       HelpText
+               Sheet music typeset by GNU LilyPond,
+               converted to .pdf or .eps for inclusion
+               Using .eps requires at least lilypond 2.6
+               Using .pdf requires at least lilypond 2.9
+       HelpTextEnd
+       InputFormat "lilypond"
+       FileFilter "*.ly"
+       AutomaticProduction true
+       Transform Rotate
+       Transform Resize
+       Transform Clip
+       Transform Extra
+       Preview InstantPreview
+       Format LaTeX
+               TransformOption Rotate RotationLatexOption
+               TransformOption Resize ResizeLatexOption
+               TransformOption Clip   ClipLatexOption
+               TransformOption Extra  ExtraOption
+               Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
+               Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
+               UpdateFormat eps
+               UpdateResult "$$AbsPath$$Basename.eps"
+               Requirement "graphicx"
+               ReferencedFile latex "$$AbsPath$$Basename.eps"
+               ReferencedFile dvi   "$$AbsPath$$Basename.eps"
+       FormatEnd
+       Format PDFLaTeX
+               TransformOption Rotate RotationLatexOption
+               TransformOption Resize ResizeLatexOption
+               TransformOption Clip   ClipLatexOption
+               TransformOption Extra  ExtraOption
+               Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
+               Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
+               UpdateFormat pdf6
+               UpdateResult "$$AbsPath$$Basename.pdf"
+               Requirement "graphicx"
+               ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
+       FormatEnd
+       Format Ascii
+               Product "[LilyPond: $$FName]"
+       FormatEnd
+       Format DocBook
+               Product "[LilyPond: $$FName]"
+       FormatEnd
+TemplateEnd
+
+Template PDFPages
+       GuiName "PDF pages"
+       HelpText
+               Includes PDF documents, using the 'pdfpages' package.
+               To include multiple pages, use the 'pages'-option,
+               which must be inserted to 'Options'.
+               Examples:
+               * pages={x-y} (for a range of pages)
+               * pages={x,y,z} (for specific pages)
+               * pages=- (to include all pages)
+               * pages=last-1 (to include all pages in reverse order)
+               With the option 'noautoscale' the PDF pages are
+               inserted in their original size.
+               Read the documentation of the pdfpages package
+               for further options and details.
+       HelpTextEnd
+       InputFormat pdf6
+       FileFilter "*.pdf"
+       AutomaticProduction true
+       Transform Rotate
+       Transform Resize
+       Transform Extra
+       Preview Graphics
+       Format LaTeX
+               TransformOption Rotate RotationLatexOption
+               TransformOption Resize ResizeLatexOption
+               TransformOption Extra  ExtraOption
+               Option Arg "[$$Extra,$$Rotate,$$Resize]"
+               Product "\\includepdf$$Arg{$$AbsOrRelPathMaster$$Basename}"
+               UpdateFormat pdf6
+               UpdateResult "$$AbsPath$$Basename.pdf"
+               Requirement "pdfpages"
+               ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
+       FormatEnd
+       Format Ascii
+               Product "[PDFPages: $$FName]"
+       FormatEnd
+       Format DocBook
+               Product "[PDFPages: $$FName]"
        FormatEnd
 TemplateEnd
 
@@ -181,24 +349,80 @@ Template Date
        InputFormat date
        FileFilter "*"
        AutomaticProduction true
+       Preview Off
        Format LaTeX
                Product "$$Contents(\"$$Tempname\")"
                UpdateFormat dateout
                UpdateResult "$$Tempname"
        FormatEnd
-       Format Ascii
+       Format PDFLaTeX
                Product "$$Contents(\"$$Tempname\")"
                UpdateFormat dateout
                UpdateResult "$$Tempname"
        FormatEnd
-       Format DocBook
+       Format Ascii
                Product "$$Contents(\"$$Tempname\")"
                UpdateFormat dateout
                UpdateResult "$$Tempname"
        FormatEnd
-       Format LinuxDoc
+       Format DocBook
                Product "$$Contents(\"$$Tempname\")"
                UpdateFormat dateout
                UpdateResult "$$Tempname"
        FormatEnd
 TemplateEnd
+
+Template Dia
+       GuiName "Dia diagram"
+       HelpText
+               Dia diagram.
+       HelpTextEnd
+       InputFormat dia
+       FileFilter "*.dia"
+       AutomaticProduction true
+       # LyX has hard-coded support for these transformations
+       Transform Rotate
+       Transform Resize
+       Transform Clip
+       Transform Extra
+       Preview InstantPreview
+       Format LaTeX
+               TransformOption Rotate RotationLatexOption
+               TransformOption Resize ResizeLatexOption
+               TransformOption Clip   ClipLatexOption
+               TransformOption Extra  ExtraOption
+               Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
+               # This string is what is output to the LaTeX file.
+               Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
+               UpdateFormat eps
+               UpdateResult "$$AbsPath$$Basename.eps"
+               Requirement "graphicx"
+               ReferencedFile latex "$$AbsPath$$Basename.eps"
+               ReferencedFile dvi   "$$AbsPath$$Basename.eps"
+       FormatEnd
+       Format PDFLaTeX
+               TransformOption Rotate RotationLatexOption
+               TransformOption Resize ResizeLatexOption
+               TransformOption Clip   ClipLatexOption
+               TransformOption Extra  ExtraOption
+               Option Arg "[$$Extra,$$Rotate,$$Resize,$$Clip]"
+               Product "\\includegraphics$$Arg{$$AbsOrRelPathMaster$$Basename}"
+               UpdateFormat pdf6
+               UpdateResult "$$AbsPath$$Basename.pdf"
+               Requirement "graphicx"
+               ReferencedFile pdflatex "$$AbsPath$$Basename.pdf"
+       FormatEnd
+       Format Ascii
+               Product "$$Contents(\"$$AbsPath$$Basename.asc\")"
+               UpdateFormat asciiimage
+               UpdateResult "$$AbsPath$$Basename.asc"
+       FormatEnd
+       Format DocBook
+               Product "<graphic fileref=\"$$AbsOrRelPathMaster$$Basename.eps\"></graphic>"
+               UpdateFormat eps
+               UpdateResult "$$AbsPath$$Basename.eps"
+               ReferencedFile docbook     "$$AbsPath$$Basename.eps"
+               ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
+       FormatEnd
+TemplateEnd
+