WebDev - блог

Я решил подробнее описать основы работы с моим плагином A2P-SAPELinks, предназначенным, как ясно из названия, для показа ссылок, размещаемых на вашем сайте через биржу ссылок SAPE.
Некоторые действия описаны, возможно, слишком подробно, но я постарался написать так, чтобы даже начинающие пользователи Wordpress смогли быстро начать использовать этот плагин по назначению.

Установка

Установка плагина не отличается от установки любого плагина для Wordpress. Просто копируется содержимое архива(папку с содержимым) в каталог wp-content/plugins. После это плагин активируется на странице Плагины (Plugins) панели управления блогом.

Настройка плагина

Плагин имеет несколько режимов работы, которые задаются с помощью настроек.
Для задания настроек плагина необходимо перейти на страницу управления плагином - Настройки -> SAPELinks (Settings -> SAPELinks).

Описание настроек плагина

Общие настройки

• Включить локальный тестовый режим - включение этого режима позволяет проверить только правильность установки плагина. При этом на страницах сайтах должны выводится тестовые ссылки.Если добавлен хотя бы один виджет (см. далее), то будут показаны тестовые ссылки (количество зависит от настроек виджета). При этом максимальное количество тестовых ссылок - 5.Если включён режим контекстных ссылок (см. далее), то вместо текста будет выведен тестовый текст со ссылкой. При этом, в зависимости, от режима контекстных ссылок, тестовый текст может быть показан как на всех страницах, так и только на страницах просмотра полного содержимого записи или страницы.
  При включении локального тестового режима необходимо в поле Ваш SAPE код(хэш) (см. далее) прописать значение 1234567890.
• Включить тестовый режим SAPE - при включении тестового режима SAPE в местах показа ссылок будет выведен блок HTML-комментария с содержимым <!-- check code -->
• Ваш SAPE код(хэш) - в это поле необходимо ввести название папки, в которой размещён ваш файл sape.php.
• Требуемая кодировка ссылок - в этом поле можно задать требуемую кодировку ссылок. По-умолчанию в системе используется WINDOWS-1251. Если ваш блог использует кодировку UTF-8 (Wordpress уже давно использует именно ее), то необходимо указать это.
• Код SAPE используется на нескольких сайтах (Multisite) - при включение этого режима добавляется параметр multi-site. Пока не тестировался.

Настройки контекстных ссылок

• Включить контекстные ссылки - включить вывод контекстных ссылок. При этом режим работы контекстных ссылок зависит от параметров, описанных ниже. По-умолчанию (если остальные параметры не включены), контекстные ссылки включаются на всех страницах блога.
• только для страниц с полным текстом (Page, Post) - при включении этой опции, контекстные ссылки будут включаться только на страницах просмотра одиночной записи или страницы (не будут включены для страниц со списками статей - категорий, архивов и прочее).
• включить также для краткого описания сообщения (Excerpt) - в некоторых темах, на страницах со списком статей используется функция the_excerpt() вместо the_content(), которая выводит краткое описание записи, которое вводится в отдельное поле при создании записи.
  Как правило, если вы хотите, чтобы на таких страницах включались контекстные ссылки, то достаточно просто включить их используя первую опцию и не включая вторую.

Оформление виджетов со ссылками

Эти поля можно использовать для задания общих для всех виджетов блоков текста, которые будут показаны перед и после виджета.

• Код перед виджетом - код который будет выведен перед виджетами, для которых не заданы собственные значения этого параметра, например <p>предлагаем посетить сайты наших партнёров</p>
• Код после виджета - код который будет выведен после виджетов, для которых не заданы собственные значения этого параметра, например <p>переход по ссылке будет выполнен в новом окне</p>

Примеры настроек контекстных ссылок

Если в настройках плагина включена только опция Включить контекстные ссылки , то контекстные ссылки будут включены как для страниц со списком записей (главная страница, страница со списком записей в категории, архив за месяц и другие списки записей), так и на странице просмотра содержимого отдельной записи.

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

Работа с виджетами

Виджеты предназначены для показа обычных SAPE-ссылок. Если вы не добавите ни одного виджета, то ссылки показаны не будут.

Создание нескольких виджетов

Вы можете добавить любое количество виджетов. Для этого необходимо перейти на страницу Дизайн -> Виджеты. В нижней части этой страницу будет блок с заголовком SAPE Links: Виджеты ссылок. В выпадающем списке вы можете выбрать требуемое число виджетов и нажать на кнопку "Сохранить". Созданные виджеты добавятся в колонку доступных виджетов с заголовками A2P Sape Links N, где N - номер виджета.

Настройка виджетов

После создания нужного количества виджетов, необходимо их разместить на панелях (для этого на странице управления виджетами в правой части нужно выбрать требуемую панель(сайдбар) и кликнуть по кнопке "Показать").

После размещения виджетов, для каждого из них можно задать необязательные параметры:

• Заголовок - заголовок виджета.
• Количество ссылок - максимальное количество SAPE-ссылок выводимых в данном блоке.
• Текст перед виджетом - текст который будет выведен перед виджетом. Если этот параметр не задан, будет использовано значение, заданное в настройках плагина.
• Текст после виджета - текст который будет выведен после виджета. Если этот параметр не задан, будет использовано значение, заданное в настройках плагина.

Замечания

1. Для последнего виджета желательно всегда оставлять значение параметра "Количество ссылок" пустым. Это будет означать, что в данном блоке будут показаны все, оставшиеся в списке для данной странице непоказанными, ссылки.
2. При этом вам необходимо следить, чтобы этот виджет выводился именно последним, так как иначе в нем будут показаны все ссылки, а в следующих за ним не будет ничего.
3. При изменении настроек не забывайте чистить кэш(если у вас установлен какой-либо из плагинов кэширования).
4. Не забывайте, что некоторые изменения могут отобразиться не раньше чем через час (так как файлы, создаваемые кодом системы SAPE обновляются через час). Для ускорения можно удалить файлы words.db и links.db, находящиеся в папке с файлом sape.php.

Читать полностью »