آموزش ثبت افزونه در مخزن وردپرس

یکی از دلایلی که وردپرس را به یکی از بهترین سیستم‌های مدیریت محتوا تبدیل کرده، وجود افزونه‌های بسیار زیاد برای آن است. ساخت افزونه و ثبت آن در مخزن وردپرس یکی از راه‌هایی است که شما می‌توانید به جامعه‌ی وردپرس خدمت کنید.

تعدادی از توسعه دهندگان افزونه‌های خود را در مخزن وردپرس ثبت نمی‌کنند و یکی از مهم‌ترین دلایل این کار این است که آن ها نمی‌دانند که چگونه افزونه خود را در مخزن وردپرس ثبت کنند.

در این نوشته از وبلاگ هاستینگ ماندگار وب، ثبت افزونه در مخزن وردپرس را مرحله به مرحله به شما آموزش می‌دهیم.

با ما همراه باشید.

هنگامی که افزونه دلخواه خود را ساختید زمان زیادی طول نمی‌کشد که آن را به مخزن افزونه‌های وردپرس اضافه کنید.

شما فکر می‌کنید که چرا باید با اضافه کردن افزونه خود به مخزن وردپرس وقت خود را هدر دهید.

مزایای افزودن افزونه به مخزن وردپرس:

1. آمار دریافت – می‌توانید بفهمید که افزونه شما چندبار دریافت شده است.
2. انتقادات و پیشنهادات – می‌توانید انتقادات و پیشنهادات کاربران را دریافت کنید. این بخش می‌توانید شامل گزارش باگ‌ها و یا ایده‌های تازه برای بهبود افزونه باشد.
3. بازدید عموم مردم – مخزن وردپرس در روز بازدید کننده‌های بسیار زیادی دارد. این ویژگی برای توسعه دهندگان بسیار مفید است به این صورت که افزونه شما کاربران بیشتری پیدا می‌کند و افرادی می‌توانند برای توسعه افزونه به شما کمک مالی کنند.
4. به‌روزرسانی آسان – فرض کنید که شما  یک افزونه را منتشر کرده‌اید و آن را در مخزن وردپرس ثبت نکرده‌اید. اگر بخواهید یک نسخه جدید از افزونه را منتشر کنید مطلع کردن کاربران کار بسیار سختی است اما با ثبت افزونه در مخزن وردپرس با استفاده از SVN و به راحتی می‌توانید تمامی کاربران را از انتشار نسخه تازه آگاه کنید.
5. کسب اعتبار – اگر یک افزونه در مخزن رسمی وردپرس داشته باشید کاربران شما را به عنوان یک توسعه دهنده معتبر خواهند شناخت. به طور کلی مردم به افزونه‌های موجود در مخزن اعتماد بیشتری دارند.

برخی قوانین وجود دارند که برای افزودن افزونه به مخزن باید آن‌ها را رعایت کرد:

• افزونه شما باید بر اساس مجوز GPLv2 باشد.
• افزونه نباید شامل موارد غیرقانونی باشد (این مورد توسط تیم بررسی کننده افزونه‌ها بررسی خواهد شد).
• نباید در افزونه لینک‌های خارجی که به یک سایت پیوند داده می‌شوند وجود داشته باشد. مانند: “ساخته شده توسط X”

در اولین مرحله شما باید یک فایل با نام readme.txt برای افزونه خود بسازید و افزونه را از طریق این لینک ارسال کنید تا پس از مدتی (بعضی از افزونه‌ها پس از چند ساعت و بعضی‌ها هم پس از چند روز تایید می‌شوند) تایید شود.

آموزش ساخت فایل readme.txt

وردپرس یک فایل readme.txt استاندارد دارد که از اینجا می‌توانید آن‌را دریافت کنید.

محتوای این فایل به صورت زیر است:

=== Plugin Name ===
Contributors: (this should be a list of wordpress.org userid's)
Donate link: http://example.com/
Tags: comments, spam
Requires at least: 3.0.1
Tested up to: 3.4
Stable tag: 4.3
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Here is a short description of the plugin. This should be no more than 150 characters. No markup here.
== Description ==
This is the long description. No limit, and you can use Markdown (as well as in the following sections).
For backwards compatibility, if this section is missing, the full length of the short description will be used, and
Markdown parsed.
A few notes about the sections above:
* "Contributors" is a comma separated list of wp.org/wp-plugins.org usernames
* "Tags" is a comma separated list of tags that apply to the plugin
* "Requires at least" is the lowest version that the plugin will work on
* "Tested up to" is the highest version that you've *successfully used to test the plugin*. Note that it might work on
higher versions... this is just the highest one you've verified.
* Stable tag should indicate the Subversion "tag" of the latest stable version, or "trunk," if you use `/trunk/` for
stable.
Note that the `readme.txt` of the stable tag is the one that is considered the defining one for the plugin, so
if the `/trunk/readme.txt` file says that the stable tag is `4.3`, then it is `/tags/4.3/readme.txt` that'll be used
for displaying information about the plugin. In this situation, the only thing considered from the trunk `readme.txt`
is the stable tag pointer. Thus, if you develop in trunk, you can update the trunk `readme.txt` to reflect changes in
your in-development version, without having that information incorrectly disclosed about the current stable version
that lacks those changes -- as long as the trunk's `readme.txt` points to the correct stable tag.
If no stable tag is provided, it is assumed that trunk is stable, but you should specify "trunk" if that's where
you put the stable version, in order to eliminate any doubt.
== Installation ==
This section describes how to install the plugin and get it working.
e.g.
1. Upload `plugin-name.php` to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress
1. Place `<?php do_action('plugin_name_hook'); ?>` in your templates
== Frequently Asked Questions ==
= A question that someone might have =
An answer to that question.
= What about foo bar? =
Answer to foo bar dilemma.
== Screenshots ==
1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from
the /assets directory or the directory that contains the stable readme.txt (tags or trunk). Screenshots in the /assets
directory take precedence. For example, `/assets/screenshot-1.png` would win over `/tags/4.3/screenshot-1.png`
(or jpg, jpeg, gif).
2. This is the second screen shot
== Changelog ==
= 1.0 =
* A change since the previous version.
* Another change.
= 0.5 =
* List versions from most recent at top to oldest at bottom.
== Upgrade Notice ==
= 1.0 =
Upgrade notices describe the reason a user should upgrade. No more than 300 characters.
= 0.5 =
This version fixes a security related bug. Upgrade immediately.

1. Plugin Name : نام افزونه (انگلیسی)
2. Contributors : سازندگان افزونه – در این قسمت باید نام کاربری سایت WordPress.org را وارد کنید. اگر افزونه شما به وسیله چند توسعه دهنده ساخته شده می‌توانید نام کاربری آن‌ها را به وسیله کامای لاتین (,) جدا کنید.
3. Donate link : لینک کمک مالی به افزونه
4. Tags : برچسب‌های افزونه – این برچسب‌ها را مانند برچسب زدن هنگام ارسال نوشته به وسیله ویرگول لاتین (,) جدا کنید.
5. Requires at least : حداقل نسخه وردپرس که افزونه به آن نیاز دارد.
6. Tested up to : بالاترین نسخه وردپرس که افزونه روی آن تست شده است.
7. Stable tag : نسخه فعلی (پایدار) افزونه
8. License : این قسمت هم مربوط به مجوز افزونه است که باید بر اساس GPL نسخه 2 یا بالاتر باشد. نیازی به تغییر این قسمت نیست.

به جای متن
Here is a short description of the plugin.  This should be no more than 150 characters.  No markup here.
باید توضیحات کوتاهی درباره‌ی افزونه بنویسید. این قسمت نباید بیشتر از 150 حرف باشد و باید به صورت متن نوشته شود. این متن در بخش زیر نمایش داده می‌شود:

در قسمت بعدی یعنی Description باید توضیحات افزونه را وارد کنید که در صفحه اصلی افزونه و در تب Description نمایش داده می‌شوند.

در قسمت Installation باید توضیخاتی درباره‌ی نحوه‌ی نصب افزونه و این که افزونه چطور کار می‌کند، بدهید.

Frequently Asked Questions مخصوص پرسش‌های متداول کاربران درباره‌ی افزونه است. در این قسمت باید پرسش‌های مشترکی که ممکن است برای همه کاربران پیش بیاید را بنویسید و به آن پاسخ دهید.

یکی از قسمت‌هایی که ممکن است در آن برای شما مشکل پیش بیاید، Screenshots است.

فرض کیند شما می‌خواهید 3 اسکرین شات برای افزونه قرار دهید. برای این کار باید در فایل readme.txt و در قسمت Screenshots آن‌ها را شماره گذاری کنید. مثلا کدهای شما در قسمت اسکرین شات‌ها به صورت زیر هستند:

<ol>
<li>توضیحات دلخواه برای تصویر 1</li>
<li>توضیحات دلخواه برای تصویر 2</li>
<li>توضیحات دلخواه برای تصویر 3</li>
</ol>

حال باید تصاویری را با نام‌های (png یا jpg یا jpeg یا gif) بسازید و در پوشه افزونه قرار دهید.

در قسمت Changelog باید لیست تغییرات در نسخه‌های مختلف افزونه برای هر نسخه را بنویسید.

اگر می‌خواهید هنگام به‌روزرسانی افزونه یک اطلاعیه برای کاربران بفرستید می‌توانید از قسمت آخر یعنی Upgrade Notice استفاده کنید.

حالا که فایل readme.txt ساخته شد باید افزونه را به همراه این فایل برای ثبت در مخزن ارسال کنید.

بعد از چند روز اگر افزونه مشکلی نداشت ایمیلی با موضوع تایید شدن افزونه برای شما ارسال می‌شود که در آن آدرس SVN افزونه نیز موجود است. آدرس SVN به شکل زیر است:
http://plugins.svn.wordpress.org/your-plugin/
دقت کنید که به این آدرس نیاز داریم پس آن را در جایی ذخیره کنید.

برای کار با SVN ما به یک نرم افزار نیاز داریم که ما نرم افزار TortoiseSVN را پیشنهاد می‌کنیم که می‌توانید آن را از اینجا دریافت کنید.

نرم افزار را نصب کنید.

حال باید یک پوشه در رایانه خود با یک نام دلخواه بسازید. ما در اینجا نام پوشه خود را mandegar-feed در نظر می‌گیریم. روی پوشه راست کلیک کنید و گزینه SVN Checkout را انتخاب کنید.

بعد از کلیک روی این گزینه پنجره‌ی زیر نمایان می‌شود.

در قسمت URL of repository باید آدرس SVN را که در بالا اشاره شد وارد کنید و OK را بزنید.

صبر کنید تا عملیات پایان یابد سپس روی OK کلیک کنید.

بعد از پایان این کار چند پوشه در پوشه شما ساخته می‌شود که عبارت‌اند از:

• assets
• branches
• tags
• trunk

از پوشه اول یعنی assets شروع می‌کنیم.

تصویر سربرگ افزونه در صفحه افزونه و آیکون افزونه در قسمت جست‌و‌جوی افزونه‌ها در این قسمت قرار می‌گیرند.

برای قرار دادن تصویر سربرگ افزونه یک تصویر با مشخصات زیر بسازید:

– نام: banner-772×250

– فرمت: jpg یا png

– اندازه: 772×250

و آن را در این پوشه (assets) قرار دهید.

برای قراردادن آیکون برای افزونه در قسمت جست‌و‌جوی افزونه‌ها باید دو تصویر با مشخصات زیر بسازید:

– نام: icon-128×128 و icon-256×256

– فرمت: jpg یا png

– اندازه: 128×128 و 256×256

و آن را در این پوشه (assets) قرار دهید.

حال نوبت به انتشار افزونه می‌رسد.

همه‌ی فایل‌های افزونه (فایل readme.txt – فایل‌های پی اچ پی – پوشه‌ها – اسکرین شات‌ها و…) را در پوشه trunk قرار دهید سپس روی پوشه‌ای که ساختید (your-plugin) راست کلیک کنید و گزینه SVN Commit را بزنید.

در قسمت Message یک پیام دلخواه بنویسید و روی OK کلیک کنید.

نرم‌افزار از شما نام کاربری و رمز عبور درخواست می‌کند. در این قسمت باید نام کاربری و رمز عبور سایت WordPress.org را وارد کنید و صبر کنید تا عملیات پایان یابد. روی OK کلیک کنید.

تبریک می‌گوییم افزونه شما با موفقیت منتشر شد.

پوشه branches برای به‌روزرسانی‌‌‌های عمده مورد استفاده قرار می‌گیرد.

آموزش به روزرسانی افزونه:

پوشه tags برای به‌روزرسانی افزونه به نسخه‌های جدید در نظرگرفته شده است.

فرض کنید شما می‌خواهید افزونه را از نسخه 1.0 به نسخه 2.0 ارتقا دهید.

برای این کار باید یک پوشه در پوشه tags با نام 1.0 بسازید و کلیه محتویات پوشه trunk را در آن کپی کنید.

حال تغییراتی که می‌خواهید در افزونه انجام دهید را روی فایل‌های موجود پوشه trunk انجام دهید (تغییر نسخه افزونه، تغییر کدهای افزونه و…).

روی پوشه افزونه کلیک کنید و گزینه SVN Commit را بزنید و کارهایی را که هنگام منتشر کردن افزونه انجام می‌دادید، اینجا هم انجام دهید و افزونه خود را به روزرسانی کنید.

امیدواریم که این آموزش برای شما مفید واقع شود.