Metadata-Version: 1.0
Name: djlime-news
Version: 0.9.1
Summary: The application of news.
Home-page: https://github.com/whitespy/djlime-news
Author: Andrey Butenko
Author-email: whitespysoftware@yandex.ru
License: BSD
Description: djlime-news
        ===========
        
        djlime-news — это простое подключаемое django-приложение, которое
        осуществляет функции добавления, редактирования и отображения новостей.
        
        Установка
        ---------
        
        Из pypi::
        
            $ pip install djlime-news
        
        или::
        
            $ easy_install djlime-news
        
        или склонировать репозитарий с github::
        
            $ git clone git://github.com/whitespy/djlime-news.git
        
        и выполнить следующие действия::
        
            $ cd djlime-news
            $ sudo python setup.py install
        
        Настройка
        ---------
        
        - Добавьте приложение news в кортеж INSTALLED_APPS::
        
            INSTALLED_APPS = (
                ...
                'news',
            )
        
        - Выполните команду python manage.py syncdb
        
        - Также необходимо добавить следующую строчку в корневой URLconf::
        
            url(r'^news/', include('news.urls')),
        
        Приложение news имеет минимальное количество настроек, которые являются не
        обязательными и могут быть переопределены в файле settings.py вашего проекта.
        
        **NEWS_IMAGES_DIR** - директория относительно MEDIA_ROOT, где будут хранится
        изображения новостей.
        Значение по умолчанию: ``news/images``.
        
        **NEWS_THUMBNAIL_SIZE** - Размер миниатюры изображения новости, отображаемой
        в списке новостей. Значением должен быть кортеж с двумя положительными,
        целочисленными элементами, хранящих значения ширины и высоты.
        Значение по умолчанию: ``(140, 140)``.
        
        **NEWS_SIDEBAR_THUMBNAIL_SIZE** - Размер миниатюры изображения новости,
        отображаемой в боковой панели сайта. Значением должен быть кортеж с двумя
        положительными, целочисленными элементами, хранящих значения ширины и высоты.
        Значение по умолчанию: ``(66, 66)``.
        
        **NEWS_ADMIN_THUMBNAIL_SIZE** - Размер миниатюры изображения новости,
        отображаемой в интерфейсе администратора. Значением должен быть кортеж с двумя
        положительными, целочисленными элементами, хранящих значения ширины и высоты.
        Значение по умолчанию: ``(60, 60)``.
        
        **NEWS_THUMBNAIL_FORMAT** - Формат файла миниатюры изображения новости.
        Значение по умолчанию: ``PNG``.
        
        **NEWS_LIST_TEMPLATE** - Шаблон для отображения списка новостей.
        Значение по умолчанию: ``news/news_list.html``.
        
        При создании пользовательских шаблонов отображения списка новостей, стоит
        помнить, что список новостей хранится в контекстной
        переменной ``news_list``.
        
        Пример пользовательского шаблона отображения списка новостей::
        
            {% block content %}
                <h1 class="page_title left">Список новостей</h1>
        
                {% for news in news_list %}
                    <div class="news">
                        <div class="thumb">
                            <a href="{% url 'news_detail' news.id %}"><img src="{{ news.thumbnail.url }}" alt="{{ news.title }}"/></a>
                        </div>
                        <div class="info">
                            <h2 class="title"><a href="{% url 'news_detail' news.id %}">{{  news.title }}</a></h2>
                            <div class="date">{{ news.pub_date|date:"j F Y" }}</div>
                            <div class="clear_both"></div>
                            <div class="body">
                                {{ news.description|safe }}
                                <a href="{% url 'news_detail' news.id %}" class="read_more_link">Подробнее</a>
                            </div>
                        </div>
                        <div class="clear_both"></div>
                    </div>
                {% endfor %}
        
                {% if news_list.has_other_pages %}
                    <div class="pagination">
                        {% for page in news_list.paginator.page_range %}
                            {% if page == news_list.number %}
                                <a href="javascript:void(0);" class="current">{{ page }}</a>
                            {% else %}
                                <a href="?page={{ page }}">{{ page }}</a>
                            {% endif %}
                        {% endfor %}
                    </div>
                {% endif %}
        
            {% endblock %}
        
        **NEWS_DETAIL_TEMPLATE** - Шаблон для отображения одной новости.
        Значение по умолчанию: ``news/news_detail.html``.
        
        При определении пользовательских шаблонов отображения новости,
        объект новости доступен через контекстную переменную
        ``news``.
        
        Пример пользовательского шаблона отображения новости::
        
            {% block content %}
                <div class="date_block">{{ news.pub_date|date:"j F Y" }}</div>
                    <div class="clear_both"></div>
                    <h1 class="news_title">{{ news.title }}</h1>
                    <div class="news_content">
                        {{ news.content|safe }}
                </div>
            {% endblock %}
        
        **NEWS_PER_PAGE** - Количество новостей отображаемых на странице при
        постраничном выводе(пагинации). Значение по умолчанию: ``4``.
        
        Контекстный процессор
        ---------------------
        
        Если вам необходимо иметь доступ с к списку новостей на любой странице
        вашего проекта, необходимо подключить контекстный процессор
        ``news.context_processors.news``::
        
            TEMPLATE_CONTEXT_PROCESSORS = (
                ...
                'news.context_processors.news'
            )
        
        После чего, в шаблонах станет доступна переменная ``news_context``,
        содержащая список всех новостей.
        
        Пример вывода списка новостей в боковой панели сайта::
        
            <div class="sidebar_list">
                {% for news in news_context|slice:":4" %}
                    <div class="item">
                        <div class="image">
                            <a href="{% url 'news_detail' news.id %}">
                               <img src="{{ news.sidebar_thumbnail.url }}" alt="{{ news.title }}" />
                            </a>
                        </div>
                        <div class="info">
                            <h4 class="title"><a href="{% url 'news_detail' news.id %}">{{ news.title }}</a></h4>
                            {{ news.description|striptags|truncatewords:8|capfirst|cut:"..." }}
                            <a href="{% url 'news_detail' news.id %}" class="read_more">...</a>
                        </div>
                        <div class="clear_both"></div>
                    </div>
                {% endfor %}
                <div class="sidebar_more">
                    <a href="{% url 'news' %}">Посмотреть все новости</a>
                </div>
            </div>
        
        Именнованные URL-щаблоны
        ------------------------
        
        **{% url 'news' %}** - Cписок новостей
        **{% url 'news_detail' news.id %}** - Новость с указанным id
        
        Поля модели News
        ----------------
        
        ::
        
            title - Строка длиной 255 символов
            pud_date - Дата и время публикации новости
            image - Изображение новости
            description - Текст краткого описания новости
            content - Содержание новости
            thumbnail - Миниатюра изображения новости для списка новостей
            sidebar_thumbnail - Миниатюра изображения новости для боковой панели сайта
            admin_thumbnail - Миниатюра изображения новости для интерфейса
            администратора
        
        Текстовые поля и интеграция текстового редактора
        ------------------------------------------------
        
        Визуальный редактор tinymce, автоматически подключится к текстовым полям
        приложения в том случае, если он уcтановлен в кортеже INSTALLED_APPS.
        
        
        
Platform: any
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
