mirror of
https://github.com/DRYTRIX/TimeTracker.git
synced 2026-05-20 21:30:12 -05:00
Dries Peeters
269 lines
14 KiB
HTML
269 lines
14 KiB
HTML
{% extends "base.html" %}
|
|
|
|
{% block title %}Help - {{ app_name }}{% endblock %}
|
|
|
|
{% block content %}
|
|
<div class="container">
|
|
<div class="row">
|
|
<div class="col-lg-3">
|
|
<!-- Navigation -->
|
|
<div class="card sticky-top" style="top: 1rem;">
|
|
<div class="card-header">
|
|
<h5 class="mb-0">
|
|
<i class="fas fa-list"></i> Contents
|
|
</h5>
|
|
</div>
|
|
<div class="card-body">
|
|
<nav class="nav flex-column">
|
|
<a class="nav-link" href="#getting-started">Getting Started</a>
|
|
<a class="nav-link" href="#timer">Using the Timer</a>
|
|
<a class="nav-link" href="#projects">Managing Projects</a>
|
|
<a class="nav-link" href="#reports">Reports</a>
|
|
{% if current_user.is_admin %}
|
|
<a class="nav-link" href="#admin">Admin Features</a>
|
|
{% endif %}
|
|
<a class="nav-link" href="#faq">FAQ</a>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="col-lg-9">
|
|
<div class="text-center mb-4">
|
|
<img src="{{ url_for('static', filename='images/drytrix-logo.svg') }}" alt="DryTrix Logo" class="mb-3" width="48" height="48">
|
|
<h1 class="h2 mb-2">Help & Documentation</h1>
|
|
<p class="text-muted">TimeTracker by <strong>DryTrix</strong></p>
|
|
</div>
|
|
|
|
<!-- Getting Started -->
|
|
<section id="getting-started" class="mb-5">
|
|
<h2 class="h3 mb-3">Getting Started</h2>
|
|
<div class="card">
|
|
<div class="card-body">
|
|
<h5>First Time Setup</h5>
|
|
<ol>
|
|
<li>Log in with your username (no password required)</li>
|
|
<li>If you're an admin, create projects for your team</li>
|
|
<li>Start tracking time on your first project</li>
|
|
</ol>
|
|
|
|
<h5>Navigation</h5>
|
|
<ul>
|
|
<li><strong>Dashboard:</strong> Overview of your current timer and recent activity</li>
|
|
<li><strong>Timer:</strong> Start, stop, and manage time tracking</li>
|
|
<li><strong>Projects:</strong> View and manage projects (admin only)</li>
|
|
<li><strong>Reports:</strong> Generate time reports and export data</li>
|
|
{% if current_user.is_admin %}
|
|
<li><strong>Admin:</strong> Manage users and system settings</li>
|
|
{% endif %}
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
<!-- Timer -->
|
|
<section id="timer" class="mb-5">
|
|
<h2 class="h3 mb-3">Using the Timer</h2>
|
|
<div class="card">
|
|
<div class="card-body">
|
|
<h5>Starting a Timer</h5>
|
|
<ol>
|
|
<li>Go to the Timer page or use the "Start Timer" button on the dashboard</li>
|
|
<li>Select a project from the dropdown</li>
|
|
<li>Add optional notes about what you're working on</li>
|
|
<li>Add optional tags (separated by commas)</li>
|
|
<li>Click "Start Timer"</li>
|
|
</ol>
|
|
|
|
<h5>Active Timer</h5>
|
|
<ul>
|
|
<li>The timer runs continuously until you stop it</li>
|
|
<li>You can see the current duration in real-time</li>
|
|
<li>The timer persists even if you close your browser</li>
|
|
<li>Only one timer can be active at a time per user</li>
|
|
</ul>
|
|
|
|
<h5>Stopping a Timer</h5>
|
|
<ul>
|
|
<li>Click the "Stop Timer" button to end the current session</li>
|
|
<li>The time entry will be saved automatically</li>
|
|
<li>You can edit the entry later if needed</li>
|
|
</ul>
|
|
|
|
<h5>Manual Time Entries</h5>
|
|
<p>You can also create time entries manually by specifying start and end times, useful for recording time spent away from the computer.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
<!-- Projects -->
|
|
<section id="projects" class="mb-5">
|
|
<h2 class="h3 mb-3">Managing Projects</h2>
|
|
<div class="card">
|
|
<div class="card-body">
|
|
<h5>Project Structure</h5>
|
|
<ul>
|
|
<li><strong>Name:</strong> Descriptive project name</li>
|
|
<li><strong>Client:</strong> Optional client name for organization</li>
|
|
<li><strong>Description:</strong> Project details and scope</li>
|
|
<li><strong>Billable:</strong> Whether time should be tracked for billing</li>
|
|
<li><strong>Hourly Rate:</strong> Rate for billable time calculations</li>
|
|
<li><strong>Status:</strong> Active or archived</li>
|
|
</ul>
|
|
|
|
{% if current_user.is_admin %}
|
|
<h5>Admin Project Management</h5>
|
|
<ul>
|
|
<li>Create new projects with the "New Project" button</li>
|
|
<li>Edit existing projects to update details</li>
|
|
<li>Archive projects to hide them from timers (data is preserved)</li>
|
|
<li>Delete projects (use with caution - this removes all associated time entries)</li>
|
|
</ul>
|
|
{% endif %}
|
|
|
|
<h5>Viewing Project Details</h5>
|
|
<p>Click on any project to view detailed statistics, time entries, and user breakdowns.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
<!-- Reports -->
|
|
<section id="reports" class="mb-5">
|
|
<h2 class="h3 mb-3">Reports</h2>
|
|
<div class="card">
|
|
<div class="card-body">
|
|
<h5>Available Reports</h5>
|
|
<ul>
|
|
<li><strong>Project Report:</strong> Time breakdown by project with filtering options</li>
|
|
<li><strong>User Report:</strong> Time tracking statistics by user</li>
|
|
<li><strong>Summary Report:</strong> Overview of key metrics and trends</li>
|
|
<li><strong>CSV Export:</strong> Export time entries for external analysis</li>
|
|
</ul>
|
|
|
|
<h5>Filtering Options</h5>
|
|
<ul>
|
|
<li><strong>Date Range:</strong> Filter by start and end dates</li>
|
|
<li><strong>Project:</strong> Filter by specific project</li>
|
|
<li><strong>User:</strong> Filter by specific user</li>
|
|
<li><strong>Status:</strong> Filter by project status</li>
|
|
</ul>
|
|
|
|
<h5>Exporting Data</h5>
|
|
<p>Use the CSV export feature to download time entries for use in external tools like Excel or accounting software.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
{% if current_user.is_admin %}
|
|
<!-- Admin Features -->
|
|
<section id="admin" class="mb-5">
|
|
<h2 class="h3 mb-3">Admin Features</h2>
|
|
<div class="card">
|
|
<div class="card-body">
|
|
<h5>User Management</h5>
|
|
<ul>
|
|
<li>Create new users with username-only authentication</li>
|
|
<li>Assign user roles (user or admin)</li>
|
|
<li>Activate/deactivate user accounts</li>
|
|
<li>View user statistics and activity</li>
|
|
</ul>
|
|
|
|
<h5>System Settings</h5>
|
|
<ul>
|
|
<li>Configure timezone and currency</li>
|
|
<li>Set time rounding rules</li>
|
|
<li>Enable/disable self-registration</li>
|
|
<li>Configure backup settings</li>
|
|
</ul>
|
|
|
|
<h5>System Maintenance</h5>
|
|
<ul>
|
|
<li>Create manual database backups</li>
|
|
<li>View system information and health</li>
|
|
<li>Monitor system statistics</li>
|
|
<li>Clean up old data</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
{% endif %}
|
|
|
|
<!-- FAQ -->
|
|
<section id="faq" class="mb-5">
|
|
<h2 class="h3 mb-3">Frequently Asked Questions</h2>
|
|
<div class="card">
|
|
<div class="card-body">
|
|
<div class="accordion" id="faqAccordion">
|
|
<div class="accordion-item">
|
|
<h2 class="accordion-header">
|
|
<button class="accordion-button" type="button" data-bs-toggle="collapse" data-bs-target="#faq1">
|
|
What happens if I forget to stop my timer?
|
|
</button>
|
|
</h2>
|
|
<div id="faq1" class="accordion-collapse collapse show" data-bs-parent="#faqAccordion">
|
|
<div class="accordion-body">
|
|
The timer will continue running until you stop it. You can see your active timer on the dashboard and timer page. The timer persists even if you close your browser.
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="accordion-item">
|
|
<h2 class="accordion-header">
|
|
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#faq2">
|
|
Can I edit time entries after they're created?
|
|
</button>
|
|
</h2>
|
|
<div id="faq2" class="accordion-collapse collapse" data-bs-parent="#faqAccordion">
|
|
<div class="accordion-body">
|
|
Yes, you can edit any time entry by clicking the edit button. You can modify the project, start/end times, notes, tags, and billable status.
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="accordion-item">
|
|
<h2 class="accordion-header">
|
|
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#faq3">
|
|
How do I track time for multiple projects?
|
|
</button>
|
|
</h2>
|
|
<div id="faq3" class="accordion-collapse collapse" data-bs-parent="#faqAccordion">
|
|
<div class="accordion-body">
|
|
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. You can also create manual time entries for past work.
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="accordion-item">
|
|
<h2 class="accordion-header">
|
|
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#faq4">
|
|
How do I export my time data?
|
|
</button>
|
|
</h2>
|
|
<div id="faq4" class="accordion-collapse collapse" data-bs-parent="#faqAccordion">
|
|
<div class="accordion-body">
|
|
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 can be opened in Excel or other spreadsheet applications.
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="accordion-item">
|
|
<h2 class="accordion-header">
|
|
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#faq5">
|
|
What's the difference between billable and non-billable time?
|
|
</button>
|
|
</h2>
|
|
<div id="faq5" class="accordion-collapse collapse" data-bs-parent="#faqAccordion">
|
|
<div class="accordion-body">
|
|
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.
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
{% endblock %}
|