Subversion

Столкнулся я с этой системой буквально пару дней назад. Зарегистрировался на Wordpress.org и стал контребьютором (^_^) своего плагина NS Recent Plugins. Теперь мой плагин можно скачать с официального репозитория плагинов для Wordpress.

Subversion — свободно распространяемая система управления версиями с открытым кодом. Subversion разработана специально для замены CVS, самой распространённой открытой системы управления версиями. Она обладает всеми основными функциями CVS (хотя некоторые из них выполняет другими способами) и лишена ряда её недостатков.

via Wikipedia

Разобраться было бы не сложно, но я так понимаю, команда Wordpress не любит Виндоузятников или просто думают, что все нормальные программисты работают на Unix-based системах. Помогла Википедия. Прочитав что такое svn и subversion, загрузив пару программ-клиентов для работы с репозиторием, я разобрался в использовании и наконец-таки влез в свой аккаунт на svn.wp-plugins.org

Smart SVN

На windows платформе я поставил програмку Smart SVN, которая оказалась портированной из под Linux – интерфейс как у KDE приложений. Мало того, что триальная, так ещё куча лишних настроек и новых непонятных терминов. В письме от WPшников мне обещали закрыть хостинг-аккаунт если я не воспользуюсь им в течение часа. Так что времени особо не было, пришлось пользовать, то что успел найти.

В принципе, рабочего потенциала программы мне хватило чтобы залогиниться в репозиторий и закинуть в папку trunk текущую версию плагина и readme файл.

Пришёл на работу и обнаружил, что в репозитории информация о плагине отображается как-то лево. Тогда я понял что информация о плагине черпается из readme файла. А ведь надо было сначала инструкцию прочитать. Как говориться “Инструкцию читают либо когда нечего читать, либо когда уже всё сломалось”. Но за что я люблю эру компьютеров и связанные с ней технологии, так это за то, что всё можно исправить (если уметь). Никогда ничего не выбрасывается. ))

KDEsvn

Поскольку лень было искать Windows клиент для работы с Subversion, проще было найти клиент под Unix. Переключился на старенький комп с PC-BSD и полез в Википедию. Там я без удивления узнал, что существует GUI клиент под KDE – KDEsvn. Но качать я его не стал. Поставил из портов. Но сначала нужно апгрейднуть neon (если он конечно установлен).

Короче, вот что понадобилось сделать:


$ cd /usr/ports/www/neon
$ make install FORCE_PKG_REGISTER=1
$ make clean distclean


$ cd /usr/ports/devel/kdesvn
$ make
$ make install
$ make clean distclean


Ставился, собирался, компилился KDEsvn долго. Но когда поставился, и я рестартанул иксы, то програмка меня очень порадовала.

Достаточно компактна и по внешнему виду и по количеству пунктов меню. Не то, что Smart SVN. Достаточно простое подключение к репозиторию. Естественно пароли хранятся в KDE Wallet.

WP-plugins readme.txt

Есть оказывается особенности синтаксиса readme файла для Wordpress плагинов. И когда я их соблёл, то всё встало на свои места и отобразилось нужным образом. Вот пример readme файла.. В нём написано как правильно нужно оформлять этот документ. А от меня вам справочник по форматирования readme.txt

Справочник по форматированию readme файла для Wordpress плагинов


=== My Wordpress Plugin === - Название плагина. Пишется в самом начале, на первой строке.
Contributors: markjaquith, mdawaffe - распрастранители плагина в репозитории. Пишется имя пользователя зарегистрированного на wordpress.org
Donate link: http://example.com/ - ссылка для пожертвований автору плагина.
Tags: comments, spam - Тэги связанные по теме плагина
Requires at least: 2.0.2 - Минимальная версия Wordpress на которой работает плагин.
Tested up to: 2.1 - До какой версии был тестирован.
Stable tag: 4.3 - стабильная версия плагина. Разные версии можно выкладывать в папку tags своего репозитория. Не путайте с тэгами - ключевыми словами.

Короткое описание. Будет отображаться под названием плагина в списке плагинов. Просто текст. Без форматирования. До 150 знаков.

== Description == - меню описания.

Описание плагина, будет отображаться в меню Description. Поддерживается форматирование. Если этого текста нет, то берётся текст из короткого описания.

В тексте можно использовать маркированый список:

* Должен начинаться со знака звёздочки.
* В начале и в конце списка должна быть пустая строка.
* Чтобы привести пример кода нужно код заключить в `косые кавычки`.
* Текст в любом месте, кроме как в коде, можно сделать **жирным**.
* Или *наклонным*.

Также можно использовать и нумерованный список

1. Каждый пункт меню начинается с цифры 1 с точкой
1. Никаких "1. 2. 3."
1. Только "1. 1. 1"
1. Тоже должны быть пустые строки перед списком и после списка.

> Перед цитатой пишется "знак больше". Как здесь.

== Installation == - меню установки

Описание установки. Поддерживается форматирование описанное выше.

== Frequently Asked Questions == - меню часто задаваемых вопросов.

= Вопрос? =

Ответ

= Ещё вопрос? =

Ещё ответ

== Screenshots == - Меню скриншотов

1. Здесь ссылки на скриншоты не пишутся. Берётся номер который написан в начале строки и подцепляется картинка screenshot-1.(png|jpg|jpeg|gif) лежащая в папке со стабильной версией (например /tags/2.0/screenshot-1.jpg или trunk/screenshot-1.jpg если стабильная версия не указана). Здесь пишется только описание к скриншоту.
2. Здесь идёт описание к screenshot-2.(png|jpg|jpeg|gif). Формат картинки один из указанных. Репозиторий сам подберёт расширение.

== Other Notes == - Любой другой заголовок автоматически записывается под пунктом меню Other Notes.

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

== Big Header == - большой заголовок в меню Other Notes

Кстати, можно использовать форматирование для ссылок [Заголовок ссылки](http://adress.ssilki.com/ "Текст для атрибута title") или такое форматирование. Текст для атрибута title естественно не обязателен.

= Small Header = - заголовок поменьше. Тоже отправляется в меню Other Notes

Все заголовки, списки и абзацы должны быть отделены пустыми строками.