workPro Documentation
User Guides
USER_MANUAL_QUICK_REFERENCE.md

User Manual Viewer - Quick Reference

🚀 Access Your User Manual

Direct URL:
http://your-domain.com/workpro/public/user-manual.php

📚 Available Sections

Section URL Purpose
Getting Started ?section=getting-started Introduction & orientation
Dashboard Home ?section=dashboard-home Dashboard overview
Navigation ?section=navigation UI navigation guide
Work Entry ?section=work-entry Creating work entries
Quantity Management ?section=quantity-management BOQ & quantities
Photo Upload ?section=photo-upload Photo documentation
Reporting ?section=reporting Reports & analytics
Approval Process ?section=approval-process Work approvals
BOQ Management ?section=boq-management BOQ operations
Administration ?section=administration Admin functions
Troubleshooting ?section=troubleshooting Problem solving
FAQ ?section=faq Common questions
Appendix ?section=appendix Reference materials

For Data Entry Operators

http://domain/workpro/public/user-manual.php?section=work-entry
http://domain/workpro/public/user-manual.php?section=photo-upload
http://domain/workpro/public/user-manual.php?section=quantity-management

For Supervisors/Approvers

http://domain/workpro/public/user-manual.php?section=approval-process
http://domain/workpro/public/user-manual.php?section=reporting

For Managers

http://domain/workpro/public/user-manual.php?section=reporting
http://domain/workpro/public/user-manual.php?section=faq

For Troubleshooting

http://domain/workpro/public/user-manual.php?section=troubleshooting
http://domain/workpro/public/user-manual.php?section=faq

🎨 Features

Automatic Table of Contents - Generated from headings
Sidebar Navigation - Quick access to all sections
Responsive Design - Works on desktop, tablet, mobile
Smooth Scrolling - Click TOC items to jump
Active Section Highlighting - Know where you are
Professional Styling - Clean, modern appearance
Print Friendly - Can print documentation
No Dependencies - Works with any server


📝 File Locations

Documentation Source Files:
/workpro/docs/DASHBOARD_USER_MANUAL_FULL.md
/workpro/docs/DASHBOARD_USER_MANUAL_TOC.md
/workpro/docs/features/*/
/workpro/docs/quick-ref/

User Manual Viewer:
/workpro/public/user-manual.php

Setup Guides:
/workpro/SETUP_USER_MANUAL_VIEWER.md
/workpro/MARKDOWN_TO_PHP_GUIDE.md

🔧 Adding to Navigation Menu

HTML Code to Add

<!-- Add to your navigation menu -->
<a href="<?php echo $baseUrl; ?>public/user-manual.php" class="nav-link">
    <i class="fas fa-book"></i> User Manual
</a>

<!-- Or with icon and badge -->
<a href="<?php echo $baseUrl; ?>public/user-manual.php" class="nav-link">
    <i class="fas fa-question-circle"></i> Help & Docs
    <span class="badge bg-info">NEW</span>
</a>

PHP Code to Add

<?php
$baseUrl = 'http://your-domain.com/workpro/';
$manualUrl = $baseUrl . 'public/user-manual.php';
?>

<a href="<?php echo $manualUrl; ?>">User Manual</a>
<a href="<?php echo $manualUrl; ?>?section=troubleshooting">Troubleshooting</a>
<a href="<?php echo $manualUrl; ?>?section=faq">FAQ</a>

🎯 Common Use Cases

User Can't Find Feature

→ Direct to: ?section=navigation

User Doesn't Know How to Enter Work

→ Direct to: ?section=work-entry

User Has Technical Issue

→ Direct to: ?section=troubleshooting

User Asks Common Question

→ Direct to: ?section=faq

Supervisor Needs Approval Guide

→ Direct to: ?section=approval-process

Manager Needs Report Help

→ Direct to: ?section=reporting


📱 Mobile Access

The manual is 100% mobile responsive:

  • Sidebar collapses on mobile
  • Touch-friendly buttons and links
  • Readable on any screen size
  • Quick navigation with mobile menu

Just access the same URL on any device!


🔍 Adding Search (Optional)

To enable search functionality, uncomment the search box in user-manual.php:

// Around line 503, change:
.search-box {
    display: none;  /* ← Change to display: flex; */
}

This enables the search input in the header.


💾 Backup & Version Control

Backup Documentation

# Backup your markdown files
cp -r docs/ docs_backup/
cp SETUP_USER_MANUAL_VIEWER.md SETUP_USER_MANUAL_VIEWER.backup.md

Git Version Control

# Add to version control
git add public/user-manual.php
git add docs/DASHBOARD_USER_MANUAL_FULL.md
git add SETUP_USER_MANUAL_VIEWER.md
git commit -m "Add HTML user manual viewer"

🆘 Troubleshooting

Q: Page shows "Documentation Not Found"

  • A: Check markdown file path in $documentFiles array
  • A: Verify file exists in /docs/ directory

Q: Sidebar doesn't collapse on mobile

  • A: Clear browser cache (Ctrl+Shift+Delete)
  • A: Hard refresh (Ctrl+F5)
  • A: Check browser JavaScript is enabled

Q: Markdown not formatting correctly

  • A: Check markdown syntax is correct
  • A: Use proper code block syntax: ```code```
  • A: Use proper link syntax: [text](url)

Q: Styling looks broken

  • A: Hard refresh browser (Ctrl+F5)
  • A: Clear browser cache
  • A: Try different browser

📊 Statistics

Documentation Coverage:

  • 120+ subsections
  • 1000+ lines of content
  • 5 major feature guides
  • 40+ code examples
  • 50+ FAQ items

User Manual Viewer:

  • Zero external dependencies
  • Responsive on all devices
  • Optimized for performance
  • Professional design

🎓 Learning Resources

For users accessing the manual:

  1. First Visit:

    • Go to "Getting Started" section
    • Read orientation guide
    • Explore your role's sections
  2. When Learning Features:

    • Use sidebar to navigate
    • Click section in TOC
    • Follow step-by-step guides
    • Check FAQ for quick answers
  3. When Having Issues:

    • Go to "Troubleshooting"
    • Check FAQ
    • Contact support if needed

📞 Support

Need help with the manual viewer?

  1. Check the setup guide: SETUP_USER_MANUAL_VIEWER.md
  2. Review the tech guide: MARKDOWN_TO_PHP_GUIDE.md
  3. Contact system administrator

Issues with manual content?

  1. Check FAQ section
  2. Check Troubleshooting section
  3. Contact support team

Status: ✅ Ready for Production

Version: 1.0
Date: December 17, 2025
Files: ✅ All created and functional
Testing: ✅ Syntax verified


Next Steps

  1. ✅ Bookmark the manual URL
  2. ✅ Share link with users
  3. ✅ Add to help menu
  4. ✅ Train users on features
  5. ✅ Keep updated as features change

Enjoy your new documentation system! 📚

workPro Documentation | v1.3
Login to Dashboard