Для повышения удобства обновления описания товаров и его вывода на странице товара на сервисе CODESELLER была добавлена markdown-разметка для readme файлов.

Зачастую, на странице описания товара, кроме важной информации о товаре авторы размещают второстепенные данные, которые некоторым посетителям, до приобретения товара, будут не интересны, например: порядок установки и обновления, часто задаваемые вопросы или лог изменений и исправлений. Чтобы не превращать страницу товара в длинную портянку, автору товара будет уместно воспользоваться новой возможностью и разделить описание товара на смысловые блоки, между которыми посетитель сможет быстро переключаться.

Например: https://codeseller.ru/products/user-info-tab/

Для этого, в корневой папке вашего плагина или дополнения, необходимо разместить файл readme.txt, разместив там нужный контент согласно требуемой разметке.

Требования к разметке

Основные контентные блоки на которые будет делиться контент файла readme должны разделяться заголовками этих блоков. Заголовок блока размещается на отдельной строке, перед контентом, к которому этот заголовок относится. На строке заголовка, перед ним и после него обязательно ставится двойной знак равенства.

Например, укажем в файле readme, три контентных блока:

  • Установка и обновление
  • FAQ
  • Changelog
== Установка и обновление ==

Тут информация об установке плагина и его обновлении

== FAQ ==

Тут наиболее часто задаваемые вопросы и ответы на них

== Changelog ==

Здесь будет размещаться информация об истории изменений

В результате, на странице товара будут созданы три контентные вкладки, между которыми мы сможем переключаться:

"Описание" - первая вкладка, создается автоматически, содержит контент, указанный автором через визуальный редактор на странице создания и редактирования товара. Эта вкладка отображает контент по-умолчанию.

Остальные вкладки будут содержать контент, который был указан через файл readme.

Если в отдельном блоке будет необходимо разделить контент на дочерние блоки со своими заголовками и контентом, то можно указывать заголовки меньшего уровня, отделяя их одинарным знаком равенства. Например, для блока Changelog это будет выглядеть так:

== Changelog ==
= 2.2 =
* от 19.12.2016 Журнал каждого проекта режется до определённой длины, что бы избежать засорение
= 2.1 =
* от 18.12.2016 Исправленно множество ошибок, переписан журнал проектов.
= 1.8 =
* Исправленны некоторые ошибки, добавлена возможность собирать запись исходя из комментариев. Возможность собирать комментарии.

Результатом будет такое отображение:

При необходимости, в контенте файла readme можно использовать HTML-разметку.

Вот и все, быстро и просто мы добавили для нашего товара файл readme, а на его странице мы разделили описание на удобные вкладки.

Важно! Создаваемый файл readme, должен иметь

  • формат - .txt,
  • кодировку  - UTF-8 без BOM,
  • формат конца строки - UNIX

Как только созданный файл readme.txt будет загружен к вашему товару, вы сразу сможете наблюдать изменения на его странице.

4

Автор публикации

не в сети 47 минут

Андрей CS

12K
занят
Комментарии: 2727Публикации: 493Регистрация: 30-11--0001Продаж/Покупок: 0/0