User Tools

Site Tools


user-defined-tools-prefs

This is an old revision of the document!


User Defined Tool (UDT) Preferences

(Menu Bar > Tools Menu > Preferences > User Defined Tools)

(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 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.
  • Arguments
    Displays the additional information that will be passed to the tool via its command-line. For more information see 'Arguments' below.

New Tool
Creates a new entry and prompts you to enter a name to identify your tool on the 'Tools' Menu and application toolbar.

Delete Tool
Deletes the selected 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 for user data.

Import…
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
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
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.

The following table contains all currently supported placeholders (which should always be in lower-case):

Menu ItemPlaceholderComments
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
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 Minimised
Runs the tool as a minimised task. Useful for running batch files.


See also: User Defined Tools, Preferences Dialog, Tools Menu, Application Toolbar

user-defined-tools-prefs.1501034311.txt.gz · Last modified: 2017/07/26 01:58 by admin