From 2c7b7e3e48cce55cc97d977166b64292056ede36 Mon Sep 17 00:00:00 2001
From: Angus Leeming <leeming@lyx.org>
Date: Thu, 29 Apr 2004 11:33:04 +0000
Subject: [PATCH] Add some commentary.

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@8708 a592a061-630c-0410-9148-cb99ea01b6c8
---
 lib/ChangeLog          |  5 +++++
 lib/external_templates | 13 +++++++++++++
 2 files changed, 18 insertions(+)

diff --git a/lib/ChangeLog b/lib/ChangeLog
index a545bedecc..1aadec9713 100644
--- a/lib/ChangeLog
+++ b/lib/ChangeLog
@@ -1,3 +1,8 @@
+2004-04-29  Angus Leeming  <leeming@lyx.org>
+
+	* external_templates: add some commentary to the RasterImage
+	template.
+
 2004-04-27  Angus Leeming  <leeming@lyx.org>
 
 	* configure.m4: don't create a lyxpreview -> png converter if
diff --git a/lib/external_templates b/lib/external_templates
index fc79017581..6154609fee 100644
--- a/lib/external_templates
+++ b/lib/external_templates
@@ -35,13 +35,25 @@ PreambleDefEnd
 
 
 Template RasterImage
+	# By default, InsetExternal is displayed as a grey button
+	# containing this text.
 	GuiName "Bitmap: $$AbsOrRelPathParent$$Basename"
+	# 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
@@ -52,6 +64,7 @@ Template RasterImage
 		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"
-- 
2.39.2