Help & Support

Comprehensive guides for using Insurgent Ink

Document Management

Organize, search, and manage your uploaded documents efficiently using Insurgent Ink's comprehensive document management tools.

Document Management Overview

The Documents section provides a centralized hub for managing all your uploaded files, tracking their translation status, and organizing them for easy access.

View & Organize

Browse all documents with sorting and filtering options

Search & Filter

Find documents quickly using advanced search capabilities

Track Progress

Monitor translation status and document statistics

Document List Features

Viewing Your Documents

The main documents page displays all your uploaded files in an organized list or grid view with essential information at a glance.

Document Information Displayed

  • Document Title: Custom name or filename
  • File Type: PDF, DOCX, TXT, EPUB, ODT with file size
  • Upload Date: When the document was added
  • Status: Processing, Ready, Translated, etc.
  • Segment Count: Number of text segments
  • Translation Progress: Completion percentage for ongoing translations

Document Actions

Each document provides quick action buttons for common operations:

View Details

Access comprehensive document information, segments, and translation history.

Start Translation

Begin a new translation with your chosen AI provider and settings.

Download

Download original document or completed translations in various formats.

Delete

Remove documents and all associated translations permanently.

Search and Filtering

Quickly find specific documents using powerful search and filtering capabilities.

🔍 Text Search

Search by document title, description, or content using the search bar.

Example: "contract", "user manual", "chapter 3"

📂 Filter by Status

  • All Documents: Show everything
  • Ready: Processed and ready for translation
  • In Progress: Currently being translated
  • Completed: Translation finished
  • Failed: Requires attention

📄 Filter by Type

  • PDF: Portable documents
  • DOCX: Word documents
  • TXT: Plain text files
  • EPUB: E-book files
  • ODT: OpenDocument text

📅 Sort Options

• Upload Date (newest first)
• Upload Date (oldest first)
• Document Name (A-Z)
• Document Name (Z-A)
• File Size (largest first)
• File Size (smallest first)
• Status
• File Type

Document Details Page

Clicking on any document opens the detailed view with comprehensive information and management options.

Document Information

Basic Details

  • • Full document title and description
  • • Original filename and file size
  • • Upload timestamp and user
  • • Processing status and any errors

Content Analysis

  • • Total number of text segments
  • • Estimated word and character count
  • • Detected language (if applicable)
  • • Content structure overview

Translations Overview

View all translations associated with this document, including:

  • Active Translations: Currently in progress with real-time status
  • Completed Translations: Finished translations ready for download
  • Translation History: Previous attempts and their outcomes
  • Cost Tracking: API usage and cost breakdown per translation
  • Quality Metrics: Success rates and processing times

Segment Management

Access individual document segments for detailed review and management:

1

View All Segments

Browse through all text segments extracted from your document with preview content.

2

Segment Status

Track which segments have been translated, are in progress, or encountered issues.

3

Individual Management

Retry failed segments, review translations, or manage specific content sections.

Organization Best Practices

📝 Naming Conventions

  • • Use descriptive, consistent document titles
  • • Include version numbers for updated documents
  • • Add project or category prefixes when useful
  • • Avoid special characters that may cause issues

🗂️ Content Organization

  • • Group related documents by project or theme
  • • Use descriptions to provide context and notes
  • • Regularly review and clean up old documents
  • • Keep track of document relationships and dependencies

⏰ Workflow Management

  • • Process documents promptly after upload
  • • Monitor translation progress regularly
  • • Address failed translations quickly
  • • Download and backup completed translations

💾 Storage Management

  • • Be mindful of storage limits and quotas
  • • Delete unnecessary duplicate documents
  • • Archive completed projects appropriately
  • • Consider file size optimization before upload

Document Statistics

Monitor your document usage and performance metrics:

Upload Statistics

  • • Total documents uploaded
  • • Total storage used
  • • Average document size
  • • Upload success rate

Processing Metrics

  • • Average processing time
  • • Segmentation efficiency
  • • Processing success rate
  • • Error frequency by file type

Translation Activity

  • • Documents with translations
  • • Active translation projects
  • • Completed translation count
  • • Average time to completion

Common Management Issues

Document Not Showing

Check your filter settings and search terms. Ensure the document upload completed successfully and try refreshing the page.

Processing Stuck

Large documents may take time to process. If a document remains in processing status for over 10 minutes, try re-uploading or contact support.

Cannot Delete Document

Documents with active translations cannot be deleted. Wait for translations to complete or cancel them first before attempting deletion.