timetable for wordpress - rik de vos · 2017-01-25 · wordpress 3.x 1.2 installation the...
TRANSCRIPT
Timetable for Wordpress
By Rik de Vos ( www.rikdevos.com ) on January 9th, 2012
1
Thank you for purchasing this item. If you have any questions that are
beyond the scope of this help file, please feel free to email via my user page
contact form here. Thanks so much!
Timetable for Wordpress
By Rik de Vos ( www.rikdevos.com ) on January 9th, 2012
2
Table of Contents
1 Getting Started
1.1 Requirements
1.2 Installation
1.3 How it works
2 Timetable Settings
2.1 General Settings
2.2 Help
3 Manage Timetables
3.1 Introduction
3.2 Add Timetable
3.3 Edit Timetable
3.4 Delete Timetable
4 Manage Locations
4.1 Introduction
4.2 Add Location
4.3 Edit Location
4.4 Change Location Order
4.5 Delete Location
5 Manage Events
5.1 Introduction
5.2 Add Event
5.3 Edit Event
5.4 Delete Event
6 Adding the Timetable
6.1 Using the WYSIWYG button
6.2 Using the Shortcode
7 Import & Export
7.1 Exporting a Timetable
7.2 Importing a Timetable
Timetable for Wordpress
By Rik de Vos ( www.rikdevos.com ) on January 9th, 2012
3
Timetable for Wordpress
By Rik de Vos ( www.rikdevos.com ) on January 9th, 2012
4
1. Getting Started
1.1 Requirements
PHP5+ Wordpress 3.x
1.2 Installation
The installation of “Timetable” is very easy. Either copy the folder “timetable” to
the Wordpress plugin directory (default: wp-content/plugins/) or upload the .zip
file to Wordpress using Wordpress’ plugin upload form. Then, login to your
Wordpress admin and navigate to the “Plugins” page. You’ll then have to
activate the plugin, so click “activate” under “Timetable”. If the plugin is
activated a new link “Timetable” will appear in the navigation sidebar. There you
will be able to change all the settings, or click the “Help” tab for more
information.
1.3 How it works
First you’ll have to create a new timetable on the “Timetables” tab. Then you’ll
have to add one or more locations to the timetable on the “Locations” tab. Then
you can create events for particular locations on the “tab Events” page.
To add the timetable to a page/post on your website, use the timetable
shortcode, or click the timetable icon in the editor when editing a page or post.
Timetable for Wordpress
By Rik de Vos ( www.rikdevos.com ) on January 9th, 2012
5
2. Timetable Settings
2.1 General Settings
To navigate to the “Settings” page, just click the “Timetable” link in the
sidebar. On this page you can change the general settings for the timetables.
Color Scheme: Here you can set the color scheme for the timetable. You can
choose between white, ocean, light green, orange, black, red, blue and green.
Time Format: Here you can choose the time format of the timetable. If you
choose 24-hour, the times will display 14:00, 14:30, 15:00 etc. If you choose
12-hour, the times will display 2:00pm, 2:30pm, 3:00pm etc.
To save the settings, click “Save Changes”
2.2 Help
Click the “Help” tab on the settings page to view a brief help file.
Timetable for Wordpress
By Rik de Vos ( www.rikdevos.com ) on January 9th, 2012
6
3. Manage Timetables
3.1 Introduction
To manage timetables, click on the “Timetables” tab. On this page you’ll be
able to preview your timetables, edit them, remove them or add new
timetables.
3.2 Add Timetable
To add a timetable, scroll down to “Add Timetable” and fill in the form.
Name: Name of the timetable which is used in the shortcode. Preferably only
lower-case characters without spaces. It must be a unique name.
Title: This is an optional field. If the field is not left empty, a title will appear
above the timetable on your website.
Start: The time at which every day starts, and the date at which the timetable
starts.
End: The time at which every day ends, and the date at which the timetable
ends. Note: The start and end time cannot be the same as timetables
cannot be 24h00m long.
Show Date: Date the timetable show to the users when they first load the
page.
Autoscroll: Automatically scroll to events when a user clicks on them.
Show Indicator Bar: Show a less-accurate the time bar above the timetable.
Scale: The width of each block on the timetable.
Print: Show a print button which users can use to easily print a copy of the
timetable.
Timetable for Wordpress
By Rik de Vos ( www.rikdevos.com ) on January 9th, 2012
7
Popup Print: Open print page in a popup rather than a new window.
Program: Allow users to add events to their personal program. These events
will be highlighted when the timetable is printed.
If you’ve filled in these fields, click “Add Timetable” to add the timetable.
3.3 Edit Timetable
To edit a timetable, click the “Edit” link when hovering over a timetable on
the “Timetables” tab. A tab will open with the same fields as when adding a
timetable. Make your changes, and then click “Save Changes” to save the
changes.
3.4 Delete Timetable
To delete a timetable, click the “Remove” link when hovering over a
timetable on the “Timetables” tab. A popup will appear where you’ll have to
confirm that you want to delete the timetable. Click “OK” to delete the
timetable.
If you’ve deleted the timetable, all its events and location will also be
deleted. This action cannot be undone.
Timetable for Wordpress
By Rik de Vos ( www.rikdevos.com ) on January 9th, 2012
8
4. Manage Locations
4.1 Introduction
To manage locations, click on the “Locations” tab. On this page you can add,
edit and remove locations from timetables. You can also change the order of
the locations in the timetables.
4.2 Add Location
To add a location, scroll down to the “Add Location” form, then fill in the
form.
Timetable*: This is the timetable for the location. You will not be able to
change this later.
Title*: The title of the location.
Subtitle: This optional field will be the subtitle of the location.
* Required field
If you’ve filled in these fields, click “Add Location” to add the location.
4.3 Edit Location
To edit a location, click the pen icon of a location. A tab will open where you
can edit the title, subtitle and timetable of the location. Click “Update
Location” if you’re done editing the location.
Timetable for Wordpress
By Rik de Vos ( www.rikdevos.com ) on January 9th, 2012
9
4.4 Change Location Order
Changing the location order is very easy. Simply drag the locations to change
the order. The changes to the order will be automatically saved. You cannot
drag locations between different timetables.
4.5 Delete Location
To delete a location, click the delete icon of a location. A popup will appear
where you’ll have to confirm that you want to delete the location. Click “OK”
to delete the location.
If you’ve deleted the location, all its events will also be deleted. This action
cannot be undone.
Timetable for Wordpress
By Rik de Vos ( www.rikdevos.com ) on January 9th, 2012
10
5. Manage Events
5.1 Introduction
To manage events, go to the “Events” tab. On this page you can add, edit and
remove events from timetables and location.
5.2 Add Event
To add an event, scroll down to the “Add Event” form and fill it in. Most of
these options are optional.
Title*: The title of the event.
Subtitle: The subtitle of the event. Leave blank if you don't want a subtitle.
Start*: The time and date when the event starts.
End*: The time and date when the event ends.
Location*: Choose a timetable and location for this event..
YouTube: URL to YouTube video.
Image: URL to image for in the event description.
Link: Link in the bottom of the event description.
Link Text: Text for the link in the bottom of the event description.
Description: Description of the event. You can use HTML.
* Required field
Timetable for Wordpress
By Rik de Vos ( www.rikdevos.com ) on January 9th, 2012
11
5.3 Edit Event
To edit an event, click the pen icon of an event. A popup will appear where
you can edit the settings of the event. Click “Save Changes” if you’re done
editing the event and the changes will be saved.
5.4 Delete Event
To delete an event, click the cross icon of an event. A popup will appear
where you’ll have to confirm that you want to delete the event. Click “OK” to
delete the event. This action cannot be undone.
Timetable for Wordpress
By Rik de Vos ( www.rikdevos.com ) on January 9th, 2012
12
6. Adding the Timetable
6.1 Using the WYSIWYG button
You can easily add timetables to posts and pages by clicking the timetable
icon when editing/adding a post/page. Click the icon and a popup will appear
where you can click on timetable you have created. Click on a timetable, and
a shortcode will be added on the place you positioned your cursor.
6.2 Using the Shortcode
You can also manually insert a timetable using the following shortcode:
[timetable name=“your_timetable_name”]
The “name” attribute will be the name you chose for the timetable.
Timetable for Wordpress
By Rik de Vos ( www.rikdevos.com ) on January 9th, 2012
13
7. Import & Export
7.1 Exporting a Timetable
To export a timetable, go to the “Import & Export” tab. Next, find the
timetable you wish to export in the table, and click on the button “Export
.csv”. The “.csv” file will begin downloading.
7.2 Importing a Timetable
To import a “.csv” file, go to the “Import & Export” tab, then go to the
“Import” form. Choose whether to override timetables that have the same
name, or to rename them. Next, select your “.csv” file on your computer, and
click “Import”. The timetable will be imported and the locations and events
will be added to it.
While editing your “.csv” file, be very careful to keep the same syntax. I
recommend creating a timetable with 2 locations and 4 events, exporting
that, and then edit that file. You can add as much locations or events as you
want, but you may not remove any of the timetable, location or event
properties, or change their order. Also, do not remove the whitespace.
Timetable for Wordpress
By Rik de Vos ( www.rikdevos.com ) on January 9th, 2012
14
Once again, thank you so much for purchasing this item. As I said at the
beginning, I'd be glad to help you if you have any questions relating to this
item. No guarantees, but I'll do my best to assist. If you have a more general
question relating to the items on CodeCanyon, you might consider visiting
the forums and asking your question in the "Item Discussion" section.
Thanks!
Rik de Vos