14 сентября 2022

Поддержка формата Markdown в IDE Delphi 11.2

    Последние годы у программистов получил широкое распространение язык разметки текстовых документов Markdown (.md). Его используют для подготовки технической документации и вывода в программах форматированного текста. Это делают, как программисты одиночки, так и большие корпорации. Markdown можно увидеть у Microsoft, Google, GitHub, GitLab, Stack Overflow, Reddit, Telegram... После выпуска RAD Studio 11.2 Alexandria IDE Delphi тоже может похвастаться поддержкой файлов формата Markdown.

    Разработчики RAD Studio 11.2 для предварительного просмотра файлов формата Markdown не стали "изобретать велосипед", т.е. писать свою реализацию, а воспользовались готовой библиотекой HTML Component Library. Эта библиотека так же позволила отказаться в IDE от использования встраивания Internet Explorer для отображения подсказок Help Insight и предварительного просмотра файлов формата HTML. Поздравляю автора HTML Component Library с неплохой рекламой!

    По умолчанию файлы Markdown открываются на вкладке "Предварительный просмотр".

IDE Delphi 11.2 - markdown preview
У формата Markdown нет единого стандарта и каждый, кто встраивает его разметку в свой продукт, дополняет базовый синтаксис языка своими тегами. Из-за использования сторонней библиотеки разработчики RAD Studio не создавали свой стандарт Markdown. Поддерживаемых тегов вполне достаточно для просмотра сложных "readme.md": заголовки различного уровня, стили шрифта, маркеры списка, нумерованные списки, цитаты, таблицы, горизонтальные линии, ссылки и даже изображения (правда, только локальные).
IDE Delphi 11.2 - markdown editor
Для указания цвета шрифта можно использования не только HTML-цвета, но и:
  • цвета, используемые при программировании на Delphi. Например, clBtnFace, clBtnShadow или clWindowText. Только без использования префикса "cl", т.е. BtnFace, BtnShadow, WindowText...
  • цвета из внутренней цветовой палитры IDE. Оттенок таких цветов зависит от используемой в IDE темы. Для их обозначения используются константы с префиксом "ide_": ide_blue, ide_red, ide_yellow, ide_green, ide_violet, ide_gray и ide_orange. Пока это не документированная возможность. Документация по цветовой палитре IDE появится, когда ее добавят в ToolsAPI для использования разработчиками плагинов.

    Предварительный просмотр файлов в формате Markdown настраивается через CSS-стили. Файл с настройками Markdown.css можно найти в папке "путь к RAD Studio\ObjRepos". Например, изменим в Markdown.css цвет ссылок c ide_violet

a:link {
    text-decoration: underline dotted; 
    color: ide_violet;
}
на ide_yellow
a:link {
    text-decoration: underline dotted; 
    color: ide_yellow;
}
Обратите внимание на то, что ссылка теперь имеет немного странный оттенок желтого цвета, который соответствует цвету кнопки "Open":
IDE Delphi 11.2 - markdown link preview
Это наглядный пример того, что оттенок цвета из внутренней цветовой палитры IDE зависит от используемой темы.

    Файл формата Markdown можно установить в качестве "стартового экрана" проекта (файла с информацией, который открываться автоматически при открытии проекта). Раньше в этом качестве можно было использовать только файлы формата HTML.

IDE Delphi 11.2 - Project Page Options
Project > Project Page Options

Комментариев нет:

Отправить комментарий