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 [2017/07/26 01:00]
admin
user-defined-tools-prefs [2017/07/26 02:03] (current)
admin
Line 7: Line 7:
 **(Grid)** **(Grid)**
  
-  * **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. For more information see below. ​Note: This name will also be used as the tool's tooltip on the application toolbar.+  * **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**\\ Displays the full path to the application,​ batch file, or script that you wish to run. For more information see '​Path'​ below. ​   * **File Path**\\ Displays the full path to the application,​ batch file, or script that you wish to run. For more information see '​Path'​ below. ​
Line 16: Line 16:
  
 **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 32: Line 32:
 Click the folder icon to browse to the application,​ batch file, or script that you wish to run. 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.+**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**\\
 This field allows you to pass additional information to your chosen tool via its command-line. ​ 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. +To allow you to pass information about the active tasklist and/or the currently selected taskthe '​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 ​are Case-Sensitive):+The following table contains all currently supported placeholders (which ​should always be in **lower-case**):
  
 ^Menu Item^Placeholder^Comments^ ^Menu Item^Placeholder^Comments^
Line 47: Line 47:
 |Tasklist File Title|$(filetitle)|The filename of the active tasklist without the extension| |Tasklist File Title|$(filetitle)|The filename of the active tasklist without the extension|
 |Tasklist Filename|$(filename)|The full filename of the active tasklist| |Tasklist Filename|$(filename)|The full filename of the active tasklist|
-|Selected Task ID|$(selTID)|ID of the current selected task| +|Selected Task ID|$(seltid)|ID of the current selected task| 
-|Selected Task Title|$(selTTitle)|Title 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 External ID|$(seltextid)|External ID of the current selected task| 
-|Selected Task Comment|$(selTComments)|Comments 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 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 Filepath|$(userfile,​ var_file1, "File Prompt",​ default_path)|(see 'User placeholders'​ below)|
Line 58: Line 62:
  
 **User placeholders**\\ **User placeholders**\\
-Placeholders ​prefixed by '​user'​ will result in the user (you) being 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:+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)   * a unique variable name (eg. var_text1)
user-defined-tools-prefs.1501030824.txt.gz · Last modified: 2017/07/26 01:00 by admin