katheroine/layin

General purpose web page layout.

Maintainers

Details

github.com/katheroine/layin

Source

Issues

Installs: 14

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 1

Language:HTML

Type:layout

0.4.0 2023-03-21 12:58 UTC

Requires

Requires (Dev)

MIT ae56f2c1ce27d490a3a1201b7c2491570eacf110

  • Katarzyna Krasińska <katheroine.woop@gmail.com>

layoutkatheroinelayin

This package is not auto-updated.

Last update: 2024-05-04 18:03:00 UTC

README

General purpose web page layout.

See demo [https://katheroine.github.io/layin]

Prerequisites

  1. PHP: at least PHP 7.2.5
  2. Composer - dependency manager for PHP.
  3. A web server (Apache has been used in the example below).

Project set-up

  1. Create project directory and place composer.json - project configurtion file for Composer with appropriate content, eg.:
{
    "name": "awesomeauthor/awesomesite",
    "description": "Some awesome site.",
    "type": "project",
    "require": {
        "katheroine/layin": "*"
    },
    "require-dev": {
        "phpunit/phpunit": "*",
        "squizlabs/php_codesniffer": "*"
    },
    "autoload": {
        "psr-4": {
            "AwesomeAuthor\\AwesomeSite\\": [
                "src/"
            ],
            "AwesomeAuthor\\AwesomeSite\\Preconfiguration\\": [
                "site/preconfigurations/",
                "site/preconfigurations/page_renderers/"
            ]
        }
    },
    "autoload-dev": {
        "psr-4": {
            "AwesomeAuthor\\AwesomeSite\\": [
                "tests/"
            ]
        }
    }
}
  1. Run in the console:
$ composer install

The vendor directory will be created and the dependencies will be placed there.

  1. If you're using Git, create .gitignore file with vendor directory and optionally composer.lock:
vendor
composer.lock

It will remove those files/directories from the Git tracking process, so that those ones won't be placed in the respository.

  1. Prepare project directories structure within the main project directory:
- site
    - config
    - preconfigurations
    - public
        - assets
            - images
            - scripts
            - stylesheets
        - pages
    - templates

You can use the predefined Layin command:

$ vendor/bin/layin site:prepare
  1. Choose concrete theme, e.g. Violet - currently the only available, and generate links to its files, which will be placed in the site directory. You can use the predefined Layin command:
$ vendor/bin/layin theme:load violet
  1. Copy and edit the configuration files from vendor/katheroine/layin/site/config to site/config directory and replace its content with the one appropriate to your site:
  • site.config.yaml
html_doc_title: Some awesome site
html_doc_description: My awesome site based on the Layin layout system
html_doc_keywords: awesome site, layin example
html_doc_author:
  name: Lucy Diamond
  email: lucy.diamond@someemailbox.com
html_doc_charset: utf-8
html_doc_language: english
html_doc_language_code: en-EN
header_title: The awesome site
header_subtitle: good place on the web
footer_copyright_range: 2023
footer_site_name: The awesome site
  • navigation_links.yaml
- css_id: home-link
  title: News
  url_part: [[base_url]]
  • contact_info_links.yaml
- css_id: email-action
  title: e-mail
  value: lucy.diamond@someemailbox.com
  url: mailto:lucy.diamond@someemailbox.com
  1. Copy and edit the AbstractBasePreconfiguredPageRenderer.php file from vendor/katheroine/layin/site/preconfigurations/page_renderers to site/preconfigurations/page_renderers:
<?php

namespace AwesomeAuthor\AwesomeSite\Preconfiguration;

use Katheroine\Layin\Renderer\AbstractPageRenderer;
use Katheroine\Layin\Renderer\AbstractVioletPreconfiguredPageRenderer;
use Katheroine\Layin\Renderer\TwigPageRenderer;

abstract class AbstractBasePreconfiguredPageRenderer extends AbstractVioletPreconfiguredPageRenderer
{
    protected function providePageRenderer(): AbstractPageRenderer
    {
        return new TwigPageRenderer();
    }

    abstract protected function providePreconfiguration(): array;
}

Copy and edit the IndexPreconfiguredPageRenderer.php file from vendor/katheroine/layin/site/preconfigurations/page_renderers to site/preconfigurations/page_renderers directory:

<?php

namespace AwesomeAuthor\AwesomeSite\Preconfiguration;

class IndexPreconfiguredPageRenderer extends AbstractBasePreconfiguredPageRenderer
{
    protected function providePreconfiguration(): array
    {
        return [
            'templates_dir_path' => __DIR__ . '/../../templates',
            'template_subdir_path' => '',
            'template_file_extension' => 'twig.html',
            'page_file_extension' => 'php',
            'site_config_path' => '../../config/site_config.yaml',
            'navigation_links_config_path' => '../../config/navigation_links.yaml',
            'contact_info_links_config_path' => '../../config/contact_info_links.yaml',
            'base_url' => '../',
            'subpages_url' => 'pages',
            'assets_dir_path' => '../assets',
            'is_debug_mode' => false,
        ];
    }
}
  1. Create custom Twig base template (needed for adding custom CSS stylesheets) base.awesomesite.twig.html
{% extends 'base.violet.twig.html' %}
{% block stylesheets_custom %}
{% endblock stylesheets_custom %}
  1. Create Twig template for index page index.awesomesite.twig.html, based on base.awesomesite.twig.html
{% extends 'base.awesomesite.twig.html' %}
{% block board %}
{% endblock %}
  1. Copy and edit the index.php file from vendor/katheroine/layin/site/public/pages to site/public/pages directory
<?php
require_once __DIR__ . '/../../../vendor/autoload.php';

use AwesomeAuthor\AwesomeSite\Preconfiguration\IndexPreconfiguredPageRenderer;

$pageRenderer = new IndexPreconfiguredPageRenderer();
$pageRenderer->setTemplateName('index.awesomesite');

echo $pageRenderer->render();
  1. Generate Composer autoload files
$ composer dump-autoload

  1. Set-up new Apache virtualhost besed on example with ServerName set to awesomesite.local.

  2. Add appropriate entry in the /etc/hosts file.

  3. Run http://awesomesite.local/ on the web browser. You should see the properly displayed page with the header title and subtitle previously configured by you, but with no graphics nor styles.

  4. If you need to use external fonts, create the fonts defining stylesheet in the site/public/assets/stylesheets directory and name them with the awesomesite phrase eg. fonts.awesomesite.css:

@font-face
{
  font-family: liberation-sans-regular;
  src: url('../font/liberation-sans/LiberationSans-Regular.ttf');
}

Choose and download the appropriate font files (like above LiberationSans-Regular.ttf). Place them in the appropriate public directory, eg. site/public/assets/font/liberation-sans/.

  1. Create the colors defining stylesheets in the site/public/assets/stylesheets directory and fill with the choosen colors (use the examples below):
  • colors.awesomesite.css
:root
{
  --white: #ffffff;
  --dark-violet: #2d004c;
  --middle-violet: #3e1d54;
  --light-violet: #62357e;
  --dark-orange: #ce6122;
  --deep-orange: #de6c2a;
  --dim-orange: #f17c39;
  --middle-orange: #ff8d4c;
  --light-orange: #fc9d67;
  --dark-blue: #0b1a2e;
}
  • colors-site.awesomesite.css
:root
{
  --body-background-color: var(--dark-violet);
  --banner-background-color: var(--dark-violet);
  --banner-text-color: var(--white);
  --controls-background-color: var(--middle-orange);
  --controls-text-color: var(--white);
  --controls-backlight-color: var(--light-orange);
  --guideboard-background-color: var(--middle-orange);
  --guideboard-text-color: var(--white);
  --guideboard-backlight-color: var(--dim-orange);
  --guideboard-button-separator-color: var(--dim-orange);
  --guideboard-submenu-background-color: var(--deep-orange);
  --guideboard-submenu-text-color: var(--white);
  --guideboard-submenu-backlight-color: var(--dark-orange);
  --guideboard-submenu-button-separator-color: var(--dark-orange);
  --board-background-color: var(--white);
  --board-text-color: var(--dark-blue);
  --info-background-color: var(--dark-violet);
  --info-text-color: var(--white);
  --info-backlight-color: var(--middle-violet);
  --info-button-separator-color: var(--middle-violet);
  --copyright-background-color: var(--light-violet);
  --copyright-font-color: var(--white);
}
  • colors-site-accessibility.awesomesite.css
:root
{
  /* contrast */
  --contrast-header-background-color: #182652;
  --contrast-header-text-color: white;
  --contrast-controls-background-color: #6e005f;
  --contrast-controls-text-color: white;
  --contrast-controls-backlight-color: #2668bf;
  --contrast-guideboard-background-color: #6e005f;
  --contrast-guideboard-text-color: white;
  --contrast-guideboard-backlight-color: #2668bf;
  --contrast-guideboard-submenu-background-color: #9764c8;
  --contrast-guideboard-button-separator-color: white;
  --contrast-board-background-color: black;
  --contrast-board-text-color: white;
  --contrast-footer-background-color: #6e005f;
  --contrast-footer-backlight-color: #2668bf;
  --contrast-footer-button-separator-color: white;
  --contrast-copyright-background-color: navy;
}
  1. Complete the site/templates/base.awesomesite.twig.html template file with previously creates CSS stylesheets:
{% extends 'base.violet.twig.html' %}
{% block stylesheets_custom %}
<link type="text/css" rel="stylesheet" href="{{assets_dir}}/stylesheets/fonts.awesomesite.css">
<link type="text/css" rel="stylesheet" href="{{assets_dir}}/stylesheets/colors.awesomesite.css">
<link type="text/css" rel="stylesheet" href="{{assets_dir}}/stylesheets/colors-site.awesomesite.css">
<link type="text/css" rel="stylesheet" href="{{assets_dir}}/stylesheets/colors-site-accessibility.awesomesite.css">
{% endblock stylesheets_custom %}

After refreshing the site in the web browser you should see the change in the colors.

  1. Prepare logo in the PNG format and save it as site/public/assets/images/logo.png. After refreshing the site in the web browser you should see the logo on the page.

  2. Prepare the background cover in the PNG format and save it as site/public/assets/images/cover.jpeg. After refreshing the site in the web browser you should see the cover on the page.

  3. Create the icons setting site/public/assets/stylesheets/link-icons.awesomesite.css stylesheet:

#dial .menu-button#increase-font-trigger:before
{
  background-image: url('../images/icons.violet/a_plus.svg');
}

#dial .menu-button#decrease-font-trigger:before
{
  background-image: url('../images/icons.violet/a_minus.svg');
}

#dial .menu-button#toggle-contrast-trigger:before
{
  background-image: url('../images/icons.violet/contrast.svg');
}

#dial .menu-button#reset-accessibility-trigger:before
{
  background-image: url('../images/icons.violet/reset.svg');
}

#dial .menu-button#go-up-link:before
{
  background-image: url('../images/icons.violet/arrow_up.svg');
}

#dial .menu-button#guideboard-trigger:before
{
  background-image: url('../images/icons.violet/hamburger.svg');
}

nav .menu-button#home-link:before
{
  background-image: url('../images/icons.violet/house.svg');
}

#contact-info .menu-button#address-link:before
{
  background-image: url('../images/icons.violet/map.svg');
}

#contact-info .menu-button#email-action:before
{
  background-image: url('../images/icons.violet/monkey_envelope.svg');
}

#contact-info .menu-button#phone-action:before
{
  background-image: url('../images/icons.violet/phone.svg');
}

#contact-info .menu-button#fax-action:before
{
  background-image: url('../images/icons.violet/fax.svg');
}

After refreshing the site in the web browser you should see the icons on the page.

  1. You can use the content theme, e.g. Swamp Violet - currently the only available, and generate links to its files, which will be placed in the site directory. That will provide you the CSS styles for the headers, paragraps, lists, tables, images, etc. in the articles placed in the main tag. You can use the predefined Layin command:
$ vendor/bin/layin theme:load swamp_violet
  1. You also need to provide the CSS files defining the used colors for the content, eg. colors-content.awesomesite.css:
:root
{
    --content-normal-background-color: var(--white);
    --content-normal-text-color: var(--dark-blue);
    --content-normal-border-color: var(--middle-blue);
    --content-special-background-color: var(--middle-blue);
    --content-special-text-color: var(--white);
    --content-special-border-color: var(--white);

    --content-table-normal-border-color: var(--dark-blue);
    --content-table-special-background-header-color: var(--dark-blue);
    --content-table-special-background-odd-row-color: var(--middle-blue);
    --content-table-special-background-even-row-color: var(--light-blue);

    --content-definition-background-color: var(--white);
    --content-definition-text-color: var(--dark-blue);
    --content-definition-border-color: var(--light-blue);

    --content-terminal-background-color: var(--black);
    --content-terminal-text-color: var(--white);
    --content-terminal-prompt-text-color: var(--cybergreen);

    --content-code-background-color: var(--dark-blue);
    --content-code-text-color: var(--white);
    --content-code-border-color: var(--white);

    --content-alert-background-color: var(--orangered);
    --content-alert-text-color: var(--white);
    --content-warning-background-color: var(--orangeyellow);
    --content-warning-text-color: var(--white);
    --content-info-background-color: var(--skyblue);
    --content-info-text-color: var(--white);

    --content-keyboard-background-color: var(--skyblue);
    --content-kayboard-text-color: var(--white);

    --content-mark-color: var(--cyberblue);
    --content-strikethrough-color: var(--cyberred);
    --content-underline-color: var(--cybergreen);
    --content-pointed-color: var(--ultralight-gray);
}
  1. To handle accessibility feature you also need to provide colors-content-accessibility.awesomesite.css file:
:root
{
  /* contrast */

  --contrast-content-normal-background-color: var(--contrast-black);
  --contrast-content-normal-text-color: var(--contrast-white);
  --contrast-content-normal-border-color: var(--contrast-middle-violet);
  --contrast-content-special-background-color: var(--contrast-middle-blue);
  --contrast-content-special-text-color: var(--contrast-white);
  --contrast-content-special-border-color: var(--contrast-white);

  --contrast-content-table-normal-border-color: var(--contrast-white);
  --contrast-content-table-special-background-header-color: var(--contrast-dark-blue);
  --contrast-content-table-special-background-odd-row-color: var(--contrast-middle-blue);
  --contrast-content-table-special-background-even-row-color: var(--contrast-middle-blue);

  --contrast-content-definition-background-color: var(--contrast-black);
  --contrast-content-definition-text-color: var(--contrast-white);
  --contrast-content-definition-border-color: var(--contrast-white);

  --contrast-content-terminal-background-color: var(--contrast-dark-green);
  --contrast-content-terminal-text-color: var(--contrast-white);
  --contrast-content-terminal-prompt-text-color: var(--cybergreen);

  --contrast-content-code-background-color: var(--contrast-dark-blue);
  --contrast-content-code-text-color: var(--contrast-white);
  --contrast-content-code-border-color: var(--contrast-white);

  --contrast-content-preformatted-background-color: var(--contrast-dark-grey);
  --contrast-content-preformatted-text-color: var(--contrast-white);
  --contrast-content-preformatted-border-color: var(--contrast-white);

  --contrast-content-alert-background-color: var(--contrast-light-orange);
  --contrast-content-alert-text-color: var(--contrast-white);
  --contrast-content-warning-background-color: var(--contrast-light-yellow);
  --contrast-content-warning-text-color: var(--contrast-white);
  --contrast-content-info-background-color: var(--contrast-light-blue);
  --contrast-content-info-text-color: var(--contrast-white);

  --contrast-content-keyboard-background-color: var(--skyblue);
  --contrast-content-kayboard-text-color: var(--contrast-white);

  --contrast-content-image-normal-border-color: var(--contrast-white);

  --contrast-content-mark-color: var(--cyberblue);
  --contrast-content-strikethrough-color: var(--cyberred);
  --contrast-content-underline-color: var(--cybergreen);
  --contrast-content-pointed-color: var(--ultralight-gray);
}
  1. For the above example you need to extend the existing colors.awesomesite.css file with the new colors:
:root
{
  --white: #ffffff;
  --black: #000000;
  --dark-blue: #0b1527;
  --middle-blue: #1c2c4a;
  --light-blue: #253757;
  --dark-violet: #2d004c;
  --middle-violet: #562f71;
  --light-violet: #624079;
  --amaranthine: #6e005f;
  --cybergreen: #17ffa9;
  --cyberblue: #38f9ff;
  --cyberred: #fd3f1e;
  --skyblue: #0081c7;
  --orangeyellow: #f17e00;
  --orangered: #e24600;
  --ultralight-gray: #aaaaaa;
  --ultralight-blue: #e4e7f0;

  --contrast-white: #ffffff;
  --contrast-black: #000000;
  --contrast-dark-blue: #09286b;
  --contrast-middle-blue: #1050a3;
  --contrast-light-blue: #1e64be;
  --contrast-middle-violet: #6e005f;
  --contrast-light-violet: #9764c8;
  --contrast-dark-green: #023d2e;
  --contrast-dark-grey: #292a2e;
  --contrast-light-yellow: #e28800;
  --contrast-light-orange: #d15400;
}
  1. Finally, you need to place the new CSS files into the template file base.awesomesite.twig.html:
{% extends 'base.violet.twig.html' %}
{% block stylesheets_custom %}
<link type="text/css" rel="stylesheet" href="{{assets_dir}}/stylesheets/fonts.awesomesite.css">
<link type="text/css" rel="stylesheet" href="{{assets_dir}}/stylesheets/colors.awesomesite.css">
<link type="text/css" rel="stylesheet" href="{{assets_dir}}/stylesheets/colors-site.awesomesite.css">
<link type="text/css" rel="stylesheet" href="{{assets_dir}}/stylesheets/colors-site-accessibility.awesomesite.css">
<link type="text/css" rel="stylesheet" href="{{assets_dir}}/stylesheets/colors-content.awesomesite.css">
<link type="text/css" rel="stylesheet" href="{{assets_dir}}/stylesheets/link-icons.awesomesite.css">
<link type="text/css" rel="stylesheet" href="{{assets_dir}}/stylesheets/content.swamp_violet.css">
<link type="text/css" rel="stylesheet" href="{{assets_dir}}/stylesheets/content-accessibility.swamp_violet.css">
<link type="text/css" rel="stylesheet" href="{{assets_dir}}/stylesheets/colors-content-accessibility.awesomesite.css">
<link type="text/css" rel="stylesheet" media="screen and (min-width: 0px)" href="{{assets_dir}}/stylesheets/content-s.swamp_violet.css">
<link type="text/css" rel="stylesheet" media="screen and (min-width: 640px)" href="{{assets_dir}}/stylesheets/content-m.swamp_violet.css">
<link type="text/css" rel="stylesheet" media="screen and (min-width: 1024px)" href="{{assets_dir}}/stylesheets/content-l.swamp_violet.css">
{% endblock stylesheets_custom %}