enfr

Snippets: letterhead and closing

Updated: 2016-12-01

Snippets allow you to insert a piece of template code into another template. This is an easy way to share template content that you use in more than one place. Use the Template Editor to create, edit and use snippets.

Built-in Letterhead, Address, Salutation, and Closing snippets

In order to allow you to customize the letterhead, salutation, address and the closing signature of all templates and still get the latest body from the built-in templates, we have created snippets. These snippets mean you don't need to edit every template in which these details appear, you can just clone and edit the snippet to have it apply across templates.

  • All built-in templates use Letterhead and Closing snippets (if needed) to insert the letterhead and signature in each template. The Letterhead and Closing snippets automatically use the image files you set in Options to add a signature and logo.   
  • The Address snippet inserts the taxpayer's address wherever it is needed.
  • For 2018 T1, we added a Salutation snippets for client (CSalutation), joint (JSalutation), family (FSalutation) and deceased taxpayers (DSalutation). Edit these to change the way you address the beginning of the letters. The Salutation snippets refer to the Address snippet.

Editing built-in snippets

  1. In the Templates sidebar, find and open the built-in Letterhead snippet for the module and year you are working on.
  2. Click Clone Template to create a copy of the snippet that replaces the built-in snippet. 
  3. The first time you clone a snippet it replaces the built-in template of the same name. (If you clone it a second time, it will not replace the built-in snippet.)
  4. Edit the cloned snippet until it looks as you want it. (To remove the entire existing letterhead, press Ctrl+A to select all, then press Delete.)
  5. Preview and test just your snippet as you would any other template. (Learn more in the Template Editor help topic.)
  6. Preview and test the snippet again with a built-in letter or invoice to make sure it works correctly once inserted.

letterhead-snippet636156183568496046

Using snippets in templates

While TaxCycle has built-in snippets to help with letterheads and closing statements, you can also create your own snippets to insert anywhere for sharing frequently-used content. Here's how to insert a snippet in a template.

  1. Click New to start a new template.
  2. Check the years and modules to which the snippet will apply.
  3. In the Properties sidebar, enter a Name and Description. In this example, we will create a snippet called Salutation.
  4. For the type, select Snippet for the Type.
  5. Add content to the snippet and preview/test the snippet as you normally would any other template. 
  6. Go to the template in which you wish to use the snippet, and enter the code to refer to the snippet: In between double braces {{ }} (curly brackets), enter a greater-than symbol  > and then the name of the snippet template. For example, to insert the snippet into a template, use the code: {{> Salutation }}
  7. Take care to test well if you created snippet across tax modules, as only some field codes are common between T1 and T2, for example. Most field codes are consistent between different years of tax modules, but you may need to create a snippet for each type of tax return if they contain content specific to that module.

salutation-snippet

Changing the layout of the letterhead

A common request we have is to change the letterhead from side-by-side to a more vertical layout, with the logo at the top.

  1. Make sure you add your logo to options (see above).
  2. Clone the Letterhead template (see above).
  3. Right-click on the place where you see the logo and select Delete Columns. This deletes the column that contains the logo on the right.
  4. To re-insert a logo, place your cursor at the very start {{# CurrentClient.Engage.Preparer }} and press Enter to start a new line. Then, click Insert Picture to browse for and select the logo image file.
  5. To centre-align the entire header, select everything from and including the logo you just inserted to {{/ CurrentClient.Engage.Preparer }} and press the Centre button in the toolbar.
  6. If your logo contains the business name and you don't want it inserted from the Engagement form, delete the text from {{# OperatingName}} to {{/ not(OperatingName}}.
    Remove the firm name from the letterhead
  7. Save the template to keep your changes.

Letterhead instead of logo

If you use an image to create your letterhead—one that contains a logo and the address—you can simply modify the Letterhead snippet to include just the logo and then enter the path to your full letterhead in options.  

  1. Use the Logo field in options to insert your full letterhead image.
  2. Download this template to use it for all years and all modules (up to 2018): GlobalLetterhead.taxcycletemplate 
  3. Put the template in your templates folder.