Skip to content

User Guide

Jump to bottom
Underground Trading edited this page Sep 14, 2025 · 1 revision

📖 User Guide

Complete guide to using HeadForge effectively.

🎯 Getting Started

Opening HeadForge

  1. Click the Extension Icon - Look for the HeadForge icon in your browser toolbar
  2. Extension Popup Opens - The main interface will appear
  3. Ready to Use - You can now start generating headers

Interface Overview

  • Language Selector - Choose your programming language
  • Form Fields - Enter project information
  • Header Type - Select simple or complete header
  • Preview - See your header before generating
  • Actions - Generate, copy, and export options

📝 Creating Headers

Step 1: Select Language

  1. Click Language Dropdown - Opens the language selection menu
  2. Choose Your Language - Select from 25+ supported languages
  3. Auto-formatting - HeadForge automatically adjusts comment syntax

Step 2: Fill Information

Required fields:

  • Project Name - Your project's name
  • Author - Your name or team name
  • Description - Brief project description

Optional fields:

  • Version - Project version (e.g., 1.0.0)
  • Created Date - Project creation date
  • Updated Date - Last update date
  • License - Project license
  • Repository - Git repository URL
  • Email - Contact email
  • Website - Project website
  • Keywords - Project keywords
  • Category - Project category
  • Status - Development status

Step 3: Choose Header Type

  • Simple Header - Basic information only
  • Complete Header - Full details with decorative borders

Step 4: Generate Header

  1. Click "Generate Header" - Creates your header
  2. Preview Appears - See the formatted header
  3. Copy to Clipboard - Click "Copy" button
  4. Paste in Code - Paste into your code file

🎨 Header Types

Simple Headers

Basic information in a clean format:

// Project: My Awesome App
// Author: John Doe
// Description: A modern web application
// Version: 1.0.0
// Created: 2024-01-15
// Updated: 2024-01-20

Complete Headers

Full details with decorative borders:

/*
 * =============================================================================
 * Project: My Awesome App
 * Author: John Doe
 * Description: A modern web application
 * Version: 1.0.0
 * Created: 2024-01-15
 * Updated: 2024-01-20
 * License: MIT
 * Repository: https://github.com/user/repo
 * =============================================================================
 */

⚙️ Settings & Preferences

Theme Settings

  • Auto - Follows system theme (default)
  • Light - Always use light theme
  • Dark - Always use dark theme

Default Values

  • Default Language - Set your preferred language
  • Auto-fill Author - Automatically fill author name
  • Auto-fill Version - Set default version format
  • Date Format - Choose date format preference

Export Options

  • Copy to Clipboard - Default copy behavior
  • Download as File - Save headers as files
  • Bulk Export - Export multiple headers
  • File Format - Choose export format

🔧 Advanced Features

Custom Templates

  1. Go to Settings - Click the settings icon
  2. Select Templates - Choose "Custom Templates"
  3. Create New - Click "Create New Template"
  4. Define Format - Set your header format
  5. Save Template - Save for future use

Bulk Operations

  1. Select Multiple Files - Choose multiple files
  2. Set Template - Choose header template
  3. Generate All - Create headers for all files
  4. Export Batch - Export all headers at once

Project Integration

  1. Set Project Defaults - Configure project settings
  2. Save Project Template - Create project-specific template
  3. Auto-fill Settings - Configure automatic field filling
  4. Export Project - Export entire project headers

📋 Keyboard Shortcuts

Navigation

  • Tab - Move to next field
  • Shift + Tab - Move to previous field
  • Enter - Generate header
  • Escape - Close popup

Actions

  • Ctrl/Cmd + Enter - Generate header
  • Ctrl/Cmd + C - Copy to clipboard
  • Ctrl/Cmd + S - Save as file
  • Ctrl/Cmd + Z - Undo last action

Templates

  • Ctrl/Cmd + 1 - Simple header
  • Ctrl/Cmd + 2 - Complete header
  • Ctrl/Cmd + 3 - Custom template
  • Ctrl/Cmd + T - Open templates

🎯 Best Practices

Header Content

  • Be Descriptive - Use clear, descriptive project names
  • Include Version - Always include version information
  • Update Dates - Keep creation and update dates current
  • Add License - Include license information
  • Link Repository - Add repository URL for easy access

Formatting

  • Consistent Style - Use consistent formatting across projects
  • Appropriate Length - Keep descriptions concise but informative
  • Proper Syntax - Ensure comment syntax matches language
  • Clean Layout - Maintain clean, readable layout

Organization

  • Project Structure - Organize headers by project structure
  • Template Library - Build a library of useful templates
  • Version Control - Track header changes in version control
  • Documentation - Document custom templates and formats

🔍 Troubleshooting

Common Issues

  • Header Not Generating - Check all required fields are filled
  • Wrong Comment Syntax - Verify language selection is correct
  • Copy Not Working - Check browser permissions
  • Template Not Saving - Ensure template name is unique

Performance

  • Slow Generation - Close other browser tabs
  • Memory Issues - Restart browser if needed
  • Extension Crashes - Reinstall extension

Browser Compatibility

  • Chrome - Full support, all features available
  • Firefox - Full support, all features available
  • Edge - Full support, all features available

📚 Additional Resources

Need more help? Check our FAQ or join the community discussions!

Clone this wiki locally