plugins.mkdnflow.toDo.complete
This option can be used to stipulate which symbols shall be used when updating a parent
to-do’s status when a child to-do’s status is changed.
This is not required: if toDo.symbols
is customized but this option is not
provided, the plugin will attempt to infer what the meanings of the symbols in your list
are by their order.
For example, if you set toDo.symbols
as [" " "⧖" "✓"]
, " "
will be assigned to
toDo.notStarted
, “⧖” will be assigned to toDo.inProgress
, etc.
If more than three symbols are specified, the first will be used as notStarted
, the
second will be used as inProgress
, and the last will be used as complete
.
If two symbols are provided (e.g. " ", "✓"
), the first will be used as both
notStarted
and inProgress
, and the second will be used as complete
.
toDo.complete
stipulates which symbol represents a complete to-do.
Type: null or string or raw lua code
Default:
null
Plugin default: "X"
Declared by:
plugins.mkdnflow.toDo.inProgress
This option can be used to stipulate which symbols shall be used when updating a parent
to-do’s status when a child to-do’s status is changed.
This is not required: if toDo.symbols
is customized but this option is not
provided, the plugin will attempt to infer what the meanings of the symbols in your list
are by their order.
For example, if you set toDo.symbols
as [" " "⧖" "✓"]
, " "
will be assigned to
toDo.notStarted
, “⧖” will be assigned to toDo.inProgress
, etc.
If more than three symbols are specified, the first will be used as notStarted
, the
second will be used as inProgress
, and the last will be used as complete
.
If two symbols are provided (e.g. " ", "✓"
), the first will be used as both
notStarted
and inProgress
, and the second will be used as complete
.
toDo.inProgress
stipulates which symbol represents an in-progress to-do.
Type: null or string or raw lua code
Default:
null
Plugin default: "-"
Declared by:
plugins.mkdnflow.toDo.notStarted
This option can be used to stipulate which symbols shall be used when updating a parent
to-do’s status when a child to-do’s status is changed.
This is not required: if toDo.symbols
is customized but this option is not
provided, the plugin will attempt to infer what the meanings of the symbols in your list
are by their order.
For example, if you set toDo.symbols
as [" " "⧖" "✓"]
, " "
will be assigned to
toDo.notStarted
, “⧖” will be assigned to toDo.inProgress
, etc.
If more than three symbols are specified, the first will be used as notStarted
, the
second will be used as inProgress
, and the last will be used as complete
.
If two symbols are provided (e.g. " ", "✓"
), the first will be used as both
notStarted
and inProgress
, and the second will be used as complete
.
toDo.notStarted
stipulates which symbol represents a not-yet-started to-do.
Type: null or string or raw lua code
Default:
null
Plugin default: " "
Declared by:
plugins.mkdnflow.toDo.symbols
A list of symbols (each no more than one character) that represent to-do list completion
statuses.
MkdnToggleToDo
references these when toggling the status of a to-do item.
Three are expected: one representing not-yet-started to-dos (default: ' '
), one
representing in-progress to-dos (default: -
), and one representing complete to-dos
(default: X
).
NOTE: Native Lua support for UTF-8 characters is limited, so in order to ensure all functionality works as intended if you are using non-ascii to-do symbols, you’ll need to install the luarocks module “luautf8”.
Type: null or (list of (string or raw lua code))
Default:
null
Plugin default:
[
" "
"-"
"X"
]
Declared by:
plugins.mkdnflow.toDo.updateParents
Whether parent to-dos’ statuses should be updated based on child to-do status changes
performed via MkdnToggleToDo
true
(default): Parent to-do statuses will be inferred and automatically updated when a child to-do’s status is changedfalse
: To-do items can be toggled, but parent to-do statuses (if any) will not be automatically changed
Type: null or boolean or raw lua code
Default:
null
Plugin default: true
Declared by: