cubear/cwd_project

A lightweight Drupal 8 child theme, to be used with cubear/cwd_base; from Cornell University CIT-CD.

3.0.5 2024-01-30 17:20 UTC

GPL-2.0+

• Anthony Adinolfi (ama39)

README

Starter Child Theme for CD Projects

See also: CD Demo - a Drupal starter-kit and demo site.

Usage

Create a child theme from cwd_project

1. Grab a copy of this "cwd_project" folder from the GitHub repo.

   • If your site is a fresh clone of CD Demo, you'll already have cwd_project in web/themes/custom.

2. Rename this copy to suit your project. This will effectively be the machine name for your theme (e.g., The College of Ursine Studies at Cornell might be named cwd_ursine.). For consistency, we usually name our folders and files "cwd_xxxx".

   • CWD is the legacy name for the web development unit of Custom Development. While it's deprecated now, it's still used in many places, and three letters are more distinctive than two. So for now, I recommend just going with it! 😛

3. There are a few files in the starter theme that will also need their filenames updated to match:

   • cwd_project.info.yml → cwd_ursine.info.yml

   • cwd_project.libraries.yml → cwd_ursine.libraries.yml

   • cwd_project.theme → cwd_ursine.theme

     • CSS and JavaScript assets should be renamed too, but don't need to match the theme's machine name. Simplifying to ursine.css would be fine, for example.

     • The starter project.scss and project.css files are empty (except for some breakpoint recommendations in comments). The starter project.js is also empty, except for Drupal-specific search code that we commonly need on every project (but also commonly customized).

4. The "project" machine name must also be updated in the contents of the newly renamed cwd_ursine.info.yml. These instances are marked with a @CUSTOMIZE comment for extra clarity. For example, in the libraries section:

   • - 'cwd_project/global-styling' # @CUSTOMIZE (line 25)

5. Also in cwd_ursine.info.yml, the front-facing "CWD Starter Theme" name should be set appropriately. (line 5)

   • Optionally, you can also uncomment the libraries reference to custom CKEditor styles. (lines 27 & 28)

   • CKEditor styles are already inherited from the Base Theme, so you should only uncomment these two lines if project-specific styles are needed, and they would not be appropriate to add to the Base Theme itself. If you use custom CKEditor styles, you'll need to add a copy of the css/ckeditor folder from the Base Theme to your child theme for modification, and update the templates/ckeditor_templates.js file as needed.

6. In cwd_ursine.libraries.yml, the references to filenames for CSS and JavaScript assets (named in step 3 above) should be updated. This is also where you will add any additional custom assets for your project.

7. There is also a screenshot.png file in the theme which is used in the Drupal CMS. Ask a designer for help updating this!

   • If you want it to match the Base Theme, the typography is done in Avenir Next Medium.

8. Remove composer.json from your new theme (no need to keep it).

9. ⚠️ Proceed with "Drupal" steps below, including the very important clean-up of cwd_project.

Drupal

After you create your child theme and commit it to your site repo:

1. Go to /admin/appearance
2. Enable your new child theme and set it as the default.
3. Uninstall cwd_project.
4. Codify the config for the aforementioned theme changes.
5. Remove cwd_project from your code repo.

Template sub-folders

Content types and other components

Sub-folders called news, events, slideshow, etc., are meant for content types and other components. Broader sub-folders for components are also ok, whatever works best for your project. (For example, on Biotech, it made sense to have a resources sub-folder, with templates for Service and Instrument components.)

partials

Put "partial" templates in here, such as site-footer.html.twig and incl--article-image.html.twig. These templates do not fill out an entire template, they are pieces of reusable/repeat markup. They can be included straight-up, or with arguments (i.e. include ... with).

Example usage:

• html.html.twig use of site-footer.html.twig
• news--full.html.twig use of incl--article-image.html.twig

overrides

Put full template overrides in here, such as views-view.html.twig, media.html.twig, field--post-date.html.twig, _block--with-button.html.twig. These templates are just that: complete templates. They can be included straight-up, or included with arguments, or extended, or embedded.

Example usage:

• TO DO