Skip to content

Latest commit

 

History

History
181 lines (138 loc) · 9.96 KB

README.md

File metadata and controls

181 lines (138 loc) · 9.96 KB
Raw

oik

banner

Over 80 advanced, powerful shortcodes, and 9 blocks for displaying the content of your WordPress website.

Description

Now with 9 blocks:

  • Address - Displays your address from oik-options
  • Contact form - Displays a contact form
  • Contact field - Part of the Contact form
  • Countdown - Countdown / count since timer
  • Dynamic content - Dynamic content block
  • Follow me - Displays your social media links
  • Google Maps - Displays a Google Maps map using oik options
  • PayPal button - PayPal button for: Pay Now, Buy Now, Donate, Add to Cart, and View Cart / Checkout
  • Shortcode block for oik shortcodes - Expands oik shortcodes

The oik base plugin provides a series of advanced WordPress shortcodes that help you display dynamic content from your website's pages, posts, attachments, links and custom post types. The OIK Information Kit uses lazy smart shortcode technology to display your WordPress website's content including your often included key-information. The functionality in the oik base plugin is used by over 40 other WordPress plugins, providing powerful facilities for an efficient, performant website.

oik now provides over 80 shortcodes including:

  • [bw_pages], [bw_posts], [bw_thumbs], [bw_attachments], [bw_images], [bw_pdf] shortcodes to list subpages, posts, attachments or custom post types
  • [bw_cycle] to display content using jQuery cycle.
  • [bw_list], [bw_tree] to display lists of links to pages, posts, attachments or custom post types
  • [bw_table] to tabulate pages, posts or custom post types
  • [bw_bookmarks] to list links
  • [paypal] shortcodes for PayPal buttons: Pay Now, Buy Now, Donate, Add to Cart, View Cart/Checkout
  • [bw_block] & [bw_eblock], [div] & [ediv], [clear] - to create block structures within your pages, posts and even widgets
  • [bw_button], [bw_contact_button] - to provide call-to-action button style links for Artisteer themes
  • helper shortcodes for web designers and developers: [bw_editcss], [bwtrace], [bw_wpadmin], [bw_wtf], [stag] & [etag]

oik helps you to display information about you, your company, your social networking ids and your website using standard formats that search engines such as Google recognise.

  • You enter your information once, then use oik shortcodes to display it wherever you want; in titles, post and page content, header, sidebar and footer widgets.
  • Whenever you need to change a value you only need to update it in one place; and your website is updated instantly.
  • Shortcodes to display often included key information include: [bw_contact], [bw_telephone], [bw_mobile], [bw_mailto], [bw_company], [bw_address], [bw_show_googlemap], [bw_directions], [bw_logo], [bw_qrcode], [bw_copyright]
  • For your social networking use the [bw_follow_me] shortcode to display your links to Twitter, Facebook, LinkedIn, etcetera

Features:

  • oik provides buttons to help you write the shortcodes, showing you the parameters you can choose and default values
  • oik provides a shortcode discovery page where you can find out about every shortcode which is active in your site
  • lazy programming means that code is only loaded when it's actually needed
  • smart means that the shortcodes can recognise the content in which they're used and adjust their behaviour accordingly
  • oik is extendable - plugin developers can build on the oik base functionality
  • using the oik API: help, syntax information, examples AND HTML snippets can be produced for any plugin or theme that provides shortcodes
  • oik is theme independent; meaning that you can change your theme without having to worry about whether or not the shortcodes will still work.
  • oik uses microformats so that Google and other search engines can understand your content.

Installation

See Frequently Asked Questions

Frequently Asked Questions

Installation

  1. Upload the contents of the oik plugin to the `/wp-content/plugins/oik' directory
  2. Activate the oik base plugin through the 'Plugins' menu in WordPress
  3. Go to oik options > options to fill in your often included key information
  4. Use the blocks or shortcodes when writing your content

Where is the FAQ?

oik FAQ

Is there a support forum?

Yes - please use the oik plugin forum

Can I get support?

Yes - see above

Where are the blocks documented?

oik blocks

For blocks of many other WordPress plugins ( including WordPress SEO, Jetpack, WooCommerce ) see blocks.wp-a2z.org

Where are the shortcodes documented?

oik shortcodes

The shortcode reference includes the standard WordPress shortcodes and help for shortcodes provided by other oik plugins.

For other popular WordPress plugins (e.g. Jetpack, Easy-Digital-Downloads, WooCommerce) see WP-a2z.org

Screenshots

  1. oik options - Options
  2. Demonstrating [bw_pages] and [bw_thumbs]
  3. [bw_contact_form] - Contact form and [bw_show_googlemap] - Google Map
  4. Option to display post IDs on admin pages
  5. Custom CSS button
  6. oik button dialog - to create the [bw_button] shortcode
    1. oik PayPal dialog - create PayPal buttons: Pay Now, Buy Now, Donate, Add to Cart and View Cart/Checkout
  1. oik shortcodes dialog - showing syntax for [bw_block]
  2. oik options - Shortcode help - lists ALL active shortcodes
  3. oik options - Buttons

Upgrade Notice

4.14.0

Improved support for block based themes. New shortcode [bw_x] to replace [bw_twitter].

Changelog

4.14.0

  • Changed: Update [bw_follow_me] to support X #231
  • Added: [bw_x] shortcode to replace [bw_twitter] #231
  • Added: Add bw_block_theme_extras. Automatically enable oik shortcodes for block based themes #233
  • Tested: With WordPress 6.7-beta3 and WordPress Multisite
  • Tested: With PHP 8.3
  • Tested: With PHPUnit 9.6

Further reading

If you want to read more about the oik plugins then please visit the oik plugin "the oik plugin - for often included key-information"

Other plugins

Other plugins which depend upon the oik API are available on WordPress.org:

  • bbboing - obfuscate text but leave it readable
  • cookie-cat - [cookies] shortcode to list the cookies your website may use
  • oik-batchmove - batch change post categories or published date
  • oik-nivo-slider - [nivo] shortcode for the jQuery "Nivo slider" for posts, pages, attachments and custom post types
  • oik-privacy-policy - generate a privacy policy page, compliant with UK cookie law (EU cookie directive)
  • oik-read-more - progressively reveal content by clicking on "read more" buttons

Plugins which participate with oik shared libraries are:

  • oik-bwtrace - Debug trace for WordPress, including action and filter tracing
  • oik-css - [bw_css] for CSS styling per page
  • uk-tides - [bw_tides] shortcode for tide times and heights in the UK (replaces oik-tides)

These plugins are not dependent upon oik:

More FREE and Premium plugins are available from oik-plugins.com including:

oik plugins are suitable for:

  • WordPress site owners
  • WordPress site administrators
  • WordPress designers
  • WordPress web site developers
  • WordPress plugin developers

oik plugins are tested with:

  • WordPress
  • WordPress Multisite
  • PHP 8.1, PHP 8.2 and PHP 8.3
  • PHPUnit 9.6

All of the plugins are developed using a set of functions that can make PHP and HTML coding a bit easier. These are known as the OIK Application Programming Interface (OIK API)