Project

Purpose:
xx
Namespace:
urn:WebWorks-XSLT-Extension-Project
Prefix:
wwprojext
Methods:
GetDocumentsToGenerateChecksum():

xx

Returns:
String.
Example:
xx
GetProjectDataDirectoryPath():

This returns the project's top level data directory path. Traditionally this is the "Data" directory that is located next to the project file (.wep).

Returns:
String.
Example:
<!-- Create an absolute path to a configuration file in the data directory -->
<!--                                                                       -->
<xsl:variable name="VarConfFilename">MyConfigurationFile.xml</xsl:variable>
<xsl:variable name="VarDataDirectory" select="wwprojext:GetProjectDataDirectoryPath()" />
<xsl:variable name="VarPathToConfigurationFile" select="wwfilesystem:Combine($VarDataDirectory, $VarConfFilename)" />
GetProjectFilesDirectoryPath():

xx

Returns:
String.
Example:
xx
GetProjectFormatDirectoryPath():

xx

Returns:
String.
Example:
xx
GetProjectTargetName():

xx

Returns:
String.
Example:
xx
GetTargetDataDirectoryPath():

xx

Returns:
String.
Example:
xx
GetTargetOutputDirectoryPath():

This returns the full path to the current target's output directory.

Returns:
String.
Example:

Create a path to "UserManual.pdf" in the output directory.

<xsl:variable name="VarUserManualFilePath select="wwfilesystem:Combine(wwprojext:GetTargetOutputDirectoryPath(), 'UserManual.pdf')" />
GetConfigurationChangeID():

xx

Returns:
String.
Example:
xx
GetRule(string ruleTypeAsString, string ruleName):

xx

Returns:
xx
Example:
xx
GetContextRule(string ruleTypeAsString, string ruleName, string documentID, string uniqueID):

xx

Returns:
xx
Example:
xx
GetOverrideRule(string ruleTypeAsString, string ruleName, string documentID, string uniqueID):

xx

Returns:
xx
Example:
xx
GetFormatName():

xx

Returns:
String.
Example:
xx
GetFormatID():

xx

Returns:
String.
Example:
xx
GetFormatSetting(string name, string defaultValue*):

This retrieves a value from the format settings. New format settings can be created using the .fti files found in the format. For example, the company info settings are found in:

Formats/Shared/common/companyinfo/companyinfo.fti

[Comment from David Shaked] Please provide a list of the format identifiers (values of the "name" parameter) that can be used in this method. I found examples by searching the XSL. Some of them are not obvious.]

Returns:
String.
Example:
<!-- in companyinfo.fti -->
<Settings>
  ...
  <Setting name="company-name" group="company-info" default="">
    <SettingClass name="string" />
  </Setting>
  ...
</Setting>

<!-- in the XSLs -->

<!-- get the company name from the format settings -->
<xsl:variable name="VarCompanyName" select="wwprojext:GetFormatSetting('company-name', 'WebWorks.com')" />
GetConditionIsPassThrough(string conditionName):

xx

Returns:
Boolean.
Example:
xx
GetGroupName(string groupID):

Gets the name of the group based on the groupID.

Returns:
String.
Example:
<xsl:variable name="VarGroupName" select="wwprojext:GetGroupName($VarProjectGroup/@GroupID)" />
GetGroupDataDirectoryPath(string groupID):

xx

Returns:
String.
Example:
xx
GetDocumentPath(string documentID):

xx

Returns:
String.
Example:
xx
GetDocumentDataDirectoryPath(string documentID):

xx

Returns:
String.
Example:
xx
GetDocumentGroupPath(string documentID):

xx

Returns:
String.
Example:
xx
DocumentExtension(string extension):

xx

Returns:
Boolean.
Example:
xx

DevCenter/Documentation/ExtensionObjects/ePublisher/Project (last edited 2014-06-24 20:54:54 by LiefErickson)