Skip to content

Хранение данных, структура папок и настройки

В этом документе описано, где именно хранятся данные Firok Fax, как переносить шаблоны между компьютерами и как работает изоляция настроек от файлов контента.


1. Общая структура каталогов

Приложение разделяет данные на три изолированные области:

text
📁 Папка проекта / контента (Content Directory)
├── 📁 documents/
│   ├── umowa-zlecenie.json
│   └── faktura.json
└── 📁 templates/
    ├── umowa-zlecenie.docx
    └── faktura.docx

📁 Папка готовых документов (Output Directory)
└── Umowa-zlecenie-Jan-Kowalski-2026-09-01.docx

📁 Папка профиля пользователя (App Data / Profile)
├── settings.json
└── autofills.json

2. Папка content (Шаблоны и Схемы)

Папка content содержит все рабочие шаблоны. Вы можете указать произвольный путь к ней в настройках приложения («Ustawienia» $\rightarrow$ «Folder content»).

  • content/templates/:
    • Хранит исходные файлы Microsoft Word (.docx).
    • Приложение считывает эти файлы только для чтения и создает новые документы на их основе.
  • content/documents/:
    • Хранит определения полей и метаданные в формате .json.
    • Имя файла соответствует id шаблона (например, umowa-zlecenie.json).

💾 Резервное копирование: Чтобы перенести все шаблоны на другой компьютер или сохранить в Git, достаточно скопировать папку content.


3. Папка output (Готовые документы)

  • Путь настраивается в «Ustawienia» $\rightarrow$ «Folder gotowych dokumentów».
  • По умолчанию сгенерированные файлы DOCX сохраняются в эту папку.
  • Имена файлов формируются по шаблону outputName, указанному в настройках шаблона (например, Umowa-{pracownik_imie_nazwisko}-{data_dzis}.docx).

4. Папка профиля приложения (Настройки и Автозаполнение)

Настройки программы и сохраненные наборы автозаполнения хранятся отдельно от файлов шаблонов в стандартном системном каталоге профиля пользователя:

  • Windows: %APPDATA%\firok-fax\ или %LOCALAPPDATA%\firok-fax\
  • macOS: ~/Library/Application Support/firok-fax/
  • Linux: ~/.config/firok-fax/

Файлы профиля:

  • settings.json:
    • Путь к рабочей папке contentDirectory
    • Путь к папке вывода outputDirectory
    • Опция открытия файла после генерации openAfter
    • Язык интерфейса language (pl или ru)
    • Тема theme (light или dark)
  • autofills.json:
    • Сохраненные наборы автозаполнения (реквизиты компаний, данные постоянных контрагентов, паспортные данные и т.д.).

5. Быстрые действия в интерфейсе

  • В разделе «Ustawienia» есть две удобные кнопки:
    • «Otwórz folder content» — моментально открывает папку с шаблонами в Проводнике Windows / Finder.
    • «Otwórz folder gotowych dokumentów» — открывает папку с экспортированными файлами.
  • В редакторе шаблона рядом с полем выбора файла DOCX есть кнопка с иконкой папки, открывающая сразу каталог content/templates/.