WordPress.org
Get WordPress

Plugin Directory

Changeset 3261546


Ignore:
Timestamp:
03/25/2025 12:47:59 PM (12 months ago)
Author:
dramb
Message:

Minor comment changes

Location:
cs-integration
Files:
14 edited

Legend:

Unmodified
Added
Removed

  • cs-integration/tags/1.0.3/README.md

    r3257921 r3261546  
    3232
    3333
    34 ### A little Technical information
     34## A little Technical information
    3535
    3636For the technical among you: This shortcode works on the 'server side',
    … …  
    3838Future updates will provide 'client side' javascript alternative shortcodes
    3939so that you can choose where the processing is done.
     40
     41
     42### Difference between this plugin and cs-js-integration
     43
     44We also provide the `cs-js-integration` plugin.  That plugin uses the more
     45recent v3 ChurchSuite API which does permit such flexibility because it
     46requires you to create a ChurchSuite 'embed configuration' to pass in the
     47shortcode call.  It also does all the work on the 'client side' so that
     48the client browser holds the cached data and the client browser creates all
     49the html for output.  That plugin use Javascript to create the response
     50whereas this plugin uses php.  This server-side implementation can be faster
     51for many repeated requests, and is less speed dependent on the client
     52provision. However the client-side implementation can be faster for an
     53individual user. The cs-js-integration plugin uses Alpine.js to output the
     54HTML, which means an end user could change the output by changing the HTML
     55files without having to get into the php of the plugin. However, the
     56Alpine.js code isn't straightforward and so this is likely to be of little
     57advantage. Really, it's simply 'horses for courses' - you have the choice
     58of which to use!
    4059
    4160
    … …  
    148167### The shortcode produces no output
    149168
    150     The default behaviour when there is an error is to give no output rather
    151     than produce error messages all over your website.  Check that you have
    152     supplied the correct churchname, or test it with the churchname 'cambray'
    153     to see if that is the problem.  Check that you can actually get to your
    154     ChurchSuite JSON api url - try entering the following URL in a browser
    155     with your church name instead of `mychurch`:
    156 
    157         https://mychurch.churchsuite.com/embed/calendar/json?num_results=3
     169The default behaviour when there is an error is to give no output rather
     170than produce error messages all over your website.  Check that you have
     171supplied the correct churchname, or test it with the churchname 'cambray'
     172to see if that is the problem.  Check that you can actually get to your
     173ChurchSuite JSON api url - try entering the following URL in a browser
     174with your church name instead of `mychurch`:
     175
     176    https://mychurch.churchsuite.com/embed/calendar/json?num_results=3
    158177
    159178### How do I add my church so that I get the JSON feed for my church?
    160179
    161     You must use the shortcode `church_name` parameter:
     180You must use the shortcode `church_name` parameter:
    162181
    163182        [cs-event-cards church_name="mychurch" num_results="3"]
    … …  
    165184### I want to limit the number of events in the shortcode
    166185
    167     You can use a shortcode parameter for showing a particular number of events:
    168 
    169         [cs-events-list church_name="mychurch" num_results="6"]
     186You can use a shortcode parameter for showing a particular number of events:
     187
     188    [cs-events-list church_name="mychurch" num_results="6"]
    170189
    171190### I want to change how the output looks:
    172191
    173     The output is formatted via css - just override the defaults in your theme
     192The output is formatted via css - just override the defaults in your theme
    174193
    175194

  • cs-integration/tags/1.0.3/README.txt

    r3257921 r3261546  
    3232
    3333
    34 == A little Technical information
     34== A little Technical information ==
    3535For the technical among you: This shortcode works on the 'server side',
    3636building the response which is delivered to your browser from churchsuite.
    37 Future updates will provide 'client side' javascript alternative shortcodes
    38 so that you can choose where the processing is done.
     37
     38
     39= Difference between this plugin and cs-js-integration =
     40
     41We also provide the `cs-js-integration` plugin.  That plugin uses the more
     42recent v3 ChurchSuite API which does permit such flexibility because it
     43requires you to create a ChurchSuite 'embed configuration' to pass in the
     44shortcode call.  It also does all the work on the 'client side' so that
     45the client browser holds the cached data and the client browser creates all
     46the html for output.  That plugin use Javascript to create the response
     47whereas this plugin uses php.  This server-side implementation can be faster
     48for many repeated requests, and is less speed dependent on the client
     49provision. However the client-side implementation can be faster for an
     50individual user. The cs-js-integration plugin uses Alpine.js to output the
     51HTML, which means an end user could change the output by changing the HTML
     52files without having to get into the php of the plugin. However, the
     53Alpine.js code isn't straightforward and so this is likely to be of little
     54advantage. Really, it's simply 'horses for courses' - you have the choice
     55of which to use!
     56
    3957
    4058

  • cs-integration/tags/1.0.3/admin/class-cs-integration-admin.php

    r3257115 r3261546  
    33namespace amb_dev\CSI;
    44
    5 
    6 /**
    7  * The admin-specific functionality of the plugin.
    8  *
    9  * @link       https://https://github.com/AlwynBarry
    10  * @since      1.0.0
    11  *
    12  * @package    Cs_Integration
    13  * @subpackage Cs_Integration/admin
    14  */
    155
    166/**
    … …  
    2212 * Defines the plugin name, version, and two examples hooks for how to
    2313 * enqueue the admin-specific stylesheet and JavaScript.
     14 *
     15 * @link       https://https://github.com/AlwynBarry
     16 * @since      1.0.0
    2417 *
    2518 * @package    Cs_Integration

  • cs-integration/tags/1.0.3/includes/class-cs-integration-deactivator.php

    r3257115 r3261546  
    33namespace amb_dev\CSI;
    44
    5 /**
    6  * Fired during plugin deactivation
    7  *
    8  * @link       https://https://github.com/AlwynBarry
    9  * @since      1.0.0
    10  *
    11  * @package    Cs_Integration
    12  * @subpackage Cs_Integration/includes
    13  */
    145
    156/**
    … …  
    189 * This class defines all code necessary to run during the plugin's deactivation.
    1910 *
     11 * @link       https://https://github.com/AlwynBarry
    2012 * @since      1.0.0
    2113 * @package    Cs_Integration

  • cs-integration/tags/1.0.3/includes/class-cs-integration-i18n.php

    r3257115 r3261546  
    33namespace amb_dev\CSI;
    44
     5
    56/**
    6  * Define the internationalization functionality
     7 * Define the internationalization functionality.
    78 *
    89 * Loads and defines the internationalization files for this plugin
    … …  
    1011 *
    1112 * @link       https://https://github.com/AlwynBarry
    12  * @since      1.0.0
    13  *
    14  * @package    Cs_Integration
    15  * @subpackage Cs_Integration/includes
    16  */
    17 
    18 /**
    19  * Define the internationalization functionality.
    20  *
    21  * Loads and defines the internationalization files for this plugin.
    22  *
    2313 * @since      1.0.0
    2414 * @package    Cs_Integration
    … …  
    4535
    4636
    47 
    4837}

  • cs-integration/tags/1.0.3/includes/class-cs-integration-loader.php

    r3257115 r3261546  
    33namespace amb_dev\CSI;
    44
    5 /**
    6  * Register all actions and filters for the plugin
    7  *
    8  * @link       https://https://github.com/AlwynBarry
    9  * @since      1.0.0
    10  *
    11  * @package    Cs_Integration
    12  * @subpackage Cs_Integration/includes
    13  */
    145
    156/**
    … …  
    2011 * run function to execute the list of actions and filters.
    2112 *
     13 * @link       https://https://github.com/AlwynBarry
     14 * @since      1.0.0
    2215 * @package    Cs_Integration
    2316 * @subpackage Cs_Integration/includes

  • cs-integration/tags/1.0.3/includes/class-cs-integration.php

    r3257115 r3261546  
    22
    33namespace amb_dev\CSI;
    4 
    5 
    6 /**
    7  * The file that defines the core plugin class
    8  *
    9  * This class includes attributes and functions used across both the
    10  * public-facing side of the site and the admin area.
    11  *
    12  * @link       https://https://github.com/AlwynBarry
    13  * @since      1.0.0
    14  *
    15  * @package    Cs_Integration
    16  * @subpackage Cs_Integration/includes
    17  */
    184
    195
    … …  
    2713 * version of the plugin.
    2814 *
     15 * @link       https://https://github.com/AlwynBarry
    2916 * @since      1.0.0
    3017 * @package    Cs_Integration
    … …  
    123110         * side of the site.
    124111         */
    125         require_once plugin_dir_path( dirname( __FILE__ ) ) . 'public/class-cs-integration-public.php';
    126        
     112        require_once plugin_dir_path( dirname( __FILE__ ) ) . 'public/class-cs-integration-public.php';
    127113
    128114        $this->loader = new Cs_Integration_Loader();

  • cs-integration/trunk/README.md

    r3257921 r3261546  
    3232
    3333
    34 ### A little Technical information
     34## A little Technical information
    3535
    3636For the technical among you: This shortcode works on the 'server side',
    … …  
    3838Future updates will provide 'client side' javascript alternative shortcodes
    3939so that you can choose where the processing is done.
     40
     41
     42### Difference between this plugin and cs-js-integration
     43
     44We also provide the `cs-js-integration` plugin.  That plugin uses the more
     45recent v3 ChurchSuite API which does permit such flexibility because it
     46requires you to create a ChurchSuite 'embed configuration' to pass in the
     47shortcode call.  It also does all the work on the 'client side' so that
     48the client browser holds the cached data and the client browser creates all
     49the html for output.  That plugin use Javascript to create the response
     50whereas this plugin uses php.  This server-side implementation can be faster
     51for many repeated requests, and is less speed dependent on the client
     52provision. However the client-side implementation can be faster for an
     53individual user. The cs-js-integration plugin uses Alpine.js to output the
     54HTML, which means an end user could change the output by changing the HTML
     55files without having to get into the php of the plugin. However, the
     56Alpine.js code isn't straightforward and so this is likely to be of little
     57advantage. Really, it's simply 'horses for courses' - you have the choice
     58of which to use!
    4059
    4160
    … …  
    148167### The shortcode produces no output
    149168
    150     The default behaviour when there is an error is to give no output rather
    151     than produce error messages all over your website.  Check that you have
    152     supplied the correct churchname, or test it with the churchname 'cambray'
    153     to see if that is the problem.  Check that you can actually get to your
    154     ChurchSuite JSON api url - try entering the following URL in a browser
    155     with your church name instead of `mychurch`:
    156 
    157         https://mychurch.churchsuite.com/embed/calendar/json?num_results=3
     169The default behaviour when there is an error is to give no output rather
     170than produce error messages all over your website.  Check that you have
     171supplied the correct churchname, or test it with the churchname 'cambray'
     172to see if that is the problem.  Check that you can actually get to your
     173ChurchSuite JSON api url - try entering the following URL in a browser
     174with your church name instead of `mychurch`:
     175
     176    https://mychurch.churchsuite.com/embed/calendar/json?num_results=3
    158177
    159178### How do I add my church so that I get the JSON feed for my church?
    160179
    161     You must use the shortcode `church_name` parameter:
     180You must use the shortcode `church_name` parameter:
    162181
    163182        [cs-event-cards church_name="mychurch" num_results="3"]
    … …  
    165184### I want to limit the number of events in the shortcode
    166185
    167     You can use a shortcode parameter for showing a particular number of events:
    168 
    169         [cs-events-list church_name="mychurch" num_results="6"]
     186You can use a shortcode parameter for showing a particular number of events:
     187
     188    [cs-events-list church_name="mychurch" num_results="6"]
    170189
    171190### I want to change how the output looks:
    172191
    173     The output is formatted via css - just override the defaults in your theme
     192The output is formatted via css - just override the defaults in your theme
    174193
    175194

  • cs-integration/trunk/README.txt

    r3257921 r3261546  
    3232
    3333
    34 == A little Technical information
     34== A little Technical information ==
    3535For the technical among you: This shortcode works on the 'server side',
    3636building the response which is delivered to your browser from churchsuite.
    37 Future updates will provide 'client side' javascript alternative shortcodes
    38 so that you can choose where the processing is done.
     37
     38
     39= Difference between this plugin and cs-js-integration =
     40
     41We also provide the `cs-js-integration` plugin.  That plugin uses the more
     42recent v3 ChurchSuite API which does permit such flexibility because it
     43requires you to create a ChurchSuite 'embed configuration' to pass in the
     44shortcode call.  It also does all the work on the 'client side' so that
     45the client browser holds the cached data and the client browser creates all
     46the html for output.  That plugin use Javascript to create the response
     47whereas this plugin uses php.  This server-side implementation can be faster
     48for many repeated requests, and is less speed dependent on the client
     49provision. However the client-side implementation can be faster for an
     50individual user. The cs-js-integration plugin uses Alpine.js to output the
     51HTML, which means an end user could change the output by changing the HTML
     52files without having to get into the php of the plugin. However, the
     53Alpine.js code isn't straightforward and so this is likely to be of little
     54advantage. Really, it's simply 'horses for courses' - you have the choice
     55of which to use!
     56
    3957
    4058

  • cs-integration/trunk/admin/class-cs-integration-admin.php

    r3257115 r3261546  
    33namespace amb_dev\CSI;
    44
    5 
    6 /**
    7  * The admin-specific functionality of the plugin.
    8  *
    9  * @link       https://https://github.com/AlwynBarry
    10  * @since      1.0.0
    11  *
    12  * @package    Cs_Integration
    13  * @subpackage Cs_Integration/admin
    14  */
    155
    166/**
    … …  
    2212 * Defines the plugin name, version, and two examples hooks for how to
    2313 * enqueue the admin-specific stylesheet and JavaScript.
     14 *
     15 * @link       https://https://github.com/AlwynBarry
     16 * @since      1.0.0
    2417 *
    2518 * @package    Cs_Integration

  • cs-integration/trunk/includes/class-cs-integration-deactivator.php

    r3257115 r3261546  
    33namespace amb_dev\CSI;
    44
    5 /**
    6  * Fired during plugin deactivation
    7  *
    8  * @link       https://https://github.com/AlwynBarry
    9  * @since      1.0.0
    10  *
    11  * @package    Cs_Integration
    12  * @subpackage Cs_Integration/includes
    13  */
    145
    156/**
    … …  
    189 * This class defines all code necessary to run during the plugin's deactivation.
    1910 *
     11 * @link       https://https://github.com/AlwynBarry
    2012 * @since      1.0.0
    2113 * @package    Cs_Integration

  • cs-integration/trunk/includes/class-cs-integration-i18n.php

    r3257115 r3261546  
    33namespace amb_dev\CSI;
    44
     5
    56/**
    6  * Define the internationalization functionality
     7 * Define the internationalization functionality.
    78 *
    89 * Loads and defines the internationalization files for this plugin
    … …  
    1011 *
    1112 * @link       https://https://github.com/AlwynBarry
    12  * @since      1.0.0
    13  *
    14  * @package    Cs_Integration
    15  * @subpackage Cs_Integration/includes
    16  */
    17 
    18 /**
    19  * Define the internationalization functionality.
    20  *
    21  * Loads and defines the internationalization files for this plugin.
    22  *
    2313 * @since      1.0.0
    2414 * @package    Cs_Integration
    … …  
    4535
    4636
    47 
    4837}

  • cs-integration/trunk/includes/class-cs-integration-loader.php

    r3257115 r3261546  
    33namespace amb_dev\CSI;
    44
    5 /**
    6  * Register all actions and filters for the plugin
    7  *
    8  * @link       https://https://github.com/AlwynBarry
    9  * @since      1.0.0
    10  *
    11  * @package    Cs_Integration
    12  * @subpackage Cs_Integration/includes
    13  */
    145
    156/**
    … …  
    2011 * run function to execute the list of actions and filters.
    2112 *
     13 * @link       https://https://github.com/AlwynBarry
     14 * @since      1.0.0
    2215 * @package    Cs_Integration
    2316 * @subpackage Cs_Integration/includes

  • cs-integration/trunk/includes/class-cs-integration.php

    r3257115 r3261546  
    22
    33namespace amb_dev\CSI;
    4 
    5 
    6 /**
    7  * The file that defines the core plugin class
    8  *
    9  * This class includes attributes and functions used across both the
    10  * public-facing side of the site and the admin area.
    11  *
    12  * @link       https://https://github.com/AlwynBarry
    13  * @since      1.0.0
    14  *
    15  * @package    Cs_Integration
    16  * @subpackage Cs_Integration/includes
    17  */
    184
    195
    … …  
    2713 * version of the plugin.
    2814 *
     15 * @link       https://https://github.com/AlwynBarry
    2916 * @since      1.0.0
    3017 * @package    Cs_Integration
    … …  
    123110         * side of the site.
    124111         */
    125         require_once plugin_dir_path( dirname( __FILE__ ) ) . 'public/class-cs-integration-public.php';
    126        
     112        require_once plugin_dir_path( dirname( __FILE__ ) ) . 'public/class-cs-integration-public.php';
    127113
    128114        $this->loader = new Cs_Integration_Loader();
Note: See TracChangeset for help on using the changeset viewer.