WordPress Theme for www.toastmasters.pl

A custom WordPress theme for the Toastmasters in Poland website. Uses the official Toastmasters color system, as defined by the organization's Brand Guidelines, but with a fresh twist to underline the youth dynamic of the organization in Poland.

Screenshot

Features

• self-contained---doesn't rely on external widgets or plug-ins,
• fully responsive---works on any screen size,
• HTML5 and CSS3,
• support for translations.

Requirements

• PHP 5.6 or newer,
• WordPress 4.5 or newer,
• supports Internet Explorer 11, Edge and any current version of Chrome or Firefox. This is mostly due to use of CSS flexbox.

Installation

1. Unpack (or clone) the theme into a subdirectory of your WordPress's wp-content/themes/, named for instance toastmasterspl.

2. Parse the SASS files into proper CSS:

   sass --no-source-map --style=compressed --update wp-content/themes/toastmasterspl/
   

3. The theme should now be available in your Themes WordPress section. You can activate it and customize to your liking.

Customizing

Logo

You can upload a logo through the theme customization screen.

• height shouldn't exceed 100px,
• width can be anything that won't collide with the page title.

Main Navigation

The main navigation menu contains links to subpages of the website. It expects page links with some limitations:

• the first link is expected to be the home page; it will be replaced with a home icon,
• the menu has only one level of depth; links beyond the first level will not be displayed.

1. Create a new menu, call it eg. "Page Navigation",
2. Add the link to the home page first,
3. Add links to any other pages you'd like, mind the width of the screen:
   • replace long page titles with shorter labels,
   • keep the amount of links reasonable, so that the menu doesn't break into multiple lines on smaller screens (on tablets it'll be displayed vertically at the bottom of the page),
4. Set the menu to appear in the Primary Page Navigation placement.

Organization Breadcrumb Navigation

The organization breadcrumb menu displays a coma-separated list of links above the page title. It expects custom links to websites of higher organizational structures, eg. Toastmasters International and District 95.

1. Create a new menu, call it eg. "Organization Breadcrumb",
2. Add a few custom links (not too many so that the links don't break into multiple lines),
   • enter the full URL to the organization's website, eg. http://www.toastmasters.org/,
   • enter the name of the organizational structure, eg. Toastmasters.
3. Set the menu to appear in the Organization Breadcrumb placement.

Social Links

The social links menu at the bottom expects custom links with URLs to popular social networks. It will extract the name of the social network from the URL and replace the textual link with a matching FontAwesome icon.

1. Create a new menu, call it eg. "Social Links",
2. Add any number of custom links,
   • enter the full URL to the social network page, eg. https://facebook.com/ToastmastersPolskaPL,
   • as Label enter the name of the social network, eg. Facebook.
3. Set the menu to appear in the Social Links placement.

Developing

You'll need a proper Wordpress installation to test the theme. To ease that setup, there's a docker-compose.yml file in the repository that runs a vanilla Wordpress on MariaDB. You can start it by running:

docker-compose up

from the main directory, then open http://localhost in a web browser and follow the Wordpress installation procedure. You'll find the database root password in the console output from docker-compose.

You can stop it by calling docker-compose stop or destroy it with docker-compose down. Keep in mind that down will also destroy all the state, so the next time you call up you'll have to re-run the Wordpress installation.

License

Copyright 2016 Michał Paluchowski

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.