Skip to content

Commit

Permalink
feat: updated readme file.
Browse files Browse the repository at this point in the history
  • Loading branch information
vinay-osseed committed Dec 14, 2023
1 parent 876eecc commit e28d279
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 18 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# com.osseed.eventcalendar

![Screenshot](screenshot/eventcalendar.jpg)
![Screenshot](screenshot/eventcalendar.png)

[Check Event Calendar Settings](screenshot/eventsettings.png)

The extension is licensed under [AGPL-3.0](LICENSE.txt).

Expand Down Expand Up @@ -35,21 +37,26 @@ cv en eventcalendar

## Getting Started

Event Calendar Extension allows you to view all CiviCRM events in a Calendar by month,day,week.The setting page allows us to select which events should be shown on Calendar with the color we want for particular event type.The setting page configuration for event types filters allows us to filter by particular event types on calendar.
Event Calendar Extension allows you to view all CiviCRM events in a Calendar by month, day, week.
The setting page allows us to select which events should be shown on calendar with the color we want for particular event type
The setting page configuration for event types filters allows us to filter by particular event types on calendar.

## Requires

Extension required <https://www.drupal.org/project/jquery_update> module for installation with Drupal7.
Extension required <https://www.drupal.org/project/jquery_update> module for installation with Drupal 7 setup.

## Usage

1. Click Administrator->CiviEvent->Event Calendar Settings menu (civicrm/admin/event-calendar) -- change the setting if required.
1. Click `Administrator -> CiviEvent -> Event Calendar Settings (civicrm/admin/event-calendar)` menu, Please change the setting if required.
2. Now you can add multiple calendar with specific settings & preview event data as per settings on calendar.
3. Click Events->Show Events menu (civicrm/showevents) -- to view global Event Calendar with Events as per settings.
3. Click `Events->Show Events (civicrm/showevents)` menu to view global `Event Calendar` with Events as per default settings.

## Note

1. If you are using Joomla CMS then copy the folder "yourextensiondirectory/com.osseed.eventcalendar/joomla/EventCalendar" to "joomlarootdirectory/components/com_civicrm/views/" which will add menu item type for Event Calendar.
2. If you are using Wordpress CMS then copy the folder "yourextensiondirectory/com.osseed.eventcalendar/wordpress/wordpress-event-calendar" to "wordpressdirectory/wp-content/plugins/" and activate the plugin which will add CiviCRM frontend type for Event Calendar.
3. In Joomla for frontend Calendar display you need to add menu items with menu item type as `Event calendar` & configure event calendar setting id (if you have multiple calendar) under it.If you pass empty ID it will display global calendar for frontend.
4. In wordpress you need to add shortcode under page like `[event_calendar component="event-calendar"]` for displaying calendar on front-end page view.Also you can add parameter for id specific calendar if multiple calendar setting are present.
1. If you are using `Joomla` CMS then copy the folder `yourextensiondirectory/com.osseed.eventcalendar/joomla/EventCalendar` to `joomlarootdirectory/components/com_civicrm/views/` which will add menu item type for Event Calendar.

2. If you are using Wordpress CMS then copy the folder `yourextensiondirectory/com.osseed.eventcalendar/wordpress/wordpress-event-calendar` to `wordpressdirectory/wp-content/plugins/` and activate the plugin which will add CiviCRM frontend type for Event Calendar.

3. In `Joomla` for frontend calendar display you need to add menu items with menu item type as `Event calendar` & configure event calendar setting id (if you have multiple calendar) under it. If you pass empty `ID` it will display global calendar for frontend.

4. In `Wordpress` you need to add `Shortcode` under page like `[event_calendar component="event-calendar"]` for displaying calendar on front-end page view. Also you can add parameter for `id` specific the calendar `id` if multiple calendar settings are present.
25 changes: 16 additions & 9 deletions README.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# com.osseed.eventcalendar

![Screenshot](screenshot/eventcalendar.jpg)
![Screenshot](screenshot/eventcalendar.png)

[Check Event Calendar Settings](screenshot/eventsettings.png)

The extension is licensed under [AGPL-3.0](LICENSE.txt).

Expand Down Expand Up @@ -35,21 +37,26 @@ cv en eventcalendar

## Getting Started

Event Calendar Extension allows you to view all CiviCRM events in a Calendar by month,day,week.The setting page allows us to select which events should be shown on Calendar with the color we want for particular event type.The setting page configuration for event types filters allows us to filter by particular event types on calendar.
Event Calendar Extension allows you to view all CiviCRM events in a Calendar by month, day, week.
The setting page allows us to select which events should be shown on calendar with the color we want for particular event type
The setting page configuration for event types filters allows us to filter by particular event types on calendar.

## Requires

Extension required <https://www.drupal.org/project/jquery_update> module for installation with Drupal7.
Extension required <https://www.drupal.org/project/jquery_update> module for installation with Drupal 7 setup.

## Usage

1. Click Administrator->CiviEvent->Event Calendar Settings menu (civicrm/admin/event-calendar) -- change the setting if required.
1. Click `Administrator -> CiviEvent -> Event Calendar Settings (civicrm/admin/event-calendar)` menu, Please change the setting if required.
2. Now you can add multiple calendar with specific settings & preview event data as per settings on calendar.
3. Click Events->Show Events menu (civicrm/showevents) -- to view global Event Calendar with Events as per settings.
3. Click `Events->Show Events (civicrm/showevents)` menu to view global `Event Calendar` with Events as per default settings.

## Note

1. If you are using Joomla CMS then copy the folder "yourextensiondirectory/com.osseed.eventcalendar/joomla/EventCalendar" to "joomlarootdirectory/components/com_civicrm/views/" which will add menu item type for Event Calendar.
2. If you are using Wordpress CMS then copy the folder "yourextensiondirectory/com.osseed.eventcalendar/wordpress/wordpress-event-calendar" to "wordpressdirectory/wp-content/plugins/" and activate the plugin which will add CiviCRM frontend type for Event Calendar.
3. In Joomla for frontend Calendar display you need to add menu items with menu item type as `Event calendar` & configure event calendar setting id (if you have multiple calendar) under it.If you pass empty ID it will display global calendar for frontend.
4. In wordpress you need to add shortcode under page like `[event_calendar component="event-calendar"]` for displaying calendar on front-end page view.Also you can add parameter for id specific calendar if multiple calendar setting are present.
1. If you are using `Joomla` CMS then copy the folder `yourextensiondirectory/com.osseed.eventcalendar/joomla/EventCalendar` to `joomlarootdirectory/components/com_civicrm/views/` which will add menu item type for Event Calendar.

2. If you are using Wordpress CMS then copy the folder `yourextensiondirectory/com.osseed.eventcalendar/wordpress/wordpress-event-calendar` to `wordpressdirectory/wp-content/plugins/` and activate the plugin which will add CiviCRM frontend type for Event Calendar.

3. In `Joomla` for frontend calendar display you need to add menu items with menu item type as `Event calendar` & configure event calendar setting id (if you have multiple calendar) under it. If you pass empty `ID` it will display global calendar for frontend.

4. In `Wordpress` you need to add `Shortcode` under page like `[event_calendar component="event-calendar"]` for displaying calendar on front-end page view. Also you can add parameter for `id` specific the calendar `id` if multiple calendar settings are present.
Binary file added screenshot/eventcalendar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshot/eventsettings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e28d279

Please sign in to comment.