AgileApps Support Wiki

Difference between revisions of "Add a Document Template"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
 
(21 intermediate revisions by the same user not shown)
Line 1: Line 1:
A Print Template can be added to any object, except for the built-in [[Documents]] and [[Users]] objects. It can use a [[Page]] stored in the platform, or it can be creating using an external HTML, Word, or Excel file. This section outlines the process.
A Document Template can be added to any object, except for the built-in [[Users]] object. It can use a [[Page]] stored in the platform, or it can be created using an external HTML, Word, or PowerPoint file. This section outlines the process.


;A. Get the names of variables you'll be using in the template:
'''To add a Document Template to an Object:'''
#Click '''Designer > Data > Objects > {object} > Print Templates'''
#Click the '''[New Template]''' button.<br>The ''New Template'' page appears.
#Click the '''[New Template]''' button
#:
#In the ''New Template'' page, use the [[Template Variable Tool]] to get the names of variables you can use in the template:
#Use the [[Template Variable Tool]] to get the names of variables you can use in the template:
#:[[File:TemplateVariableTool.jpg]]
#:[[File:TemplateVariableTool.jpg]]
#:''Note:'' Template variables work only in HTML pages. They do not work in JSP pages.<br>(In those pages, use standard JSP programming techniques to access platform information.)
#:'''Note:'''<br>Template variables can be used in HTML, Word, and PowerPoint files. (In [[Pages]] stored in the platform, you use standard JSP programming techniques to access platform information, rather than template variables.)
 
#:
;B. Create the template:
# If it does not already exist, create the template.<br>Follow the instructions below to add images and template variables, depending on the type of template you need to create:
#Create a JSP/HTML [[Page]] in the platform
#:* [[Create an MS Word Document Template]]
#* Turn off the ''Include Headers'' option for that page.<br>(Those headers contain platform-specific Javascript that interfere with template processing.)<br>&nbsp;'''-or-'''
#:* [[Create a PowerPoint Document Template]]
# Create an HTML page on your local system.<br>&nbsp;'''-or-'''
#:* [[Create an HTML Document Template]]
# Create a Word document on your local system, saved in <tt>.docx</tt> format.<br>&nbsp;'''-or-'''
#:* [[Create a JSP Page Document Template]]
# Create an Excel spreadsheet document on your local system, saved in <tt>.pptx</tt> format.<br>&nbsp;'''-or-'''
#:* [[Create a Compound Document Template]], composed of multiple parts
# Add "boilerplate" text and graphics to the template,
#:
{{Note|The <tt>.docx</tt> and <tt>.pptx</tt> files are stored in an XML format the platform can parse and work with. The <tt>.doc</tt> and <tt>.ppt</tt> formats are binary formats that won't work.}}
 
;C. Add the Print Template to an Object:
#Provide the information in the Template Information section:
#Provide the information in the Template Information section:
#:;Template Title:The template name
#:;Template Title:The template name
#:;Description:Describe the purpose of the template or other information about it.
#:;Description:Describe the purpose of the template or other information about it.
#:;Ready to Use:The default setting for the template is Yes.
#:;Ready to Use:The default setting for the template is Yes.
#:;Type:Choose from:
#:;Type:
#::;Template File:This file that provides the template structure. Click the '''[Browse]''' button to locate the HTML, Word, or Excel file.
#::'''HTML -''' To upload an HTML, Word, or PowerPoint file stored on your local system.
#::;Page:JSP Page;
#:::* The '''[Browse]''' button appears.
#:::*A list of platform [[Pages]] is displayed.
#:::* Click it to locate the file to upload.
#::::(The list does not include pages that have the ''Include Headers'' option.)
#::'''Page -''' To use a JSP/HTML [[Page]] stored in the platform.
#:::*Choose one of the JSP files stored in the platform.  
#:::* A list of platform [[Pages]] is displayed.
#:::: (The list does not include pages that have the ''Include Headers'' option.)
#:::* Choose one of the listed pages.  
#:
#Click '''[Save]'''
#Click '''[Save]'''

Latest revision as of 00:51, 21 March 2014

A Document Template can be added to any object, except for the built-in Users object. It can use a Page stored in the platform, or it can be created using an external HTML, Word, or PowerPoint file. This section outlines the process.

To add a Document Template to an Object:

  1. Click the [New Template] button.
    The New Template page appears.
  2. Use the Template Variable Tool to get the names of variables you can use in the template:
    TemplateVariableTool.jpg
    Note:
    Template variables can be used in HTML, Word, and PowerPoint files. (In Pages stored in the platform, you use standard JSP programming techniques to access platform information, rather than template variables.)
  3. If it does not already exist, create the template.
    Follow the instructions below to add images and template variables, depending on the type of template you need to create:
  4. Provide the information in the Template Information section:
    Template Title
    The template name
    Description
    Describe the purpose of the template or other information about it.
    Ready to Use
    The default setting for the template is Yes.
    Type
    HTML - To upload an HTML, Word, or PowerPoint file stored on your local system.
    • The [Browse] button appears.
    • Click it to locate the file to upload.
    Page - To use a JSP/HTML Page stored in the platform.
    • A list of platform Pages is displayed.
    (The list does not include pages that have the Include Headers option.)
    • Choose one of the listed pages.
  5. Click [Save]
Retrieved from "https://agileappscloud.info/aawiki-src/index.php?title=Add_a_Document_Template&oldid=1944"