Firok Fax

Appearance

Документация Firok Fax 📄 ​

Добро пожаловать в документацию приложения Firok Fax — настольного приложения для быстрой и удобной генерации документов в формате .docx (Microsoft Word) на основе настраиваемых шаблонов.

📚 Разделы документации ​

  1. 🚀 Быстрый старт и руководство пользователя

    • Выбор шаблона и заполнение полей
    • Использование автозаполнения (Autofill)
    • Генерация готового документа .docx
    • Настройки приложения и смена языка/темы

  2. 📝 Создание и настройка шаблонов

    • Как разметить Word-документ тегами Docxtemplater ({tag}, {#list}, etc.)
    • Визуальный конструктор шаблонов в приложении
    • Типы полей: текст, многострочный текст, числа, даты, списки и таблицы
    • Настройка шаблона имени выходного файла (outputName)

  3. 🪄 Числа и суммы прописью (Кнопка «✨ Wylicz»)

    • Как настроить автоматический перевод сумм и ставок в слова
    • Поддержка языков (PL, UK, RU, EN, DE)
    • Склонения валют: PLN (złote/złotych), UAH (гривні/гривень), EUR, USD
    • Форматы вывода (00/100, полные слова, только число)

  4. 📂 Хранение данных и структура папок

    • Где хранятся шаблоны .docx и схемы .json
    • Папка готовых документов (output)
    • Где сохраняются профили автозаполнения и настройки
    • Резервное копирование и перенос шаблонов

⚡ Краткий обзор работы ​

mermaid
graph LR
    A[Word .docx с тегами] -->|поместить в| B[content/templates/]
    C[Создать схему в UI] -->|сохраняется в| D[content/documents/*.json]
    B --> E[Firok Fax]
    D --> E
    E -->|Заполнение данных| F[Готовый .docx в output/]