asmbs/wp-schedule-builder

Build interactive agendas for scientific meetings

ScheduleBuilder

ScheduleBuilder is a WordPress plugin for building interactive agendas for scientific meetings., _(*1)

, _(*2)

Requirements

• PHP 7.0+
• A Composer-based WordPress stack like Bedrock
• Node + NPM
• The Advanced Custom Fields (ACF) Pro WordPress plugin v5.7+

Installation

1. Install with Composer:, _(*3)

   composer require asmbs/wp-schedule-builder
   

2. Activate the plugin., _(*4)

3. Go to the newly created Schedule Settings page and add the conference dates, venues, rooms and credit information for the event you're managing.
4. Start building!

Development

Requirements

• NPM
• Composer

Getting Started

To install the development dependencies, run:, _(*5)

composer install
npm install

To rebuild the assets, run:, _(*6)

npx webpack

(Requires npx), _(*7)

RESTful API

As of v5.0 this plugin is bundled with a GET only api. To enable this feature set the SCHEDULE_BUILDER_API environmental variable 1. For details on the endpoints provided please see the Schedule-Builder API documentation, _(*8)

Webhook

With the RESTful API enable it is possible to report changes to session, abstract, and person post types by setting SCHEDULE_BUILDER_WEBHOOK_URL environmental variable to an absolute URL. The webhook MUST accept HTTP POST method with a JSON body,, _(*9)

{
  "@type": "{post_type}",
  "@id": "{post_type}/{post_id}",
  "import_id": "{post_type}_{post_id}",
  "update": true|false,
  "status": publish|trash
}

Where {post_type} is either session|abstract|person and {post_id} is the Wordpress post id, _(*10)

When sending the POST request to the webhook, if the environmental variable SCHEDULE_BUILDER_WEBHOOK_AUTHORIZATION is configured its value is added as a bearer token in the request Authorization header., _(*11)

Example

The application .env file as:, _(*12)

# .env
SCHEDULE_BUILDER_WEBHOOK_AUTHORIZATION=the_webhooks_authorization_token_value

will translate to an HTTP authorization header:, _(*13)

Authorization: Bearer the_webhooks_authorization_token_value

Viewing API Documentation

Once deployed to view the API documents navigate to https://<meeting base url>/app/plugins/wp-schedule-builder/docs/ where <meetting base url> is the meetings Wordpress site's FQDN. Information on compiling the API documentation see docs/open-api.md, _(*14)