Authors
=======

.. contents:: :depth: 2

General Usage
-------------

Example
*******

.. code:: xml

    <authors
        source="followers"
        source_site="current_site"
        limit="25"
        offset="50"
        template="jinja/authors.html"
    />

Attributes
**********

- ``source`` (default: *permissions*)

  - *permissions* (see: `Permissions Source <#permissions-source>`_)
  - *followers* (see: `Followers Source <#followers-source>`_)
  - *following* (see: `Following Source <#following-source>`_)
  - *search* (see: `Search Source <#search-source>`_)

- ``source_site`` (default: *current_site*) -- sets up the context

  - *current_site*

    - **author/community** -- for profile pages and community posts pages
    - **runner/roar** -- for other pages

  - *parent_site*
    - **runner/roar** -- for all pages

- ``limit`` -- sets the max number of results

- ``offset`` (default: 0) -- sets the number of results to skip

- ``template`` -- path to Jinja template that takes the following structure as input:

  - `jinja/authors.html <https://github.com/RebelMouseTeam/rebelmouse/blob/87a2ad4da65ee853461576d7feb6166fbc93c94b/engine/odysseyonline/templates/jinja/authors.html#L2>`_
  - `jinja/authors_count.html <https://github.com/RebelMouseTeam/rebelmouse/blob/752811b7ed54172b9259082b73b805016d3f5b2a/engine/odysseyonline/templates/jinja/authors_count.html#L1>`_

.. code:: python

    {
        'node': node,  # <authors> node reference
        'sites': node_input['site_data_list'],  # list of sites
        'count': node_input['total_count'],  # total number of sites
    }

Sources
-------

Permissions source
******************

Example
#######

.. code:: xml

    <authors
        source_site="current_site"
        source="permissions"
        role="editors"
        order="title"
        limit="25"
        template="jinja/authors.html"
    />

Attributes
##########

- ``role`` (default: ``none``)

  - *readers*
  - *editors*
  - *coowners*
  - *approvals*
  - *guest_writer*
  - *guest_editor*
  - *admins*
  - *developers*
  - <custom role title>

- ``order`` (default: ``none``)

  - *title*
  - *rating*


Followers source
****************

Example
#######

.. code:: xml

    <authors
        source_site="current_site"
        source="followers"
        order="rating"
        limit="25"
        template="jinja/authors.html"
    />

Attributes
##########

- ``order`` (default: ``none``)

  - *title*
  - *rating*


Following source
****************

Example
#######

.. code:: xml

    <authors
        source_site="current_site"
        source="following"
        order="rating"
        limit="25"
        template="jinja/authors.html"
    />

Attributes
##########

- ``order`` (default: ``none``)

  - *title*
  - *rating*


Search source
*************

Example
#######

.. code:: xml

    <authors
        source_site="parent_site"
        source="search"
        phrase="{{page.search_phrase}}"
        type="author"
        limit="25"
        cache_ttl_in_seconds="120"
        template="jinja/authors.html"
    />

Attributes
##########

- ``phrase`` (default: value from ``q`` query parameter)

  - Can be a specific phrase
  - Can be a Skeleton Expression

- ``type`` (default: ``author``)

  - *author*
  - *community*


Ids source
**********

Example
#######

.. code:: xml

    <authors
        source="ids"
        ids="123123,4356546,67896879"
        template="jinja/authors.html"
    />

Attributes
##########

- ``ids`` -- comma-separated list for author IDs

  - Can be a specific list
  - Can be a Skeleton Expression