TaskRoll: Table of Contents


App Folder Files

TaskRoll allows you to use Dropbox to store your task lists. Within the “Dropbox” folder, there is an “Apps” folder in which you will find the “TaskRoll” folder where all the files are placed.

You will see three types of files:

  1. FileName.md

    Any .md file will be parsed to create a (new) task roll. Each file is a plain text file using MarkDown syntax for the lists; the syntax is outlined in the template shown below.

    Note that the file name is not very important; the project title is declared within its contents.

    For new users, TaskRoll will insert an example task roll named “Example.md”.

  2. ReadMe.txt

    An informational file that describes the files and their use. If missing, TaskRoll will create it.

  3. Other

    Any other files or folders are ignored, but since their names need to be scanned, it is recommended not to add unnecessary files. Otherwise, synching run time may be adversely affected.

Additionally, there is a hidden .task folder where you would find .aux files:

  1. .task/FileName.aux

    These are auxiliary files that are used to track the state of a task roll. There is one .aux file for each .md file. The .task folder is normally hidden and you should never need to edit or create any of the .aux files. The TaskRoll app will create or update an .aux file whenever it were missing, if it were out-of-sync with the corresponding .md file, or whenever the current task changes (i.e. when the user completed a task).

MarkDown Syntax

Markdown is a plain text formatting language that was originally created to simplify the generation of formatted web pages. It is now used in many systems where it is desirable to keep the source text separate from tool-specific formats. Within TaskRoll, we use a small subset of Markdown to store our task lists.

TaskRoll uses the following simple template for the .md files:

# Roll Title

Optional comment for this
roll.

1.  Action One Title

    Optional comment for
    action one.

2.  `shell command`

3.  Action Two
    Title

    Optional comment for
    action two.

Formatting Notes


Next: URL Schemes