callumalpass_tasknotes/docs/settings.md
Callum Alpass ac57dd738a feat: add OpenAPI specification and Pomodoro API endpoints
## OpenAPI Specification
- Add decorator-based OpenAPI system with @OpenAPIController and @OpenAPI decorators
- Generate machine-readable OpenAPI 3.0 spec at /api/docs
- Serve interactive Swagger UI documentation at /api/docs/ui
- Complete schema definitions for all API types and responses
- Enable TypeScript experimental decorators support

## Pomodoro API Endpoints
- POST /api/pomodoro/start - Start new pomodoro session with optional task
- POST /api/pomodoro/stop - Stop current session
- POST /api/pomodoro/pause - Pause running session
- POST /api/pomodoro/resume - Resume paused session
- GET /api/pomodoro/status - Get current session status and statistics
- GET /api/pomodoro/sessions - Get session history with filtering
- GET /api/pomodoro/stats - Get daily/date-specific statistics

## Documentation Updates
- Add comprehensive HTTP API documentation with pomodoro examples
- Include JavaScript PomodoroController integration example
- Update feature documentation with view types and settings
- Improve navigation structure across documentation files

## Dependencies
- Add reflect-metadata for decorator metadata support
- Remove unused express dependency
- Update TypeScript configuration for decorator support

All endpoints include proper error handling, OpenAPI documentation, and support for recurring task integration.
2025-08-13 22:12:14 +10:00

2.2 KiB

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.

← Back to Documentation

Task Defaults

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.

For more detailed information, see the Task Defaults documentation.

Inline Task Settings

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.

For more detailed information, see the Inline Task Settings documentation.

Calendar Settings

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.

For more detailed information, see the Calendar Settings documentation.

Advanced Settings

These settings provide more advanced customization options, such as field mapping, custom status and priority workflows. You can also configure the Pomodoro timer from this section.

For more detailed information, see the Advanced Settings documentation.

Misc Settings

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 Misc Settings documentation.

Property-based Identification (Boolean note)

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 for examples.