.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../Includes.txt

.. _users-manual:

Users manual
============

.. _users-manual-configuration:

Configuration
-------------

If you want to use reader on your page you have to create plugin instance inside content element and fill configuration like this on screenshot below


.. figure:: ../Images/UsersManual/PluginConfiguration.png
	:width: 600px
	:alt: Plugin Configuration

.. t3-field-list-table::
 :header-rows: 1

 - :Field:
         Setting

   :Description:
         Description

 - :Field:
         Action

   :Description:
         Selected option is used by the plugin. List shows all entries read by the extension from feed or feeds

 - :Field:
         Sort by

   :Description:
         This option gives possibility to sort entries by several fields. Available are *Feed* (based on sorted feeds list), *Guid*, *Datetime*, *Title*, *Link*, *Author*, *Teaser* and *Content*

 - :Field:
         Sort order

   :Description:
         Items can sorted in two different ways - ascending and descending

 - :Field:
         Max items in list

   :Description:
         Max items shown by list action

 - :Field:
         Max length of description

   :Description:
         Max length of description (teaser) shown in the list view. Content over that value is cropped

 - :Field:
         Show as internal item

   :Description:
         Option to render item as the internal. Link doesn't use guid to redirect to external version

 - :Field:
         Item details page

   :Description:
         Page where should be shown item. It has to contain another instance of plugin but with *Show* action

 - :Field:
         Feeds

   :Description:
         List of feeds use by the plugin. All entry has three fields: *Name*, *Feed URL* and *Social feed*. Option *Social feed* should be used when the reader will have problems to get content of the feed (e.g. Facebook's feed)

.. _users-manual-displaying:

Displaying
----------

The extension provides three default options to show entries in the system. They are *Normal*, *Slider* and *Scroller*. They work only with list view.

.. t3-field-list-table::
 :header-rows: 1

 - :Field:
         How to display

   :Description:
         Description

 - :Field:
         Normal

   :Description:
         Items list will be shown in standard way

 - :Field:
         Slider

   :Description:
         Extension will use slider to show all read entries. Built-in slider is `bxSlider`_.

 - :Field:
         Scroller

   :Description:
         Extension will use scroller to show all read entries. Built-in scroller is `mCustomScrollbar`_.

.. _bxSlider: http://bxslider.com/options
.. _mCustomScrollbar: http://manos.malihu.gr/jquery-custom-content-scroller/#configuration-section