Trade Southwest - Sunday, April 7th, 2019Comments Off on Documentation
Installation This section describes how to install the plugin and get it working.
Upload the plugin files to the /wp-content/plugins/plugin-name directory, or install the plugin through the WordPress plugins screen directly.
Activate the plugin through the ‘Plugins’ screen in WordPress
Use the Scheduler->VertyCal Settings screen to configure the plugin If you are using the files from jQuery UI in your theme or plugin, please be aware of a change. With 4.6 you can omit calling these files and enqueue the default datepicker which will use the built-in defaults from WordPress.
Instructions for Administrator Setup
1Public Heading Title
This field sets the title of the Scheduler table. This helps brand your site to any type of listing you would like it to be. Possible titles could be Schedules, Scheduler, Deliveries, Events, Meetings, etc.
2Page Name of Scheduler
A page name <!>is required<!> to make the VertyCal scheduler page display the table page to the public, or private. By default the page name is Scheduler and you should not have to change this unless you would like to have the url in the address bar display a different name–such as service-calls, etc. It may also be needed for language translations where you language type set is only readable with a certain font, maybe.
3Email to Send Notification
By adding an email to this field you are telling the plugin to send an email to the address you enter whenever a scheduled item is marked Complete. If you leave this blank then no emails will be sent. By default your WordPress admin email will not be used. Be sure to add an email here if you want to receive messages.
4Schedule Page Margin
This setting is for using VertyCal with themes which may or may not support VertyCal plugin. Default is 15 pixels so you may not need to change anything. The setting makes more space between the bottom of the scheduling table and whatever comes after that in your theme. This helps with mobile views as well. Adjust accordingly by experimenting with various devices. By default the Scheduler Theme* that is designed for VertyCal should work well on all devices. Also check the Custimzer settings if you are using the Scheduler Theme. There are several functions to help you preserve more space and helps provide a cleaner user interface.
5Scheduler Font Size
TYou can set the size of the font in the scheding table. This setting is adjusted by a percentage factor of the theme default font size. If the body tag has a font size of 16px, for example, then 100% would be 16 pixels.
6Limit User Data
This option allows users to edit only their own items and see only their own attachments such as documents and media they may have uploaded. Settings are restricted to allow only Administrators to edit_posts, edit_published_posts, edit_others_posts and edit_private_posts. Ticing this box makes only Administrator level users have the capabilities to do these tasks. Otherwise if you uncheck the box field you will have all items including media and editing of others items available. This could be used if you have a team or only one person using the site and you want to have broader access to editing items.
7Mark Complete Usage
By ticcing this option your are allowing users to mark a Scheduled item as ‘Fulfilled'. By default marking a task as complete must be done on the Admin side editor page. Checking this box will allow task to be marked complete directly from the Scheduler page. Once checked and submitted an email is sent to the admin of site.
8Show Hide Year
By checking the box in this setting you will be removeing the year from in front of the first displayed date in the scheduler table. By unchecking you will be showing the year date format. Show is the default.
9Add Custom Dashboard Widget
By activating the branding option you are turning on several settings and optimizing components to the Admin side Dashboard and Menus. Turning on this selection will effect most of the settings options. For example if you want to use the color settings for more than just the public/front-side colors. Once this is turned on you can custom brand your backend to fit your company branding.
10Date Time Primary Colors
If the branding option is activated this options and the next two options will work. This color option sets the sidebar menu color AND the color of the text on the scheduler front side table. You may try several configurations to get the one that works best for you branding to match your company colors or just to make the screen easier to read for your users.
11Admin Text Color
Set the text color for all elements inside the administrative page menu sidebar. This color should be the opposite contrast of the above setting which is the background color of sidebar menus.
12Admin Background Color
Setting the background color of your working admin main body using this option will also set the background color of the main scheduler table on the front viewable side.
13Determine What Content Shows
By default all content of this plugin should be private and not viewable to the public with the exception of the scheduler table. You may change this by selecting on of the four options. 1. Protect All VertyCal Pages – just means anyone must be logged in to view any VertyCal page. 2. Protect Single Listing Publicly. This protects only the single full page listing of a scheduled item. You will know this page by looking at the address bar and it says ‘scheduled/’ just before the name of the page item. By contrast the page you see the main scheduler table on will display ‘scheduler’ in the address bar. 3. No Restrict Scheduler Page. Logged in users will see both Scheduler and single Scheduled pages. But both pages will not be seen by the public. 4. Protect Single Listing Only. Logged in users will see only Scheduler page. This means that no one but Admins will see any single Scheduled page. 5. Publicly View All Pages Debugging only. Everyone will see both pages but not able to use Add New form. only recommended if your information is OK to be seen publically.
14Set Post ID to Show for Options
Enter the post ID number to display on the Options page of Scheduler. You can add any tyype of content to a post and build an buide book or any type of regulations or service level expectations, maybe. Create a post using the standard post type and get the ID of said post by looking at the address bar. The ID number will be followed by ‘?edit.php=xxxx’.
Your theme may not support Full Width Layout. First try looking for a Full Width or No Sidebar template in the page editor. If neither is available, or do not work, Try removing the widgets inside of any sidebar from the Widgets page.
Added new user but they can not add Schedules
You must make the new user an Editor or Administrator when the new user is added. This can be done under Users > Role.
How Do I Set the Number of Rows to Show Per Page?
You can set the number of scheduler table rows to show on the Scheduler page by going to Settings > Reading > Blog pages to show at most.
Options Settings Reference
Vertycal Option Name
Vertycal Option Name
Public Heading Title
Page Name of Scheduler
Email to Send Fulfilled
Single Page Margin
Limit User Data
Mark Complete Usage
Add Custom Dashboard Widget
Shortcode to Use
Where to Use
Function or Page
Displays the date on the user Dashboard page.
To Translate the Days and Months of the Scheduler Options page Clock you can do this manually if you are confident with changing the code in this file: “wp-contents/plugins/vertycal/inc/vertycal-template-options.php” on or around line 308.