Configuring the bATR

The bATR settings are stored in the bATR.config file. Below you will find all options available for configuring. The basic structure of this file looks like this:

<?xml version="1.0"?>
<bATRConfig>
	<admin>
		<username>any</username>
		<password>any</password>
	</admin>
	<themes>		
		<theme>
			<style />
			<style />
		</theme>
	</themes>
</bATRConfig>



The bATRConfig attributes:
AttributeDescriptionRequiredValues
cacheExpirationDuration for caching the images in minutesnoany, default=300
cachedItemsLimitThe max. # of cached itemsnoany, default=100
cachingCaching enablednotrue(default), false
clientCacheExpirationExpiration, in days, on the clientsidenoany, default=7
bATREnginePathPath to the engineyes~/bATR/
imagePathPath where the images are requestedyes/bATRCache
replaceImagesOnPrintImages are not great for printing; this option replaces the images on printingnotrue(default), false



bATRConfig.admin section:
ElementDescriptionRequiredValues
usernameusername for viewing cache monitoryesany
passwordrelated passwordyesyany




The bATRConfig.themes theme attributes:
AttributeDescriptionRequiredValues
namename of the theme you want to createyesany
defaultFontNameThe default font for this theme (possible override in style)yesthe font name
defaultFontStyleThe default style the font should get (possible override in style)noNormal and others in System.Windows.FontStyles
defaultFontWeightThe default font weight (possible override in style)noNormal and others in Sysem.Windows.FontWeights
defaultFontStretchthe default font stretch (possible override in style)noNormal and others in System.Windows.FontStretches



The bATRConfig.theme.theme.Style attributes:
AttributeDescriptionRequiredValues
nameName of the style, use in bATRImage usercontrolyesany
fontSizesize of the text in EMyes10, 12.5, 14.4
fontColorThe HEX color the text thould be presented inyes#aabbcc, #ffffff
bgColorThe HEX backgroundcolor the images must be written onyes#ffffff, #aabbcc
fontNameoverride the themes fontnamenosee theme desc
fontStyleoverride the themes stylenosee theme desc
fontWeightoverrides the themes weightnosee theme desc
lineHeightsets the texts lineheight in pixelsnoany int like 21
characterSpacingthe space between the characters in pixelsno1, 3, 10
spaceSizethe size of the space character in pixels,optional when letterSpacing is setno10
inlineImagerelative url to an image that should be placed in backgroundno~/images/btn.png
inlineImageRectrectangle the image should be placed in, only used when you use an inline imageno"0,0,20,20"
textStartPointfor positioning the textno"0,20"
headerHtmlTagThe HTML tag to render with the bATRnoh2, h3
textToLowerRenders all texts to lowernotrue, false
textToUpperRenders all text to uppernotrue, false
renderedImageWidthFixed width, in px, for image outputno100, 200
renderedImageHeightFixed height, in px, for image outputno20, 30
New in version 1.6
gradientColorThe color to fade to in gradientno#aabbcc, #ffffff
gradientAngleThe angle to create the gradient inno0>360
decorationStyleStyles like underline, striketroughnoAny value from System.Windows.TextDecorationLocation
decorationColorColor for the underlineno#aabbcc or any HEX
decorationGradientThe gradient color for the decorationno#aabbcc or any HEX
decorationGardientAngleThe angle for the gradientno0>360
decorationThicknessThe thickness for the decorationno3 or so
decorationOffSetThe offset for the line positioning the lineno2 or so