Skip to content

Latest commit

 

History

History
24 lines (19 loc) · 1.11 KB

org-mode-features.md

File metadata and controls

24 lines (19 loc) · 1.11 KB
title Org-mode Features
description
linkTitle Org-mode Features
menu
main
weight
10

How xc Finds org-mode Files

When using xc with org-mode, it looks in the current directory (then in parents) for a README.org and treats sub-headers under the "Tasks" header as tasks.

Note: in a directory that contains both README.org and README.md, xc will look for tasks in the Markdown README only.
You can change this using the type flag, i.e. xc -type org TASK

Comment headings

xc will skip over org-mode comment headings beginning with COMMENT.

Header tags

When xc looks for tasks, it expects to find them under a header called "Tasks". To override this, you can put an :xc_heading: tag on any heading and xc will find tasks under the first such heading it encounters. Here's what this looks like in practice, supposing you want to use "Getting started" as your task heading:

** Getting started                                              :xc_heading:
*** build
  [...etc]