MacRecon

Page Contents:



TaskAgent Plain Text Formatting Guide


Last updated: 9/14/12

This is how a TaskAgent list looks as a UTF-8 encoded text file:

sample.txt

First, it should be noted that the name of the .txt file should not contain special or international characters — try keeping your titles alphanumerical if you can.

At each new line there’s a task. Each task requires “-“ or “x” at the beginning. You can’t divide a task, including its note, between multiple lines. The best rule to remember is to never press enter on the keyboard unless it’s a new task.

If the task has a comment, it will be found between parentheses. Otherwise, there is no need to add parentheses.

When the task is completed or checked, this will be set by adding x before the task. Otherwise, a hyphen must be added before the task.

If you wish to create a new list from scratch in the Dropbox folder TaskAgent is using, the text file you’d create should look something like this:

untitled






TaskAgent URL Scheme


Last updated: 12/9/13

TaskAgent 2.5 and later for iOS supports x-callback-url for external apps to interact with TaskAgent:

taskagent://x-callback-url/action?
x-source=[Source App]&
x-success=[sourceapp://x-callback-url/TaskAgentSuccess]&
x-cancel=[sourceapp://x-callback-url/TaskAgentCanceled]&
x-error=[sourceapp://x-callback-url/TaskAgentError]&
list=[target list name without .txt]&
task=[task goes here]&
note=[task note goes here]&
done=[YES or NO]


The previous URL scheme is intended for the following:
1. Creating the list if it doesn’t exist
2. Opening the list if it does exist
3. Creating tasks in the specified list (with note and done if not empty)

All parameters but list are optional. Please note that list currently only works for files not found inside folders.

x-source is not used in this version of the app but may be used in future releases.

x-success will always be called after executing any of the above actions. This field should be omitted if you don’t want to be taken back to the previous app, like when just opening an existing list.

x-cancel is called when the user cancels an action that requires prompting, like creating a non-existing list.

x-error is not used in this version of the app but may be used in future releases.

task will always be added regardless of whether it already exists in the list. Duplicate tasks will not be deleted or overwritten.

Please observe that note and done will be ignored if task is empty.



Examples that can be used from external apps to communicate with TaskAgent:

taskagent://x-callback-url/action?list=Example
This will open the list called “Example”. If “Example” does not already exist, it will be created.

taskagent://x-callback-url/action?list=Example&task=My%20Task
This will create a task called “My Task” in a list called “Example”. If “Example” does not already exist, it will be created, as well.

taskagent://x-callback-url/action?x-success=SampleApp://x-callback-url/success&list=Example&task=Homework¬e=Done%20for%20today&done=YES
This will create a task called “Homework” with the note “Done for today” and marked as done in a list called “Example”. If “Example” does not already exist, it will be created. If the action was successful, TaskAgent will attempt to call the URL “SampleApp://x-callback-url/success” as defined in the x-success parameter.



Regarding TaskAgent’s Actions found inside the app’s settings:

It is possible to add custom URL actions to be executed with a single task’s information by setting them up inside the Actions view. Simply name the new action and enter the external app’s URL scheme with the task blocks to execute it with the task’s information.

You can use the following blocks to automatically use the task’s information:

[task-title][task-note][task-done]

Example: If you have Due installed on the same device as TaskAgent, you can use the following to quickly create a new reminder inside that app using the task’s title:

due://x-callback-url/add?title=[task-title]





JotAgent Title Formatting Guide


Last updated: 1/18/12

Since version 1.2, JotAgent supports as an option the ability to allow the user to manipulate how it automatically formats the title of new notes.

Important! This feature is recommended for advanced users only because of the following reason:
If JotAgent formats all notes in an identical format, the older note will be overwritten with the new one.

Under the title format field, feel free to use any of the following modifiers, all in lower case and between parentheses like shown below:

(month) for the current month (shortened)
(day) for the current day
(year) for the current year
(hour) for the current hour in 24-hour format
(minutes) for the current minutes
(seconds) for the current seconds
(month number) for the current month in number format
(weekday long) for the full, current weekday
(weekday) for the current weekday (shortened)
(month long) for the full, current month
(hour 12) for the current hour in 12-hour format
(am pm) for the current hour to show AM or PM
(year short) for the current year’s last two digits

As of version 2.5, the (line) option no longer works. Now you can set custom titles by tapping on the “JotAgent” header. Or you can re-enable similar functionality in the formatting option within the app’s settings.

For anything not supported above, feel free to add it between apostrophes, like so:
‘My note’

The default is:
(month)(day)’-'(hour)(minutes)(seconds)

The above will set titles to something like this:
Oct12-120513

The previous example is based upon that the iOS device’s clock registered the following as the date:
October 12th, 2010 at 12:05:13pm

Another example:
‘My note for ‘(month)’ ‘(day)’, ‘(year)

The above will set titles to something like this:
My note for Oct 12, 2010

The previous example is actually not recommended if you intend to take more than one note per day, since another note will overwrite the previous one. (Even the default format will overwrite an existing note each year if they coincide to the exact same second that two notes are uploaded.) Such example was actually used to further show how customization is possible between apostrophes which will add to a more descriptive title. There must be no spaces between apostrophes and parentheses, so if you wish to add blank space please do so between apostrophes as shown above.

Due to chance for data corruption, avoid using the characters “/“, “\”, or “.”
If you’re using these characters, you will get an alert the next time you try to edit a note as a safety precaution.

To make the example as effective as possible, let’s modify it to the following:
‘My note for ‘(month)’ ‘(day)’, ‘(year)’ at ‘(hour)’-'(minutes)’-'(seconds)

As so, the previous example will format titles to something like this:
My note for Oct 12, 2010 at 12-05-13
This example is infallible and will never be overwritten unless you manually regress the iOS device’s clock to the previous date and time already passed.

The reason the previous example used “-” instead of “:” for the time is because some Windows users reported that special characters like “:” did not work in their version of the Dropbox client.