=== Knights of Columbus - State ===
Contributors: falcon13
Donate link: https://onthegridwebdesign.com/software/kofc-state-plugin/
Tags: knights of columbus, widget, shortcode, kofc, catholic, council directory, nonprofit, directory
Requires at least: 4.0
Tested up to: 7.0
Requires PHP: 5.6
Stable tag: 2.5.3
License: GPLv3

A WordPress plugin for Knights of Columbus State Councils — council and assembly directories, recruiting scoreboards and Star Council tracking.

== License ==
Released under the terms of the GNU General Public License.

== Description ==
Knights of Columbus – State is a WordPress plugin built specifically for Knights of Columbus State Councils. It provides a directory and scoreboard system for managing and displaying Councils, Assemblies and individual Knights on your state council website.

Originally built for the Utah Knights of Columbus State Council, it is freely available to any KofC state council website running WordPress.

= Who Is This For? =
This plugin is designed for Knights of Columbus State Council websites. If you manage a state council website and need a directory of councils and assemblies, a recruiting scoreboard or a Star Council tracking page, this plugin was built for you.

= How It Works =
The plugin adds three custom post types — Councils, Assemblies, and Knights — each with their own pages and built-in contact forms so visitors can reach out directly. Shortcodes let you display council and assembly directories, recruiting scoreboards by knight, council, or district, and Star Council requirement tracking anywhere on your site.

= Features =
* Council, Assembly, and Knight custom post types with individual pages
* Built-in contact/email forms on each page with spam protection via hCaptcha
* Shortcode for displaying a council directory as a table or visual box list
* Shortcode for displaying an assembly directory as a table or visual box list
* Recruiting scoreboard shortcode — display by knight, council, or district
* Star Council requirements scoreboard shortcode
* Inbound messages stored in the admin for easy reference
* Configurable number of districts to match your state council's structure

= Use Cases =
* Council Directory — Display all councils and assemblies in your state with individual pages that includes a contact form.
* Recruiting Scoreboard — Track and publicly display recruiting numbers by individual knight, council, or district to encourage friendly competition and recognize top recruiters.
* Star Council Tracker — Show which Star Council program requirements each council has completed, keeping the whole state informed and motivated.
* Member Contact — The knight post type generates a page that includes a built-in contact form so prospective members and the public can reach out easily.

DISCLAIMER: Under no circumstances do we release this plugin with any warranty, implied or otherwise. We cannot be held responsible for any damage that might arise from the use of this plugin. Back up your WordPress database and files before installation.

== Installation ==
After activating go to the settings page. Here you can set the number of districts you have. To enable spam reduction on the email forms, Google reCaptcha keys are required. Links to the settings page are under Settings in the admin and on the plugins page.
The admin menu will have the two new post types in the main admin menu along with the Scoreboard and Inbound Messages menu items.

= Knight and Council Pages =
Once you create a knight or council post, you can link it to its page:
http://[site.domain]/knight/[post-title]
http://[site.domain]/council/[council #]
http://[site.domain]/assembly/[assembly #]

== Shortcode [otgkofcs_scoreboard] ==
= Options =
type: "councils", "knights" or "districts" (default: none)

= Examples =
[otgkofcs_scoreboard type="knights"]
[otgkofcs_scoreboard type="councils"]

== Shortcode [otgkofcs_star_reqs] ==
No options

= Examples =
[otgkofcs_star_reqs]

== Shortcode [otgkofcs_council_table] and [otgkofcs_assembly_table] ==
These create a table with no additional styling (it uses the themes styling for a table). For styling create a css class and add its name in the options.
= Options =
class: css class for the table

= Examples =
[otgkofcs_council_directory class="pretty_table"]

== Shortcode [otgkofcs_council_box_list] & [otgkofcs_assembly_box_list] ==
No options

= Examples =
[otgkofcs_council_box_list]

== Screenshots ==
1. Individual council page with built-in contact form
2. Admin Add Council Page
3. Star Council requirements tracker — shows completion status for each council
4. Recruiting scoreboard by knight, council, and district
5. Admin Star Requirements Page
6. Admin Council List Page - where you enter info about the council
7. Admin Settings Page
8. Admin Add Knight Page

== Changelog ==
2.5.3 (6/10/2026)
- Updated Datatables Javascript library to version 2.3.8.
- Changed table row styles to use even/odd psuedo classes due to the classes not always being added to <tr> tag when tbody is generated.

2.5.2 (6/12/2025)
- Council scoreboard view link fix and change percentage to no decimal places.
- Add default to link filter function.

2.5.1 (4/10/2025)
- A filter function that was being used for output filtering was removed in last updated. Replaced it with htmlentities.

2.5.0 (9/10/2024)
- Updated validation and filter helper functions, including splitting validation and filter functions into separate helper files.

2.4.4 (6/1/2024)
- Small tweaks

2.4.3 (5/5/2023)
- Tweaked forms

2.4.2 (12/8/2022)
- Updated validation and view helpers. Code improvements.
- Datatables JS library update.

2.4.1 (2/27/2022)
- Fixed council type edit page not showing the saved charter date.

2.4 (2/6/2022)
- Replaced reCaptcha with hCaptcha
- Added assembly to council.
- Changed lists to use datatables (except post types). Also merged setting knights scores into the knights list (non-post type).

2.3 (5/14/2020)
- Added Assembly post type
- Enhanced council table and box list shortcodes and added copies of them for assemblies
- The otgkofcs_council_directory shortcode was replaced with otgkofcs_council_table and will be removed in a future version

2.2.2 (4/20/2019)
- Added jQuery UI Stylesheet

2.2.1 (4/18/2019)
- First WordPress Directory release.
- Minor wording and style changes.

2.2.0 (3/12/2019)
- Updated all form data to go through filters.
- Made frontend type pages theme independent.
- Added more sorting to post types and list pages in admin.
- The original shortcode [otgkofcs] renamed [otgkofcs_scoreboard]
- Checked for and remove/updated outdated and unsecure code.
- Checked for and fixed function and other names were not using standards for this plugin.
- Small bug fixes.

2.1.0 (11/11/2018)
- Added charter date to councils.
- Added sender name & email into message body and sender name into from.

2.0.0 (6/6/2018)
- Change from just a recruiting and star council scoreboard to handling directory listings.
- Knight and Council post types added.
- Old council table and related admin removed; scoreboard uses post type list.
- Added storage for message sent through post type pages.
- Council directory list shortcode.

== Frequently Asked Questions ==

= Are the knights on the scoreboard and the knights post type the same? =
* No. They are separate. The Knight post type is for the directory and stores more detailed information with its own page and contact form. The knights used in the scoreboard are only for tracking and displaying recruiting numbers.
= Will there be a council finder for prospective and new members? =
* Yes, a council finder is planned for a future version.
= Can you make creating state office holders and program directors lists that use the knight post type? =
* Yes, lists for state office holders and program directors using the Knight post type are also planned.
directory and scoreboard system.
= Is this plugin only for state councils or can local councils use it too? =
* The knights post type and knights scoreboard could be used by councils, but it is not designed for that.
= Does it work with any WordPress theme? =
* Yes. The frontend pages are designed to be theme independent and will inherit your theme's basic styling. Table shortcodes use your theme's table styles. Additional CSS customization is always possible.
= How do I set up spam protection on the contact forms? =
* The plugin uses hCaptcha for spam reduction on all email contact forms. You will need a free hCaptcha account to get your site key and secret key, which are entered on the plugin settings page. If those keys are not entered, the hCaptcha is disabled.
= What was in version 1.0? =
* The first version was only a scoreboard under a different name. It was not publicly released and was only used on the Utah Knights of Columbus website. Version 2.0 expanded it into a full