Первый плагин, который я поместил на WordPress.org, не отправлял ничего в течение девяти дней. я зафиксировал код, отметил выпуск, посмотрел обновление списка с моим новым описанием и сказал людям, что оно вышло. Загрузки остались на месте, потому что кнопка загрузки обслуживала пустую папку тегов: моя readme.txt сказал Stable tag: 1.0.1 и тег, который я на самом деле создал, был 1.0. Меня ничего не предупредило. Каталог сделал именно то, что я ему сказал.
Эта строка является полем с самыми высокими ставками в плагине WordPress и #39;s readme.txt, и это один из нескольких, которые терпят неудачу тихо, а не громко. Это руководство охватывает то, что каталог делает с каждой частью этого файла, в том порядке, в котором повреждение имеет тенденцию происходить.The Генератор WordPress Readme строит файл с этими правилами, прикрепленными к полям, к которым они применяются.
TL;DR:
Stable tagназывает версию, которую действительно обслуживает каталог. Она читается изtrunk/readme.txt, и он указывает на папку под/tags/это должно существовать и должно содержать выпуск Если он называет версию, которой нет, пользователи ничего не получают; если он все еще называет старый, они получают старый код, независимо от того, что вы совершили.Tested up toконтролирует предупреждение о совместимости в вашем списке,Tagsиндексирует только первые пять, а краткое описание сокращено до 150 символов.
Чем на самом деле управляет тег Stable?
Плагин в каталоге живет в Subversion, с trunk/ для текущего развития и tags/<version>/ для релизов. когда кто-то нажимает Скачать, каталог не отправляет их trunk. Оно гласит trunk/readme.txt, находит Stable tagи служит tags/<that value>/, йо-
Далее следуют три последствия, и все три кусают реальные выпуски:
- Реадм, который решает это, тот, кто в багажнике. Редактирование readme внутри папки тегов ничего не меняет в том, что поставляется.
- Тег должен существовать. равняется
Stable tagименование папки, которая так и не была создана, означает, что загрузка пуста или не удалась. - Магистраль - это не то, что получают пользователи. Вы можете фиксировать транк всю неделю; пока стабильный тег не переместится, выпущенный код будет таким, какой есть в старом теге.
выше Справочник плагинов излагает правило ясно, и стоит прочитать один раз правильно, а не копировать readme из другого плагина и редактировать поля Единственное исключение стоит знать: Stable tag: trunk означает ли & quot;serve trank& quot;, что является законным и является тем, как выпускается несколько плагинов. Это также означает, что каждая фиксация к транку немедленно выполняется для каждого пользователя, поэтому почти никто не должен этого делать.
Есть вторая половина релиза, которую readme вообще не контролирует Версия в Stable tag должен соответствовать Version: заголовок в вашем основном файле PHP плагина, потому что именно с этим сравнивается установленный сайт, чтобы решить, существует ли обновление. Отправьте тег, в заголовке плагина которого все еще указан предыдущий номер, а каталог предлагает обновление, которое устанавливает что-то, что утверждает, что является уже присутствующей версией.
Что каждая строка заголовка делает с вашим списком
Блок заголовка состоит из девяти линий равнины Key: value и каждый из них меняет что-то видимое.
| Линия | Что делает | Что идет не так |
|---|---|---|
Stable tag |
Выбирает обслуживаемую версию | Неправильное значение ничего не дает или отправляет старый код |
Requires at least |
Минимальная версия WordPress | Устанавливается слишком высокий уровень блоков, которые будут работать |
Tested up to |
Заявление о совместимости | Отставание показывает & quot;untested& quot; предупреждение |
Requires PHP |
Минимальная версия PHP | Слишком низкий уровень позволяет устанавливать и отказывать несовместимым сайтам |
Tags |
Ключевые слова каталога | Индексируются только первые пять |
Contributors |
Ссылки Профили WordPress.org | Опечатка молча никому не приписывает |
Donate link |
Кнопка пожертвования боковой панели | Отсутствует - это нормально, сломан - нет |
License / License URI |
Лицензия | Чтобы быть в списке, он должен быть совместим с GPL |
Tested up to это тот, который стоит загрузки бесшумно Когда он отстает более чем на несколько основных выпусков, в списке отображается уведомление, сообщающее посетителям, что плагин не проверен с их версией WordPress, а плагин, который выглядит заброшенным, устанавливается меньше независимо от того, работает ли он Обновление этой строки является фиксацией readme для транка и занимает минуту, что является самым дешевым обслуживанием в экосистеме.
Tags индексы пять. шестой тег не является ошибкой и не вызывает никаких предупреждений; это просто мертвый текст в вашем файле. Выберите пять человек, которые действительно напечатают.
Как разделяется описание и почему это имеет значение?
В теме чтения есть два описания, и они выполняют разные работы.
выше краткое описание это единый блок текста между строками заголовка и первой == Section ==. Он ограничен 150 символами, и после этого каталог усекает его в результатах поиска и на карте плагина, обычно в середине предложения. Это строка, которую большинство людей читают, прежде чем решить, нажимать ли, что делает 150 символов наиболее ценным недвижимым имуществом в файле.
выше длинное описание Является ли == Description == раздел и он становится телом вашей страницы объявления. он принимает подмножество Markdown: заголовки, жирным шрифтом, курсивом, списки, ссылки. необработанный HTML is striped.Tables, огражденные блоки кода с подсветкой синтаксиса, и более экзотический Markdown не рендеринг, поэтому readme, который выглядит правильно в Markdown превьюере все еще может выглядеть неправильно на WordPress.org.
Каждый из остальных разделов сопоставляется с вкладкой в списке:
== Description == the main body
== Installation == the Installation tab
== Frequently Asked Questions == the FAQ tab, one "= question =" per entry
== Screenshots == numbered captions, matched to files in /assets/
== Changelog == one "= version =" block per release, newest first
== Upgrade Notice == the short line shown inside wp-admin on update
Upgrade Notice заслуживает большего внимания, чем обычно получает Это единственный текст, который большинство пользователей видят перед нажатием обновления: одна или две строки, в приглашении на обновление, объясняющие, почему этот выпуск имеет значение. исправление безопасности, прерывистое изменение, новое требование PHP. Оставлен пустым, обновление - это всего лишь число.
Где живут знамя и икона?
Не в readme.txt. Это сбивает с толку почти всех с первого раза, потому что Readme - это то место, откуда берется любой другой фрагмент листингового контента.
Изображения живут в /assets/ каталог в SVN, рядом trunk а tagsи им соответствует имя файла:
| Файл | определенный | Размер |
|---|---|---|
banner-772x250.png |
Заголовок листинга | 772 х 250 |
banner-1544x500.png |
Заголовок сетчатки | 1544 х 500 |
icon-128x128.png |
Значок результатов поиска | 128 х 128 |
icon-256x256.png |
Значок сетчатки | 256 х 256 |
screenshot-1.png |
Первый скриншот | какой-нибудь |
Скриншоты подключаются к Readme по номеру. screenshot-1.png описывается первой строкой ниже == Screenshots ==, screenshot-2.png ко второму и так далее. подпись без соответствующего файла ничего не показывает; файл без подписи показывает изображение без метки.
Как выглядит хороший журнал изменений?
Один блок за выпуск, самый новый вверху, каждая строка говорит, что изменилось от пользователя & #39;s точка зрения:
= 3.2.5 =
* Fixed: admin menu order lost after a role change
* Improved: login customizer previews without saving
= 3.2.4 =
* Added: per-role dashboard widget visibility
"Исправления ошибок и улучшения & quot; ничего не говорит пользователю и меньше говорит рецензенту. В журнале изменений также каждый, кто решает, доверять ли вашему плагину, выглядит первым: устойчивый список конкретных записей читается как обслуживание, а двухлетний перерыв читается как отказ от того, работает ли код.
Длинные журналы изменений можно сократить. Сохраните последние выпуски readme.txt а остальное переместить в а changelog.txt; каталог считывает обрезанный, и история остается в репозитории.
Проверка файла перед отправкой
Механические проверки проводятся быстро: есть Stable tag сопоставьте существующую папку тегов, соответствует ли она Version: в заголовке плагина есть Tested up to текущее, это краткое описание размером менее 150 символов, имеется ли пять тегов или меньше.
У WordPress.org есть официальный валидатор readme это анализирует файл и сообщает, что он не смог прочитать, что стоит запустить один раз за выпуск. The Генератор ReadMe идет в другом направлении: он строит файл из полей, устанавливает каждый из этих ограничений рядом с полем, к которому он применяется, просматривает список, который создаст файл, и читает существующий readme.txt вернитесь в форму, чтобы старый файл плагина 's можно было обновить, не перепечатывая его.
Если вы смотрите на плагины других людей и #39;s, а не публикуете свои собственные, Детектор плагинов WordPress перечисляет, что загружает страница, и детектор тем читает тему, стоящую за ним.
