Authors
=======
.. contents:: :depth: 2
General Usage
-------------
Example
*******
.. code:: xml
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 `_
- `jinja/authors_count.html `_
.. code:: python
{
'node': node, # 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
Attributes
##########
- ``role`` (default: ``none``)
- *readers*
- *editors*
- *coowners*
- *approvals*
- *guest_writer*
- *guest_editor*
- *admins*
- *developers*
-
- ``order`` (default: ``none``)
- *title*
- *rating*
Followers source
****************
Example
#######
.. code:: xml
Attributes
##########
- ``order`` (default: ``none``)
- *title*
- *rating*
Following source
****************
Example
#######
.. code:: xml
Attributes
##########
- ``order`` (default: ``none``)
- *title*
- *rating*
Search source
*************
Example
#######
.. code:: xml
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
Attributes
##########
- ``ids`` -- comma-separated list for author IDs
- Can be a specific list
- Can be a Skeleton Expression