File Header
The file header for a gear manifest file looks like this:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE portal-manifest PUBLIC
"-//Art Technology Group, Inc.//DTD Portal Manifest//EN"
"http://www.atg.com/dtds/portal/framework/portal_manifest_1.0.dtd">
<portal-manifest name="NAME" version="1.0" author="AUTHOR">
<!-- BODY OF MANIFEST GOES HERE --!>
</portal-manifest>
Gear Manifest Example
The gear manifest file sets values for the gear. For example, if the <dimensions> setting in the manifest file is specified as wide when the manifest file is imported into the PAF, this does not mean that the gear can only be rendered in a wide column. It simply means that by default it will be placed in a wide column.
In particular, note the <servlet-context> setting for the gear. The servlet context is the gear’s URI (considered independently of the portal). The servlet context must match the value of <context-root> in the gear’s Enterprise Application Deployment Descriptor file (application.xml).
The following shows an abbreviated gear manifest file for a document exchange gear.
<!--FILE HEADER GOES HERE --!> <gear-definitions> <gear-definition name="Document Exchange" version="1.0" author="AUTHOR"> <description>Document Exchange Gear</description> <servlet-context>/gear/docexch</servlet-context> <dimensions> <dimension name="height">noPreference</dimension> <dimension name="width">wide</dimension> </dimensions> <gear-modes> <gear-mode name="content"> <display-modes> <display-mode name="shared"> <device-output name="html">/DocExchShared.jsp</device-output> </display-mode> <display-mode name="full"> <device-output name="html">/DocExchFull.jsp</device-output> </display-mode> </display-modes> </gear-mode> <gear-mode name="userConfig"> <display-modes> <display-mode name="full"> <device-output name="html">/UserConfig.jsp</device-output> </display-mode> </display-modes> </gear-mode> <!-- ADDITIONAL GEAR MODES GO HERE --!> </gear-modes> <instance-parameters> <parameter name="repositoryPath" required="false"> <default-value> /atg/portal/gear/docexch/DocumentRepository </default-value> </parameter> <parameter name="itemDescriptorName" required="false"> <default-value> document </default-value> </parameter> </instance-parameters> <!-- ADDITIONAL INSTANCE PARAMETERS GO HERE --!> <user-parameters> <parameter name="shortListSize" required="false"> <default-value> 3 </default-value> </parameter> <parameter name="fullListPageSize" required="false"> <default-value> 12 </default-value> </parameter> </user-parameters> <!-- ADDITIONAL USER PARAMETERS GO HERE --!> </gear-definition> </gear-definitions>
