Advanced Format and Target Customizations
Understanding Customized Processing
Format and Target Overrides
Creating Format Overrides
Creating Target Overrides
Managing Overrides
Customizing Page Templates (*.asp)
Page Templates Reference
Namespace and Attributes
Using ePublisher Style Variables in Page Templates
Using Markers in Page Templates
ePublisher Pipeline and Transforms
Terminology
Processing Workflow
Transformation Process
Adapters Transform Source Documents to WIF
WebWorks Intermediate Format (WIF)
Processing Files by Type
Identifying Files to Process
TOC Processing Example
Stationery, Projects, and Overrides
File Locations
File Processing
ePublisher File Types
Format Trait Info (*.fti) Files
format.wwfmt Files
files.info Files
Stationery Design Project .wep File
Project .wrp File
Stationery .wxsp File
XSL Match Templates
Root Match Templates
Root Match Templates in ePublisher
Extension Objects
Output and Console Customizations
Creating Super Overrides
Introduction
Audience
Help
Conventions
Formatting
Terminology
Organization
About XML and XSL
Architectural Overview
Real World Example
File Reference
File Locations
File Processing
What This Means For The User
File Types
Format Trait Info (*.fti)
Explanation
Components
Relationships
format.wwfmt
Explanation
Components
Relationships
files.info
Explanation
Components
Relationships
Designer Project File (.wep)
Stationery File (.wsxp)
Express Project File (.wrp)
XSL Match Templates
Root Match Templates
Root Match Templates in ePublisher Designer
Real Life Example
Extension Objects
Output Customizations
Transform Overrides
Creating Transform Overrides
Information about Overriding files
XSLT Reference
XSLT Documentation
Good to Know
Using Extension Objects
General XSL Extensions
Microsoft Extensions
Using ePublisher XSLT Extensions
ePublisher Platform XSLT Extensions
Class Documentation
Adapter
void AddToPDFPageNumberOffset (int addToPageNumberOffset)
bool GeneratePDF (string originalDocumentPath, string conversionPDFDocumentPath, bool singleFile, XPathNodeIterator tocStyleNodesIterator, XPathNodeIterator groupFileNodesIterator, string pdfJobSettings, string pdfFilePath)
bool GeneratePDFWithSaveAs (string originalDocumentPath, string conversionPDFDocumentPath, bool singleFile, XPathNodeIterator tocStyleNodesIterator, XPathNodeIterator groupFileNodesIterator, string pdfJobSettings, string pdfFilePath)
bool GeneratePostScriptForImage (object input, string postScriptPath)
long GeneratePostScriptForPDF (string originalDocumentPath, string conversionPDFDocumentPath, bool singleFile, XPathNodeIterator tocStyleNodesIterator, XPathNodeIterator groupFileNodesIterator, string postScriptFilePath)
void SetPDFPageNumberOffset (int pageNumberOffset)
bool TemporaryLicense (string toolAdapterName)
AdapterConfiguration
string GetValue (string name)
string GetValue (string name, string defaultValue)
DateTimeUtilities
string GetNow (string format)
string GetGenerateStart (string format)
string GetFileCreated (string filepath, string format)
string GetFileLastModified (string filepath, string format)
string GetFromDateTimeString (string dateTime, string inputFormat, string outputFormat)
Environment
string ApplicationBaseHelpURI ()
string CurrentUILocale ()
long GetTotalMemory ()
long GetTotalMemory (bool forceFullCollection)
string HTMLHelpWorkshopPath ()
string JavaBits ()
string JavaHome ()
string JavaVersion ()
string JDKBits ()
string JDKHome ()
string JDKVersion ()
string JREBits ()
string JREHome ()
string JREVersion ()
bool RequestedPipeline (string pipelineName)
Exec
XPathNodeIterator Execute (string commandLine)
XPathNodeIterator ExecuteCommand (string command [, string argument1, string argument2, string argument3, string argument4, string argument5, string argument6, string argument7, string argument8, string argument9, string argument10, string argument11, string argument12, string argument13, string argument14, string argument15, string argument16, string argument17, string argument18, string argument19, string argument20])
XPathNodeIterator ExecuteCommandNoReturn (string command)
XPathNodeIterator ExecuteCommandInDirectory (string directoryPath, string command [, string argument1, string argument2, string argument3, string argument4, string argument5, string argument6, string argument7, string argument8, string argument9, string argument10, string argument11, string argument12, string argument13, string argument14, string argument15, string argument16, string argument17, string argument18, string argument19, string argument20])
XPathNodeIterator ExecuteCommandInDirectoryWithTimeout (long timeoutInSeconds, string directoryPath, string command [, string argument1, string argument2, string argument3, string argument4, string argument5, string argument6, string argument7, string argument8, string argument9, string argument10, string argument11, string argument12, string argument13, string argument14, string argument15, string argument16, string argument17, string argument18, string argument19, string argument20])
XPathNodeIterator ExecuteCommandWithTimeout (long timeoutInSeconds, string command [, string argument1, string argument2, string argument3, string argument4, string argument5, string argument6, string argument7, string argument8, string argument9, string argument10, string argument11, string argument12, string argument13, string argument14, string argument15, string argument16, string argument17, string argument18, string argument19, string argument20])
XPathNodeIterator ExecuteInDirectory (string directoryPath, string commandLine)
XPathNodeIterator ExecuteInDirectoryWithTimeout (long timeoutInSeconds, string directoryPath, string commandLine)
XPathNodeIterator ExecuteProgramWithArguments (string program, string arguments)
XPathNodeIterator ExecuteProgramWithArgumentsInDirectory (string directoryPath, string program, string arguments)
XPathNodeIterator ExecuteProgramWithArgumentsInDirectoryWithTimeout (long timeoutInSeconds, string directoryPath, string program, string arguments)
XPathNodeIterator ExecuteProgramWithArgumentsWithTimeout (long timeoutInSeconds, string program, string arguments)
XPathNodeIterator ExecuteWithTimeout (long timeoutInSeconds, string commandLine)
ExecPython
XPathNodeIterator ExecutePyScriptInCommandLine (string commandLine)
XPathNodeIterator ExecPyScript (string pyScriptPath [, string argument1, string argument2, string argument3, string argument4, string argument5, string argument6, string argument7, string argument8, string argument9, string argument10, string argument11, string argument12, string argument13, string argument14, string argument15, string argument16, string argument17, string argument18, string argument19])
XPathNodeIterator ExecutePyScriptInDirectoryInCommandLine (string directoryPath, string commandLine)
XPathNodeIterator ExecPyScriptInDirectory (string directoryPath, string pyScriptPath [, string argument1, string argument2, string argument3, string argument4, string argument5, string argument6, string argument7, string argument8, string argument9, string argument10, string argument11, string argument12, string argument13, string argument14, string argument15, string argument16, string argument17, string argument18, string argument19])
Sass
XPathNodeIterator SassToCss (string inputSassFilePath, string outputCssFilePath)
void ReplaceAllVariablesInFile (string inputSassFilePath, object replacements)
ExslDocument
void Document (object input, string path [, string encoding, string method, string version, string indent, string omit_xml_declaration, string standalone, string doctype_public, string doctype_system, string cdata_section_elements, string media_type])
XPathNodeIterator LoadXMLWithoutResolver (string uriAsString [, bool preserveSpace])
XPathNodeIterator LoadXMLWithResolver (string uriAsString [, bool preserveSpace])
XPathNodeIterator MakeEmptyElement (object input)
Files
bool UpToDate (string path, string projectChecksum, string groupID, string documentID, string actionChecksum)
FileSystem
bool AppendFileWithFile (string targetPath, string sourcePath)
bool ChecksumUpToDate (string path, string checksum)
string Combine (string path, string component1 [, string component2, string component3, string component4, string component5, string component6, string component7, string component8, string component9, string component10])
XPathNodeIterator CopyDirectoryFiles (string sourceDirectoryPath, string destinationDirectoryPath)
XPathNodeIterator CopyFile (string sourcePath, string destinationPath)
bool CreateDirectory (string path)
void DeleteDirectory (string path)
void DeleteFile (string path)
bool DirectoryExists (string path)
bool Exists (string path)
bool FileExists (string path)
bool FilesEqual (string alphaPath, string betaPath)
string GetAbsoluteFrom (string relativePath, string referencePath)
string GetBaseName (string path)
string GetChecksum (string path)
string GetDirectoryName (string path)
string GetExtension (string path)
string GetFileName (string path)
string GetFileNameWithoutExtension (string path)
XPathNodeIterator GetFiles (string path)
string GetLongPathName (string path)
XPathNodeIterator GetRelativeFiles (string path)
string GetRelativeTo (string path, string anchorPath)
string GetShortPathName (string path)
string GetTempFileName ()
string GetTempPath ()
string GetWithExtensionReplaced (string path, string extension)
string MakeValidFileName (string fileNameSeed)
void TranslateFileToEncoding (string sourceFilePath, string sourceFileEncodingName, string destinationFilePath, string destinationFileEncodingName)
Fonts
bool UnicodeFont (string fontFamily)
Imaging
XPathNodeIterator GetInfo (string imageFilePath)
void MapPDFLinks (object fileTable, string fileToFix, string fileToWrite, string originalFilePath, string outputFilePath, bool useAbsPath)
bool MergePDFs (object sourceFileList, string targetFilePath)
bool MergePDFs (object sourceFileList, object fileTable, string targetFilePath)
bool PostScriptToPDF (string postScriptFilePath, string pdfJobSettings, string pdfFilePath)
XPathNodeIterator RasterizePostScript (string postScriptFilePath, int renderHorizontalDPI, int renderVerticalDPI, int renderWidth, int renderHeight, string targetImageFormatAsString, int targetImageColorDepth, bool targetImageGrayscale, bool targetImageTransparent, bool targetImageInterlaced, int targetImageQuality, string targetFilePath)
XPathNodeIterator Transform (string inputImageFilePath, string outputImageFormat, int outputImageWidth, int outputImageHeight, string outputImageFilePath)
XPathNodeIterator Transform (string inputImageFilePath, string outputImageFormatAsString, int Choice_outputImageQuality_outputImageWidth, int Choice_outputImageWidth_outputImageHeight, string Choice_outputImageHeight_outputImageFilePath, string Choice_outputImageFilePath_outputResolution)
XPathNodeIterator Transform (string inputImageFilePath, string outputImageFormatAsString, int outputImageQuality, int outputImageWidth, int outputImageHeight, string outputImageFilePath, int outputResolution)
Log
void Error (string message1 [, string message2, string message3, string message4, string message5, string message6, string message7, string message8, string message9, string message10])
void Message (string message1 [, string message2, string message3, string message4, string message5, string message6, string message7, string message8, string message9, string message10])
void Warning (string message1 [, string message2, string message3, string message4, string message5, string message6, string message7, string message8, string message9, string message10])
MultiSearchReplaceExtension
void ReplaceAllInFile (string inputEncodingAsString, string inputFilePath, string outputFilePath, object replacements)
void ReplaceAllInFile (string inputEncodingAsString, string inputFilePath, string outputEncodingAsString, string outputFilePath, object replacements)
string ReplaceAllInString (string input, object replacements)
NodeSet
XPathNodeIterator FirstUnique (object input, string attributeLocalName)
XPathNodeIterator FirstUniqueWithNamespace (object input, string attributeLocalName, string attributeNamespaceURI)
XPathNodeIterator LastUnique (object input, string attributeLocalName)
XPathNodeIterator LastUniqueWithNamespace (object input, string attributeLocalName, string attributeNamespaceURI)
Progress
bool Abort ()
void Cancel ()
void End ()
void QueueAlert (string message)
void Retry ()
void SetStatus (string message)
void Start (int totalSubSteps)
Project
bool DocumentExtension (string extension)
bool GetConditionIsPassThrough (string conditionName)
string GetConfigurationChangeID ()
XPathNodeIterator GetContextRule (string ruleTypeAsString, string ruleName, string documentID, string uniqueID)
string GetDocumentDataDirectoryPath (string documentID)
string GetDocumentGroupPath (string documentID)
string GetDocumentID (string documentPath [, string groupID])
string GetDocumentPath (string documentID)
string GetDocumentsToGenerateChecksum ()
string GetFormatID ()
string GetFormatName ()
string GetFormatSetting (string name)
string GetFormatSetting (string name, string defaultValue)
string GetGroupDataDirectoryPath (string groupID)
string GetGroupName (string groupID)
XPathNodeIterator GetOverrideRule (string ruleTypeAsString, string ruleName, string documentID, string uniqueID)
string GetProjectDataDirectoryPath ()
string GetProjectDirectoryPath ()
long GetProjectDocumentsCount ()
string GetProjectFilesDirectoryPath ()
string GetProjectFormatDirectoryPath ()
string GetProjectName ()
string GetProjectReportsDirectoryPath ()
string GetProjectTargetName ()
string GetProjectTargetOverrideDirectoryPath ()
XPathNodeIterator GetRule (string ruleTypeAsString, string ruleName)
string GetTargetDataDirectoryPath ()
string GetTargetFilesInfoPath (string targetIDAsString)
string GetTargetOutputDirectoryPath ()
string GetTargetReportsDirectoryPath ()
StageInfo
string Get (string param_key)
void Set (string param_key, string param_value)
StringUtilities
string CSSClassName (string styleName)
string DecodeURI (string value)
string DecodeURIComponent (string value)
string EclipseId (string identifier)
string EncodeURI (string value)
string EncodeURIComponent (string value)
string EscapeForXMLAttribute (string value)
string Format (string format, string argument1 [, string argument2, string argument3, string argument4, string argument5, string argument6, string argument7, string argument8, string argument9, string argument10])
string FromFile (string sourceFilePath, string sourceFileEncodingName)
string JavaScriptEncoding (string value)
bool MatchExpression (string input, string matchExpressionAsString)
string MatchExpressionValue (string input, string matchExpressionAsString)
string MD5Checksum (string value)
string NCNAME (string identifier)
string NormalizeQuotes (string value)
string OEBClassName (string styleName)
string Replace (string input, string search, string replacement)
string ReplaceWithExpression (string input, string searchExpressionAsString, string replacement)
string ReplaceWithExpressionForCount (string input, string searchExpressionAsString, string replacement, int count)
string SHA1Checksum (string value)
string ToLower (string value)
string ToUpper (string value)
string ToCamel (string value)
string ToPascal (string value)
bool EndsWith (string input, string suffix)
string WebWorksHelpContextOrTopic (string key)
Units
double Convert (double sourceValue, string sourceUnits, string targetUnits)
string CSSRGBColor (string htmlColor)
string EncodingFromCodePage (int codePage)
string NumericPrefix (string value)
string RTFColor (string htmlColor)
string UnitsSuffix (string value)
URI
string AsFilePath (string uriAsString)
string AsURI (string filePathAsString)
string EscapeData (string unescapedString)
string EscapeUri (string unescapedUri)
string GetRelativeTo (string uriAsString, string anchorUriAsString)
bool IsFile (string uriAsString)
string MakeAbsolute (string absoluteUriAsString, string uriAsString)
XPathNodeIterator PossibleResolvedUris (string uriAsString)
string Unescape (string escapedString)
ZipExtension
void Zip (string zipFilePath, object nodes)
void ZipAdd (string zipFilePath, object nodes)
void ZipAddWithoutCompression (string zipFilePath, object nodes)
void ZipDirectory (string zipFilePath, string directoryPath)
void ZipDirectoryWithoutCompression (string zipFilePath, string directoryPath)
void ZipExtract (string zipFilePath, string targetDirectory)
void ZipWithoutCompression (string zipFilePath, object nodes)
epub-advanced-customizations
epub-markers-in-templates