Installation

Navigation

• Installation requirements
• Installation instructions
• Theme configuration

---

Installation requirements

This theme is developed and tested against WordPress 5.2.2+ and PHP 7.0+.

While this theme should work against any server running the minimum requirements for WordPress installations, we cannot guarantee compatibility with, or provide support for, installations on non-LAMP stacks (e.g. Windows installations).

Parent Theme

The UCF WordPress Theme must be installed for this child theme to function properly.

Required Plugins

These plugins must be activated for the theme to function properly.

• Advanced Custom Fields PRO
• Advanced Custom Fields: Font Awesome
• FinAid Utilities

Supported Plugins

The plugins listed below are extended upon in this theme--this may include custom layouts for feeds, style modifications, etc. While these plugins are intended to be activated on the Financial Aid website, they are not technically required. A plugin does not have to be listed here to be compatible with this theme.

For more information on how these plugins are extended in this theme, please see our Plugin Extensions and Overrides docs.

• Athena Shortcodes
• TinyMCE Advanced
• UCF FAQ Custom Post Type
• UCF Section
• Yoast SEO

Other Recommended Plugins

Plugins listed below aren't technically required for the Financial Aid site to run, and don't have explicit extensions or overrides in this theme, but provide expected functionality or other helpful utilities. A plugin does not have to be listed here to be compatible with this theme.

• Automatic Section Menu Shortcodes
• UCF Document Plugin
• UCF Events
• UCF Post List Shortcode
• UCF Spotlights
• WP Shortcode Interface

---

Installation instructions

Before getting started: make sure you've satisfied all the installation requirements for this theme, and that any required plugins or recommended plugins that you wish to use are installed and activated.

1. Install the theme:**

   • via Github Updater

     This theme supports installation and updates via the Github Updater plugin. See their documentation for more information on setup and usage. (Requires PHP 5.6.0+)

   • via standard (manual) installation

     Download the theme .zip file here: https://github.com/UCF/FinAid-Child-Theme/archive/master.zip

     This theme can be installed via traditional installation methods if desired. After downloading the latest theme .zip file onto your computer, follow the steps on this page.

     Alternatively, if you're running a WordPress Multisite instance, you can install the theme by navigating to the network admin, go to Themes > Add New, then click the "Upload Theme" button to upload the .zip file. After uploading and installing the theme, you can choose to either network activate it, or activate the theme for a specific site (navigate to All Sites, click on a site in the list, then click the Themes tab and enable the theme in the list.)

   • via WP-CLI

     $ wp theme install https://github.com/UCF/FinAid-Child-Theme/archive/master.zip

     See the WP-CLI docs for more information.

2. Activate the theme: from your site's admin, navigate to Appearance > Themes, hover over the theme's thumbnail, and click the "Activate" button that appears.

3. Configure the theme: create and set menus, and make any other configuration updates noted in the theme configuration steps.

That's it! Now you're ready to start adding content.

** Note that this theme is not deployed to the WordPress theme directory, and therefore will not notify you of theme updates, unless you are using Github Updater. You are responsible for keeping your copy of this theme up-to-date with bugfixes and other new releases.

---

Theme configuration

After installing this theme, you should perform the following configuration steps:

• Create and set a static front page under Settings > Reading.
• If you plan on using premium webfonts using Cloud.Typography, ensure that webfonts have been properly configured to a Cloud.Typography CSS Key that allows access to your environment. A Cloud.Typography CSS Key URL can be added via the WordPress Customizer (Appearance > Customize > Web Fonts).
• Under Appearance > Menus, create and assign a new menu to the "Header Menu" display location.
• Assign content to the site footer using widgets, under Appearance > Widgets.
• Configure other site-specific settings from the Theme Customizer.
• Under Plugins > Advanced Custom Fields: Font Awesome > Settings, ensure "Version" is set to "4.x" and save.
• If TinyMCE Advanced is installed: Under Settings > TinyMCE Advanced, scroll down to "Administration", click "Import Settings", then upload the settings file for TinyMCE Advanced located in the child theme's dev directory.
• If UCF Events is installed: Under Settings > UCF Events, update the "UCF Events JSON Feed URL" setting to point to the upcoming feed of the Office of Student Financial Assistance calendar. The value provided should end in /upcoming/feed.json.

NOTE: The UCF WordPress Theme has its own ACF config file which is not used by this theme. If you uploaded the ACF config from the UCF WordPress Theme prior to activating the FinAid Child Theme, you should deactivate the child theme, remove the fields, and then re-activate the child theme.