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

К сожалению, некоторые разработчиков плагинов просмотре написания readme.txt файл как наименее важная часть их работы.Таким образом, мы в конечном итоге с вещами вроде следующего:

• Описания только с одной line,
• Описания практически без information,
• Нет перевода на English,
• Typos,
• Confusion.

Почему вы должны заботиться о ваших Readme.txt

Плохо написана readme.txt не обязательно означает, что плагин плохо написана, код может быть уме-blowingly хорошо.Но это впечатление полного отсутствия внимания к деталям и отсутствия медицинской помощи для конечных пользователей.Вы видите, никто не заметит, если файл ридми особенно удивительным, но они заметят, если это bad.

Вам не нужно просмотреть файл Readme, как боль в приклад домашние задания, которые вы должны сделать после того, как все весело у вас было с кодированием.Ридми преимущества you.Вот как:

• Дает вам возможность сказать почему ваш плагин так good,
• Хвастается __ 40 вашего плагина | features,
• Делает легко users установить и использовать плагин,
• Anticipates вопросы поддержки с подробным FAQ,
• Links на ваш сайт и другие продукты,
• Upsells Ваши коммерческие services.

В этой статье мы рассмотрим, как улучшить вашу WordPress ридми файл, так что он приносит пользу как пользователям и you.

Но, во-первых, mechanics.

Использование (квази-) Markdown

Markdown является преобразование текста в HTML преобразования инструмент, разработанный Джон Грубер и Аарон Шварц, который используется для файлов справки плагинов в WordPress repository.

Вы пишете ридми в Markdown, и Markdown преобразует его в HTML для страницы каталога WordPress, но он все равно будет хорошо выглядеть в задней части WordPress и когда вы взглянуть на это в вашем любимом текстовомeditor.

Взгляните на странице каталога Простой Twitter Connect:

Список простых Twitter Connect в WordPress плагин directory.

Вот как это выглядит, когда я загрузить и распаковать ридми:

Ридми Простой Twitter Connect в файле в Notepad.

А вот как оно появляется в задней части WordPress ‘:

Простой Twitter Connect на русском языке на кнопку “Edit Plugin” страницы в WordPress Dashboard.

Это readable ни на что средние оно рассматривается дюйма Представьте себе, как трудно читать ридми в текстовом редакторе, если бы он был отмечен в HTML.Markdown делает ваш ридми ясно, чтения и semantic.

WordPress.org использует то, что Все Jacquith описывает как квази-markdown.Она в основном работает как уценки, и большая часть синтаксиса и то же, но есть несколько важных различий, особенно в headers.

Для начала с WordPress ридми, вот таблица, содержащая синтаксис, который вы будете need.

Syntax	Example	Выходы as	Использование for
=== Foo ===	=== Plugin Name ===	< h2> Плагин Name< / h2>	Плагин name
== Foo ==	== Описание ==	< h3> Description< / h3>	Вкладками раздел headings
= Foo =	= Встроенный заголовок =	< h4> Встроенные heading< / h4>	Заголовки в тексте readme
* Foo	Списка *, * список item	< ul>< Li> список item< / li>< Li> список item< / li>< / Ul>	Неупорядоченный list
1.Фу, 2.foo	1.Элемент списка, 2.Список item	< ol>< Li> список item< / li>< Li> список item< / li>< / Ol>	Заказанные list
Foo bar	? Вы говорите мне	< blockquote>? Вы говорите мне < / blockquote>	Блокquotes
* Foo *	* Внимание *	< em> emphasis< / em>	Italics
** Foo **	** Жирный **	< strong> bold< / strong>	Bold
‘ foo’	‘ WP-config.php’	WP-config.php	Любой код, вы хотите показать (в том числе короткие номера)
[Ссылка] (http://foobar.com “ foobar”)	[WordPress] (http://wordpress.org/ “ Ваше любимое software”)	< HREF = ” http://wordpress.org/” название = ” Ваш любимый software” > WordPress< / a>	Links
< http://foobar.com>	< http://wordpress.org>	< HREF = ” http://wordpress.org” > Http://wordpress.org< / a>	Links
[YouTube http://foobarvideo.com]	[YouTube http://www.youtube.com/watch?v=CVmGBoPx6Ms]	< DIV класс = ’ video’ > < Объект ширина = ’ 532′ высота = ’ 325′ > < параметр имя = ’ movie’ значение = ’ http://www.youtube. COM / V / CVmGBoPx6Ms фс = 1′? > < / param> < параметр имя = ’ allowFullScreen’ значение = ’ true’ > < / param> < параметр имя = ’ allowscriptaccess’ значения= ’ never’ > < / param> < Код для вставки SRC = ’ http://www.youtube.com/v/ CVmGBoPx6Ms фс = 1′? типа = ’ применение / х-ударно-flash’ AllowScriptAccess= ’ never’ allowfullscreen = ’ true’ ширина = ’ 532′ высота = ’ 325′ > < / embed> < / object> < / div>	Video

Теперь, когда вы знаете, как писать в WordPress вкусом Markdown, давайте начал писать readme.

Написание Readme.txt

Написание ридми не трудно, но положить немного thought в него заранее ничего платить off.

• Что вы думаете конечным пользователям будет необходимо для того, чтобы получить оптимальное использование с вашего плагина
• ? Вам необходимо включить любые специальные инструкции или фрагменты кода
• Какие проблемы вы ожидаете пользователей, работающих в
• Как вы можете сделать свой плагин как можно более привлекательным
• В насыщенном рынке, что делает ваш плагин выделяются

Немного мыслей, вы можете получить полезные русском языке, что демонстрирует лучшие стороны Вашего plugin.

При написании ридми, помните, что если у людей есть возможность использовать свой плагин должным образом, то они будут менее склонны постучится в ваши двери, прося help.

Давайте посмотрим на каждый из основных разделов ридми, чтобы увидеть то, что вы можете сделать, чтобы улучшить его.В качестве точки отсчета, мы будем использовать ридми для Простой Twitter Connect, который является кратким, полезно и хорошо formed.

Плагин Header

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

Вот что вам понадобится, чтобы завершить его:

• ContributorsЛюбой, кто внес вклад в плагине.Вы должны использовать имя пользователя вкладчика от WordPress.org, связывая его с их WordPress.org профилей, которые перечислены все плагины вкладчика.К сожалению, многие разработчики не говоря уже об их WordPress имя пользователя, которое означает, что они упускают возможность продемонстрировать остальным их работы. Вклад теги сделано right. Вклад теги сделано wrong.
• Donate linkЭто ваш шанс получить немного назад, то от сообщества WordPress.Если у вас нет ссылки подарить, вы не даете людям возможность поблагодарить вас
• TagsПо состоянию на блоге, теги используются для категоризации контента.В каталоге 15000 WordPress плагины, с помощью тегов effectively делает его легким для людей, чтобы найти плагин.Держите теги актуальной, и думаю, что люди, которые нуждаются в вашей плагин можно найти.Некоторые разработчики размещать свои плагины слова, которые лишь косвенное отношение.Этот список для тега Twitter не является полезным, потому что это раздутый, не относящимися к содержанию.Как WordPress членов сообщества и вкладчиков, мы обязаны сохранить каталога плагинов интуитивное, как possible.
• Автор URIВаш дом page.
• Плагин URIГлавная страница плагина.Обратите внимание, что URI Автор и Plugin URI не включены в ридми шаблон предоставляемых WordPress.В том числе им, безусловно, хорошая вещь, потому что они прямые людей к вашему дому соответствующих pages.
• Требуется leastЭто версия WordPress, что ваш плагин требует.Некоторые люди не обновить WordPress (некоторые по уважительным причинам, а некоторые для немых причинам).Скажите им, будь WordPress будет работать с их version.
• Испытано на toЕще одной важной информацией.Это говорит людям, какая версия WordPress плагин был испытан до to.
• Стабильный tagСтабильная теги рассказываетWordPress, какая версия плагина появится в каталоге.Это должно быть в числовом формате, который намного легче для WordPress дело.Цель для номера, как 1,5, 0,5 или любую версию вы находитесь.Если ваша стабильная версия в багажнике в Subversion, то вы можете указать “ствол”, но это единственный раз, когда вы должны использовать слова вместо numbers.

Вот то, что информация заголовка для простых Twitter Connect выглядит следующим образом:

=== Simple Twitter Connect ===
Contributors: Otto42
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=otto%40ottodestruct%2ecom
Tags: twitter, connect, simple, otto, otto42, javascript
Requires at least: 3.0
Tested up to: 3.2
Stable tag: 0.15

Советы для написания заголовков Information

• Использование WordPress.org имена пользователей для contributors.
• Использование number для стабильного tag.
• Включить donation ссылке, чтобы сделать некоторые cash.
• Держите теги relevant.
• Test с самыми последними WordPress version.

Короткие Description

Краткое описание то, что появляется на странице WordPress.org, в котором перечислены plugins.

Он также появляется в списке пользователей установленных плагинов:

Это ваш шанс, чтобы выработать энергичный 150-описание характера, которые сделают люди хотят установить plugin.

К сожалению, некоторые люди попадают в цель:

Я не уверен, что это одно это все о:

Ни одна из этих кратких описаний вам сказать о том, что плагин делает.Они совершенно бесполезны в предоставлении информации WordPress users.

Еще одна проблема, когда разработчики не добавляют краткое описание вообще.В этом случае 150 символов взяты из длинного описания.Проверьте краткое описание для Простой TrackbackSimple Trackback проверки с Topsy Blocker:

Краткое описание отключается в середине слова.Мы знаем, что плагин выполняет тест на обратных ссылок, но зачем?За что?Как

Короткие описания, Get It Right

• VideoPress“Управление и вставлять видео размещенные на VideoPress.Требуется блоге WordPress.com с обновлением премии VideoPress “
• Yet Another Похожие сообщения Plugin“Покажите список соответствующих записей на вашем сайте и кормов на основе уникального алгоритма.Шаблонов позволяет настроить дисплей “
• BuddyPress«Социальные сети в коробке.Создать социальную сеть для вашей компании, школы, спортивной команды или нишу сообщества “
• Google Button“Добавляет Google 1 кнопку на ваш сайт, чтобы ваши посетители могут голосовать, чтобы рассказать миру, как велика ваш сайт!”

Советы по написанию коротких Description

• Stick для под 150 characters.
• Не полагайтесь на тексте, вытащил из долго description.
• Рассказать людям, что плагин воли do для them.
• Не беспокойтесь о технической details. Вы можете представить их в долгий description.
• Расскажи людям ли плагин имеет никакого requirements работы, такие как subscription.

Long Description

Длинное описание, где Вы действительно пойти в город.Вы подключили людей с кратким описанием; теперь пришло время продать свой plugin.Давайте проверим Полное описание для простых Twitter Connect:

== Description ==
Simple Twitter Connect is a series of plugins that let you add any sort of Twitter functionality you like to a WordPress blog. This lets you have an integrated site without a lot of coding, and still letting you customize it exactly the way you’d like.

First, you activate and set up the base plugin, which makes your site have basic Twitter functionality. Then, each of the add-on plugins will let you add small pieces of specific Twitter-related functionality, one by one.

Bonus: Unlike other Twitter plugins for WordPress, this one helps you create your own Twitter application and identity, so your tweets from here show up as being from Your Blog, not from some plugin system. You’ll never see "posted by Simple Twitter Connect" in your tweet stream, you’ll see "posted by Your Blog Name". Great way to drive traffic back to your own site and to see your own Twitter userbase.

Requires WordPress 3.0 and PHP 5.

**Current add-ons**
* Login using Twitter
* Comment using Twitter credentials
* Users can auto-tweet their comments
* Tweet button (official one from twitter)
* Tweetmeme button
* Auto-tweet new posts to an account
* Manual Tweetbox after Publish
* Full @anywhere support
* Auto-link all twitter names on the site (with optional hovercards)
* Dashboard Twitter Widget

**Coming soon**
* More direct retweet button (instead of using Tweetmeme)
* (Got more ideas? Tell me!)

If you have suggestions for a new add-on, feel free to email me at otto@ottodestruct.com.
Want regular updates? Become a fan of my sites on Facebook!

http://www.facebook.com/apps/application.php?id=116002660893

http://www.facebook.com/ottopress

Or follow my sites on Twitter!

http://twitter.com/ottodestruct

Что делает это хороший пример того, длинное описание

1. Открытие описание четкое и useful.Он говорит вам, что плагин делает и как он works.
2. ключевых особенностей стоит out. (Вы можете сказать, что плагин создает собственное приложение Twitter)
3. requirements которые listed.
4. Markdown
   Если вы хотите прочитать полностью статью, посетите сайт наших спонсоров
   
   
   
   Главная → Wordpress → 23.11.2011 by Newsbot