Скрипт каталога ссылок. Документация. V3.07

C чего начать?

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

Установка каталога
Каталог размещается в двух разделах, ему необходимы две директории. Первая - директория для администрирования. В ней будут находиться файлы скрипта (поддиректория scripts), базы (поддиректория data) и темплейтов(поддиректория темплейты). Вторая рубрика - директория для сгенерированного каталога. Файлы, находящиеся в ней, будут отображаться как каталог ссылок на вашем сервере.

Для начала работы необходимо:

1. Создать директории для админской части и каталога. Присвоить им права доступа, позволяющие менять и перезаписывать файлы скрипту во время работы (в самом общем случае - 777). О том, что такое права и как их менять, можно прочитать по адресу http://hippo.su/different/chmod.htm.
2. Распаковать архив и скопировать его файлы в директорию администратора.
3. Запустить install.php и заполнить все поля - адреса директорий, e-mail редактора каталога, логин и пароль, которые вы будете использовать в работе с каталогом.

Создание разделов каталога
Для создания разделов каталога выберите пункт первый меню Список рубрик. Для добавления новой рубрики надо заполнить три поля после заголовка Добавить рубрику.
1. Русское название - используется при генерации как заголовок страницы и как название рубрики в каталоге.
2. Латинское название - используется при генерации в адресе страницы.
3. Метатеги, используются в заголовке страницы рубрики.
Обязательны для заполнения два первых поля.
Одна из особенностей каталога - неизменное расположение ссылок на сайты, которые в нем находятся. Адрес страницы, где размещается ссылка, меняется только в одном случае - при переносе ссылки в другую рубрику. Поэтому рекомендуем создавать сразу достаточно рубрик. Чтобы при росте каталога не приходилось бы создавать новые разделы и переносить туда уже введенные ссылки, меняя при этом их адрес.

Добавление новых ссылок
Чтобы добавить ссылку в каталог надо зайти в программу администрирования, в раздел Список рубрик и кликнуть на названии рубрики, в которую необходимо добавить ссылку на сайт.
У вас появится список уже введенных ранее ссылок, а под ним, под заголовком Добавить ссылку, - поля для ввода новой ссылки.
Любое поле может быть оставлено пустым, это не вызовет ошибки.
URL (как и все другие адреса, используемые в скрипте) обязательно надо вводить, используя префикс http://.
При добавлении ссылки, если поставить галочку Послать предложение об обмене, пойдет письмо-извещение по введенному e-mail о том, что ссылка на сайт добавлена. Текст письма можно редактировать в пункте меню Тексты писем. Поэкспериментируйте, введите для начала свой адрес и получите письмо сами!

Настройка внешнего вида каталога
Внешний вид каталога настраивается с помощью темплейтов, пункт меню Templates.
Программа использует около 20 шаблонов-темплейтов и 25 переменных, которые могут применяться в шаблонах.
Для первой настройки каталога достаточно задать header, footer и таблицу стилей. Более того, можно и ничего не задавать - программа сгенерирует черно-белый каталог, который будет вполне действующим.
Пример настройки темплейтов вы можете найти в демо-каталоге ( http://hippo.su/admin/scripts/templates.php ).
Для определения количества ссылок на одной странице используйте пункт меню Настройки.
Как посмотреть результат?
Сразу при создании каталога (после запуска программы install) вы уже можете видеть готовый каталог.
Для этого выберите пункт меню Генерация каталога. В правой части страницы появятся ссылка на созданные рабочие страницы каталога. Они сгенерируются в той директории, адрес которой для каталога вы ввели при инсталляции.
Первоначально каталог будет черно-белым и иметь всего одну рубрику, Партнеры.
Добавляйте рубрики, добавляйте сайты в них, настраивайте внешний вид.
Результат всех действий можно смотреть практически немедленно, запуская перегенерацию каталога.
Обратите внимание - рубрики, не содержащие ни одного сайта, в сгенерированном каталоге не отображаются.

Данные, условные обозначения

В сгенерированном каталоге отображаются только активные ссылки. При поиске тоже находятся только активные ссылки.

Формат входных данных
Все данные (информация о структуре каталога, о линках и о кнопках сайта) программа хранит в формате xml:
<имя параметра>
значенеие параметра
</имя параметра>

Файлы возможно редактировать вручную, оффлайн.
Но следует учесть, что при создании/изменении вручную файлов базы вам, как правило, придется поставить к ним доступ 777. Иначе админке не хватит прав изменять данные, перезаписывать то, что внесено по ftp.
Символы угловых скобок (< и >) а также кавычек " хранятся в базе в виде их кодов. lt; gt; quot;.
Файлы базы находятся в поддиректории админки data.

Комментарии к полям:
1. Список категорий, cat.dat
n - номер рубрики;
name - русское название рубрики;
lat - латинское название рубрики;
meta - метатеги данной рубрики;
npages - количество страниц в рубрике;
changetime - дата последнего изменения;
nsites - количество ссылок на страницах, через запятую.

2. Файл одной категории, список ссылок. n-i.dat (n - номер категории, i-номер страницы)
item - начало описания одной ссылки;
nstr - номер страницы раздела, на которой будет размещена ссылка;
name - наименование ресурса;
url - УРЛ ссылки;
link - страница с нашей ссылкой на описываемом ресурсе;
status - статус ссылки (активная или неактивная);
mail - адрес контактного лица;
button - код кнопки партнера;
description - описание ресурса;
ourbutton - код нашей кнопки, переданной для обмена;
date1 - не используется в настоящее время;
date2 - не используется в настоящее время;
time - дата добавления файла;
comment - комментарий редактора.

3. Список кнопок проекта, button.dat
n - номер кнопки;
kode - код кнопки;
img - ссылка на изображение;
type - кнопка/ссылка, переключатель.

Список рубрик позволяет
управлять рубрикацией (создавать, удалять, переименовывать рубрики).
Рубрика под номером "0" является особенной, "родительской".
Ее нельзя удалить.

Каждая рубрика характеризуется тремя параметрами:

1. Русское название - используется при генерации как заголовок страницы.
2. Латинское название - используется при генерации как наименование страницы
   лат-name-n.html, где лат-name - латинское название рубрики, n - номер страницы (рубрика может содержать несколько страниц).
3. Метатеги, используемые в заголовке рубрики.

По клику на названии рубрики показывается список содержащихся в ней ссылок.
Рубрики, не содержащие ни одного файла, в сгенерированном каталоге не отображаются.

Список ссылок

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

Поля, характеризующие сайт:

• название сайта;
• описание;
• URL сайта;
• URL сссылки на нас;
• код кнопки сайта;
• код нашей кнопки;
• e-mail;
• статус ссылки (активный, ждет валидации и пр..);
• время создания ссылки;
• комментарий.

Темплейты.
Для того, чтобы сгенерированные страницы каталога вписывались в любой дизайн, используются темплейты.
Главные из них -
preheader (метатеги, таблица стилей, скрипты и пр.);
header (общая для всех страниц "шапка");
footer (общее для всех страниц подножие).
При update каталогов LinkClub более ранних версий, эти темплейты сохраняют свои значения (как и другие данные, используемые скриптом).
Одним из основных темплейтов является также table_page_link_tr - именно в нем определяется форма отображения конкретной ссылки.
Сгенерированный каталог состоит из четырех типов страниц:
Первая страница каталога, текущая страница каталога, страница поиска и страница добавления ссылок. Именно их темплейты определяют в целом вид каталога. Они расположены в начале списка темплейтов. Список темплейтов представлен в виде таблицы. Первая колонка содержит название темплейта, вторая - список элементов и переменных, которые может включать темплейт. В последней колонке дано краткое описание темплейта или переменной, их роль.
Первые три основные страницы настраиваются очень гибко. Последняя, страница добавления нового ресурса, практически не допускает редактирования непосредственно форм ввода. Это связано с необходимостью проверки полноты и корректности вводимых пользователем данных.
Каждая рубрика имеет свои, соответствующие теме, метатеги, которые определяются в списке рубрик, а не в разделе Темплейты.
Для генерации корректного кода страниц header не должен переопределять метатеги, вводимые в рубриках.

Генерация каталога
По команде сгенерировать каталог скрипт создает в заданной администратором директории статичные страницы. Страницы отлично индексируются поисковыми системами. URL ссылок (если не переносить их в другую рубрику) остается неизменным. По умолчанию страницы генерируются с расширением html. В Настройках возможно задать и любое другое расширение (php, shtml и т.п.).
Сгенерированный каталог в точности повторяет структуру, созданную администратором через админскую часть. Сайты в сгенерированном каталоге отображаются в том же порядке, как и расположены на странице. Номера страниц также сохраняют свои значения. Отображаются только "зеленые" сайты. Неактивные ссылки в сгенерированном каталоге отсутствуют.
После выполнения команды Сгенерировать каталог появляется список ссылок на сгенерированные файлы.
Любую страницу можно открыть и посмотреть что получилось, ссылка откроется в новом окне.
Каталог по определению многостраничен (несколько рубрик, в каждой рубрике - несколько страниц). Каждая страница (если это предусмотрено в темплейтах) имеет ссылки навигации по каталогу.

Дизайн отображения ссылок на странице задается темплейтами.

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

Количество ссылок на странице
Адрес страницы, содержащей ссылку

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

Выбор кнопки
Каталог содержит список из нескольких кнопок. При регистрации через форму в каталоге пользователь должен выбрать одну из них (коды всех кнопок и их вид в виде готовой ссылки выводятся на странице уже сгенерированного каталога добавить ссылку).
Замечание. При добавлении кнопки/ссылки в список ваших кнопок разместите кнопку где-либо на другом сервере, сымитировав обмен, и проверьте, находится ли ваша ссылка. Не все коды находятся, к сожалению. Например выявлено, что не находятся кнопки, содержащие круглые скобки ().
Контролю за существованием обратной ссылки могут помешать особенности сервера или браузера. Поэтому, начиная с версии 2.30 предоставляется возможность посетителю добавить ссылку даже в том случае, если обратная ссылка не обнаруживается программой. При этом, в комментарии к введенному ресурсу, указывается, что "автоматически обратная ссылка не обнаружена".

Форма регистрации ресурса пользователем
Программа запрашивает следующие поля:

• Рубрика каталога, в которой "претендент" хотел бы разместить свои данные (обязательное поле);
• Название сайта "претендента" на обмен ссылками;
• Урл сайта;
• Описание - код текстовой ссылки "претендента" на обмен ссылками;
• Код графической кнопки "претендента" на обмен ссылками;
• Е-мейл "претендента", по которому будет вестись дальнейшая переписка (обязательное поле);
• Номер нашей кнопки из предложенного списка (обязательное поле);
• УРЛ страницы "претендента", на которой уже установлена ссылка на сайт каталога (обязательное поле, проверяется программой наличие кнопки).

После ввода ресурса "претендентом" сайт попадает не прямо в базу, а в промежуточный буфер. При этом на мэйл редактору приходит извещение о добавлении сайта с текстами всех введенных полей.
Т.к. новые сайты попадают не в базу, а в промежуточный буфер, из уже сгенерированного каталога нет никаких обращений к базе. Это важно для обеспечения безопасности и приватности каталога. Теперь определить местоположение админской части из сгенерированного каталога невозможно. Второй плюс записи вводимых пользователем сайтов в промежуточный буфер - базу теперь можно править оффлайн, не боясь потерять свежевведенные ресурсы.
Администратор добавляет введенные пользователем ресурсы через пункт в админской части Сайты от пользователей.
Если у Вас совершенно нет времени просматривать то, что добавили в ваш каталог пользователи, то можно воспользоваться опцией Добавить не глядя . Все добавленные ресурсы при этом попадут в базу без предварительного администрирования.

В настоящее время каталог дает возможность рассылать три типа писем пользователю.
1. При валидации введенного ресурса. Посылается письмо "Ваша ссылка проверена, спасибо за ее добавление в каталог".
2. При переводе ресурса в "неактивный" (смена статуса на красный). Посылается письмо "Не найдена обратная ссылка, через некоторое время удалим Ваш ресурс из каталога".
3. При вводе ресурса редактором. Посылается письмо "Давайте поменяемся ссылками. мы Ваш ресурс уже добавили."
Все письма посылаются только по включению соответствующего чекбокса, по умолчанию он отключен.
Тексты писем можно менять. Для использования в письмах предусмотрены специальные переменные, доступные администратору - hippo@hippo.su - адрес партнера, {url} - URL сайта партнера, {link_url} - адрес страницы, на которой размещена ссылка на сайт партнера. Полный список переменных есть на странице редактирования писем.

Настройки.

В Настройках определяется куда будет генерироваться каталог, в какую директорию. После определения директории каталога, программа попытается ее создать. При этом, вполне вероятно, могут возникнуть проблемы, связанные с правами доступа. Дайте родительской рубрике, где планируется расположить каталог, права записи 777. После создания рубрики права доступа к родительской рубрике можно сделать прежними.


Синтаксис задания относительного пути каталога стандартный:

Пример1 : Пусть админский раздел имеет урл http://linkclub.ru/catalogue/admin/.
Вы хотите поместить сгенрированый каталог в http://linkclub.ru/catalogue/.
Тогда в строке УРЛ каталога необходимо задать ../
Пример2 : Пусть админский раздел имеет урл http://linkclub.ru/admin/.
Вы хотите поместить сгенрированый каталог в http://linkclub.ru/catalogue.
Тогда в строке УРЛ каталога необходимо задать ../catalogue/
Пример3 : Пусть админский раздел имеет урл http://linkclub.ru/admin/.
Вы хотите поместить сгенрированый каталог в http://linkclub.ru/admin/catalogue.
В этом случае в строке УРЛ каталога необходимо задать catalogue/
Пример4 : Пусть админский раздел имеет урл http://linkclub.ru/php/admin/.
Вы хотите поместить сгенрированый каталог в http://linkclub.ru/catalogue.
В этом случае в строке УРЛ каталога необходимо задать ../../catalogue/

В разделе "Настройки" определяется количество ссылок на странице каталога (об этой опции подробнее см в разделе "Количество ссылок на странице" и мэйл редактора, по которому приходит извещение о добавлении новой ссылки. Мэйл редактора на страницах сгенерированного каталога появляется защищенный скриптом от спамеров.
Тут же, в "Настройках", вы можете запретить/разрешить показывать форму автоматического добавления в каталог.

ДАЛЕЕ >>