Документация Markdown Table Editor
Полное описание программного продукта: назначение и функциональные характеристики, системные требования, порядок установки и эксплуатации обоих плагинов, процессы жизненного цикла, техническая поддержка и условия лицензии. Документация относится к версии 11.1.0 и обновляется вместе с каждым релизом.
Общие сведения о программе
Markdown Table Editor - комплект дополнительных программных модулей (плагинов), которые превращают текстовый редактор Notepad++ и IDE JetBrains на платформе IntelliJ в удобный редактор Markdown-таблиц. Продукт решает задачу поддержания таблиц в читаемом виде: выравнивает колонки, переставляет строки и колонки, сортирует данные и превращает CSV/TSV в готовую Markdown-таблицу.
- Наименование
- Markdown Table Editor
- Версия
- 11.1.0
- Правообладатель
- Овчаренко Андрей Александрович, ОГРНИП 318619600238627
- Класс программного обеспечения
- 05.02 - дополнительные программные модули (плагины)
- Языки интерфейса
- Русский и английский, а также локали, поставляемые в IDE JetBrains
- Лицензия
- GNU General Public License v3.0 или более поздней версии
Состав продукта
- Модуль для IDE JetBrains - плагин IntelliJ Platform, устанавливается в IntelliJ IDEA, WebStorm, PyCharm, PhpStorm, GoLand, CLion, Rider, RubyMine, DataGrip, DataSpell, RustRover, Android Studio и другие совместимые продукты.
- Модуль для Notepad++ - плагин в виде библиотеки MarkdownTableEditor.dll для редактора Notepad++, сборки для архитектур x86, x64 и ARM64.
- Библиотека ядра - независимая от редактора реализация разбора и форматирования Markdown-таблиц. Java-версия опубликована как открытый артефакт name.krot:markdown-table-core, для модуля Notepad++ используется эквивалентная реализация на языке C++. Обе реализации сверяются одним набором эталонных сценариев.
Оба модуля работают только с текстом открытого документа и не передают данные пользователя за пределы рабочей станции. Плагины не обращаются к сети, не собирают телеметрию и не требуют учётной записи или активации.
Функциональные характеристики
Набор возможностей одинаков для обоих модулей, за исключением отдельных функций, привязанных к особенностям среды.
- Выравнивание Markdown-таблицы вокруг курсора с сохранением разметки и маркеров выравнивания вида двоеточий в строке-разделителе.
- Автоматическое выравнивание таблицы после каждой правки без изменения общей ширины.
- Подгонка ширины таблицы под видимую ширину окна редактора, разовая и автоматическая.
- Сужение и расширение текущей колонки на одну экранную позицию.
- Переход к следующей и предыдущей ячейке таблицы.
- Вставка, удаление и перемещение строк таблицы.
- Вставка, удаление и перемещение колонок таблицы.
- Сортировка строк данных по текущей колонке по возрастанию и по убыванию.
- Конвертация выделенного CSV- или TSV-текста либо текущего блока в Markdown-таблицу. Разделители внутри кавычек не считаются границами полей, соседний обычный текст в таблицу не попадает.
- Вставка новой пустой таблицы с заданным числом колонок и строк.
- Корректная обработка экранированных вертикальных черт внутри ячеек.
- Перенос длинных ячеек в строки-продолжения под текущую ширину окна - в модуле для Notepad++.
- Обработка таблиц с широкими символами и составными графемами по правилам отображаемой ширины, включая кириллицу, иероглифы и эмодзи.
- Оптимизация под большие таблицы: пороговые значения времени выполнения операций контролируются автоматическими тестами производительности при каждой сборке.
Системные требования
Модули устанавливаются в уже работающий редактор и не предъявляют требований сверх требований самого редактора. Дополнительные среды исполнения, серверные компоненты и системы управления базами данных не нужны.
Модуль для Notepad++
| Архитектура | Минимальная версия Notepad++ | Операционная система |
|---|---|---|
| x86 | 7.5.9 | Windows 7 и новее |
| x64 | 8.3.1 | Windows 7 и новее |
| ARM64 | 8.3.1 | Windows 10 и новее на ARM |
На 64-разрядных сборках Notepad++ 7.5.9 - 8.2.1 плагин загружается и его меню появляется, но команды редактирования не изменяют документ из-за ограничений интерфейса тех версий. Сборка ARM64 для Notepad++ 7.5.9 не выпускалась.
Модуль для IDE JetBrains
| Параметр | Значение |
|---|---|
| Минимальная линейка платформы | IntelliJ Platform 2022.3, номер сборки 223 |
| Верхняя граница совместимости | Не ограничена, плагин совместим с последующими линейками |
| Среда исполнения | Java 17, поставляется в составе IDE |
| Операционные системы | Windows, Linux, macOS - все, где работает сама IDE |
| Зависимости платформы | Только базовый модуль платформы, дополнительные плагины не требуются |
Аппаратные требования
- Процессор, оперативная память и дисковая подсистема - на уровне требований установленного редактора.
- Свободное место на диске: не более 2 МБ на модуль.
- Сетевое подключение требуется только для загрузки дистрибутива и обновлений.
Установка
Установка выполняется штатными средствами редактора и не требует прав администратора, если выбран пользовательский каталог.
Модуль для IDE JetBrains
- Откройте страницу продукта в JetBrains Marketplace и нажмите кнопку установки либо найдите Markdown Table Editor в разделе установки плагинов внутри IDE.
- Для установки из архива скачайте ZIP последнего релиза со страницы релизов проекта.
- В IDE откройте раздел настроек Settings, затем Plugins.
- В меню шестерёнки выберите пункт установки плагина из файла и укажите скачанный ZIP.
- Плагин собран как динамический и в совместимых версиях IDE подключается без перезапуска. Если платформа запросит перезапуск, выполните его.
Модуль для Notepad++
- Скачайте ZIP-архив последнего релиза для вашей архитектуры: x86, x64 или ARM64.
- Распакуйте архив.
- Скопируйте каталог MarkdownTableEditor в каталог плагинов Notepad++.
- Перезапустите Notepad++.
- Откройте меню Plugins, пункт Markdown Table Editor - команды плагина доступны в этом подменю.
Обычный путь установки для 64-разрядного Notepad++:
C:\Program Files\Notepad++\plugins\MarkdownTableEditor\MarkdownTableEditor.dllЕсли запись в каталог программы запрещена политиками системы, используйте пользовательский каталог:
%LOCALAPPDATA%\Notepad++\plugins\MarkdownTableEditor\MarkdownTableEditor.dllПроверка подлинности дистрибутива
Каждый релиз публикуется вместе с файлом контрольных сумм SHA256SUMS.txt, спецификацией состава CycloneDX SBOM и подтверждениями сборки GitHub attestations. Контрольные суммы проверяются штатной утилитой sha256sum, происхождение артефакта - командой проверки подтверждений в интерфейсе командной строки GitHub.
Эксплуатация
Команды вызываются из меню редактора, из контекстного меню или горячими клавишами. В IDE JetBrains меню находится в разделе Tools, в Notepad++ - в разделе Plugins.
Быстрый старт
- Откройте файл с Markdown-таблицей или вставьте таблицу, созданную другим инструментом либо языковой моделью.
- Поставьте курсор внутрь таблицы.
- В IDE JetBrains нажмите Tab, в Notepad++ - Ctrl + Alt + Shift + 1. Колонки выровняются, разметка сохранится.
- Дальше пользуйтесь командами перемещения, вставки, удаления и сортировки - таблица остаётся выровненной автоматически.
Команды
| Действие | Сочетание клавиш | Описание |
|---|---|---|
| Выравнивание таблицы по Tab | Tab | В IDE JetBrains выравнивает таблицу под курсором; вне таблицы работает как обычный отступ |
| Выровнять таблицу | Ctrl + Alt + Shift + 1 | Разовое выравнивание текущей таблицы без изменения её ширины |
| Автовыравнивание после правки | Ctrl + Alt + Shift + A | Режим, при котором таблица выравнивается сама после каждой правки |
| Подогнать ширину под окно | Ctrl + Alt + Shift + W | Разовая подгонка таблицы под видимую ширину редактора |
| Автоподгонка ширины под окно | Ctrl + Alt + Shift + F | Режим постоянной подгонки ширины; включает автовыравнивание |
| Следующая и предыдущая ячейка | Ctrl + Alt + Shift + 2 и 3 | Перемещение курсора по ячейкам таблицы |
| Вставить и удалить строку | Ctrl + Alt + Shift + 4 и 5 | Добавление строки ниже текущей и удаление текущей строки |
| Вставить и удалить колонку | Ctrl + Alt + Shift + 6 и 7 | Добавление колонки справа от текущей и удаление текущей колонки |
| Сузить и расширить колонку | Ctrl + Alt + Shift + , и . | Изменение ширины текущей колонки на одну экранную позицию |
| Переместить строку | Ctrl + Alt + Shift + 8 и 9 | Перемещение текущей строки вверх и вниз |
| Переместить колонку | Ctrl + Alt + Shift + [ и ] | Перемещение текущей колонки влево и вправо |
| Сортировка строк | Ctrl + Alt + Shift + = и - | Сортировка по текущей колонке по возрастанию и по убыванию |
| Конвертация CSV и TSV | Ctrl + Alt + Shift + 0 | Преобразование выделенного фрагмента или текущего блока в Markdown-таблицу |
| Вставить новую таблицу | Ctrl + Alt + Shift + \ | Вставка пустой таблицы заданного размера |
В IDE JetBrains сочетания переназначаются в разделе настроек Keymap, в Notepad++ - в диалоге управления горячими клавишами. Полный список команд с точными наименованиями пунктов меню приведён в файлах README обоих репозиториев исходного кода.
Автоматические режимы
Два режима работают независимо от ручных команд. Режим автовыравнивания поддерживает колонки ровными после каждой правки, не меняя общую ширину таблицы. Режим автоподгонки дополнительно удерживает правую границу таблицы в пределах видимой ширины окна: длинные ячейки переносятся в строки-продолжения, а при расширении окна строки-продолжения снова собираются в одну строку. В модуле для Notepad++ оба режима включены сразу после установки, состояние режимов сохраняется между сеансами. В IDE JetBrains режимы переключаются командами меню и двумя индикаторами в строке состояния в левом нижнем углу окна.
Типовые затруднения
| Признак | Причина и действие |
|---|---|
| Меню плагина в Notepad++ не появилось | Разрядность библиотеки не совпадает с разрядностью редактора. Установите архив, соответствующий вашей сборке Notepad++, и проверьте путь установки |
| Меню есть, но команды не меняют документ | Версия Notepad++ ниже минимально поддерживаемой для этой архитектуры. Обновите редактор |
| Клавиша Tab в IDE не выравнивает таблицу | Курсор находится вне таблицы либо строка-разделитель оформлена неверно. Проверьте, что под строкой заголовка есть строка с дефисами и вертикальными чертами |
| Сочетание клавиш не срабатывает | Сочетание занято другой командой редактора или сторонним плагином. Назначьте своё сочетание в настройках горячих клавиш |
| Таблица выровнена не так, как ожидалось | В ячейках встречаются неэкранированные вертикальные черты. Экранируйте их обратной косой чертой |
Процессы жизненного цикла
Разработка, сборка, тестирование, выпуск и сопровождение продукта выполняются правообладателем по описанному ниже регламенту.
Разработка и контроль качества
- Исходный текст хранится в системе контроля версий, каждое изменение проходит через отдельную ветку и запрос на слияние.
- На каждое изменение автоматически выполняются сборка и модульные тесты для всех поддерживаемых конфигураций и архитектур.
- Поведение обеих реализаций ядра сверяется общим набором эталонных сценариев, включая тысячи автоматически порождённых случаев.
- Контролируются покрытие тестами, статический анализ безопасности исходного текста и пороговые значения времени выполнения операций.
- Для каждого релиза формируются спецификация состава программного обеспечения и контрольные суммы артефактов.
Выпуск версий и обновление
- Версии нумеруются по правилам семантического версионирования, история изменений публикуется на этом сайте в разделе изменений и в репозиториях.
- Дистрибутивы публикуются на странице релизов каждого репозитория, модуль для IDE JetBrains дополнительно публикуется в JetBrains Marketplace.
- Обновление выполняется штатными средствами редактора либо повторной установкой нового дистрибутива поверх предыдущего.
- Пользовательские настройки и состояние автоматических режимов сохраняются при обновлении.
Сопровождение и требования к персоналу
- Обращения принимаются через систему учёта задач репозиториев и по электронной почте, указанной в разделе контактов.
- Регистрация обращения выполняется в течение одного рабочего дня, ответ по существу и оценка сроков - в течение трёх рабочих дней.
- Ошибки, приводящие к порче содержимого документа, устраняются в приоритетном порядке отдельным исправительным выпуском.
- Для эксплуатации специальная подготовка не нужна: достаточно навыков работы с текстовым редактором и знания разметки Markdown.
- Для развития и сопровождения продукта требуется разработчик с опытом программирования на языках Java уровня 17 и C++, знанием платформы IntelliJ и интерфейса плагинов Notepad++.
Стоимость и условия лицензии
Продукт распространяется бесплатно на условиях свободной лицензии. Плата за передачу прав, за установку, за обновления и за техническую поддержку не взимается.
- Стоимость
- 0 рублей, продукт предоставляется безвозмездно неограниченному кругу лиц
- Лицензия
- GNU General Public License версии 3 или более поздней
- Срок предоставления прав
- На весь срок действия исключительного права, территория не ограничена
Единые условия действуют для всех составных частей продукта: модуля для IDE JetBrains, модуля для Notepad++ и библиотеки ядра. Полный текст лицензии входит в состав каждого дистрибутива и опубликован в репозиториях исходного кода вместе с перечнем сторонних компонентов и их лицензий.
Техническая поддержка и контакты
Поддержку оказывает правообладатель. Обращения принимаются на русском и английском языках без ограничения по количеству и без дополнительной оплаты.
- Электронная почта - адрес приведён ниже, в нижней части страницы.
- Учёт обращений по модулю для IDE JetBrains - раздел задач репозитория IdeaMarkdownTableEditor.
- Учёт обращений по модулю для Notepad++ - раздел задач репозитория NppMarkdownTableEditor.
- Приём сообщений об уязвимостях - в порядке, описанном в политике безопасности каждого репозитория.
Демонстрационный доступ для проверки продукта не требуется: обе полнофункциональные сборки публично доступны для загрузки и работают без ограничений по времени и функциям.