Skip to content

Latest commit

 

History

History
75 lines (60 loc) · 2.65 KB

mytodo-yaml.md

File metadata and controls

75 lines (60 loc) · 2.65 KB

MyToDoBoard - Yaml

MyToDoBoard™ stores all information in a single yaml file for easy sync. Recommended file name extension is .mytodo. Alternative file name extensions are .mytodo.yaml and .mytodo.yml, which are not recommended. Only use those if you need the yaml file format extension for support of other tooling.

$schema: https://go.grottel.net/mytodoboard/schema.json

columns:

- name: ToDo
  cards:
  - title: Complex task
    desc: |
      Use the `desc` member to add a string with detailed, human-readable description
    links:
    - https://www.google.de
  - title: Second task
    desc: |
      The order of `cards` within a `column` is to be understood as ordering on the board top to bottom, e.g. a priority.
  - title: Simple task card without description

- name: Doing
  cards:
  - title: Writing an yaml example for MyToDoBoard™
    links:
    - https://github.com/sgrottel/MyToDoBoard

- name: Done
  cards:

This is an example MyToDoBoard™ .mytodo file.

This yaml file format is also meant to be stable for data interchange between different tools, apps, in the context of the MyToDoBoard™ project, and beyond.

This minimal example should stay valid for future versions of this tool, maybe limiting some functionality.

File Format Schema

$schema: https://go.grottel.net/mytodoboard/schema.json

The schema line is optional. The value of $schema is a live url to a schema file. This is primarily meant for editors supporting schema files, e.g. for validation or editing support, like auto complete.

Visual Studio Code

You can work with in-development versions of the schema of this repository:

  • Edit the settings to edit *.mytodo files as yaml:
"files.associations": {
  "*.mytodo": "yaml"
}
  • Install the YAML extension for Visual Studio Code redhat.vscode-yaml
  • Edit in the extension's settings the schema section:
"yaml.schemas": {
	"C:/path/to/your/checkout/MyToDoBoard/doc/schema.json": "*.mytodo"
},

Columns

The vertical columns are mainly lists of task cards. They also have a meaning, expressed by their name, and can have further attributes. The ordering of the column objects in the top-level columns array relates to a "process order," i.e., ToDo -> Doing -> Done.

Cards

The task card objects are collected in the cards array of each column. Each card represents a logical task, which can be described by it's title and description, both generic human-readable strings without conflict resolution.

Each card can have a list of links, usually live web urls, pointing to additional information.