Difference between revisions of "Create an HTML Document Template"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
Line 1: | Line 1: | ||
# | ===Creating the Template Page=== | ||
# Start by creating a JSP/Html [[Page]] in the platform. | |||
#: Turn off the ''Include Headers'' option for that page. | #: Turn off the ''Include Headers'' option for that page. | ||
#: (Those headers contain platform-specific Javascript that interfere with template processing.) | #: (Those headers contain platform-specific Javascript that interfere with template processing.) | ||
Line 21: | Line 22: | ||
:<tt><nowiki><img src=”IMG{$Customer.logo_image}”></nowiki></tt> | :<tt><nowiki><img src=”IMG{$Customer.logo_image}”></nowiki></tt> | ||
==Inserting a Chart== | ===Inserting a Chart=== | ||
To insert a chart into a Print Template, use the platform <tt>CHART</tt> tag in an HTML <tt>img</tt> element. | To insert a chart into a Print Template, use the platform <tt>CHART</tt> tag in an HTML <tt>img</tt> element. | ||
Revision as of 00:30, 17 February 2012
Creating the Template Page
- Start by creating a JSP/Html Page in the platform.
- Turn off the Include Headers option for that page.
- (Those headers contain platform-specific Javascript that interfere with template processing.)
- ...
Inserting an Image Stored in an Object Record
To insert an image into a Print Template, use the platform IMG tag in an HTML img element.
- Format
- <img src="IMG{$objectName.imageFieldName}">
where:
- objectName - The name of the current object. (This variable is in Template:Velocity format. The object name effectively creates a namespace, ensuring that there is no conflict with another variable that might have the same name.)
- imageFieldName - The name of the field in the current record that contains the image to display, joined to the object name by a "dot" (.).
- Result
- The URL for the image is inserted into the generated page. When viewed, the image is displayed.
- Example
- <img src=”IMG{$Customer.logo_image}”>
Inserting a Chart
To insert a chart into a Print Template, use the platform CHART tag in an HTML img element.
- Format
- <img src="CHART{$report_id}">
- <img src="CHART{$report_id, chart-title=Your Title, field1=value, ...}">
where:
- report_id - A required argument that gives the ID of the report that generates the chart.
- chart-title - An optional argument containing text for a chart title.
- field1 - An optional record field. Only records with a matching value will be included in the generated chart. Up to three fields and values can be specified in the comma-separated list. (More can be specified, but only the first three are used.)
- Result
- A URL for the generated chart is inserted into the generated page. When viewed, the chart image is displayed.
Example #1 - Inserting a chart with no optional arguments:
- <img src="CHART{c5cc43653b1b49db8142bc844735c209}">
Example #2 - Inserting a chart of Orders taken by the owner of the current record:
- <img src="CHART{c5cc43653b1b49db8142bc844735c209, chart-title=Orders by $Order.owner.full_name, owner_id=$Order.owner.id}">