WordPress.org
Get WordPress

Plugin Directory

Changeset 3371380


Ignore:
Timestamp:
10/01/2025 06:59:06 PM (5 months ago)
Author:
lehelm
Message:

update readme.

Location:
atomic-events-calendar
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • atomic-events-calendar/tags/1.0.3/README.md

    r3371369 r3371380  
    22Contributors: lehelm
    33Donate link: https://matyus.me/
    4 Tags: events, event, atomic events
     4Tags: events, event, calendar
    55Requires at least: 5.8
    66Tested up to: 6.8
    … …  
    1818Instead of starting from scratch on every project, Atomic Events Calendar gives you: 
    1919
    20 - A ready-to-use **Events post type** 
    21 - Essential event fields (date, venue, type, etc.) 
    22 - Developer-friendly **shortcodes** to display and filter events 
    23 - A robust **theming structure** for easy overrides and custom designs 
     20– A ready-to-use **Events post type** 
     21– Essential event fields (date, venue, type, etc.) 
     22– Developer-friendly **shortcodes** to display and filter events 
     23– A robust **theming structure** for easy overrides and custom designs 
    2424
    2525✨ Think of it as a lightweight **framework disguised as a plugin**: everything you need to set up events quickly, with the freedom to extend and customize as you like. 
    … …  
    2929== Features ==
    3030
    31 * **Developer-Friendly** - Clean code structure with services architecture
    32 * **Responsive Design** - Built with Tailwind CSS for modern, responsive layouts
    33 * **Structured Data for Search Engines** - Automatic JSON-LD schema markup for better SEO and rich snippets
    34 * **Custom Post Type** - Dedicated 'atomic-event' post type with all necessary fields
    35 * **Template Override System** - Easy theme integration with template hierarchy
    36 * **Shortcode Support** - Display events anywhere with `[atomic-events]` shortcode
    37 * **Featured Events** - Mark and display featured events prominently
    38 * **Location Management** - Complete address fields (street, city, state, country, postcode)
    39 * **Date & Time Support** - Start/end dates with time support
    40 * **Image Support** - Featured images with captions
    41 * **Member-Only Events** - Restrict events to members only
    42 * **Performance Caching** - Automatic shortcode caching with smart invalidation
     31* **Developer-Friendly** – Clean code structure with services architecture
     32* **Responsive Design** – Built with Tailwind CSS for modern, responsive layouts
     33* **Structured Data for Search Engines** – Automatic JSON-LD schema markup for better SEO and rich snippets
     34* **Custom Post Type** – Dedicated 'atomic-event' post type with all necessary fields
     35* **Template Override System** – Easy theme integration with template hierarchy
     36* **Shortcode Support** – Display events anywhere with `[atomic-events]` shortcode
     37* **Featured Events** – Mark and display featured events prominently
     38* **Location Management** – Complete address fields (street, city, state, country, postcode)
     39* **Date & Time Support** – Start/end dates with time support
     40* **Image Support** – Featured images with captions
     41* **Member-Only Events** – Restrict events to members only
     42* **Performance Caching** – Automatic shortcode caching with smart invalidation
    4343
    4444Basic usage is through shortcode:
    4545
    46 ``
    47 [atomic-events filter max='10' columns='3' featured='0' skip_first_x='0' skip skip_first_x_featured='1' order='ASC']
    48 ``
     46<code>
     47[atomic-events filter max='10' columns='3' featured='0'
     48    skip_first_x='0' skip skip_first_x_featured='1' order='ASC']
     49</code>
    4950
    5051== Installation ==
    … …  
    7071
    7172If you experience 404 errors when viewing event pages:
    72 1. Go to WordPress Admin → Events → Settings
     731. Go to WordPress Admin <span aria-hidden="true" class="wp-exclude-emoji">→</span> Events <span aria-hidden="true" class="wp-exclude-emoji">→</span> Settings
    73742. Click "Flush Rewrite Rules"
    74 3. If that doesn't work, go to Settings → Permalinks and click "Save Changes"
     753. If that doesn't work, go to Settings <span aria-hidden="true" class="wp-exclude-emoji">→</span> Permalinks and click "Save Changes"
    7576
    7677
    … …  
    7980The plugin provides a comprehensive template override system. You can override any template by creating files in your theme:
    8081
    81 <pre>
    82 your-theme/
    83 └── atomic-events/
    84 │   ├── cards/
    85 │   │   ├── card-item-default.php
    86 │   │   ├── card-item-featured.php
    87 │   │   ├── card-list-header-default.php
    88 │   │   └── card-list-footer-default.php
    89 │   ├── single/
    90 │   │   └── single-atomic-event.php
    91 │   ├── content/
    92 │   │   └── single-event.php
    93 │   │
    94 │
    95 <pre>
     82    your-theme/
     83    └── atomic-events/
     84    │   ├── cards/
     85    │   │   ├── card-item-default.php
     86    │   │   ├── card-item-featured.php
     87    │   │   ├── card-list-header-default.php
     88    │   │   └── card-list-footer-default.php
     89    │   ├── single/
     90    │   │   └── single-atomic-event.php
     91    │   ├── content/
     92    │   │   └── single-event.php
     93    │   │
     94    │
    9695
    9796=== Template Hierarchy ===
    … …  
    107106The plugin uses a custom template loader that checks for theme templates first, then falls back to the plugin's default template. This ensures:
    108107
    109 - **Theme compatibility**: Works with any WordPress theme
    110 - **Customization flexibility**: Easy to override in themes
    111 - **Update safety**: Plugin updates won't break custom templates
    112 - **Developer-friendly**: Clear hierarchy and fallback system
     108– **Theme compatibility**: Works with any WordPress theme
     109– **Customization flexibility**: Easy to override in themes
     110– **Update safety**: Plugin updates won't break custom templates
     111– **Developer-friendly**: Clear hierarchy and fallback system
    113112
    114113**Template Hierarchy Priority:**
    … …  
    119118
    120119**Available Templates:**
    121 - **Shortcode Templates**: Override how events appear in lists and grids
    122 - **Single Event Templates**: Customize individual event page layouts
    123 - **Content Templates**: Modify event content display
     120– **Shortcode Templates**: Override how events appear in lists and grids
     121– **Single Event Templates**: Customize individual event page layouts
     122– **Content Templates**: Modify event content display
    124123
    125124The default template includes:
    126 - WordPress header/footer integration
    127 - Event model for accessing custom fields
    128 - Template loader for modular content parts
    129 - Proper WordPress loop structure
     125– WordPress header/footer integration
     126– Event model for accessing custom fields
     127– Template loader for modular content parts
     128– Proper WordPress loop structure
    130129
    131130=== Custom Fields Available ===
    … …  
    133132When creating custom templates, you have access to these event fields:
    134133
    135 ```php
     134<pre>
     135<code>
    136136$event_model = new AtomicEventModel(get_the_ID());
    137137
    … …  
    156156$event_model->get_event_image_id();
    157157$event_model->get_permalink();
    158 ```
     158</code>
     159</pre>
    159160
    160161=== Creating Custom Templates ===
    … …  
    169170The plugin provides several hooks for customization:
    170171
    171 ``
     172<pre>
    172173// Filter the template path
    173174add_filter('atomic_events_template_path', 'my_custom_template_path', 10, 2);
    … …  
    178179// Filter whether to show event in lists
    179180add_filter('atomic_events_should_show_in_list', 'my_custom_visibility_logic', 10, 2);
    180 ``
     181</pre>
    181182
    182183=== Shortcode Parameters ===
    … …  
    184185The `[atomic-events]` shortcode supports these parameters:
    185186
    186 - `filter`: "future" or "past" (default: "future")
    187 - `max`: Maximum number of events (default: 20)
    188 - `columns`: Number of columns (default: 3)
    189 - `featured`: Show only featured events (true/false)
    190 - `skip_first_x`: Skip first X events
    191 - `skip_first_x_featured`: Skip first X featured events
    192 - `order`: "ASC" or "DESC" (default: "ASC")
     187– `filter`: "future" or "past" (default: "future")
     188– `max`: Maximum number of events (default: 20)
     189– `columns`: Number of columns (default: 3)
     190– `featured`: Show only featured events (true/false)
     191– `skip_first_x`: Skip first X events
     192– `skip_first_x_featured`: Skip first X featured events
     193– `order`: "ASC" or "DESC" (default: "ASC")
    193194
    194195=== Best Practices ===
    … …  
    208209Simply place a shortcode in your page content area like so:
    209210
    210 ``
    211 [atomic-events filter="future" max="10" columns="3" featured="0" skip_first_x="0" skip_first_x_featured="1" order="ASC"]
    212 ``
     211
     212    [atomic-events filter="future" max="10" columns="3" featured="0" skip_first_x="0" skip_first_x_featured="1" order="ASC"]
     213
    213214
    214215== Screenshots ==

  • atomic-events-calendar/trunk/README.md

    r3371369 r3371380  
    22Contributors: lehelm
    33Donate link: https://matyus.me/
    4 Tags: events, event, atomic events
     4Tags: events, event, calendar
    55Requires at least: 5.8
    66Tested up to: 6.8
    … …  
    1818Instead of starting from scratch on every project, Atomic Events Calendar gives you: 
    1919
    20 - A ready-to-use **Events post type** 
    21 - Essential event fields (date, venue, type, etc.) 
    22 - Developer-friendly **shortcodes** to display and filter events 
    23 - A robust **theming structure** for easy overrides and custom designs 
     20– A ready-to-use **Events post type** 
     21– Essential event fields (date, venue, type, etc.) 
     22– Developer-friendly **shortcodes** to display and filter events 
     23– A robust **theming structure** for easy overrides and custom designs 
    2424
    2525✨ Think of it as a lightweight **framework disguised as a plugin**: everything you need to set up events quickly, with the freedom to extend and customize as you like. 
    … …  
    2929== Features ==
    3030
    31 * **Developer-Friendly** - Clean code structure with services architecture
    32 * **Responsive Design** - Built with Tailwind CSS for modern, responsive layouts
    33 * **Structured Data for Search Engines** - Automatic JSON-LD schema markup for better SEO and rich snippets
    34 * **Custom Post Type** - Dedicated 'atomic-event' post type with all necessary fields
    35 * **Template Override System** - Easy theme integration with template hierarchy
    36 * **Shortcode Support** - Display events anywhere with `[atomic-events]` shortcode
    37 * **Featured Events** - Mark and display featured events prominently
    38 * **Location Management** - Complete address fields (street, city, state, country, postcode)
    39 * **Date & Time Support** - Start/end dates with time support
    40 * **Image Support** - Featured images with captions
    41 * **Member-Only Events** - Restrict events to members only
    42 * **Performance Caching** - Automatic shortcode caching with smart invalidation
     31* **Developer-Friendly** – Clean code structure with services architecture
     32* **Responsive Design** – Built with Tailwind CSS for modern, responsive layouts
     33* **Structured Data for Search Engines** – Automatic JSON-LD schema markup for better SEO and rich snippets
     34* **Custom Post Type** – Dedicated 'atomic-event' post type with all necessary fields
     35* **Template Override System** – Easy theme integration with template hierarchy
     36* **Shortcode Support** – Display events anywhere with `[atomic-events]` shortcode
     37* **Featured Events** – Mark and display featured events prominently
     38* **Location Management** – Complete address fields (street, city, state, country, postcode)
     39* **Date & Time Support** – Start/end dates with time support
     40* **Image Support** – Featured images with captions
     41* **Member-Only Events** – Restrict events to members only
     42* **Performance Caching** – Automatic shortcode caching with smart invalidation
    4343
    4444Basic usage is through shortcode:
    4545
    46 ``
    47 [atomic-events filter max='10' columns='3' featured='0' skip_first_x='0' skip skip_first_x_featured='1' order='ASC']
    48 ``
     46<code>
     47[atomic-events filter max='10' columns='3' featured='0'
     48    skip_first_x='0' skip skip_first_x_featured='1' order='ASC']
     49</code>
    4950
    5051== Installation ==
    … …  
    7071
    7172If you experience 404 errors when viewing event pages:
    72 1. Go to WordPress Admin → Events → Settings
     731. Go to WordPress Admin <span aria-hidden="true" class="wp-exclude-emoji">→</span> Events <span aria-hidden="true" class="wp-exclude-emoji">→</span> Settings
    73742. Click "Flush Rewrite Rules"
    74 3. If that doesn't work, go to Settings → Permalinks and click "Save Changes"
     753. If that doesn't work, go to Settings <span aria-hidden="true" class="wp-exclude-emoji">→</span> Permalinks and click "Save Changes"
    7576
    7677
    … …  
    7980The plugin provides a comprehensive template override system. You can override any template by creating files in your theme:
    8081
    81 <pre>
    82 your-theme/
    83 └── atomic-events/
    84 │   ├── cards/
    85 │   │   ├── card-item-default.php
    86 │   │   ├── card-item-featured.php
    87 │   │   ├── card-list-header-default.php
    88 │   │   └── card-list-footer-default.php
    89 │   ├── single/
    90 │   │   └── single-atomic-event.php
    91 │   ├── content/
    92 │   │   └── single-event.php
    93 │   │
    94 │
    95 <pre>
     82    your-theme/
     83    └── atomic-events/
     84    │   ├── cards/
     85    │   │   ├── card-item-default.php
     86    │   │   ├── card-item-featured.php
     87    │   │   ├── card-list-header-default.php
     88    │   │   └── card-list-footer-default.php
     89    │   ├── single/
     90    │   │   └── single-atomic-event.php
     91    │   ├── content/
     92    │   │   └── single-event.php
     93    │   │
     94    │
    9695
    9796=== Template Hierarchy ===
    … …  
    107106The plugin uses a custom template loader that checks for theme templates first, then falls back to the plugin's default template. This ensures:
    108107
    109 - **Theme compatibility**: Works with any WordPress theme
    110 - **Customization flexibility**: Easy to override in themes
    111 - **Update safety**: Plugin updates won't break custom templates
    112 - **Developer-friendly**: Clear hierarchy and fallback system
     108– **Theme compatibility**: Works with any WordPress theme
     109– **Customization flexibility**: Easy to override in themes
     110– **Update safety**: Plugin updates won't break custom templates
     111– **Developer-friendly**: Clear hierarchy and fallback system
    113112
    114113**Template Hierarchy Priority:**
    … …  
    119118
    120119**Available Templates:**
    121 - **Shortcode Templates**: Override how events appear in lists and grids
    122 - **Single Event Templates**: Customize individual event page layouts
    123 - **Content Templates**: Modify event content display
     120– **Shortcode Templates**: Override how events appear in lists and grids
     121– **Single Event Templates**: Customize individual event page layouts
     122– **Content Templates**: Modify event content display
    124123
    125124The default template includes:
    126 - WordPress header/footer integration
    127 - Event model for accessing custom fields
    128 - Template loader for modular content parts
    129 - Proper WordPress loop structure
     125– WordPress header/footer integration
     126– Event model for accessing custom fields
     127– Template loader for modular content parts
     128– Proper WordPress loop structure
    130129
    131130=== Custom Fields Available ===
    … …  
    133132When creating custom templates, you have access to these event fields:
    134133
    135 ```php
     134<pre>
     135<code>
    136136$event_model = new AtomicEventModel(get_the_ID());
    137137
    … …  
    156156$event_model->get_event_image_id();
    157157$event_model->get_permalink();
    158 ```
     158</code>
     159</pre>
    159160
    160161=== Creating Custom Templates ===
    … …  
    169170The plugin provides several hooks for customization:
    170171
    171 ``
     172<pre>
    172173// Filter the template path
    173174add_filter('atomic_events_template_path', 'my_custom_template_path', 10, 2);
    … …  
    178179// Filter whether to show event in lists
    179180add_filter('atomic_events_should_show_in_list', 'my_custom_visibility_logic', 10, 2);
    180 ``
     181</pre>
    181182
    182183=== Shortcode Parameters ===
    … …  
    184185The `[atomic-events]` shortcode supports these parameters:
    185186
    186 - `filter`: "future" or "past" (default: "future")
    187 - `max`: Maximum number of events (default: 20)
    188 - `columns`: Number of columns (default: 3)
    189 - `featured`: Show only featured events (true/false)
    190 - `skip_first_x`: Skip first X events
    191 - `skip_first_x_featured`: Skip first X featured events
    192 - `order`: "ASC" or "DESC" (default: "ASC")
     187– `filter`: "future" or "past" (default: "future")
     188– `max`: Maximum number of events (default: 20)
     189– `columns`: Number of columns (default: 3)
     190– `featured`: Show only featured events (true/false)
     191– `skip_first_x`: Skip first X events
     192– `skip_first_x_featured`: Skip first X featured events
     193– `order`: "ASC" or "DESC" (default: "ASC")
    193194
    194195=== Best Practices ===
    … …  
    208209Simply place a shortcode in your page content area like so:
    209210
    210 ``
    211 [atomic-events filter="future" max="10" columns="3" featured="0" skip_first_x="0" skip_first_x_featured="1" order="ASC"]
    212 ``
     211
     212    [atomic-events filter="future" max="10" columns="3" featured="0" skip_first_x="0" skip_first_x_featured="1" order="ASC"]
     213
    213214
    214215== Screenshots ==
Note: See TracChangeset for help on using the changeset viewer.