Skip to content

GTD helpers

github-actions[bot] edited this page Jun 25, 2022 · 116 revisions

GTD Helpers module

Nice helpers for GTD modules.

Overview

This module is a set of public functions designed to ease GTD development.

Usage

How to Apply

  • To manually load the module, place this code in your Neorg setup:
    ["core.gtd.helpers"] = {
       config = { -- Note that this table is optional and doesn't need to be provided
           -- Configuration here
       }
    }
    Consult the configuration section to see how you can configure core.gtd.helpers to your liking.

Configuration

This module exposes no customization options.

Developer Usage

Public API

This segment will detail all of the functions core.gtd.helpers exposes. All of these functions reside in the public table.

  • get_gtd_excluded_files
  • get_gtd_files
  • state_to_text
  • is_processed

Examples

None Provided

Extra Info

Version

This module supports at least version 0.0.9. The current Neorg version is 0.0.11.

Imports

This module does not import any other files.

Requires

  • core.norg.dirman - This module is be responsible for managing directories full of .norg files.

Required by

  • core.gtd.ui - Nicely displays GTD related information.
  • core.gtd.base - Manages your tasks with Neorg using the Getting Things Done methodology.