README

The starter theme for all ISU WP sites is based on the Timber Library and incorporates the Iowa State Frontend Library for styles, components and functionality. Please refer to that repository for specific information regarding the front-end library, and markup.

This theme utilizes twig for templating, and relies on the Advanced Custom Fields module.

Installing the Theme

Install this theme as you would any other, and be sure the Timber plugin, and ACF Plugin are activated.

1. Make sure you have installed the plugin for ACF Pro.
2. Download the zip for this theme (or install via composer) and move it to wp-content/themes in your WordPress installation.
3. Activate the theme in Appearance > Themes.

Installing via composer

composer require iastate/wordpress-theme

Updating the frontend library

composer update iastate/frontend-component-library

Development

Versioning

Releases for this project should follow Semantic Versioning.

Steps when releasing:

• Update style.css with the new release version, ie 1.0.1.
• Commit (or merge) and push master to origin.
• Tag 1.0.1 (the new release version), and push to origin. The tag is what composer uses to define a new release.

Changes

A list of package modifications can be found in CHANGELOG.MD

What's here?

• inc/ is a folder for theme functions. It serves the purpose of the functions.php file in a more organized way.
• vendor/iastate/frontend-component-library/ is the Iowa State Frontend Library, designed for the Iowa State family of websites. This is controlled by composer, and should not be modified here, except for testing.
• wp_components/ is a WordPress specific version of the component library. It contains styles specific to the WordPress interface and editor, that are not a part of the ICL.
• templates/ contains all of your Twig templates. These pretty much correspond 1 to 1 with the PHP files that respond to the WordPress template hierarchy. At the end of each PHP template, you'll notice a Timber::render() function whose first parameter is the Twig file where that data (or $context) will be used. Just an FYI.
• acf_json/ is a json copy of the custom ACF data fields, they're used for synchronization across development environments.
• bin/ and tests/ ... basically don't worry about (or remove) these unless you know what they are and want to.

Other Resources

• The main Timber Wiki is super great, so reference those often. Also, check out these articles and projects for more info:
• This branch of the starter theme has some more example code with ACF and a slightly different set up.
• Twig for Timber Cheatsheet
• Timber and Twig Reignited My Love for WordPress on CSS-Tricks
• A real live Timber theme.
• Timber Video Tutorials and an incomplete set of screencast for building a Timber theme from scratch.