Files
crm.clientright.ru/crm_extensions/file_storage/docs/MARKDOWN_FORMATTING.md
Fedor cd90b0d58a feat: Добавлен инструмент генерации документов для AI Ассистента
- Создан API create_document_with_text.php для создания DOCX/XLSX/PPTX с текстом от AI
- Поддержка Markdown форматирования (заголовки, жирный, курсив, списки, код)
- Установлен PHPWord для красивого форматирования документов
- Исправлены пути сохранения (crm2/CRM_Active_Files/... без /crm/ в начале)
- Замена пробелов на подчеркивания в именах папок
- Создана документация для AI и разработчиков
- Добавлены API для работы с шаблонами Nextcloud
2025-11-12 19:46:06 +03:00

7.9 KiB
Raw Blame History

📝 Поддержка форматирования Markdown в документах

Дата: 2025-01-XX
Статус: Реализовано

🎯 Обзор

API создания документов теперь поддерживает Markdown форматирование! AI может использовать стандартный Markdown синтаксис для создания красиво оформленных документов.

Поддерживаемые элементы форматирования

1. Заголовки

# Заголовок 1 уровня (H1) - размер 18pt, жирный
## Заголовок 2 уровня (H2) - размер 16pt, жирный
### Заголовок 3 уровня (H3) - размер 14pt, жирный

Пример:

# ПРЕТЕНЗИЯ
## Текст претензии
### Требования

2. Жирный текст

**жирный текст**
__жирный текст__

Пример:

Кому: **УК "Жилищник"**
Сумма: __400000 рублей__

3. Курсив

*курсив*
урсив_

Пример:

От: *Иванов Иван Иванович*
Дата: _15.01.2025_

4. Выделение кода

`код`

Пример:

Сумма ущерба: `400000` рублей
Статья: `ст. 1064 ГК РФ`

5. Маркированные списки

- Первый пункт
- Второй пункт
- Третий пункт

* Альтернативный маркер
* Еще один пункт

Пример:

Требования:
- Возместить ущерб
- Провести экспертизу
- Подготовить документы

6. Нумерованные списки

1. Первый пункт
2. Второй пункт
3. Третий пункт

Пример:

Порядок действий:
1. Подать претензию
2. Дождаться ответа
3. При необходимости обратиться в суд

📋 Пример полного документа с форматированием

# ПРЕТЕНЗИЯ

## Заголовок раздела

Кому: **УК "Жилищник"**
От: *Иванов Иван Иванович*

Дата: 15.01.2025

### Текст претензии

УК отказывается возмещать ущерб от залива квартиры от стояка ХВС. 
Ущерб составляет `400000` рублей.

### Требования:

1. Возместить ущерб в размере **400000 рублей**
2. Провести экспертизу для оценки ущерба
3. Возместить моральный вред

### Дополнительно:

- Провести экспертизу
- Оценить ущерб
- Подготовить документы

С уважением,
**Иванов Иван Иванович**

🎨 Как это выглядит в документе

Заголовки:

  • H1 (#) — крупный заголовок, 18pt, жирный, отступ сверху
  • H2 (##) — средний заголовок, 16pt, жирный
  • H3 (###) — маленький заголовок, 14pt, жирный

Текст:

  • Жирный — выделение важной информации
  • Курсив — акценты, названия
  • Код — статьи, суммы, технические данные (Courier New, синий цвет)

Списки:

  • Маркированные — с символом •, отступ слева
  • Нумерованные — с автоматической нумерацией, отступ слева

💡 Рекомендации для AI

Когда использовать форматирование:

  1. Заголовки — для структурирования документа:

    # ПРЕТЕНЗИЯ
    ## Текст претензии
    ## Требования
    ## Приложения
    
  2. Жирный текст — для важной информации:

    Кому: **УК "Жилищник"**
    Сумма: **400000 рублей**
    
  3. Списки — для перечислений:

    Требования:
    1. Возместить ущерб
    2. Провести экспертизу
    
  4. Код — для статей, сумм, ссылок:

    Ссылка на право: `ст. 1064 ГК РФ`
    Сумма: `400000` рублей
    

Пример использования в AI ответе:

# ПРЕТЕНЗИЯ

Кому: **УК "Жилищник"**
От: *Иванов Иван Иванович*

Дата: 15.01.2025

## Текст претензии

УК отказывается возмещать ущерб от залива квартиры от стояка ХВС. 
Ущерб составляет `400000` рублей.

## Требования:

1. Возместить ущерб в размере **400000 рублей**
2. Провести экспертизу для оценки ущерба
3. Возместить моральный вред

## Ссылки на право:

- `ст. 1064 ГК РФ` - общие основания ответственности за вред
- `ст. 15 ГК РФ` - возмещение убытков

С уважением,
**Иванов Иван Иванович**

⚠️ Ограничения

  1. Вложенные списки — не поддерживаются (только один уровень)
  2. Таблицы — не поддерживаются (можно использовать списки)
  3. Изображения — не поддерживаются
  4. Ссылки — не поддерживаются (можно использовать код [текст](url))
  5. Комбинированное форматирование**жирный *курсив* текст** работает частично

🔧 Технические детали

  • Парсинг выполняется построчно
  • Поддерживается комбинирование форматирования в одном параграфе
  • Списки автоматически завершаются при появлении обычного текста
  • Пустые строки создают отступы между блоками

📚 Справочник Markdown для AI

Используй эти элементы при генерации документов:

Элемент Синтаксис Пример
Заголовок H1 # Текст # ПРЕТЕНЗИЯ
Заголовок H2 ## Текст ## Требования
Заголовок H3 ### Текст ### Дополнительно
Жирный **текст** **400000 рублей**
Курсив *текст* *Иванов Иван Иванович*
Код `текст` `ст. 1064 ГК РФ`
Маркированный список - пункт - Первый пункт
Нумерованный список 1. пункт 1. Первый пункт

Преимущества

  1. Стандартный синтаксис — Markdown понимают все AI модели
  2. Читаемость — легко читать и редактировать
  3. Гибкость — можно комбинировать элементы
  4. Автоматическое форматирование — документ получается красивым без ручной правки