Welcome to Django Banners’s documentation!

Contents:

Установка

  • Скопируйте или склонируйте проект в папку banners в пределах области видимости
  • Добавьте url(r'^banners/', include('banners.urls')), в файл urls.py
  • Добавьте 'banners', в INSTALLED_APPS файла settings.py
  • Синхронизируйте базу данных командой manage.py syncdb
  • Соберите статику manage.py collectstatic
  • При необходимости подключите стили и скрипты модуля (вставив нижеприведённые код между тегами <head></head>)
<!-- Если используется шаблон слайдера -->
<link rel="stylesheet" href="/static/banners/css/slider.css">
<script src="/static/banners/js/slider.js" type="text/javascript"></script>

<!-- Если используется сбор статистики -->
<script src="/static/banners/js/log.js" type="text/javascript"></script>
  • Альтернативно стили и скрипты можно подключить следующим образом:
{% load staticfiles %}
<!-- Если используется шаблон слайдера -->
<link href="{%  static "banners/css/slider.css" %}" rel="stylesheet" type="text/css">

<!-- Если используется сбор статистики -->
<script src="{% static "banners/js/slider.js" %}" type="text/javascript"></script>
<script src="{% static "banners/js/log.js" %}" type="text/javascript"></script>

Зависимости

Для работы потребуется всего две библиотеки

Руководство пользователя

Создание URL

В первую очередь нужно создать URL на которых будут показываться баннеры.

В примере ниже показанно создание URL на основе регулярного выражения для всех страниц домена test.glav.it.

Добавление URL

Добавление URL

Создание групп

При создании группы указываются следующие параметры:

  • Имя
    Определяет имя группы в списке
  • Slug
    Определяет ярлык для доступа через тег
  • Ширина
    Ширина группы баннеров
  • Высота
    Высота группы баннеров
  • Скорость
    Скорость ротации баннеров
  • Публикация
    Определяет показываются ли баннеры из данной группы
Добавление группы

Добавление группы

Создание баннеров

При создании баннера указываются следующие параметры:

  • Заголовок
    Заголовок баннера
  • Альтернативный текст
    Альтернативный текст для изображения
  • Текст
    Сопроводительный текст, или HTML для рендинга
  • Изображение
    Изображение или флеш файл
  • URL
    Ссылка для перехода при клике по баннеру
  • Группа
    Группа баннеров
  • Частота
    Насколько часто показывается баннер относительно других
  • URLs
    URL на которых показывается баннер
  • Is HTML?
    Является ли баннер HTML
  • Is Flash?
    Является ли баннер Flash баннером
  • Публикация
    Будет ли баннер показывается
Добавление простого баннера

Добавление простого баннера

Добавление HTML баннера

Добавление HTML баннера

Добавление Flash баннера

Добавление Flash баннера

Вывод баннеров

Для вывода одного баннеров необходимо сначала загрузить шаблонные теги banner.

{% load banner %}

Вывод одного баннера

Один баннер выводится при помощи шаблонного тега banner_one он принимает на вход 1 обязательный параметр, ID баннера для показа. Второй необязательный параметр это шаблон вывода баннера, по умолчанию это файл banner.html.

{% load banner %}
{% banner_one 1 %}

Вывод группы баннеров

Группа баннеров выводится при помощи шаблонного тега banner_group он принимает на вход 1 обязательный параметр, Slug группы баннеров. Второй необязательный параметр это шаблон вывода группы баннеров, по умолчанию это файл group.html.

{% load banner %}
{% banner_group 'aside' %}

История изменений

Участие в проекте

  • Создайте fork проекта на github.
  • Внутри вашего проекта создайте субмодуль git при помощи: git submodule add https://github.com/_your_username_/django-banners.git banners
  • Подключите приложение согласно указаниям в разделе “Установка”
  • Внесите изменения и залейте их в свой fork
  • На сайте github создайте pull запрос для объединения с главным репозиторием https://github.com/Baltrunas/django-banners.git