User Tools

Site Tools


user-defined-tools-prefs

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
user-defined-tools-prefs [2016/10/13 06:58]
admin
user-defined-tools-prefs [2017/07/26 02:03]
admin
Line 1: Line 1:
-====== User Defined Tool Preferences ======+====== User Defined Tool (UDT) Preferences ======
  
 ([[tools-menu|Menu Bar > Tools Menu]] > Preferences > User Defined Tools) ([[tools-menu|Menu Bar > Tools Menu]] > Preferences > User Defined Tools)
Line 7: Line 7:
 **(Grid)** **(Grid)**
  
-  * **Tool Name**\\ ​This lists the currently configured tools. The names are assigned by you / the user. Tools not having a name or path will not appear in the Tools Menu. To change the name of a tool, //​single-click//​ on the tool nameor if you click on the name and it doesn't open for editing, press F2.+  * **Tool Name**\\ ​Displays ​the names of the UDTs. To change the name of a tool, //​single-click//​ on the currently selected ​tool name or press F2. **Note:** This name will also be used to identify the tool on the 'Tools' menu as well as acting as the tool's tooltip on the application toolbar.
  
-  * **File Path**\\ ​Click the folder icon to browse ​to the application,​ batch file, or script that you wish to run.+  * **File Path**\\ ​Displays ​the full path to the application,​ batch file, or script that you wish to run. For more information see '​Path'​ below
  
-  * **Arguments**\\ ​Construct a set of data that will be passed ​in the command-line. ​The down-arrow button attached to this field will display a list of "​placeholder"​ variables for data that ToDoList will substitute when you run the tool+  * **Arguments**\\ ​Displays the additional information ​that will be passed ​to the tool via its command-line. ​For more information see '​Arguments'​ below
  
 ----- -----
  
 **New Tool**\\ **New Tool**\\
-This is the first step to create ​new UDT. Enter the name that you want to appear ​on the Tools Menu.+Creates a new entry and prompts you to enter a name to identify your tool on the 'Tools' ​Menu and application toolbar
  
 **Delete Tool **\\ **Delete Tool **\\
Line 22: Line 22:
  
 **Test Tool **\\ **Test Tool **\\
-This allows you to run the selected tool using the currently selected task for data if the arguments require it. On clicking the button, a "Test Tool" window displays to tell you "Tool '​path\name.ext'​ will be run using the following commandline arguments: '-your args'. It will prompt "Do you want to continue?"​ with a Yes or No button. The arguments will be filled in with currently available data - you will be prompted if required ​to get user data.+This allows you to run the selected tool using the currently selected task for data if the arguments require it. On clicking the button, a "Test Tool" window displays to tell you "Tool '​path\name.ext'​ will be run using the following commandline arguments: '-your args'. It will prompt "Do you want to continue?"​ with a 'Yes' ​or 'No' ​button. The arguments will be filled in with currently available data - you will be prompted if required ​for user data.
  
 **Import...**\\ **Import...**\\
-- TODO -+Allows you to import existing UDTs that are stored elsewhere in another Preferences file. This can be helpful if you work in a team or have backed up your Preferences and want to restore just the UDTs.
  
 ----- -----
  
 **Path**\\ **Path**\\
-- TODO -+Click the folder icon to browse to the application,​ batch file, or script that you wish to run. 
 + 
 +**Note:** If you are wanting to create a UDT that runs ToDoList itself you need only type in '​todolist.exe'​ without any path information and this will be understood to mean the path to the currently running instance. ​
  
 **Arguments**\\ **Arguments**\\
-TODO -+This field allows you to pass additional information to your chosen tool via its command-line.  
 + 
 +To allow you to pass information about the active tasklist and/or the currently selected task, the 'down-arrow' button to the right of the field will display a list of "​placeholder"​ variables for data that ToDoList will substitute when you run the tool.\\ {{images:​screenshots:​udt_args.png}} 
 + 
 +The following table contains all currently supported placeholders (which should always be in **lower-case**):​ 
 + 
 +^Menu Item^Placeholder^Comments^ 
 +|ToDoList Pathname|$(todolist)|Full path to the ToDoList executable| 
 +|Tasklist Pathname|$(pathname)|Full path to the active tasklist| 
 +|Tasklist Folder|$(folder)|Full path to the folder containing the active task list| 
 +|Tasklist File Title|$(filetitle)|The filename of the active tasklist without the extension| 
 +|Tasklist Filename|$(filename)|The full filename of the active tasklist| 
 +|Selected Task ID|$(seltid)|ID of the current selected task| 
 +|Selected Task Title|$(selttitle)|Title of the current selected task| 
 +|Selected Task External ID|$(seltextid)|External ID of the current selected task| 
 +|Selected Task Comment|$(seltcomments)|Comments of the current selected task| 
 +|Selected Task File Link|$(seltfile)|File Link of the current selected task| 
 +|Selected Task Alloc By|$(seltallocby)|Name of the person who allocated the current selected task| 
 +|Selected Task Alloc To|$(seltallocto)|Name of the person to whom the current selected task is allocated| 
 +|Selected Task Custom Attribute|$(seltcustom,​ var_cust1)|Value of the custom attribute with an ID of '​var_cust1'​ for the current selected task| 
 +|User Date|$(userdate,​ var_date1, "Date Prompt",​ default_date)|(see 'User placeholders'​ below)| 
 +|User Filepath|$(userfile,​ var_file1, "File Prompt",​ default_path)|(see 'User placeholders'​ below)| 
 +|User Folder|$(userfolder,​ var_folder1,​ "​Folder Prompt",​ default_folder)|(see 'User placeholders'​ below)| 
 +|User Text|$(usertext,​ var_text1, "Text Prompt",​ default_text)|(see 'User placeholders'​ below)| 
 +|Today'​s Date|$(todaysdate)|Date in ISO format| 
 + 
 +**User placeholders**\\ 
 +These placeholders (prefixed by '​user'​) will cause the user (you) to be prompted to enter information when the UDT is executed. This is useful where the information is not known in advance or it frequently changes. User placeholders typically take 3 additional arguments:​ 
 + 
 +  * a unique variable name (eg. var_text1) 
 +  * an optional prompt string (eg. "Enter your username"​) which should be quoted 
 +  * an optional default value to display (eg. "​anonymous"​) which should be quoted
  
 **Icon**\\ **Icon**\\
-Each UDT can have its own icon image. The icon can come from a file of any of these types: .ico, .bmp, .png, .jpg. If the path is set to an executable program, the primary icon from that program will be used. +Click the folder ​icon to specify a unique ​image to identify each UDT. The icon can be an image file of these types: .ico, .bmp, .png, .jpg. If the path is set to an executable program, the primary icon from that program will be used. 
  
-**Run Minimized ​**\\ +**Run Minimised ​**\\ 
-Runs the tool as a minimized ​task. Useful for running batch files.+Runs the tool as a minimised ​task. Useful for running batch files.
 ----- -----
  
-See also: [[preferences-dialog|Preferences Dialog]], [[tools-menu|Tools Menu]], [[ui-toolbar|Application Toolbar]]+See also: [[user-defined-tools|User Defined Tools]], ​[[preferences-dialog|Preferences Dialog]], [[tools-menu|Tools Menu]], [[ui-toolbar|Application Toolbar]]
  
user-defined-tools-prefs.txt · Last modified: 2017/07/26 02:03 by admin