Учебник Ара

© 2007-2014 Денис Суро

https://www.iqlevsha.ru/

 

Что такое Ара

?

ARA означает Atom и RSS API, это библиотека функций для обработки файлов Atom и RSS и, в частности, для создания, редактирования и отображения потоков синдикации.

Руководство посвящено редактору и генератору потоковых файлов.

Предварительное требование

Чтобы использовать Ara, ваш хостинг должен поддерживать PHP 5. Установочный файл напишет тебе, показав версию PHP. Если PHP на сайте недоступен, ничего не будет показано.
Иногда хостинг поддерживает PHP 5, но по умолчанию настроен на PHP 4. В этом случае его придется перенастроить простой строкой в .htaccess-файл, размещенный в директории Ara.

SetEnv PHP_VER 5
ou
AddType x-mapp-php5 .php

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

Программа использует фреймворк Ajax Anaa, который включен в архив.

Установка и использование

Ara - веб-страница с формой. Чтобы использовать редактор Ara, нужно установить его на веб-сайте, содержимое которого ты хочешь синдикации. Это просто загрузка содержимого архива в поддиректорию, которая по умолчанию называется ara, но название которой ты можешь выбрать.
Нужно разместить на сайте
- все файлы, имя которых начинается с Ara, а также
- anaa.js и
- install.php.

После размещения файлов на сайте ты вводишь URL (полный адрес веб-страницы) установочного файла:

https://www.iqlevsha.ru/ara/install.php

Он просит вас сохранить логин и пароль. Они необходимы перед использованием программы, чтобы иметь право создавать и обновлять RSS-файл на вашем сайте, не имея возможности изменить его по своему усмотрению.

Запиши выбранный логин и пароль, а затем удали файл install.php для меры безопасности.

Создание потока

Благодаря многочисленным автоматам, встроенным в редактор Ara с помощью PHP-скриптов, операция очень проста. Чтобы создать новый файл, введите его имя, затем введите URL-адрес статьи, которую нужно создать, и нажмите кнопку «Добавить», а затем нажмите кнопку «Создать RSS feed». И это все. Мы подробно рассмотрим эти разные этапы.

1) Логинг

В первой рамке введите логин и пароль. Затем щелкните Проверить пользователя (Check User). Вы будете оставаться на время сеанса, так что пока вы не закроете браузер.
Как только логин и пароль признаются программой, активируются две неактивные кнопки в сером виде - кнопка «Reload» и кнопка «Create an RSS feed».
Тогда тебе разрешено создавать поток.

2) Выберите имя файла

Во второй рамке можно ввести имя RSS-канала. Если вы уже создали канал, который хотите отредактировать, нажмите кнопку «Reload».
В качестве меры безопасности имя файла должно иметь расширение, и оно должно быть частью следующего списка:

.atom
.rss
.xml
.rdf

Корневой путь

Если ты хочешь создать поток rss.xml и поместить его в корень сайта, введите:

/rss.xml

Не используйте полный URL-адрес с доменным именем.
Имя для загрузки будет именем для создания или обновления файла. Но путь другой, так как функции PHP, используемые для резервного копирования XML-файла, используют локальный путь на сервере.
Однако перемещение происходит автоматически программой, а локальный путь отображается в поле пути рядом с кнопкой Create an RSS feed.

Эти вопросы о именах файлов не применяются к именам веб-страниц, содержащих статьи потока, которые будут обозначены полным URL-адресом.

3) Задать параметры

Третья форма содержит несколько вариантов:

номер объектов

Это максимальное количество статей в файле. Выберите число из выпадающего списка или введите его прямо.

добавить описание

Установите флажок для добавления описаний к элементам .

добавить дату

Установите флажок для включения даты выпуска.

4) Указать канал

Четвертая форма позволяет ввести URL-адрес сайта канала, поэтому сайт, затронутый потоком, и на который ты загрузил Ara.
Введите полный URL-адрес.
Название, описание и дату можно править, нажав кнопку Править (Edit). Редактор находится внизу страницы, мы приедем.

5) Обозначить статьи

Пятая форма позволяет ввести URL-адреса статей и содержит текстовое поле, а также кнопку Добавить для добавления URL-адреса в список.
Отметим, что URL-адреса статей проще предоставить, открыв браузер во втором окне, показывая статьи и извлекая точный URL-адрес в строке URL-адресов двойным щелчком мыши. Затем ты вводишь CTRL + C для копирования и в поле статьи Ara вводишь CTRL + V.
При добавлении URL-адреса статьи заголовок (а не URL-адрес) отображается в списке над пятой формой.
Слева от каждого заголовка отображается кнопка EDIT. Хотя описательные данные детали автоматически извлекаются со страницы, их можно изменить.

6) Редактировать описание

Форма описания является общей для канала и статей потока. Чтобы править статью, нажмите кнопку ПРАВИТЬ слева от названия в списке.
После этого можно изменить название, описание, дату.
Затем нажмите кнопку Replace под описанием.

Кнопка «Очистить поля» стирает содержимое всех полей.

Фактически можно создать элемент с нуля с помощью редактора описаний, указав URL и все элементы описания. Кнопка Replace добавляет новый элемент в список.

7) Очистить элемент

Чтобы омолодить свой поток синдикации, нужно удалить самые старые статьи, чтобы добавить новые.
Через окно редактирования ты удаляешь статью. Щелкните ПРАВИТЬ и в форме редактирования нажмите кнопку Удалить элемент.

8) Создать поток

Если ты уже ввел имя файла в форму в верхней части страницы, указал канал и добавил хотя бы одну статью, можно создать файл канала, нажав кнопку Создать RSS Feed.

Если поток был загружен в файл, путь на сервере должен отображаться в текстовом поле над кнопкой Create an RSS feed. В противном случае введите относительный путь, например/rss.xml, и нажмите кнопку Convert справа.
Также можно ввести локальный путь прямо на сервере.

Наше, что если Ara установлен в корне сайта, или ты создаешь файл в директории ara или подкаталоге, то достаточно ввести имя (возможно, с именем подкаталога) и проблем с преобразованием путей не существует.

Сделать поток видимым

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

Чтобы браузер мог распознать наличие потока, необходимо добавить следующий тег в раздел HEAD на домашней странице или на домашней странице папки для файла в формате RSS:

<link rel="alternate" type="application/rss+xml" href="https://www.iqlevsha.ru/rss.xml">

и если он в формате Atom:

<link rel="alternate" type="application/atom+xml" href="https://www.iqlevsha.ru/atom.xml">

Ты, конечно, заменяешь iqlevsha.ru доменным именем своего сайта.
А чтобы посетители могли получить к нему доступ, используется картинка со ссылкой на файл, размещенная где угодно на странице:

 <a href="rss.xml"> <img src="images/feed-24x24.png" border="0">Mon flux</a>

Что дает в 16 пикселах или в 24 пикселах.

Вопросы безопасности

Как видно, Ara заработает, только если сначала будет дан пароль. Имя пользователя и пароль выбираются тобой сам при установке. Вы оставаетесь на редакторе и можете использовать его, пока не отключитесь от сайта, что происходит, когда вы закрываете браузер или вкладку сайта.
Еще одна мера безопасности - управление типом файла. На сайте могут быть созданы только файлы с расширениями, приведенными выше.
Не забудьте стереть файл install.php после регистрации. Эта мера предосторожности, как правило, не может повлиять на ваш сайт с помощью скриптов Ara. Однако если у тебя есть сомнения в безопасности программного обеспечения, добавь комментарий на странице Ara сайта.

Условия использования

«Ара» имеет лицензию GNU GPL. Вы можете использовать его свободно и бесплатно. Вы можете изменить источник и распространить его, но сохранить авторские уведомления в файлах. Не допускается изменение программы, чтобы снять с нее меры безопасности и распространить ее в таком виде.


Дени Суро 21 июня 2007 года. Программное обеспечение и документация по .fr.