Files
D8_rplf/modules/addtocalendar/README.md
T
2018-04-23 21:14:46 +02:00

84 lines
2.5 KiB
Markdown

CONTENTS OF THIS FILE
---------------------
* Introduction
* Module Details
* Recommended modules
* Configuration
* Troubleshooting
* FAQ
* Maintainers
INTRODUCTION
------------
Add to Calendar Module integrates 'Add to Calendar' button provided by
addtocalendar.com which supports iCalender, Google Calendar, Outlook,
Outlook Online and Yahoo Calendar. It's basically a thirdparty field
formatter setting available for datetime field formatters.
MODULE DETAILS
--------------
Add to Calendar Module makes use of ADDTOCALENDAR.COM's service which
provides free button for event page on website and email. Button
supports all modern browsers and platforms: iOS, iPad, iPhone, Android,
Windows, Blackberry. Provides handful of configuration for a really
flexible experience.
Module internally extends Datetime field formatters using third party
settings to append the "Add to Calendar" button besides date field.
When clicked on this button, the event is exported to the corresponding
website with proper information in the next tab where user can add the
event to their calendar.
External CSS and JS files are provided by Addtocalendar.com
SIMILAR MODULES
---------------
* Addtocal (https://www.drupal.org/project/addtocal)
A field formatter providing a widget for exporting events to:
Google Calendar
Yahoo! Calendar
iCal
Outlook
CONFIGURATION
-------------
* Style: As of now 3 styles are available (Blue, Glow Orange and Basic).
* Display Text: Text to be displayed on the button.
* Title, Description, Location, Organizer, Organizer Email, End Date:
These are for collecting event information, which can be configured to
be collected from other fields, direct static data or tokens.
* Private: Use public for free access to event information from any
places. User private if the event is closed to public access.
* Security Level: Use https to protect your users.
* List of calenders to show in button list.
TROUBLESHOOTING
---------------
As of now, Add to calendar Module uses Addtocalandar.com service and
css, js files. In case the module is not working properly, you may try:
* Rebuilding the cache
* Reinstalling the module.
* Try different style.
MAINTAINERS
-----------
Current maintainers:
* Purushotam Rai (https://drupal.org/user/3193859)
This project has been sponsored by:
* QED42
QED42 is a web development agency focussed on helping organisations and
individuals reach their potential, most of our work is in the space of
publishing, e-commerce, social and enterprise.