mirror of
https://github.com/callumalpass/tasknotes.git
synced 2026-07-22 12:50:26 +00:00
docs: fix documentation inaccuracies and broken navigation links
- Fix project name references from "ChronoSync" to "TaskNotes" in timezone documentation - Correct broken relative paths in settings and features back navigation links - Fix incorrect default task tag reference in troubleshooting (task vs #task) - Clarify time-blocking interaction method in calendar integration - Fix circular function reference in timezone handling guide All changes maintain neutral, factual tone and improve technical accuracy.
This commit is contained in:
parent
4e1312f62b
commit
139a5d970f
14 changed files with 31 additions and 19 deletions
|
|
@ -1,8 +1,8 @@
|
|||
# ChronoSync Timezone Handling Guide
|
||||
# TaskNotes Timezone Handling Guide
|
||||
|
||||
## Overview
|
||||
|
||||
ChronoSync uses a **UTC Midnight Convention** to ensure consistent date handling across all timezones. This guide explains how to handle dates correctly to avoid timezone-related bugs.
|
||||
TaskNotes uses a **UTC Midnight Convention** to ensure consistent date handling across all timezones. This guide explains how to handle dates correctly to avoid timezone-related bugs.
|
||||
|
||||
## Core Principle: Local Dates for Users, UTC for RRule
|
||||
|
||||
|
|
@ -126,7 +126,7 @@ const calendarDate = formatDateForStorage(date); // This now returns local anywa
|
|||
|
||||
### What About `formatDateForStorage()`?
|
||||
|
||||
This function now just calls `formatDateForStorage()` internally. It exists for backward compatibility but always returns local dates. You can use either, but prefer `formatDateForStorage()` for clarity.
|
||||
This function converts Date objects to YYYY-MM-DD format using local timezone components. It ensures consistent date formatting for storage and display purposes.
|
||||
|
||||
## Testing Your Code
|
||||
|
||||
|
|
|
|||
|
|
@ -1,14 +1,14 @@
|
|||
# UTC-Based Timezone Handling in ChronoSync
|
||||
# UTC-Based Timezone Handling in TaskNotes
|
||||
|
||||
## Overview
|
||||
|
||||
ChronoSync implements a UTC-based timezone approach to ensure consistent date handling across all timezones while maintaining intuitive user behavior. This document explains the technical implementation, design decisions, and best practices for developers working with the codebase.
|
||||
TaskNotes implements a UTC-based timezone approach to ensure consistent date handling across all timezones while maintaining intuitive user behavior. This document explains the technical implementation, design decisions, and best practices for developers working with the codebase.
|
||||
|
||||
## Core Architecture
|
||||
|
||||
### The UTC Midnight Convention
|
||||
|
||||
ChronoSync follows a **UTC Midnight Convention** that operates on two key principles:
|
||||
TaskNotes follows a **UTC Midnight Convention** that operates on two key principles:
|
||||
|
||||
1. **User-facing operations** use local dates for intuitive behavior
|
||||
2. **Internal calculations** use UTC to prevent timezone-dependent bugs
|
||||
|
|
@ -263,7 +263,7 @@ const rruleDate = createUTCDateForRRule(dateStr); // Interpreted as UTC - CONSIS
|
|||
|
||||
### Timezone-Aware Test Cases
|
||||
|
||||
ChronoSync includes comprehensive tests for timezone handling:
|
||||
TaskNotes includes comprehensive tests for timezone handling:
|
||||
|
||||
1. **Basic Date Functions**: Test date creation, parsing, and formatting across timezones
|
||||
2. **Recurring Task Logic**: Verify RRule calculations work correctly regardless of user timezone
|
||||
|
|
@ -355,6 +355,6 @@ The UTC-based approach maintains backward compatibility:
|
|||
|
||||
## Conclusion
|
||||
|
||||
The UTC-based timezone approach provides ChronoSync with robust, consistent date handling that prevents timezone-related bugs while maintaining intuitive user behavior. By following the guidelines in this document, developers can ensure their code works correctly for users in all timezones.
|
||||
The UTC-based timezone approach provides TaskNotes with robust, consistent date handling that prevents timezone-related bugs while maintaining intuitive user behavior. By following the guidelines in this document, developers can ensure their code works correctly for users in all timezones.
|
||||
|
||||
For quick reference, see the [Timezone Quick Reference Guide](TIMEZONE_QUICK_REFERENCE.md) for common patterns and functions.
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
# ChronoSync Timezone Quick Reference
|
||||
# TaskNotes Timezone Quick Reference
|
||||
|
||||
## 🚀 Quick Cheat Sheet
|
||||
|
||||
|
|
|
|||
|
|
@ -51,4 +51,4 @@ Related notes and tasks are automatically identified by their ICS event ID field
|
|||
|
||||
## Time-blocking
|
||||
|
||||
The Advanced Calendar supports time-blocking, which is a time management method that involves scheduling out parts of your day. You can create time blocks directly in the calendar, and you can link them to specific tasks. Time blocks are stored in the frontmatter of your daily notes.
|
||||
The Advanced Calendar supports time-blocking, which is a time management method that involves scheduling out parts of your day. You can create time blocks by holding the Shift key while selecting a time range in the calendar. Time blocks are stored in the frontmatter of your daily notes and can be linked to specific tasks.
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@ TaskNotes provides integration with ICS calendar events, allowing you to create
|
|||
## Overview
|
||||
|
||||
The ICS integration allows you to:
|
||||
|
||||
- View detailed information about calendar events
|
||||
- Create notes from calendar events with customizable templates
|
||||
- Generate tasks from events with proper scheduling and context
|
||||
|
|
@ -26,6 +27,7 @@ When you interact with a calendar event in TaskNotes, an information modal displ
|
|||
### Related Content
|
||||
|
||||
The modal shows a list of existing notes and tasks that are linked to the calendar event. Content is automatically categorized as:
|
||||
|
||||
- **Task** - Files containing the configured task tag
|
||||
- **Note** - Files without the task tag
|
||||
|
||||
|
|
@ -54,6 +56,7 @@ The note creation process allows customization of the generated content:
|
|||
### Template Usage
|
||||
|
||||
When a template is specified:
|
||||
|
||||
- The template file is processed with ICS-specific variables
|
||||
- Standard TaskNotes template variables are also available
|
||||
- Template content replaces the default event description format
|
||||
|
|
@ -62,6 +65,7 @@ When a template is specified:
|
|||
### Default Content
|
||||
|
||||
Without a template, notes include:
|
||||
|
||||
- Event title as the main heading
|
||||
- Formatted start and end times
|
||||
- Location information
|
||||
|
|
@ -95,12 +99,14 @@ Task content includes formatted event details similar to note creation, providin
|
|||
You can establish connections between existing vault content and calendar events:
|
||||
|
||||
### Link Process
|
||||
|
||||
1. Select an existing markdown file from your vault
|
||||
2. The file's frontmatter is updated to include the event ID
|
||||
3. The modification date is updated to reflect the change
|
||||
4. The connection appears in the related content list
|
||||
|
||||
### Bidirectional References
|
||||
|
||||
- Calendar events can display all linked content
|
||||
- Content files maintain references to their associated events
|
||||
- Multiple pieces of content can be linked to a single event
|
||||
|
|
@ -151,21 +157,27 @@ All standard TaskNotes template variables remain available:
|
|||
ICS integration settings are located in the Advanced Settings section:
|
||||
|
||||
### Default Templates
|
||||
|
||||
Configure template files for consistent content creation from events. Templates are optional and the system provides sensible defaults when not specified.
|
||||
|
||||
### Default Folders
|
||||
|
||||
Set destination folders for content created from events. This helps organize ICS-generated content separately from other vault content if desired.
|
||||
|
||||
### Filename Formats
|
||||
|
||||
The system uses the standard TaskNotes filename generation with event-specific context, ensuring unique and descriptive filenames for created content.
|
||||
|
||||
## Technical Implementation
|
||||
|
||||
### Event Identification
|
||||
|
||||
Calendar events are identified by their unique ICS event ID, which is maintained in the frontmatter of created content. This allows the system to track relationships even if event details change.
|
||||
|
||||
### Content Type Detection
|
||||
|
||||
The system distinguishes between tasks and notes by checking for the presence of the configured task tag in the content's frontmatter tags array, rather than relying on file structure or naming conventions.
|
||||
|
||||
### Error Handling
|
||||
|
||||
The integration includes error boundaries for network issues, file operations, and template processing. Failed operations provide user feedback without interrupting the overall workflow.
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
|
||||
TaskNotes integrates with other Obsidian plugins.
|
||||
|
||||
[← Back to Features](features.md)
|
||||
[← Back to Features](../features.md)
|
||||
|
||||
## Bases
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
|
||||
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)
|
||||
[← Back to Features](../features.md)
|
||||
|
||||
## Creating User Fields
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
|
||||
These settings control the visual appearance of the plugin, including the calendar, task cards, and other UI elements.
|
||||
|
||||
[← Back to Settings](settings.md)
|
||||
[← Back to Settings](../settings.md)
|
||||
|
||||
## Task Cards
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
|
||||
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)
|
||||
[← Back to Settings](../settings.md)
|
||||
|
||||
## Basic Defaults
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
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)
|
||||
[← Back to Settings](../settings.md)
|
||||
|
||||
## Inline Tasks
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
|
||||
These settings control the foundational aspects of the plugin, such as task identification, file storage, and click behavior.
|
||||
|
||||
[← Back to Settings](settings.md)
|
||||
[← Back to Settings](../settings.md)
|
||||
|
||||
## Task Storage
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
|
||||
These settings control the integration with other plugins and services, such as Bases and external calendars.
|
||||
|
||||
[← Back to Settings](settings.md)
|
||||
[← Back to Settings](../settings.md)
|
||||
|
||||
## Bases integration
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
|
||||
These settings allow you to define custom statuses, priorities, and user fields for your tasks.
|
||||
|
||||
[← Back to Settings](settings.md)
|
||||
[← Back to Settings](../settings.md)
|
||||
|
||||
## Task Statuses
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ This section covers common issues and their solutions when using TaskNotes.
|
|||
|
||||
**Solutions**:
|
||||
|
||||
1. Check that task files include the task tag configured in settings (default: `#task`)
|
||||
1. Check that task files include the task tag configured in settings (default: `task`)
|
||||
2. Verify task files are not in folders listed in "Excluded folders" setting
|
||||
3. Ensure YAML frontmatter is properly formatted with opening and closing `---` lines
|
||||
4. Try closing and reopening TaskNotes views to refresh the cache
|
||||
|
|
|
|||
Loading…
Reference in a new issue