figuren-theater / ft-theming

This package helps you & your brand with a consistent look across the figuren.theater multisite network and beyond.

figuren.theater | Theming

This package helps you & your brand with a consistent look across the figuren.theater multisite network and beyond.


Read our blog

See the network in action • Join the network • Create your own network

About

This is the long desc

• list closed tracking-issues or docs files here
• Do you have any ideas ?

Background & Motivation

...

Install

1. Install via command line

   composer require figuren-theater/ft-theming

Usage

API

Figuren_Theater::API\get_...()

Plugins included

This package contains the following plugins. Thoose are completely managed by code and lack of their typical UI.

• WP Better Emails

What does this package do in addition?

Accompaniying the core functionality of the mentioned plugins, theese best practices are included with this package.

• Allow any post type to use one or more templates, independently from the theme. This is enabled by default for the page post type by using

  add_post_type_support(
    'page',
    'post-type-templates',
    [
      'templates' => [
        'blank.php'=>'A blank canvas'
      ],
      'path'=>'ABSPATH_TO_TEMPLATE_DIRECTORY'
    ]
  );

• Allow third-party scripts to be loaded either defered or async via a filter or a URL#hash.

• Remove jquery 'MIGRATE' console message from frontend.

• Deliver our figuren.theater favicon as fallback, if non is set

• Themed Login using site-icon and theme-colors

Built with & uses

• dependabot
• code-quality A set of status checks to ensure high and consitent code-quality for the figuren.theater platform.
• ....

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Versioning

We use Semantic Versioning for versioning. For the versions available, see the tags on this repository.

Authors

• Carsten Bach - Provided idea & code - figuren.theater/crew

See also the list of contributors who participated in this project.

License

This project is licensed under the GPL-3.0-or-later, see the LICENSE file for details

Acknowledgments

• altis by humanmade, as our digital role model and inspiration
• @roborourke for his clear & understandable coding guidelines
• python-project-template for their nice template->repo renaming workflow

ft-theming's Issues

"WP Better Emails" has been closed

This plugin has been closed as of January 10, 2023 and is not available for download. Reason: Security Issue.

Add Plain-Text Email – WordPress plugin | WordPress.org

https://wordpress.org/plugins/add-plain-text-email/

Re-factor this after 6.3 was released, which provides native async & defer handling

ft-theming/inc/__best-practices/defer-async-loader.php

Lines 2 to 14 in 3f50798

	/**
	* Figuren_Theater Theming Defer_Async_Loader.
	*
	* Add async & defer attribute to asset links.
	*
	* Enqueue your scripts as normal,
	* and simply add the #asyncload, or #deferload string
	* to any script you want to async or defer.
	*
	* @package figuren-theater/theming/defer_async_loader
	*/
	namespace Figuren_Theater\Theming\Defer_Async_Loader;

WP Better Emails

Tasks

Beta Give feedback

1. "WP Better Emails" has been closed #24
   dependencies security +2

// THAT is why we need a own f.t ThemeProcessor API

	// 1.1. defaults are swapped 
	// (Lets's see how (long) this will work.)
	//
	// $relevant_colors['ft_background'] = '#f1f1f1';
	// $relevant_colors['ft_text']       = '#000';
	$relevant_colors['ft_background'] = '#000';
	$relevant_colors['ft_accent']     = '#808080';
	$relevant_colors['ft_text']       = '#f1f1f1';

ft-theming/inc/__best-practices/themed-login.php

Lines 68 to 78 in 3f50798

	$relevant_colors['ft_background'] = ( isset( $ft_global_styles['foreground'] ) ) ? $ft_global_styles['foreground'] : $relevant_colors['ft_background'];
	// @TODO // THAT is why we need a own f.t ThemeProcessor API
	$relevant_colors['ft_accent'] = ( isset( $ft_global_styles['primary'] ) ) ? $ft_global_styles['primary'] : $relevant_colors['ft_accent'];
	// @TODO // THAT is why we need a own f.t ThemeProcessor API
	// $ft_secondary = $ft_global_styles['secondary'];
	// @TODO // THAT is why we need a own f.t ThemeProcessor API
	$relevant_colors['ft_text'] = ( isset( $ft_global_styles['background'] ) ) ? $ft_global_styles['background'] : $relevant_colors['ft_text'];

Establish quality standards

Repository Standards

Beta Give feedback

1. Has nice README.md
2. Add .github/workflows/ft-issue-gardening.yml file (if not exists)
3. Add .github/workflows/release-drafter.yml file
4. Add .github/workflows/prerelease-changelog.yml file
5. Add .editorconfig file
6. Add .phpcs.xml file
7. Check that .phpcs.xml file is not present in .gitignore
8. Add CHANGELOG.md file with an Unreleased-Heading
9. Add phpstan.neon file
10. Run composer require --dev figuren-theater/code-quality
11. Run composer normalize
12. Run vendor/bin/phpstan analyze .
13. Run vendor/bin/phpcs .
14. Fix all errors ;)
15. commit, PR & merge all (additional) changes !
16. Has branch protection enabled ?
17. Add .github/workflows/build-test-measure.yml file
18. Enable repo for required Build, test & measure status checks via Repo Settings
19. Add Build, test & measure badge to the code-quality README
20. Submit repo to packagist.org
21. Remove explicit repositories entry from ft-platforms composer.json
22. Update README.md and fix LICENSE-Link, to see all workflows running
23. Publish the new drafted Release as Prerelease to trigger auto-updating versions in CHANGELOG.md and plugin.php

Maybe a new trac ticket: has_site_icon() vs. get_site_icon_url() vs. get_option('site_icon')

	 * @todo Maybe a new trac ticket: has_site_icon() vs.  get_site_icon_url() vs. get_option('site_icon')

ft-theming/inc/__best-practices/favicon-fallback.php

Line 27 in 3f50798

Add a nice default for all emails

ft-theming/inc/wp-better-emails/namespace.php

Line 67 in 3f50798

// TODO

Theming

Tasks

Beta Give feedback

1. Establish quality standards #7
   23 of 23
   automation +1
2. Add a nice default for all emails #9
   enhancement +1
3. Maybe a new trac ticket: has_site_icon() vs. get_site_icon_url() vs. get_option('site_icon') #10
   bug +1
4. Re-factor this after 6.3 was released, which provides native async & defer handling #11
   dependencies enhancement +2
5. // THAT is why we need a own f.t ThemeProcessor API #12
   enhancement +1
6. Add Plain-Text Email – WordPress plugin | WordPress.org #22
   PART Plugin enhancement +2

Plugins

Beta Give feedback

1. WP Better Emails #25
   0 of 1
   PART Plugin tracking issue +2