Extract Files

Extracts a translated file or group of translated files from a TTK. The files inside the TTK to be extracted can be filtered by name, extension or translation status.

Syntax

Catalyst /E TTKName ToFolder [/Original] [TextFileEncoding:"Option"] [Filter:Status_to_extract] [/P] [SNKFile:snkFile] [ezLogFile:ezLogFile] [/write] [/open]

Catalyst /E TTKName ToFolder [/Original] [TextFileEncoding:"Option"] FileTypes:Files_to_Extract [/include_embedded] [/P] [SNKFile:snkFile] [ezLogFile:ezLogFile] [/write] [/open]

Catalyst /E FolderName ToFolder [/S] [/P] [/Original] [TextFileEncoding:"Option"] [Filter:Status_to_extract] [/S] [/P] [SNKFile:snkFile] [ezLogFile:ezLogFile] [/write] [/open]

Catalyst /E FolderName ToFolder [/S] [/P] [/Original] [TextFileEncoding:"Option"] FileTypes:Files_to_Extract [/include_embedded] [/S] [/P] [SNKFile:snkFile] [ezLogFile:ezLogFile] [/write] [/open]

Catalyst /E TTKName ToFolder [Filename:FileName_To_Extract] [/Original] [TextFileEncoding:"Option"] [/P] [SNKFile:snkFile] [ezLogFile:ezLogFile] [/write] [/open]

Parameters

/E	Extract Files
TTKName	TTK Filename to extract files from.
ToFolder:Path	Extracted files will be stored in this folder/directory.
FolderName	The name of a folder that contains TTK files. All the TTKs in this folder will have their files extracted.
/S	Recursively scan all directories within FolderName and extract files from every TTK located. All extracted files will be stored in ToFolder.
/P	Extract files and store them in ToFolder maintaining the Project Hierarchy of each TTK. If the relevant subfolders do not exist in ToFolder then ezScript will create them automatically.
/Original	Use this option to extract the original file from the Project TTK.
TextFileEncoding:"Option"	Use this switch when extracting Text Files and you want a different encoding than the source file. The possible labels are: ANSI UTF16 UTF16BE UTF8 UTF8_NO_BOM
SNKFile:snkFile	Use this option to specify the path for the digital signature key file to be used to fully sign the .NET language assembly files when extracting them.
FileTypes:Files_to_Extract	This tag allows users to extract only the extensions matching a certain mask. Use a comma to separate each mask. Example: FileTypes:".htm, html" extracts only files with extension htm and html from the Catalyst project file. Note: You cannot use a partial file extension for a mask. FileTypes (on its own) does NOT extract the defined mask files that are embedded in other files (e.g. inside chm, madcap, etc.). To do so, use the /include_embedded switch below.
/include_embedded	Use this switch in conjonction with FileTypes: to extract the matching mask also when embedded in other types, such as an .htm file in a .chm file or Madcap .flproj.
Filter:Status_to_extract	Use this option to extract any file that contains at least one segment with the specified status OR a combination of statuses separated by a \| character. Available Segment Statuses: ForReview Signedoff Leveraged Fuzzy MachineTranslated Untranslated In assessing which files to be extracted, the status check is performed on individual segments only. The status of the files as seen in the Navigator window are not checked. Note: For files embedding other files like chm, madcap projects or VS projects, etc... this option only extracts the main file (i.e. chm) if at least one of the files contained within satisfies the status check.
Filename:FileName_To_Extract	Name of the file to be extracted from the TTK file. If backslash is used at beginning of FileName_To_Extract: only the filename with the exact path from the root will be extracted /P maintains folder structure the root folder of the ttk should not be specified If no backslash appears in front of FileName_To_Extract: file in the ttk matching that name is extracted, disregarding path in ttk If /P is used, the folder structure within the ttk is maintained on extraction If /S and /P are used, all files matching that name in the ttk are extracted and folder structure maintained if just /S is used, the first file matching that filename in the ttk is extracted
ezLogFile:ezLogFile	The user can optionally specify a log file to which results of each Catalyst ezScript command are output. If the log file is not specified by the user or is invalid, the default log file (ezScriptBatchLog.txt in the Public location) is used.
/write	The command line which has been processed by Catalyst will be written into the ezScript batch log file. This will help to debug your command if something is not behaving as expected.
/open	Launches MS Notepad and displays the content of ezScript batch log when the command finishes.

Examples

Extract all files from GMC.ttk and store them in C:\Destination

Catalyst /E GMC.ttk C:\Destination

Extract all files from C:\FinalBuilds into C:\TranslatedBuilds and preserve the TTK project hierarchy.

Catalyst /E C:\FinalBuilds C:\TranslatedBuilds /P

Extract files from all TTKs stored in C:\Translations, and all sub-folders and store them in C:\FinalFiles

Catalyst /E C:\Translations C:\FinalFiles /S

Extract all files from MixedFileTypes.ttk stored in C:\Samples and save to folder C:\Samples\Extracted. Any text files found in this TTK will be extracted with the encoding type of UTF8 with no BOM (Byte Order Mark).

Catalyst /E "C:\Samples\MixedFileTypes.ttk" "C:\Samples\Extracted" TextFileEncoding:"UTF8_NO_BOM" /P

Extract all files from DotNETProject.ttk stored in C:\Samples store them in C:\Samples\Extracted. All .NET assembly language files will be signed with the key from the file Key.snk.

Catalyst /E "C:\Samples\DotNETProject.ttk" "C:\Samples\Extracted" SNKFile:"C:\Samples\Signing\Key.snk" /P

Extract files with an extension of either *.dll, *.rc or *.json from MixedFileTypes.ttk stored in C:\Samples and save them to folder C:\Samples\Extracted.

Catalyst /E "C:\Samples\MixedFileTypes.ttk" "C:\Samples\Extracted" Filetypes:"*.dll,*.rc,*.json" /P

Extract files with an extension of either *.html or *.htm from HelpFiles.ttk located in C:\Samples and save them to folder C:\WorkingFolder\HTMoutputonly. Several chm files are included in HelpFiles.ttk and using the /include_embedded switch, all html and htm files within the chm files will be extracted to C:\WorkingFolder\HTMoutputonly, respecting the hierarchy as the /P option is used.
The Results of this command will be written to the log file C:\WorkingFolder\Batchlog.txt the contents of which will be opened in the default text editor.

Catalyst /E "C:\Samples\HelpFiles.ttk" "C:\WorkingFolder\HTMoutputonly" Filetypes:"*.html,*.htm" /include_embedded /P ezLogFile:"C:\WorkingFolder\Batchlog.txt" /open

Extract all files in ttk named Idbasedfiles.properties to location d:\Project\Extract maintaining ttk folder structure on extraction and giving all the extracted (text) files UTF16 Big Endian encoding:

Catalyst /E "d:\Project\SWProject.ttk" "d:\Project\Extract" Filename:"Idbasedfiles.properties" /P /S ezlogfile:"d:\Project\Batchlog.txt" Textfileencoding:UTF16BE /write

Extract the first file in the ttk named Idbasedfiles.properties directly to location d:\Project\Extract and giving the extracted (text) file UTF8 without BOM encoding:

Catalyst /E "d:\Project\SWProject.ttk" "d:\Project\Extract" Filename:"Idbasedfiles.properties" ezlogfile:"d:\Project\Batchlog.txt" TextFileEncoding:UTF8_NO_BOM /write

Extract only -Project Title-\New\Sub NEW\Idbasedfiles.properties from the ttk, maintaining folder structure, so resulting in: d:\Project\Extract\-Project Title-\New\Sub NEW\Idbasedfiles.properties and encoding the extracted file as UTF8:

Catalyst /E "d:\Project\SWProject.ttk" "d:\Project\Extract" Filename:"\New\Sub NEW\Idbasedfiles.properties" /P ezlogfile:"d:\Project\Batchlog.txt" TextFileEncoding:UTF8 /write

Extract all files including segments with the "For Review" status from the TTK ProjectSWfiles.ttk into folder "C:\DATA\extract status\For Review". The folder structure of the TTK will be maintained for all files matching the "For Review" filter using the /P switch.
The Results of this command will be written to the ezscript log file C:\WorkingFolder\Batchlog.txt the contents of which will be opened in the default text editor.

Catalyst /E "C:\DATA\SW\ProjectSWfiles.ttk" "C:\DATA\extract status\For Review" Filter:"ForReview" /P /Write ezLogFile:"C:\DATA\extract status\Extract_log.txt" /open

Similar to the above example, setting the filter to "Fuzzy | MachineTranslated | Untranslated" will extract all the files for which translations needs to be translated, finalized or proofed.

Catalyst /E "C:\DATA\SW\ProjectSWfiles.ttk" "C:\DATA\extract status\For Review" Filter:"Fuzzy | MachineTranslated | Untranslated" /P /Write ezLogFile:"C:\DATA\extract status\Extract_log.txt" /open