Navigation:  Welcome to BeerSmith! > Options >

Custom Reports

Previous pageReturn to chapter overviewNext page
Online Support: BeerSmith Home | Support | Forum | Videos | Blog | Purchase a Key

With BeerSmith 2 you can create your own custom report formats in addition to those included with BeerSmith.  Custom reports can be created either in plain text format or HTML format.  HTML format offers greater flexibility as you can include images, advanced formatting, etc.

 

A good starting point for a custom report is to look at the reports that come with BeerSmith.  These are typically installed to your BeerSmith templates directory under the Program Files (Application package on the Mac).  On windows this is in the "Program Files/BeerSmith2/Reports" directory.  In the Mac the reports are located within the BeerSmith2 application under the Contents/Reports section.

 

Text files may contain simple text formatting (spaces, tabs and newlines).  To insert a piece of BeerSmith data you include the name of the BeerSmith variable with a dollar sign ('$') before it in the template.  For example within a recipe $NAME will be replaced with the name of the recipe, $STYLE_NAME the name of the beer style selected, etc...

 

HTML templates work exactly the same way - including $NAME will display the name of the recipe within an HTML recipe template.

 

BeerSmith supports the names listed in the BeerXML standard - all with a dollar sign in front of them.  See the BeerXML standard for an extensive listing of variables available (see below for more tags).

 

Once you have a template created, save it to the Documents/BeerSmith2/Reports directory and then you can install it using the instructions below.

 

 

 

Commonly Used Recipe Tags

Purpose          Tag

Actual Alcohol by Vol:   $ABV

Adjust Temp for Equipment:   $EQUIP_ADJUST

Age beer for:   $AGE

Age (In Days)r:   $AGE

Asst Brewer:   $ASST_BREWER

Batch Size:   $DISPLAY_BATCH_SIZE

Bitterness:   $IBU

Bitterness Ratio:   $BITTERNESS_RATIO

Boil Ingredients:   $BOIL_INGREDIENTS

Boil Size:   $DISPLAY_BOIL_SIZE

Boil Time:   $BOIL_TIME

Boil Volume:   $DISPLAY_BOIL_SIZE

Bottling Date:   $BOTTLING_DATE

Brewer:   $BREWER

Brewhouse Efficiency:   $EFFICIENCY

Calories:   $CALORIES

Carbonation Type:   $CARBONATION_TYPE

Carbonation Used:   $CARBONATION_USED

Color Swatch:   $COLOR_SWATCH

((Added 3/28/08)) HEX Color:   $RGB_COLOR

Date:   $DATE

Display Age Temp:   $DISPLAY_AGE_TEMP

Display Batch Size:   $DISPLAY_BATCH_SIZE

Display Carbonation:   $DISPLAY_CARBONATION

Display Primary Temp:   $DISPLAY_PRIMARY_TEMP

Display Secondary Temp:   $DISPLAY_SECONDARY_TEMP

Display Tertiary Temp:   $DISPLAY_TERTIARY_TEMP

Drink and Enjoy!:   $END_DATE

Equipment:   $EQUIPMENT

Est Color:   $EST_COLOR

Est Final Gravity:   $EST_FG

Est Original Gravity:   $EST_OG

Estimated Alcohol by Vol:   $EST_ABV

Estimated pre-boil gravity:   $PRE_BOIL_OG

Ferment Ingredients:   $FERMENT_INGREDIENTS

Final Volume:   $DISPLAY_BATCH_SIZE

For Batch Size:   $BATCH_SIZE

Grain Temperature:   $GRAIN_TEMP

Ingredients:   $INGREDIENTS

Keg/Bottling Temperature:   $DISPLAY_CARB_TEMP

Mash Ingredients :   $MASH_INGREDIENTS

Mash Ingredients :   $MASH_INGREDIENTS

Measured Final Gravity:   $DISPLAY_FG

Measured Original Gravity:   $DISPLAY_OG

Name:   $NAME

Notes:   $NOTES

Prepare for Bottling/Kegging:   $BOTTLING_INGREDIENTS

Pressure/Weight:   $CARBONATION_PRESS

Primary Age:   $PRIMARY_AGE

Primary fermentation:   $PRIMARY_DATE

Primary Ingredients:   $PRIMARY_INGREDIENTS

Recipe Price   $PRICE

Secondary Age:   $SECONDARY_AGE

Secondary fermentation:   $SECONDARY_DATE

Secondary Ingredients:   $SECONDARY_INGREDIENTS

Sparge Steps:   $SPARGE_STEPS

Sparge Temperature:   $SPARGE_TEMP

Sparge Water:   $SPARGE_VOLUME

Steep Hops:   $STEEP_HOPS

Steep Ingredients:   $STEEP_INGREDIENTS

Storage Temperature:   $DISPLAY_AGE_TEMP

Style Category   $STYLE.CATEGORY

Style Letter:   $STYLE_LETTER

Style Name:   $STYLE_NAME

Taste Notes:   $TASTE_NOTES

Taste Rating(out of 50):   $TASTE_RATING

Tertiary Age:   $TERTIARY_AGE

Tertiary Fermentation:   $TERTIARY_DATE

Total Grain Weight:   $GRAIN_WEIGHT

Total Grain Weight:   $TOTAL_GRAINS

Total Hops added to boil:   $TOTAL_HOPS

TunTemperature:   $TUN_TEMP

Type:   $TYPE

Volumes of CO2:   $CARBONATION

Water preperation:   $WATER_PREP

Yeast Starter:   $YEAST_STARTERS