|
Insert Files |
Inserts a file, group of files or directory of files into a new or existing TTK.
Catalyst /M UserName [Rule:Rulename] [TTKName:TTKName] FileListFile:FileListName [NewTitle:Title] [SourceLang:Language] [TargetLang:Language] [RelativeTo:DirName] [Keywords:Keywordsfile] [ezLogFile:ezLogFile] [/write] [/open]
or
Catalyst /M UserName [Rule:Rulename] [TTKName:TTKName] FromFolder:FolderName [FileTypes:Files_to_Insert] [ExcludeFileTypes:Files_to_Exclude] [ExcludeFolders:Folders_to_Exclude] [/S] [/A] [/H] [/.Netlangfiles] [NewTitle:Title] [SourceLang:Language] [TargetLang:Language] [Keywords:Keywordsfile] [ezLogFile:ezLogFile] [/write] [/open]
or
Catalyst /M UserName [Rule:Rulename] [TTKName:TTKName] FName1 [FName2 [...]] [HHPFile:HHPFilename] [NewTitle:Title] [SourceLang:Language] [TargetLang:Language] [Keywords:Keywordsfile] [ezLogFile:ezLogFile] [/write] [/open]
or
Catalyst /M UserName [Rule:Rulename] [TTKName:TTKName] FName1 [FName2 [...]] [VSConfig:"Config|Platform"] [NewTitle:Title] [SourceLang:Language] [TargetLang:Language] [Keywords:Keywordsfile] [ezLogFile:ezLogFile] [/write] [/open]
/M |
Insert files into a new or existing TTK |
UserName |
The name that will appear in the history list in the TTK. |
TTKName:FName |
Tag used to specify the name of the TTK to create or to insert files into. Note: If a TTKName is not specified, it will be automatically created by substituting the file extension .TTK to the end of the filename being inserted. One TTK will be created for each file inserted. |
FileListFile:FileListName |
Tag used to specify the path of a file that contains a list of filenames to be inserted into a TTK. |
HHPFile:HHPFilename |
Tag used to specify a HHP when inserting a compiled CHM file into a TTK |
VSConfig:"Config|Platform" |
VSConfig allows the user to specify the build configuration to use when inserting Visual Studio projects. The syntax for this parameter is the configuration type, followed by a pipe, then followed by the target platform. Configuration names can be Debug or Release and the Target Platform can be Win32, x64 or AnyCPU. |
FileTypes:Files_to_Insert |
This tag is used
in conjunction with the FromFolder: tag and will allow the user
to only insert the extensions and filenames matching a certain
mask from a specified folder. The files to insert could be FileTypes:"*.dll,*.exe" and can also use a partial file name in the mask as well FileTypes:"*acme.Report*". It can be mix of file extension and filename FileTypes:"DLGS*,*.resx" |
FromFolder:Foldername |
Tag used to specify the path to a folder from which all files are to inserted into a TTK(s). |
/S |
Recurse all sub-folders. |
FName1 [FName2...] |
The full path of a file to be inserted into a TTK. Multiple filenames must be separated by a space. |
/A |
Preserve directory structure in Project TTK file when inserting files. |
/.Netlangfiles |
Option to also insert the .NET Language Files into the TTK during TTK creation. When present, this option is set to True. |
/H |
Exclude hidden files and folders when creating a TTK file. |
ExcludeFileTypes:Files_to_Exclude |
This tag is used
in conjunction with the FromFolder: tag. Users can exclude files
based on their extension. All files in the FromFolder: path with
the extension listed will not be parsed into the TTK project. The files to exclude could be: "*.jpg,*.png,*.bmp". |
ExcludeFolders:Folders_to_Exclude |
This tag is used
in conjunction with the FromFolder: tag and will allow the user
to exclude the folder name matching a certain mask from a specified
folder. The folders to exclude could be:".svn, temp, output". |
NewTitle:Title |
New Project Title of a TTK |
SourceLang:Language |
Tag used to specify the source language of the inserted file. See section on Language Codes. |
TargetLang:Language |
Tag used to specify the target language of the inserted file. See section on Language Codes. |
RelativeTo: |
This tag is used in conjunction with the FileListFile: tag and is used to truncate directory names with your Project TTK file relative to a declared root directory. For example if you use the RelativeTo tag, a Project TTK file will be created from all the files listed in the FileListFile tag, however the created directories within the Project TTK file will only contain the a directory name that is relative to the directory declared using the RelativeTo tag. Note: The /A switch must also be included in order to maintain the directory structure. |
Rule: |
Use the Rule tag to specify the name of an ezParse rule that is to be applied to the file type on insertion. These rules are defined using ezParse. If the Rule tag is not used, Alchemy CATALYST will always select the default first rule for each XML and Text file format. Note: "Rule:" and "embedded ext:" when supplied are not case sensitive. However the rule to be used is. Please specify the rule correctly or CATALYST will default back to the first rule in the list for that file type. |
Embedded ext: |
If you have a file, such as an executable file containing embedded files as resources, a rule can be specified for use with these embedded files. Use Embedded ext: parameter to identify the file types e.g. *.js. Follow that with a Rule name to identify the rule to be used. If no rule is specified CATALYST will default to the first rule in the ezParse list for that extension type. Note: This embedded extension parameter is used in conjunction with the Rule parameter and only when inserting files using the File List file. |
Keywords:Keywordsfile |
Tag used to allow the application of keywords on a previously created TTK file. |
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. |
This is a sample of the contents which may appear in the file "Filelist.txt" as in the first example below.
Absolute Path |
Relative Path |
"C:\Samples\Catalyst.rc" "C:\Samples\Catalyst.exe" "C:\Samples\IDBasedFiles.txt" Rule:"MyNewParser" "C:\Samples\Conditional.xml" Rule:"XML ShowAll" embedded ext:xml Rule:"XML ShowAll" embedded ext:js Rule:"MyJSRule" "C:\Samples\Catalyst.dll" "C:\Samples\SampleMFC.vcxproj" VSConfig:"Debug|AnyCPU" "C:\Samples\ezScript.chm" HHPFile:"C:\Samples\ezScript.hhp" |
Catalyst.rc Catalyst.exe IDBasedFiles.txt Rule:"MyNewParser" Conditional.xml Rule:"XML ShowAll" embedded ext:xml Rule:"XML ShowAll" embedded ext:js Rule:"MyJSRule" Catalyst.dll SampleMFC.vcxproj VSConfig:"Debug|AnyCPU" ezScript.chm HHPFile:"C:\Samples\ezScript.hhp" |
In the Filelist.txt examples above, when an embedded extension "xml" or "js" is found within the file "Catalyst.exe" or "Catalyst.dll" it will use the rule specified for that extension. This is read in order from the FileListFile and need only be declared once for all embedded extensions unless you choose to insert a different file which contains the same embedded extension using a different rule.
This example creates a new TTK called Master.ttk and inserts into it all the files that are listed in the absolute FileList.txt - the TTK is stored at the current DOS location as a direct output path has not been specified.
Catalyst /M John TTKName:Master.ttk FileListFile:Filelist.txt
This example creates a new TTK called Master.ttk and inserts the files that are listed in the relative FileList.txt. It is used in conjunction with the RelativeTo switch which will resolve the folder/file paths by amalgamating both the directory listed in the RelativeTo path and the files listed in the Filelist.txt.
Catalyst /M John TTKName:C:\Samples\Master.ttk FileListFile:Filelist.txt RelativeTo:C:\Samples
This example appends all the files in the folder and sub-folders of C:\Allfiles into a TTK called TTKfile.ttk.
Catalyst /M John TTKName:C:\English\TTKFile.ttk FromFolder:C:\AllFiles\ /S /A
This example inserts the File.exe into a new TTK which will be names File.ttk (since no TTKName is specified). As no Source Language and Target Languages have been specified the default set Project Languages will be used.
Catalyst /M John File.exe SourceLang:"English (Ireland)" TargetLang:"German (Germany)"
or
Catalyst /M John File.exe SourceLang:"en-ie" TargetLang:"de-de"
This example inserts the VortexDemo.chm into a new TTK called InsertCHM.ttk. The HHP file VortexDemo.hhp will also be inserted. As no languages have been specified the default set Project Languages will be used.
Catalyst /M John TTKName:C:\InsertCHM.ttk C:\Samples\VortexDemo.chm HHPFile:C:\Samples\VortexDemo.hhp
Catalyst /M "%USERNAME%" TTKName:"C:\Samples\SampleMFC.ttk" "C:\Samples\SampleMFC.vcxproj" VSConfig:"Release|Win32" SourceLang:"English (Ireland)" TargetLang:"French (France)"
Catalyst /M "%USERNAME%" TTKName:"D:\Folder\files_of_type.ttk" FileTypes:"*.exe,*.dll" FromFolder:"D:\Files" /S /A ezlogfile:"D:\Folder\Folder_v12Types_batchlog.txt" keywords:"C:\Settings\Keywords Files\Keywords1.txt" NewTitle:"RC Kit"