About this plugin
A collection of extra types and pieces of bonus shortcodes/functionality to help when developing a village website using WordPress. The point is to making it quicker and easier for volunteers to build the sites to help their local community grow without having to develop lots of code, or hack away using a blog post for other types of content.
Village Documents
- New post type
- Type tagging (eg. Agenda/Minutes/Newsletter)
- Shortcodes for listing and grouping
- Gives access to administrator, and also some rights to editors OOTB
- Use cases: A page listing all council minutes by month, A page listing all newsletters by month, a pod showing x most recent documents uploaded to the site
What this plugin doesn’t do
- Events * There are so many plugins already that do this well. Two that spring to mind
- Events Manager * This is the one I currently use, as time.ly has started charging for more, therefore any events features are tested with this.
- All in one events calendar (by time.ly)
- The Events Calendar * Simple output allowing some advanced theming with css without hacking away too much
- User role management * this plugin will create now permissions, but to utilize them, you will need a management plugin
- User Role Editor * Possibly a few too many options, but does all you need
- Image gallery * There are so many plugins already that do this well.
- Envira gallery lite * fast, simple, and seems reliable
More info
For further information, enable the module, and go to the settings/info page for the individual post types you would like more information on, as a lot has been put onto there for the end user.
Dependencies
- cmb2 plugin
Recommendations
- An event plugin (eg. the All-in-one event calendar from time.ly )
- “User Role Editor” plugin (can be handy IF you are playing with complex roles)
Optional
- Copy/modify the files from /template into your theme directory (eg. themes/colorway) if relevant (tweaks layout for the new types)
Shortcodes
This plugin supplies a lot of shortcodes, a few of the ones we use are:
- [rbve_events]: List of events (using a compatible events module)
- proximity: How close to today should the listed events be (for events these are events in the future)
- month
- categories: What categories should the events be tagged with (uses category ID)
- 193
- [rbve_docs]: List of document posts uplodaded to the site.
- labeltype: What format should the link to the document use for its text
- docname
- monthyear
- month
- limit-year: Whether we should only show documents for a particular year.
- 2024
- proximity: How close to today should the listed events be (for documents these are events in the past)
- month
- doctypes: What type of document to show, uses the tags set when creating the document post
- council-agenda
- council-minutes
- grouptitle: Group titles are often added automatically, this allows you to disable this title
- disabled
Usage
- Click the ‘Village Documents’ in the LHS
Troubleshooting
Links on homepage blog are going to a 404
This is usually down to how your theme is applying the homepage loop, the best fix for this (at present) would be to jump into your themes template file and find the while loop for the blog area. Once you have this you can go inside the <li> and past the below code
`php
post_type === ‘rbve_doc’) {
$post_meta = get_post_meta($post->ID);
print rbve_doc_template($post->post_title, $post_meta[‘_rbve_doc’][0]);
>
`
You will then want to find the closing </li> and add in this closing code
Please do let us know though, as there should be filters handling this now.
The new post types are not available
This can happen when you need to flush the caches, to get around this simply:
- Goto Settings > Permalinks
- Click Save
Listing pages are just showing blogs (not businesses or clubs)
- Check the variables being used (eg. use a new $args not the passed in $atts array)
Future Milestones
- 1.0.x
- If no documents returned, give some text (can be overridden with shortcode)
- improvements from feedback and usage
- new shortcodes
- Document management improvements
- Integration with Publicize (jetpack?) * so on publish, it will share the download link (to the file) with something like ‘: New uploaded ‘
- 1.1.0 * Local business/organisation post-type and shortcodes (eg. contact details, opening hours)
Other ideas
- Ability to add ‘walks and cycle rides’ to the site in a listable way, with printable maps
- Integration of events with business/organisation pages
- Ability to link an event to a business (may require time.ly)
- Some new shortcodes for the time.ly event calendar to add theming flexibility, and potential embedding on business pages
- Can the templates be handled better (eg. without template files?)
Related reading
This plugin
- https://www.smashingmagazine.com/2012/11/complete-guide-custom-post-types/
- https://codex.wordpress.org/Plugin_API/Filter_Reference
- https://codex.wordpress.org/Plugin_API/Filter_Reference/the_content
General WP links
- https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/