Customizing Templates

Introduction to Configurable Templates

In WarmHub, Templates are how you can format the way that your Repo and the data inside of it, are displayed.

There are three main templates that you can use to customize the display of your Repo.

1. The Landing Page - Landing Page - The Landing Page can be completly customized using its Template, so that you can build a page that shares the context of your Repo, and can pull in as much live data from within the Repo as you wish.

   1. Landing Page Templates can be edited by clicking the Edit Template button in the upper right hand corner of any Landing Page that you have the rights to edit.

   2. If you see formatting you like on a Repo that you do not have edit rights to, you can find a View Template Button at the bottom right of a Landing Page Template, so that you can view and copy any relevant formatting.

2. Full Instance Template - When you are viewing an instance committed to your Repo, you can define what data shows, and how it is labeled, formatted and arranged, just as you can a Landing Page.

   1. It is important to note that the template you define will apply to all instances of that type, not just to one instance.

      1. For Example, if you had a Type named Company, and you edited the Template for the WarmHub Instance, it would apply not only to the WarmHub Instance of Company, but to any instance of a company. This means that if Microsoft was another instance of Company, it would show up the same template that was defined for WarmHub. This allows you to easily define the Template for large sets of data, by editing just a few templates.

   2. The Full Instance Template can be edited by by clicking the Edit Template button in the upper right hand corner of any Instance that you have the rights to edit.

   3. For example, here is the Full Instance Template for the WarmHub Article

   
3. Summary Instance Template - This is small card that shows the summary of an instance, when it is viewed on other pages, such as in the Data/Articles Grid, or when it needs to be summarized on the full instance page for a related item.

   1. It is important to note that the template you define will apply to all instances of that type, not just to one instance.

      1. For Example, if you had a Type named Company, and you edited the Template for the WarmHub Instance, it would apply not only to the WarmHub Instance of Company, but to any instance of a company. This means that if Microsoft was another instance of Company, it would show up the same template that was defined for WarmHub. This allows you to easily define the Template for large sets of data, by editing just a few templates.

   2. The Summary Instance Template can be edited by by clicking the Edit Template button in the upper right hand corner of any Instance that you have the rights to edit and the clicking Summary Template Button in the upper left hand corner of the Template Editing Sceen.

   3. For example, here is the Summary Instance Template for the same WarmHub Article we showed above

   

Editing a template

You can access the template editor for both types of templates by visiting their respective pages:

• For Landing Pages, navigate to the Landing page of your Repo and select “Edit template”

• For instance data, navigate to the instance datum and select “Edit template”

The Template Editing Screen

• Override default template - By default, a Template is generated for each Landing page and Instance. Checking the "Override default template" checkbox will allow you to write your own template. Unchecking that box will revert the template back to the default template.

  • Unchecking the "Override default template" checkbox will not delete your previously defined template. To return to your custom template, check the "Override default template" checkbox again.

• Text Editor - On the left hand side of the Template Editing Screen is the text editor, where you can make changes to the template.

• Preview - On the right hand side of the Screen you can see the preview of the page generated from the current template, and watch it update as you make changes.

• Data - By clicking Data at the top of the Preview screen, you can view the structure of relevant data for the Template you are viewing, which can help you understand how to pull relevant data into your template.

• Validation - By clicking Validation at the top of the Preview screen, you can view any validation errors that are being thrown by the current template.

• Borders - If you are having issues that may be related to nesting or indenting in your template, you can turn on the Borders to help troubleshoot how things are aligned.

• Save - Once you save the template, it will immediately be applied in the relevant locations.