{% extends "base.html" %} {% block title %}{{ _('Help') }} - {{ app_name }}{% endblock %} {% block content %}

{{ _('Help') }}

{{ _('Complete documentation and user guide') }}

/ {{ _('Help') }}

{{ _('TimeTracker Help Center') }}

{{ _('Everything you need to know to get the most out of TimeTracker') }}

{{ _('Quick Start Guide') }}

{{ _('For New Users') }}

  1. {{ _('Log in with your username (no password required)') }}
  2. {{ _('Explore the dashboard to see your overview') }}
  3. {{ _('Start your first timer on an existing project') }}
  4. {{ _('View your time entries in reports') }}

{{ _('For Administrators') }}

  1. {{ _('Set up clients in the Client Management section') }}
  2. {{ _('Create projects and assign them to clients') }}
  3. {{ _('Configure system settings (timezone, currency, etc.)') }}
  4. {{ _('Manage users and permissions') }}

{{ _('Pro Tip:') }} {{ _('Use the mobile-friendly interface to track time on the go. The timer continues running even if you close your browser!') }}

{{ _('Time Tracking') }}

{{ _('Smart Timers') }}

{{ _('Real-time tracking with automatic idle detection and WebSocket updates') }}

{{ _('Manual Entry') }}

{{ _('Log time manually with custom start and end times') }}

{{ _('Starting a Timer') }}

  1. {{ _('Navigate to the Timer page or dashboard') }}
  2. {{ _('Select a project from the dropdown') }}
  3. {{ _('Optionally select a task for more detailed tracking') }}
  4. {{ _('Add notes about what you\'re working on (optional)') }}
  5. {{ _('Add tags separated by commas (optional)') }}
  6. {{ _('Click "Start Timer"') }}

{{ _('Timer Features') }}

  • {{ _('Real-time duration display') }}
  • {{ _('Continues running if browser closes') }}
  • {{ _('Automatic idle detection (configurable)') }}
  • {{ _('One active timer per user (configurable)') }}
  • {{ _('WebSocket live updates') }}

{{ _('Manual Time Entry') }}

{{ _('Create time entries manually when you need to record time spent away from the computer or adjust existing entries.') }}

{{ _('Required Information') }}
  • {{ _('Project selection') }}
  • {{ _('Start date and time') }}
  • {{ _('End date and time') }}
{{ _('Optional Information') }}
  • {{ _('Task assignment') }}
  • {{ _('Description/notes') }}
  • {{ _('Tags for categorization') }}
  • {{ _('Billable status override') }}

{{ _('Advanced Time Entry Features') }}

{{ _('Bulk Entry') }}

{{ _('Create multiple time entries for consecutive days with the same project and duration. Perfect for regular work patterns.') }}

{{ _('Templates') }}

{{ _('Save frequently used time entries as templates for quick reuse. Saves project, task, and notes.') }}

{{ _('Calendar View') }}

{{ _('Visualize your time entries on a calendar. Drag-and-drop to reschedule or click dates to add entries.') }}

{{ _('Project Management') }}

{{ _('Project Information') }}

  • {{ _('Name') }}: {{ _('Descriptive project name') }}
  • {{ _('Client') }}: {{ _('Associated client organization') }}
  • {{ _('Description') }}: {{ _('Project details and scope') }}
  • {{ _('Status') }}: {{ _('Active, completed, or archived') }}

{{ _('Billing Information') }}

  • {{ _('Billable') }}: {{ _('Whether time should be tracked for billing') }}
  • {{ _('Hourly Rate') }}: {{ _('Rate for billable time calculations') }}
  • {{ _('Billing Reference') }}: {{ _('PO number or billing code') }}
{% if current_user.is_admin %}

{{ _('Project Operations') }}

  • {{ _('Create new projects with client relationships') }}
  • {{ _('Edit existing projects to update details') }}
  • {{ _('Archive projects to hide from timers (preserves data)') }}
  • {{ _('Delete projects (removes all associated time entries)') }}

{{ _('Best Practices') }}

  • {{ _('Use descriptive project names') }}
  • {{ _('Set accurate hourly rates for billing') }}
  • {{ _('Archive instead of delete when possible') }}
  • {{ _('Use billing references for external tracking') }}
{% endif %}

{{ _('Client Management') }}

{{ _('The client management system helps organize your work by client organizations, preventing errors and streamlining project creation.') }}

{{ _('Client Information') }}

  • {{ _('Organization Name') }}: {{ _('Company or client name') }}
  • {{ _('Contact Person') }}: {{ _('Primary contact details') }}
  • {{ _('Email & Phone') }}: {{ _('Contact information') }}
  • {{ _('Address') }}: {{ _('Business address') }}

{{ _('Benefits') }}

  • {{ _('Dropdown selection prevents typos') }}
  • {{ _('Default rates auto-populate projects') }}
  • {{ _('Consistent client naming') }}
  • {{ _('Easier project organization') }}
{{ _('Project Count') }}

{{ _('Total and active projects') }}

{{ _('Time Tracking') }}

{{ _('Total hours worked') }}

{{ _('Cost Estimation') }}

{{ _('Estimated billing amounts') }}

{{ _('Task Management') }}

{{ _('Break down projects into manageable tasks with detailed tracking and progress monitoring.') }}

{{ _('Task Properties') }}

  • {{ _('Name & Description') }}: {{ _('Clear task identification') }}
  • {{ _('Priority Levels') }}: {{ _('Low, Medium, High, Urgent') }}
  • {{ _('Due Dates') }}: {{ _('Deadline tracking') }}
  • {{ _('Assignment') }}: {{ _('Task ownership') }}

{{ _('Status Tracking') }}

  • {{ _('To Do - Not started') }}
  • {{ _('In Progress - Currently working') }}
  • {{ _('Review - Ready for review') }}
  • {{ _('Done - Completed') }}
  • {{ _('Cancelled - Not needed') }}

{{ _('Time Tracking Features') }}

  • {{ _('Start timers directly from tasks') }}
  • {{ _('Link time entries to specific tasks') }}
  • {{ _('Track estimated vs actual hours') }}
  • {{ _('Monitor task progress automatically') }}

{{ _('Task Views') }}

  • {{ _('My Tasks - Your assigned tasks') }}
  • {{ _('All Tasks - Complete task list') }}
  • {{ _('Overdue Tasks - Past due items') }}
  • {{ _('Project Tasks - Tasks within projects') }}

{{ _('Collaboration Features') }}

  • {{ _('Task Comments - Threaded discussions on tasks') }}
  • {{ _('Markdown Support - Rich formatting in descriptions') }}
  • {{ _('User Mentions - Tag team members (if enabled)') }}
  • {{ _('File Attachments - Attach files to tasks (if enabled)') }}

{{ _('Markdown Formatting') }}

{{ _('Task and project descriptions support Markdown:') }}

  • {{ _('**Bold**, *Italic*, ~~Strikethrough~~') }}
  • {{ _('# Headings, - Lists, [Links](url)') }}
  • {{ _('```code blocks```, tables, images') }}

{{ _('Kanban Board') }}

{{ _('Visualize your workflow with a drag-and-drop Kanban board for intuitive task management.') }}

{{ _('Board Features') }}

  • {{ _('Customizable columns matching task statuses') }}
  • {{ _('Drag-and-drop tasks between columns') }}
  • {{ _('Filter by project, user, or priority') }}
  • {{ _('Quick search across all tasks') }}

{{ _('Using the Kanban Board') }}

  1. {{ _('Access from the Tasks menu or project page') }}
  2. {{ _('Drag tasks to different columns to change status') }}
  3. {{ _('Click on a task card to view/edit details') }}
  4. {{ _('Use filters to focus on specific work') }}

{{ _('Pro Tip:') }} {{ _('The Kanban board is perfect for sprint planning and daily standups. Each column represents a stage in your workflow!') }}

{{ _('Expense Tracking') }}

{{ _('Track business expenses, manage receipts, and handle reimbursements efficiently.') }}

{{ _('Expense Features') }}

  • {{ _('Categorize expenses (travel, meals, supplies, etc.)') }}
  • {{ _('Attach receipt images and documents') }}
  • {{ _('Track amounts, tax, and payment methods') }}
  • {{ _('Approval workflow for expense requests') }}

{{ _('Billing & Reimbursement') }}

  • {{ _('Mark expenses as billable to clients') }}
  • {{ _('Include expenses in client invoices') }}
  • {{ _('Track reimbursement status') }}
  • {{ _('Link expenses to specific projects') }}
1
{{ _('Record Expense') }}

{{ _('Enter details and upload receipt') }}

2
{{ _('Submit for Approval') }}

{{ _('Admin reviews and approves') }}

3
{{ _('Invoice/Reimburse') }}

{{ _('Add to invoice or reimburse') }}

4
{{ _('Track Payment') }}

{{ _('Monitor reimbursement status') }}

{{ _('Professional Invoicing') }}

{{ _('Core Features') }}

  • {{ _('Professional PDF generation') }}
  • {{ _('Company branding and logos') }}
  • {{ _('Automatic invoice numbering') }}
  • {{ _('Tax calculations') }}

{{ _('Time Integration') }}

  • {{ _('Generate from time entries') }}
  • {{ _('Smart grouping by task/project') }}
  • {{ _('Prevent double-billing') }}
  • {{ _('Use project hourly rates') }}
1
{{ _('Create Invoice') }}

{{ _('Set up client and project details') }}

2
{{ _('Add Items') }}

{{ _('Generate from time or add manually') }}

3
{{ _('Review & Send') }}

{{ _('Export PDF and update status') }}

4
{{ _('Track Payment') }}

{{ _('Monitor status and payments') }}

{{ _('Reports & Analytics') }}

{{ _('Standard Reports') }}

  • {{ _('Project Report - Time breakdown by project') }}
  • {{ _('User Report - Individual performance metrics') }}
  • {{ _('Summary Report - Key metrics and trends') }}
  • {{ _('Time Entry Report - Detailed time logs') }}

{{ _('Export Options') }}

  • {{ _('CSV Export - For external analysis') }}
  • {{ _('Configurable delimiters') }}
  • {{ _('Custom date ranges') }}
  • {{ _('Filtered data export') }}

{{ _('Filter Options') }}

  • {{ _('Date Range - Custom start and end dates') }}
  • {{ _('Project - Filter by specific projects') }}
  • {{ _('User - Filter by team members') }}
  • {{ _('Client - Filter by client organization') }}
  • {{ _('Saved Filters - Save frequently used filters') }}

{{ _('Visual Analytics') }}

  • {{ _('Interactive bar charts') }}
  • {{ _('Time distribution pie charts') }}
  • {{ _('Trend analysis over time') }}
  • {{ _('Mobile-optimized charts') }}

{{ _('Pro Tip:') }} {{ _('Use Saved Filters to quickly access your most common report views. Save filters for weekly reviews, monthly billing, or specific project tracking!') }}

{{ _('Productivity Features') }}

{{ _('Boost your efficiency with keyboard shortcuts, command palette, and automation features.') }}

{{ _('Command Palette') }}

{{ _('Access any feature instantly without leaving the keyboard') }}

{{ _('Opening the Command Palette') }}
  • ? {{ _('Press the question mark key') }}
  • Ctrl+K / Cmd+K {{ _('Quick search') }}
{{ _('Quick Actions') }}
  • g d {{ _('Go to Dashboard') }}
  • g p {{ _('Go to Projects') }}
  • g t {{ _('Go to Tasks') }}
  • n e {{ _('New Time Entry') }}
{{ _('Keyboard Shortcuts') }}

{{ _('Navigate faster with keyboard-driven commands. Press Shift+? to see all shortcuts.') }}

{{ _('Global Search') }}

{{ _('Quickly find projects, tasks, clients, and time entries from anywhere in the app.') }}

{{ _('Email Notifications') }}

{{ _('Get notified about task assignments, overdue invoices, and weekly summaries via email.') }}

{% if current_user.is_admin %}

{{ _('Administrator Features') }}

{{ _('User Management') }}

  • {{ _('Create new users with flexible authentication') }}
  • {{ _('Assign custom roles with specific permissions') }}
  • {{ _('Activate/deactivate user accounts') }}
  • {{ _('View user statistics and activity') }}
  • {{ _('Generate API tokens for users') }}

{{ _('Access Control') }}

  • {{ _('Granular role-based permissions system') }}
  • {{ _('Custom roles with fine-grained access') }}
  • {{ _('User data access controls') }}
  • {{ _('OIDC/SSO integration (Azure AD, Authelia, etc.)') }}
  • {{ _('API token management for integrations') }}

{{ _('Authentication Methods') }}

  • {{ _('Username-only (simple internal use)') }}
  • {{ _('OIDC/SSO (enterprise authentication)') }}
  • {{ _('Both methods simultaneously') }}
  • {{ _('Automatic role assignment via groups') }}

{{ _('Role & Permission Management') }}

  • {{ _('Create custom roles beyond Admin/User') }}
  • {{ _('Set granular permissions per feature') }}
  • {{ _('Assign users to multiple roles') }}
  • {{ _('View and manage all permissions') }}

{{ _('General Settings') }}

  • {{ _('Timezone and locale settings') }}
  • {{ _('Currency configuration') }}
  • {{ _('Time rounding rules') }}
  • {{ _('Self-registration settings') }}

{{ _('Timer Settings') }}

  • {{ _('Idle timeout configuration') }}
  • {{ _('Single active timer mode') }}
  • {{ _('Timer display preferences') }}
  • {{ _('Notification settings') }}

{{ _('Database Management') }}

  • {{ _('Create manual database backups') }}
  • {{ _('View database migration status') }}
  • {{ _('Monitor database performance') }}
  • {{ _('Clean up old data and logs') }}

{{ _('System Monitoring') }}

  • {{ _('View system information and health') }}
  • {{ _('Monitor application performance') }}
  • {{ _('Review system logs and errors') }}
{% endif %}

{{ _('Mobile Usage') }}

{{ _('Mobile-Friendly Features') }}

  • {{ _('Optimized for phones and tablets') }}
  • {{ _('Touch-friendly interface') }}
  • {{ _('Adaptive layouts for all screen sizes') }}
  • {{ _('High contrast for outdoor visibility') }}

{{ _('Mobile Navigation') }}

  • {{ _('Bottom tab bar for easy access') }}
  • {{ _('Quick access to dashboard') }}
  • {{ _('One-tap time logging') }}
  • {{ _('Mobile-optimized reports') }}

{{ _('Installation') }}

  1. {{ _('Open TimeTracker in your mobile browser') }}
  2. {{ _('Look for "Add to Home Screen" option') }}
  3. {{ _('Follow browser-specific installation prompts') }}
  4. {{ _('Launch from your home screen like a native app') }}

{{ _('PWA Benefits') }}

  • {{ _('Offline capability for basic functions') }}
  • {{ _('Faster loading times') }}
  • {{ _('Native app-like experience') }}
  • {{ _('Push notifications (where supported)') }}

{{ _('Troubleshooting & FAQ') }}

{{ _('What happens if I forget to stop my timer?') }}

{{ _('The timer will continue running until you stop it manually. You can see your active timer on the dashboard and timer page. The timer persists even if you close your browser or restart your device. If idle detection is enabled, the timer may pause automatically after the configured timeout period.') }}

{{ _("Can I edit time entries after they're created?") }}

{{ _('Yes, you can edit any time entry by clicking the edit button in the time entry list. You can modify the project, start/end times, notes, tags, billable status, and task assignment. Admins can edit all time entries, while regular users can only edit their own entries.') }}

{{ _('How do I track time for multiple projects?') }}

{{ _('By default, you can only have one active timer at a time. To switch projects, stop your current timer and start a new one for the different project. Alternatively, you can create manual time entries for past work or configure the system to allow multiple active timers (admin setting).') }}

{{ _('How do I export my time data?') }}

{{ _('Go to the Reports page and use the "Export CSV" feature. You can apply filters to export specific data, or export all time entries. The CSV file includes all time entry details and can be opened in Excel or other spreadsheet applications. You can also configure the delimiter for different regional standards.') }}

{{ _("What's the difference between billable and non-billable time?") }}

{{ _('Billable time is tracked for client billing purposes and can have an hourly rate associated with it. Non-billable time is for internal work that doesn\'t get charged to clients. You can mark individual time entries as billable or non-billable, and projects can have default billable settings. This distinction is crucial for accurate invoicing and profitability analysis.') }}

{{ _('How do I create an invoice from my time entries?') }}

{{ _('Navigate to Invoices → Create Invoice, set up the client and project details, then use "Generate from Time Entries" to automatically create invoice items from your tracked time. You can filter by date range and project, and the system will group time entries intelligently. Review the generated items and export as a professional PDF.') }}

{{ _('Can I use TimeTracker on my mobile device?') }}

{{ _('Yes! TimeTracker is fully responsive and works great on mobile devices. You can install it as a Progressive Web App (PWA) for a native-like experience. The mobile interface includes a bottom tab bar for easy navigation and touch-optimized controls for time tracking on the go.') }}

{{ _('How do I use the command palette and keyboard shortcuts?') }}

{{ _('Press the question mark key (?) to open the command palette. From there, you can type to search for any action or navigation target. Use keyboard sequences like "g d" for Dashboard, "g p" for Projects, or "n e" for New Entry. Press Shift+? to see all available shortcuts. Press Ctrl+K (or Cmd+K on Mac) for quick search.') }}

{{ _('How do I create bulk time entries for multiple days?') }}

{{ _('Navigate to Work → Bulk Time Entry. Select your project, choose a date range, set your daily start and end times, and optionally skip weekends. The system will create identical time entries for each day in the range. This is perfect for logging regular work patterns or filling in past time when you worked consistent hours.') }}

{{ _('What are time entry templates and how do I use them?') }}

{{ _('Time entry templates let you save frequently used time entry configurations. When creating a manual time entry, check "Save as Template" to save the project, task, and notes. Later, when creating new entries, you can select a template to quickly fill in these details. Templates are personal and only visible to you.') }}

{{ _('How do I track expenses and add them to invoices?') }}

{{ _('Go to Expenses → New Expense to record business expenses. Upload receipt images, categorize the expense, and mark it as billable if needed. When creating invoices, you can include these expenses as line items. Expenses support approval workflows, reimbursement tracking, and can be linked to specific projects.') }}

{{ _('Can I use Markdown in descriptions?') }}

{{ _('Yes! Project and task descriptions support full Markdown formatting. You can use bold, italic, headings, lists, links, code blocks, tables, and images. This allows you to create rich, well-formatted documentation directly in your projects and tasks. The Markdown editor includes a preview mode and supports dark theme.') }}

{{ _('Where can I get additional help?') }}

{{ _('Documentation') }}

{{ _('This help page covers most common questions and features. For complete documentation:') }}

{{ _('Community Support') }}

{{ _('Report issues and request features on') }} GitHub Issues.

{% if current_user.is_admin %}
{{ _('As an admin, you can access additional system information and diagnostics in the') }} {{ _('System Info') }} {{ _('section.') }}
{{ _('Admin documentation:') }} {{ _('Administrator Guide') }}
{% endif %}

{{ _('Still Need Help?') }}

{{ _('Can\'t find what you\'re looking for? Here are additional resources:') }}

{% endblock %} {% block scripts_extra %} {% endblock %}