mirror of
https://github.com/callumalpass/tasknotes.git
synced 2026-07-22 12:50:26 +00:00
docs: update documentation for version 3.23.1
This commit is contained in:
callumalpass
parent
56b31de77b
commit
4e1312f62b
14 changed files with 984 additions and 603 deletions
|
|
@ -1,4 +1,3 @@
|
|||
|
||||
# Features
|
||||
|
||||
TaskNotes is a task and note management plugin for Obsidian. It includes features for task management, inline task integration, time management, and calendar integration.
|
||||
|
|
@ -15,6 +14,7 @@ TaskNotes provides a system for managing tasks. You can create, edit, and organi
|
|||
- **Planning**: Time estimates and recurring patterns.
|
||||
- **Tracking**: Automatic creation and modification dates.
|
||||
- **Reminders**: Custom notifications for tasks using relative or absolute timing.
|
||||
- **Auto-archive**: Automatically archive tasks based on their status.
|
||||
|
||||
For more detailed information, see the [Task Management](features/task-management.md) documentation.
|
||||
|
||||
|
|
@ -25,7 +25,7 @@ TaskNotes provides comprehensive filtering capabilities through a hierarchical q
|
|||
- **Quick Search**: Instant text-based filtering
|
||||
- **Query Builder**: Complex hierarchical filter conditions with AND/OR logic
|
||||
- **Saved Views**: Named filter configurations for quick access
|
||||
- **Sorting and Grouping**: Multiple options for organizing task display
|
||||
- **Sorting and Grouping**: Multiple options for organizing task display, including by tags and custom user fields.
|
||||
|
||||
For more detailed information, see the [Filtering and Views](features/filtering-and-views.md) documentation.
|
||||
|
||||
|
|
@ -35,8 +35,9 @@ TaskNotes integrates with the Obsidian editor, which allows you to manage your t
|
|||
|
||||
- **Task Link Overlays**: Interactive widgets that display task information and allow for quick edits.
|
||||
- **Instant Task Conversion**: A feature to convert checkbox tasks into TaskNotes.
|
||||
- **`create inline task` command**: A command to create a new task from within the editor.
|
||||
- **Project Subtasks Widget**: A collapsible widget that displays tasks linked to the current project note.
|
||||
- **Natural Language Processing**: A feature to create tasks from conversational language, with automatic parsing of dates, priorities, and other details.
|
||||
- **Natural Language Processing**: A feature to create tasks from conversational language, with automatic parsing of dates, priorities, and other details. Supports 12 languages.
|
||||
|
||||
For more detailed information, see the [Inline Task Integration](features/inline-tasks.md) documentation.
|
||||
|
||||
|
|
@ -55,20 +56,35 @@ For more detailed information, see the [Time Management](features/time-managemen
|
|||
TaskNotes includes calendar integration features, such as:
|
||||
|
||||
- **ICS Calendar Subscriptions**: A feature to subscribe to external calendar feeds from Google Calendar, Outlook, and other services.
|
||||
- **ICS Export**: Export your task list as an ICS file, with automatic updates.
|
||||
- **Advanced Calendar View**: A calendar with multiple view modes (month, week, day, year, and configurable custom days), drag-and-drop scheduling, and time-blocking capabilities.
|
||||
- **Time-blocking**: A feature to create focused work periods and link them to your tasks.
|
||||
|
||||
For more detailed information, see the [Calendar Integration](features/calendar-integration.md) documentation.
|
||||
|
||||
## Workflows
|
||||
## User Fields
|
||||
|
||||
TaskNotes can be configured to support various workflows and use cases. Common workflows include:
|
||||
TaskNotes allows you to define your own custom fields for tasks. This feature allows you to:
|
||||
|
||||
- **Habit Tracking**: Using recurring tasks with completion tracking via the calendar interface
|
||||
- **Project Management**: Organizing tasks with project links and filtering
|
||||
- **Time Management**: Combining time tracking, Pomodoro sessions, and scheduling
|
||||
- **Add custom data**: Add any data you want to your tasks.
|
||||
- **Filter and sort**: Filter and sort your tasks based on your custom fields.
|
||||
- **Use in templates**: Use your custom fields in templates.
|
||||
|
||||
For detailed workflow examples, see the [Workflows](workflows.md) documentation.
|
||||
For more detailed information, see the [User Fields](features/user-fields.md) documentation.
|
||||
|
||||
## Integrations
|
||||
|
||||
TaskNotes integrates with other Obsidian plugins, such as:
|
||||
|
||||
- **Bases**: A deep integration with the Bases plugin, allowing you to use TaskNotes tasks in your Bases databases.
|
||||
|
||||
For more detailed information, see the [Integrations](features/integrations.md) documentation.
|
||||
|
||||
## REST API
|
||||
|
||||
TaskNotes provides a REST API that allows you to interact with the plugin from other applications.
|
||||
|
||||
For more detailed information, see the [HTTP API](HTTP_API.md) documentation.
|
||||
|
||||
## View Types
|
||||
|
||||
|
|
@ -76,7 +92,7 @@ TaskNotes provides multiple view types for different perspectives on your tasks:
|
|||
|
||||
- **[Task List View](views/task-list.md)** - Filtering, sorting, and grouping capabilities
|
||||
- **[Agenda View](views/agenda-view.md)** - Daily and weekly planning view
|
||||
- **[Kanban View](views/kanban-view.md)** - Card-based task organization
|
||||
- **[Kanban View](views/kanban-view.md)** - Card-based task organization
|
||||
- **[Calendar Views](views/calendar-views.md)** - Visual scheduling and time-blocking
|
||||
- **[Notes View](views/notes-view.md)** - Date-based note browsing
|
||||
- **[Pomodoro View](views/pomodoro-view.md)** - Focus timer with task integration
|
||||
|
|
@ -89,6 +105,4 @@ Configure TaskNotes to match your workflow:
|
|||
- **[Inline Task Settings](settings/inline-task-settings.md)** - Editor integration options
|
||||
- **[Calendar Settings](settings/calendar-settings.md)** - Calendar appearance and behavior
|
||||
- **[Advanced Settings](settings/advanced-settings.md)** - Field mapping and customization
|
||||
- **[Misc Settings](settings/misc-settings.md)** - Additional plugin features
|
||||
|
||||
|
||||
- **[Misc Settings](settings/misc-settings.md)** - Additional plugin features
|
||||
|
|
@ -34,6 +34,12 @@ Task link overlays work in both Live Preview and Reading modes:
|
|||
|
||||
The overlays support drag-and-drop to calendar views and provide keyboard shortcuts for quick navigation (Ctrl/Cmd+Click to open the source file).
|
||||
|
||||
## Create Inline Task Command
|
||||
|
||||
The `Create inline task` command allows you to create a new task from the current line in the editor. This command is available in the command palette.
|
||||
|
||||
When you run the command, the current line is used as the title of the new task. The line is then replaced with a link to the new task file.
|
||||
|
||||
## Instant Task Conversion
|
||||
|
||||
The **Instant Task Conversion** feature transforms lines in your notes into TaskNotes files. This works with both checkbox tasks and regular lines of text. When available, a "convert" button appears next to the content in edit mode. Clicking this button creates a new task note using the line's text as the title and replaces the original line with a link to the new task file.
|
||||
|
|
@ -161,7 +167,9 @@ The Project Subtasks widget shows the saved view name and completion counts just
|
|||
|
||||
## Natural Language Processing
|
||||
|
||||
TaskNotes includes a **Natural Language Processor (NLP)** that parses task descriptions written in English to extract structured data. This allows for task creation from conversational language, such as "Prepare quarterly report due Friday #work high priority," which would automatically set the due date, tag, and priority.
|
||||
TaskNotes includes a **Natural Language Processor (NLP)** that parses task descriptions to extract structured data. This allows for task creation from conversational language, such as "Prepare quarterly report due Friday #work high priority," which would automatically set the due date, tag, and priority.
|
||||
|
||||
The NLP engine supports multiple languages, including English, Japanese, German, Russian, and Chinese.
|
||||
|
||||
The NLP engine supports syntax for:
|
||||
|
||||
|
|
@ -173,4 +181,4 @@ The NLP engine supports syntax for:
|
|||
- **Time Estimates**: Formats like "2h," "30min," and "1h30m".
|
||||
- **Recurrence Patterns**: Phrases like "daily," "weekly," and "every Monday".
|
||||
|
||||
The NLP engine is integrated with the task creation modal. Typing a natural language description there will populate the corresponding fields.
|
||||
The NLP engine is integrated with the task creation modal. Typing a natural language description there will populate the corresponding fields.
|
||||
25
docs/features/integrations.md
Normal file
25
docs/features/integrations.md
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
|
||||
# Integrations
|
||||
|
||||
TaskNotes integrates with other Obsidian plugins.
|
||||
|
||||
[← Back to Features](features.md)
|
||||
|
||||
## Bases
|
||||
|
||||
TaskNotes integrates with the [Bases plugin](https://github.com/obsidian-community/obsidian-bases). This allows you to use your tasks as a data source in your Bases databases.
|
||||
|
||||
### Features
|
||||
|
||||
- **Task Views**: TaskNotes provides two views for Bases: "Task List" and "Kanban".
|
||||
- **Task Properties**: Task properties are displayed on the task cards in the Bases views.
|
||||
- **Formula Computation**: Use Bases formulas to perform calculations on your task data.
|
||||
|
||||
### Getting Started
|
||||
|
||||
To use the Bases integration, you need to have both the TaskNotes and Bases plugins installed and enabled.
|
||||
|
||||
1. **Enable the Integration**: Go to the TaskNotes settings and enable the "Bases Integration" option in the "Integrations" tab.
|
||||
2. **Create a View**: In Bases, create a new view and select either the "TaskNotes Task List" or "TaskNotes Kanban" view.
|
||||
|
||||
Your tasks will now be available in the Bases view.
|
||||
File diff suppressed because it is too large
Load diff
41
docs/features/user-fields.md
Normal file
41
docs/features/user-fields.md
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
|
||||
# User Fields
|
||||
|
||||
TaskNotes allows you to define your own custom fields for tasks. This feature allows you to add custom data to your tasks and use it for filtering, sorting, and grouping.
|
||||
|
||||
[← Back to Features](features.md)
|
||||
|
||||
## Creating User Fields
|
||||
|
||||
User fields are created in the TaskNotes settings, under the "Task Properties" tab. To create a new user field, click the "Add new user field" button.
|
||||
|
||||
Each user field has the following properties:
|
||||
|
||||
- **Display Name**: The name of the field as it will be displayed in the UI.
|
||||
- **Property Name**: The name of the field as it will be stored in the frontmatter of the task note.
|
||||
- **Type**: The data type of the field. The following types are supported:
|
||||
- **Text**: A single line of text.
|
||||
- **Number**: A number.
|
||||
- **Date**: A date.
|
||||
- **List**: A list of values.
|
||||
|
||||
## Using User Fields
|
||||
|
||||
Once you have created a user field, it will be available in the following places:
|
||||
|
||||
- **Task Modals**: The user field will be displayed as a field in the task creation and edit modals.
|
||||
- **Filtering**: You can filter your tasks by the user field in the FilterBar.
|
||||
- **Sorting**: You can sort your tasks by the user field.
|
||||
- **Grouping**: You can group your tasks by the user field.
|
||||
|
||||
## Frontmatter
|
||||
|
||||
User field data is stored in the frontmatter of the task note. The property name you define for the user field is used as the key in the frontmatter.
|
||||
|
||||
For example, if you create a user field with the property name "my_field", the data for that field will be stored in the frontmatter as follows:
|
||||
|
||||
```yaml
|
||||
---
|
||||
my_field: value
|
||||
---
|
||||
```
|
||||
|
|
@ -1,3 +1,4 @@
|
|||
|
||||
# TaskNotes NLP API
|
||||
|
||||
TaskNotes now exposes its natural language parsing capabilities through API endpoints, allowing external clients to parse task descriptions and create tasks using natural language input.
|
||||
|
|
@ -11,7 +12,8 @@ Parses natural language input and returns structured task data without creating
|
|||
**Request:**
|
||||
```json
|
||||
{
|
||||
"text": "Review PR #123 tomorrow high priority @work"
|
||||
"text": "Review PR #123 tomorrow high priority @work",
|
||||
"locale": "en"
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -58,7 +60,8 @@ Parses natural language input and creates a task in one step.
|
|||
**Request:**
|
||||
```json
|
||||
{
|
||||
"text": "Call mom due friday 2pm #personal"
|
||||
"text": "Call mom due friday 2pm #personal",
|
||||
"locale": "en"
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -135,6 +138,25 @@ The NLP parser can extract the following from text input:
|
|||
- **Keywords**: "done", "completed", "todo", "in-progress"
|
||||
- **Custom**: Uses your configured status types
|
||||
|
||||
### Multi-language Support
|
||||
|
||||
The NLP parser supports multiple languages. You can specify the language to use for parsing by providing a `locale` parameter in the request body. The following locales are supported:
|
||||
|
||||
- `en` (English)
|
||||
- `de` (German)
|
||||
- `es` (Spanish)
|
||||
- `fr` (French)
|
||||
- `it` (Italian)
|
||||
- `ja` (Japanese)
|
||||
- `nl` (Dutch)
|
||||
- `pt` (Portuguese)
|
||||
- `ru` (Russian)
|
||||
- `sv` (Swedish)
|
||||
- `uk` (Ukrainian)
|
||||
- `zh` (Chinese)
|
||||
|
||||
If no locale is provided, the parser will default to English.
|
||||
|
||||
## Example Inputs
|
||||
|
||||
| Input | Extracted |
|
||||
|
|
@ -166,21 +188,21 @@ Common errors:
|
|||
### JavaScript Example
|
||||
```javascript
|
||||
// Parse text only
|
||||
async function parseTask(text) {
|
||||
async function parseTask(text, locale = 'en') {
|
||||
const response = await fetch('http://localhost:8080/api/nlp/parse', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ text })
|
||||
body: JSON.stringify({ text, locale })
|
||||
});
|
||||
return response.json();
|
||||
}
|
||||
|
||||
// Parse and create task
|
||||
async function createTaskFromText(text) {
|
||||
async function createTaskFromText(text, locale = 'en') {
|
||||
const response = await fetch('http://localhost:8080/api/nlp/create', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ text })
|
||||
body: JSON.stringify({ text, locale })
|
||||
});
|
||||
return response.json();
|
||||
}
|
||||
|
|
@ -190,14 +212,14 @@ async function createTaskFromText(text) {
|
|||
```python
|
||||
import requests
|
||||
|
||||
def parse_task(text):
|
||||
def parse_task(text, locale='en'):
|
||||
response = requests.post('http://localhost:8080/api/nlp/parse',
|
||||
json={'text': text})
|
||||
json={'text': text, 'locale': locale})
|
||||
return response.json()
|
||||
|
||||
def create_task_from_text(text):
|
||||
def create_task_from_text(text, locale='en'):
|
||||
response = requests.post('http://localhost:8080/api/nlp/create',
|
||||
json={'text': text})
|
||||
json={'text': text, 'locale': locale})
|
||||
return response.json()
|
||||
```
|
||||
|
||||
|
|
@ -227,4 +249,4 @@ The NLP parser uses your TaskNotes configuration:
|
|||
- **Custom Status Types**: Your configured statuses
|
||||
- **Custom Priorities**: Your priority levels
|
||||
- **Default Behavior**: Scheduled vs due date preferences
|
||||
- **Task Creation Defaults**: Applied to created tasks
|
||||
- **Task Creation Defaults**: Applied to created tasks
|
||||
|
|
|
|||
|
|
@ -1,41 +1,41 @@
|
|||
# Settings
|
||||
|
||||
TaskNotes provides a variety of settings to customize its behavior and appearance. The settings are organized into several categories, each controlling a different aspect of the plugin.
|
||||
TaskNotes provides a variety of settings to customize its behavior and appearance. The settings are organized into several tabs, each controlling a different aspect of the plugin.
|
||||
|
||||
[← Back to Documentation](index.md)
|
||||
|
||||
## Task Defaults
|
||||
## General
|
||||
|
||||
These settings control the default properties for new tasks, such as the default status, priority, and folder location. You can also configure templates for new tasks, and set up filename generation patterns.
|
||||
These settings control the foundational aspects of the plugin, such as task identification, file storage, and click behavior.
|
||||
|
||||
For more detailed information, see the [Task Defaults](settings/task-defaults.md) documentation.
|
||||
For more detailed information, see the [General Settings](settings/general.md) documentation.
|
||||
|
||||
## Inline Task Settings
|
||||
## Features
|
||||
|
||||
These settings control the behavior of TaskNotes' inline task management features, such as the Task Link Overlay and Instant Task Conversion. You can also configure the natural language processor from this section.
|
||||
These settings allow you to enable, disable, and configure the various features of the plugin, such as inline tasks, natural language processing, the Pomodoro timer, and notifications.
|
||||
|
||||
For more detailed information, see the [Inline Task Settings](settings/inline-task-settings.md) documentation.
|
||||
For more detailed information, see the [Features Settings](settings/features.md) documentation.
|
||||
|
||||
## Calendar Settings
|
||||
## Defaults & Templates
|
||||
|
||||
These settings control the appearance and behavior of the calendar views, including the default view mode, time slot duration, and event visibility. You can also manage your external calendar subscriptions from this section.
|
||||
These settings control the default properties for new tasks, such as the default status, priority, and folder location. You can also configure templates for new tasks.
|
||||
|
||||
For more detailed information, see the [Calendar Settings](settings/calendar-settings.md) documentation.
|
||||
For more detailed information, see the [Defaults & Templates Settings](settings/defaults.md) documentation.
|
||||
|
||||
## Advanced Settings
|
||||
## Appearance & UI
|
||||
|
||||
These settings provide more advanced customization options, such as field mapping, custom status and priority workflows, and user-defined fields. You can also configure the Pomodoro timer from this section.
|
||||
These settings control the visual appearance of the plugin, including the calendar, task cards, and other UI elements.
|
||||
|
||||
**User Fields** allow you to define custom frontmatter properties that become filterable across all TaskNotes views, supporting text, number, date, boolean, and list data types with intelligent parsing.
|
||||
For more detailed information, see the [Appearance & UI Settings](settings/appearance.md) documentation.
|
||||
|
||||
For more detailed information, see the [Advanced Settings](settings/advanced-settings.md) documentation.
|
||||
## Task Properties
|
||||
|
||||
## Misc Settings
|
||||
These settings allow you to define custom statuses, priorities, and user fields for your tasks.
|
||||
|
||||
These settings control various plugin features and display options, including status bar visibility, project subtasks widget, and performance tuning.
|
||||
For more detailed information, see the [Task Properties Settings](settings/task-properties.md) documentation.
|
||||
|
||||
For more detailed information, see the [Misc Settings](settings/misc-settings.md) documentation.
|
||||
## Integrations
|
||||
|
||||
## Property-based Identification (Boolean note)
|
||||
These settings control the integration with other plugins and services, such as Bases and external calendars.
|
||||
|
||||
If you identify task files by a frontmatter property, enter boolean values as true/false (without quotes) in Settings. Obsidian stores checkbox properties as real booleans; TaskNotes matches them correctly (e.g., setting "true" matches frontmatter `true`). See [Property-based Task Identification](settings/property-identification.md) for examples.
|
||||
For more detailed information, see the [Integrations Settings](settings/integrations.md) documentation.
|
||||
70
docs/settings/appearance.md
Normal file
70
docs/settings/appearance.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
|
||||
# Appearance & UI Settings
|
||||
|
||||
These settings control the visual appearance of the plugin, including the calendar, task cards, and other UI elements.
|
||||
|
||||
[← Back to Settings](settings.md)
|
||||
|
||||
## Task Cards
|
||||
|
||||
- **Default visible properties**: Choose which properties appear on task cards by default.
|
||||
|
||||
## Task Filenames
|
||||
|
||||
- **Store title in filename**: Use the task title as the filename. The filename will update when the task title is changed.
|
||||
- **Filename format**: If "Store title in filename" is disabled, you can choose from a variety of filename generation patterns, including title-based, timestamp-based, and Zettelkasten-style.
|
||||
- **Custom filename template**: If you choose the "custom" filename format, you can define your own template using a variety of variables.
|
||||
|
||||
## Display Formatting
|
||||
|
||||
- **Time format**: Display time in 12-hour or 24-hour format throughout the plugin.
|
||||
|
||||
## Calendar View
|
||||
|
||||
- **Default view**: The calendar view shown when opening the calendar tab.
|
||||
- **Custom view day count**: Number of days to show in custom multi-day view.
|
||||
- **First day of week**: Which day should be the first column in week views.
|
||||
- **Show weekends**: Display weekends in calendar views.
|
||||
- **Show week numbers**: Display week numbers in calendar views.
|
||||
- **Show today highlight**: Highlight the current day in calendar views.
|
||||
- **Show current time indicator**: Display a line showing the current time in timeline views.
|
||||
- **Selection mirror**: Show a visual preview while dragging to select time ranges.
|
||||
- **Calendar locale**: Calendar locale for date formatting and calendar system (e.g., "en", "fa" for Farsi/Persian, "de" for German). Leave empty to auto-detect from browser.
|
||||
|
||||
## Default Event Visibility
|
||||
|
||||
- **Show scheduled tasks**: Display tasks with scheduled dates by default.
|
||||
- **Show due dates**: Display task due dates by default.
|
||||
- **Show due dates when scheduled**: Display due dates even for tasks that already have scheduled dates.
|
||||
- **Show time entries**: Display completed time tracking entries by default.
|
||||
- **Show recurring tasks**: Display recurring task instances by default.
|
||||
- **Show ICS events**: Display events from ICS subscriptions by default.
|
||||
|
||||
## Timeblocking
|
||||
|
||||
- **Enable timeblocking**: Enable timeblock functionality for lightweight scheduling in daily notes.
|
||||
- **Show timeblocks**: Display timeblocks from daily notes by default.
|
||||
|
||||
## Time Settings
|
||||
|
||||
- **Time slot duration**: Duration of each time slot in timeline views.
|
||||
- **Start time**: Earliest time shown in timeline views (HH:MM format).
|
||||
- **End time**: Latest time shown in timeline views (HH:MM format).
|
||||
- **Initial scroll time**: Time to scroll to when opening timeline views (HH:MM format).
|
||||
|
||||
## UI Elements
|
||||
|
||||
- **Show tracked tasks in status bar**: Display currently tracked tasks in Obsidian's status bar.
|
||||
- **Show project subtasks widget**: Display a widget showing subtasks for the current project note.
|
||||
- **Project subtasks position**: Where to position the project subtasks widget.
|
||||
- **Show expandable subtasks**: Allow expanding/collapsing subtask sections in task cards.
|
||||
- **Subtask chevron position**: Position of expand/collapse chevrons in task cards.
|
||||
- **Views button alignment**: Alignment of the views/filters button in the task interface.
|
||||
|
||||
## Project Autosuggest
|
||||
|
||||
- **Required tags**: Show only notes with any of these tags (comma-separated). Leave empty to show all notes.
|
||||
- **Include folders**: Show only notes in these folders (comma-separated paths). Leave empty to show all folders.
|
||||
- **Customize suggestion display**: Show advanced options to configure how project suggestions appear and what information they display.
|
||||
- **Enable fuzzy matching**: Allow typos and partial matches in project search. May be slower in large vaults.
|
||||
- **Row 1, 2, 3**: Configure up to 3 lines of information to show for each project suggestion.
|
||||
35
docs/settings/defaults.md
Normal file
35
docs/settings/defaults.md
Normal file
|
|
@ -0,0 +1,35 @@
|
|||
|
||||
# Defaults & Templates Settings
|
||||
|
||||
These settings control the default properties for new tasks, such as the default status, priority, and folder location. You can also configure templates for new tasks.
|
||||
|
||||
[← Back to Settings](settings.md)
|
||||
|
||||
## Basic Defaults
|
||||
|
||||
- **Default status**: The default status for new tasks.
|
||||
- **Default priority**: The default priority for new tasks.
|
||||
- **Default contexts**: A comma-separated list of default contexts (e.g., @home, @work).
|
||||
- **Default tags**: A comma-separated list of default tags (without #).
|
||||
- **Default projects**: Default project links for new tasks.
|
||||
- **Use parent note as project during instant conversion**: Automatically link the parent note as a project when using instant task conversion.
|
||||
- **Default time estimate**: Default time estimate in minutes (0 = no default).
|
||||
- **Default recurrence**: Default recurrence pattern for new tasks.
|
||||
|
||||
## Date Defaults
|
||||
|
||||
- **Default due date**: Default due date for new tasks.
|
||||
- **Default scheduled date**: Default scheduled date for new tasks.
|
||||
|
||||
## Default reminders
|
||||
|
||||
- **Add default reminder**: Create a new default reminder that will be added to all new tasks.
|
||||
|
||||
## Body Template
|
||||
|
||||
- **Use body template**: Use a template file for task body content.
|
||||
- **Body template file**: Path to template file for task body content. Supports template variables like `{{title}}`, `{{date}}`, `{{time}}`, `{{priority}}`, `{{status}}`, etc.
|
||||
|
||||
## Instant Task Conversion
|
||||
|
||||
- **Use task defaults on instant convert**: Apply default task settings when converting text to tasks instantly.
|
||||
51
docs/settings/features.md
Normal file
51
docs/settings/features.md
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
# Features Settings
|
||||
|
||||
These settings allow you to enable, disable, and configure the various features of the plugin, such as inline tasks, natural language processing, the Pomodoro timer, and notifications.
|
||||
|
||||
[← Back to Settings](settings.md)
|
||||
|
||||
## Inline Tasks
|
||||
|
||||
- **Task link overlay**: Replaces links to tasks with an interactive widget in Live Preview mode. The widget is not shown when the cursor is on the link, to allow for editing.
|
||||
- **Instant task convert**: Shows a button next to list items and checkboxes to convert them to tasks.
|
||||
- **Inline task convert folder**: The folder for inline task conversion. Use `{{currentNotePath}}` for a path relative to the current note.
|
||||
|
||||
## Natural Language Processing
|
||||
|
||||
- **Enable natural language task input**: Parse due dates, priorities, and contexts from natural language when creating tasks.
|
||||
- **Default to scheduled**: When NLP detects a date without context, treat it as scheduled rather than due.
|
||||
- **NLP language**: The language for natural language processing patterns and date parsing.
|
||||
- **Status suggestion trigger**: Text to trigger status suggestions (leave empty to disable).
|
||||
|
||||
## Pomodoro Timer
|
||||
|
||||
- **Work duration**: Duration of work intervals in minutes.
|
||||
- **Short break duration**: Duration of short breaks in minutes.
|
||||
- **Long break duration**: Duration of long breaks in minutes.
|
||||
- **Long break interval**: Number of work sessions before a long break.
|
||||
- **Auto-start breaks**: Automatically start break timers after work sessions.
|
||||
- **Auto-start work**: Automatically start work sessions after breaks.
|
||||
- **Pomodoro notifications**: Show notifications when Pomodoro sessions end.
|
||||
- **Sound enabled**: Play sound when Pomodoro sessions end.
|
||||
- **Sound volume**: Volume for Pomodoro sounds (0-100).
|
||||
- **Pomodoro data storage**: Where to store Pomodoro session history. Can be either "Plugin data" or "Daily notes".
|
||||
|
||||
## Notifications
|
||||
|
||||
- **Enable notifications**: Enable task reminder notifications.
|
||||
- **Notification type**: Type of notifications to show. Can be either "In-app notifications" or "System notifications".
|
||||
|
||||
## Performance & Behavior
|
||||
|
||||
- **Hide completed tasks from overdue**: Exclude completed tasks from overdue task calculations.
|
||||
- **Disable note indexing**: Disable automatic indexing of notes for better performance (may reduce some features).
|
||||
- **Suggestion debounce**: Debounce delay for file suggestions in milliseconds (0 = disabled).
|
||||
|
||||
## Time Tracking
|
||||
|
||||
- **Auto-stop tracking on complete**: Automatically stop time tracking when a task is marked complete.
|
||||
- **Time tracking stop notification**: Show notification when time tracking is automatically stopped.
|
||||
|
||||
## Recurring Tasks
|
||||
|
||||
- **Maintain due date offset in recurring tasks**: When completing recurring tasks, maintain the offset between due and scheduled dates.
|
||||
27
docs/settings/general.md
Normal file
27
docs/settings/general.md
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
|
||||
# General Settings
|
||||
|
||||
These settings control the foundational aspects of the plugin, such as task identification, file storage, and click behavior.
|
||||
|
||||
[← Back to Settings](settings.md)
|
||||
|
||||
## Task Storage
|
||||
|
||||
- **Default tasks folder**: The default location for new tasks.
|
||||
- **Move archived tasks to folder**: If enabled, tasks with a status of "archived" will be moved to the specified archive folder.
|
||||
- **Archive folder**: The folder to move archived tasks to.
|
||||
|
||||
## Task Identification
|
||||
|
||||
- **Identify tasks by**: Choose whether to identify tasks by a tag or by a frontmatter property.
|
||||
- **Tag**: If you choose to identify tasks by tag, you must specify the tag to use.
|
||||
- **Property**: If you choose to identify tasks by property, you must specify the property name and value.
|
||||
|
||||
## Folder Management
|
||||
|
||||
- **Excluded folders**: A comma-separated list of folders to exclude from the Notes tab.
|
||||
|
||||
## Task Interaction
|
||||
|
||||
- **Single-click action**: The action to perform when single-clicking a task card. Can be either "Edit task" or "Open note".
|
||||
- **Double-click action**: The action to perform when double-clicking a task card. Can be "Edit task", "Open note", or "No action".
|
||||
36
docs/settings/integrations.md
Normal file
36
docs/settings/integrations.md
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
|
||||
# Integrations Settings
|
||||
|
||||
These settings control the integration with other plugins and services, such as Bases and external calendars.
|
||||
|
||||
[← Back to Settings](settings.md)
|
||||
|
||||
## Bases integration
|
||||
|
||||
- **Enable Bases integration**: Enable TaskNotes views to be used within Obsidian Bases plugin. Bases plugin must be enabled for this to work.
|
||||
|
||||
## Calendar subscriptions
|
||||
|
||||
- **Default note template**: Path to template file for notes created from ICS events.
|
||||
- **Default note folder**: Folder for notes created from ICS events.
|
||||
- **ICS note filename format**: How filenames are generated for notes created from ICS events.
|
||||
- **Custom ICS filename template**: Template for custom ICS event filenames.
|
||||
- **Add Calendar Subscription**: Add a new calendar subscription from ICS/iCal URL or local file.
|
||||
- **Refresh all subscriptions**: Manually refresh all enabled calendar subscriptions.
|
||||
|
||||
## Automatic ICS export
|
||||
|
||||
- **Enable automatic export**: Automatically keep an ICS file updated with all your tasks.
|
||||
- **Export file path**: Path where the ICS file will be saved (relative to vault root).
|
||||
- **Update interval (between 5 and 1440 minutes)**: How often to update the export file.
|
||||
- **Export now**: Manually trigger an immediate export.
|
||||
|
||||
## HTTP API
|
||||
|
||||
- **Enable HTTP API**: Start local HTTP server for API access.
|
||||
- **API port**: Port number for the HTTP API server.
|
||||
- **API authentication token**: Token required for API authentication (leave empty for no auth).
|
||||
|
||||
## Webhooks
|
||||
|
||||
- **Add Webhook**: Register a new webhook endpoint.
|
||||
33
docs/settings/task-properties.md
Normal file
33
docs/settings/task-properties.md
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
|
||||
# Task Properties Settings
|
||||
|
||||
These settings allow you to define custom statuses, priorities, and user fields for your tasks.
|
||||
|
||||
[← Back to Settings](settings.md)
|
||||
|
||||
## Task Statuses
|
||||
|
||||
Customize the status options available for your tasks. These statuses control the task lifecycle and determine when tasks are considered complete.
|
||||
|
||||
- **Value**: The internal identifier stored in your task files (e.g., "in-progress").
|
||||
- **Label**: The display name shown in the interface (e.g., "In Progress").
|
||||
- **Color**: Visual indicator color for the status dot and badges.
|
||||
- **Completed**: When checked, tasks with this status are considered finished and may be filtered differently.
|
||||
- **Auto-archive**: When enabled, tasks will be automatically archived after the specified delay (1-1440 minutes).
|
||||
|
||||
## Task Priorities
|
||||
|
||||
Customize the priority levels available for your tasks. Priority weights determine sorting order and visual hierarchy in your task views.
|
||||
|
||||
- **Value**: The internal identifier stored in your task files (e.g., "high").
|
||||
- **Display Label**: The display name shown in the interface (e.g., "High Priority").
|
||||
- **Color**: Visual indicator color for the priority dot and badges.
|
||||
- **Weight**: Numeric value for sorting (higher weights appear first in lists).
|
||||
|
||||
## Field Mapping
|
||||
|
||||
Configure which frontmatter properties TaskNotes should use for each field. TaskNotes will read AND write using these property names. Changing these after creating tasks may cause inconsistencies.
|
||||
|
||||
## Custom User Fields
|
||||
|
||||
Define custom frontmatter properties to appear as type-aware filter options across views. Each row has a Display Name, Property Name, and Type.
|
||||
|
|
@ -155,7 +155,7 @@ Habits can be modified over time by editing the recurrence pattern:
|
|||
|
||||
## Project Management
|
||||
|
||||
TaskNotes provides integrated project management capabilities through its project assignment and organization features. Projects can be either plain text labels or links to actual Obsidian notes, enabling flexible project organization strategies.
|
||||
TaskNotes provides project management capabilities through its project assignment and organization features. Projects can be either plain text labels or links to actual Obsidian notes.
|
||||
|
||||
### Project Types and Formats
|
||||
|
||||
|
|
@ -178,6 +178,7 @@ projects: ["[[Market Research]]", "[[Q1 Strategy]]"]
|
|||
```
|
||||
|
||||
Wikilink projects provide additional benefits:
|
||||
|
||||
- Clickable links that open project notes
|
||||
- Bidirectional linking between tasks and project notes
|
||||
- Integration with Obsidian's graph view and backlinks
|
||||
|
|
@ -244,16 +245,19 @@ Projects are included in search functionality:
|
|||
#### Setting Up a New Project
|
||||
|
||||
1. **Create Project Note** (for wikilink projects):
|
||||
|
||||
- Create a new note in Obsidian for the project
|
||||
- Add project description, goals, and relevant information
|
||||
- Consider using a consistent naming convention
|
||||
|
||||
2. **Configure Default Projects**:
|
||||
|
||||
- Set default projects in task creation settings
|
||||
- New tasks will automatically include specified projects
|
||||
- Useful for focused project work periods
|
||||
|
||||
3. **Project Organization**:
|
||||
|
||||
- Use folders to organize project notes hierarchically
|
||||
- Create project templates for consistent structure
|
||||
- Link related project notes together
|
||||
|
|
@ -261,37 +265,23 @@ Projects are included in search functionality:
|
|||
#### Daily Project Work
|
||||
|
||||
1. **Filter by Current Project**:
|
||||
|
||||
- Use FilterBar to show only current project tasks
|
||||
- Focus on specific project work without distractions
|
||||
- Switch between projects using saved filter presets
|
||||
|
||||
2. **Project Progress Tracking**:
|
||||
|
||||
- Group tasks by project to see progress across initiatives
|
||||
- Use status filters to identify blocked or completed work
|
||||
- Review overdue tasks within specific projects
|
||||
|
||||
3. **Cross-Project Task Management**:
|
||||
|
||||
- Assign tasks to multiple projects when work spans initiatives
|
||||
- Use contexts and tags alongside projects for additional organization
|
||||
- Track dependencies between projects through linked notes
|
||||
|
||||
#### Project Review and Planning
|
||||
|
||||
1. **Project Dashboard Creation**:
|
||||
- Create project notes with embedded queries showing related tasks
|
||||
- Use Obsidian's dataview plugin to create project dashboards
|
||||
- Link to task files from project notes for easy navigation
|
||||
|
||||
2. **Project-Based Time Tracking**:
|
||||
- Filter time tracking reports by project
|
||||
- Use project assignment with Pomodoro sessions
|
||||
- Analyze time spent across different projects
|
||||
|
||||
3. **Project Completion Workflows**:
|
||||
- Review all project tasks before marking projects complete
|
||||
- Archive or reorganize completed project tasks
|
||||
- Update project notes with outcomes and lessons learned
|
||||
|
||||
### Project Integration Strategies
|
||||
|
||||
#### Combining Projects with Other Features
|
||||
|
|
@ -302,6 +292,7 @@ Projects are included in search functionality:
|
|||
title: "Prepare presentation slides"
|
||||
projects: ["[[Q4 Planning]]"]
|
||||
contexts: ["@computer", "@office"]
|
||||
|
||||
```
|
||||
Use contexts to specify where or how project work happens.
|
||||
|
||||
|
|
@ -311,6 +302,7 @@ Use contexts to specify where or how project work happens.
|
|||
title: "Review budget proposal"
|
||||
projects: ["[[Budget Planning]]"]
|
||||
tags: ["#review", "#finance"]
|
||||
|
||||
```
|
||||
Use tags for cross-cutting themes that span multiple projects.
|
||||
|
||||
|
|
@ -325,6 +317,6 @@ Use tags for cross-cutting themes that span multiple projects.
|
|||
- Projects are stored as arrays in task frontmatter
|
||||
- Wikilink projects must reference existing notes or will display as plain text
|
||||
- Project filtering uses exact name matching (case-sensitive)
|
||||
- Project selection modal searches note titles and file paths
|
||||
- Tasks with multiple projects appear in all relevant filtered views
|
||||
- Project links in task displays open the referenced notes when clicked
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue