Introduction

This is a base branding for new Living Atlas deployments. That is, some ALA header, banner and footer theme with:

• Well integration with ALA modules trying to avoid jquery conflicts and similar
• Well integration with CAS Authentication
• Multilingual
• Modern javascript code without lost compatibility with old browsers
• Digest usage for skip cache old js/css when we release a new version

You can use this as a basis for a new LA infrastructure branding or just to see how you can integrate your branding with ALA dependencies, etc.

Strategy

A LA compatible branding consist (currently) in a Bootstrap v3 footer and header html/css/js files that are loaded by all ALA java modules. But also some resources (like fonts, js/css dependencies, etcetera) are loaded from this branding (like jQuery or Bootstrap).

In other words, we can have our custom html with our custom look & feel, image, css, menus, and still we need to put in our branding some common libs and resources that should be loaded by the ALA modules (like bootstrap, jquery and other js libs).

Our strategy is to keep our brandings in sync with these dependencies easily. For this we just copy all that resources from the ALA current branding that is included in this repository as a git submodule and their resources are copied on each build. With the same strategy the LA branding includes their WP theme as a submodule, so, if they change some css in the WP theme, their branding is also updated.

This base branding ---- uses ---> ALA branding resources ---- uses ----> ALA WP theme resources

For instance, to avoid conflicts, we only load js libs that are not used by ALA (like i18next js lib) and we use the libs that ALA already include in their branding and software (as the jQuery lib or the Boostrap 3 framework and deps).

The goal is also not to deal with duplicate code and their problems.

So if ALA fix some js error, or if add a new chart lib, or similar, we can include that changes in our build easily.

This is how the base-branding includes the ALA theme code in the build process:

The branding also create some homepage, some test pages and a error page. But if you need some more complex homepage, and for instance, you need to use a CMS (like Wordpress), our recommendation is that you can use a similar strategy to avoid the need of keed in sync your LA branding and your CMS theme. So you can develop a common header/footer and css styling in your CMS, and include it in a fork of this sample branding. In summary:

Your branding ---- uses ---> ALA branding resources ---- uses ----> ALA WP theme resources
              `--- uses ---> you CMS theme resources

So if for instance, you change a logo or a footer link in your CMS you can have the same change in your LA portal easily. For that you need to include it a submodule and also copy your resources during the build like we do with the ALA resources.

Also in general we try not to mix libs versions like different Boostrap or jQuery versions.

Other strategy is to have an independent CMS theme with their own js/css and a simpler LA branding with a similar look a feel but using ALA libs (Bootstrap 3 ...).

Styling

ALA uses Bootstrap version 3 in most of their modules.

This branding has currently several themes in app/themes. One is a clean Boostrap 3 theme that you can easy adapt to your site needs. This is useful when you already have a css/html style (for instance of your blog or main site) that you want to integrate with the new LA portal. Based in this clean BS3 theme there are other customized versions using many of the https://bootswatch.com/3/ themes.

Additionally we have a material-bootstrap theme in app/themes/material as a demostration of how to do a different look&feel to a LA portal with other js/css libs. This material theme uses:

• Material Design Lite https://getmdl.io/ with a custom theme that you can https://getmdl.io/customize/index.html change, download and put instead of app/themes/material/css/material.min.css.
• And experimentally also Material Bootstrap Design to have similar style in the ALA modules. If you only want to do minor style changes, have a look to app/themes/material/css/material-custom-styles.css.

This styling is not the most important work of this base-branding, but instead the integration with ALA and the brunch configuration that gives you the possibility to use modern javascript code and modern libraries or use i18next, for example.

Structure

├──app
│   ├── assets           # static assets, like index/header/footer/banner.html
│   │   ├── fonts        # etc
│   │   ├── locales
│   │   └── images
│   ├── css              # put your css here
│   ├── js               # put your js code here
│   └── themes
│       ├── clean        # clean BS3 theme that you can select in settings.js
│       │   ├── assets
│       │   ├── js
│       │   └── css
│       │   (...)        # add your custom theme here
│       └── material     # material-BS3 theme that you can select in settings.js
│           ├── assets
│           ├── css
│           └── js
├──commonui-bs3-2019     # ALA branding as submodule
│
├──node-modules          # 'yarn add module', to install
│                        # any node module and use it in your js code
└──public
    ├── css              # The 'public' directory is what you have to deploy
    │   └── images       # It's generated by `brunch`
    ├── fonts
    ├── locales
    ├── images
    └── js

Brunch compiles in public your js/css and make this compatible with older browsers (so you can use node modules or ES6 code without problems).

Basic settings

See and edit app/js/settings.js there you can select for instance the theme you want to use.

Development

This is using https://brunch.io instead of gulp and using ALA commonui-bs3-2019 as a git submodule to use the same assets used by ALA modules.

There is a experimental branch vite that uses vitejs instead.

Usage

# First use:

git clone --recurse-submodule https://github.com/living-atlases/base-branding.git
# if you cloned without the submodules: git submodule update --init --recursive # use --init only the fist time

# install yarn with or similar:
# https://classic.yarnpkg.com/en/docs/install/#debian-stable

yarn install
npm install -g brunch

# During development
brunch watch -s
# or
brunch build
# or
brunch build --production

Test with:

• http://localhost:3333/
• http://localhost:3333/testPage.html
• http://localhost:3333/errorPage.html

Deployment and ALA configuration

brunch build --production && rsync -a --delete --info=progress2 public/ your-server:/srv/your-server-domain/www/test-skin/

And in your inventories:

header_and_footer_baseurl = https://l-a.site/test-skin
header_and_footer_version = 2

The version = 2 will substitute some ::variables:: like login/logout urls in your head/banner/footer.html in production. This is also done in index.html and during development with the app/js/settings.js values. See ala-bootstrap3 HeaderFotterTagLib.groovy for more details. Use the appropriate skin (see below).

test-skin is just a directory in your vhost root so you can keep different versions of a skin for testing purposes, for developing, etc. For instance when ALA uses commonui-bs3-2019 directory their modules uses resources like https://www.ala.org.au/commonui-bs3-2019/head.html.

More information about rsync and scp directories here.

About skin.layouts recommend to use on each ALA modules

In general you should use main or generic skin in your ALA modules. Some coments:

• collectory: ala skin layout works well
• species: ala skin layout works well
• regions: main skin layout works well
• bie-index: main skin layout works well
• lists: main skin layout works well
• images: main skin layout works well
• biocache: ala skin layout works well
• userdetails: ala-main skin layout works well

Here you have a table of skin layouts recommended, variables names, layouts used by ALA, links to code, etc.

Why brunch?

With brunch.io we can use node modules, ES6 js code, sourcemaps, minimize, development with watch and browser auto reload etc, with a more easy configuration than gulp.

We copy the ALA dependencies (jquery, autocomplete, etc) via a plugin from the ALA submodule, so we can integrate ALA modules well.

See the brunch-config.js for more details.

TODO

• Add error page
• LA occurrences, etc stats in index
• use of SASS and better style customization options
• Nowadays, during development, if you modify the head/footer/banner you need an extra manual brunch build to update well your index and testPage with your changes. We have to find a better way to replace the HEADER, BANNER etc. See brunch-config.js plugins for more details.
• Integration of some EU cookie utility like: https://www.npmjs.com/package/@beyonk/gdpr-cookie-consent-banner
• Add sample /favicon/{manifest.json|favicon.*} required by CAS

Pull Request welcome!

Screenshots

Material theme

Home page with stats:

Multilingual menu selection integrated with grails i18n:

CAS Authentication links in drawer (and other configurable links):

ALA Species autocompletion integrated and sticky footer:

Error page:

Clean theme

Home page with stats:

CAS Authentication links in dropdown (and other configurable links):

ALA Species autocompletion integrated and sticky footer:

Error page:

Error pages

You can enable a error banner in js/settings variable inMante to true that will visible in all the LA modules using this skin.

Also you can configure a error page in your nginx proxy, for instance:

error_page 503 https://l-a.site/errorPage.html;

or in Apache:

ErrorDocument 503 https://l-a.site/errorPage.html, for instance;

Caveats

• If this header/footer/etc are used from subdomains.your.l-a.site you can not use relative urls. You should use like https://your.l-a.site/img/someResource.png instead of img/someResource.png. If you don't use absolute urls, collectory will try to access to img/someResource.png in their tomcat without success with 404 errors, and the same with the rest of tools.
• ala-cas-5 layout ignores head.html right now.
• collectory has an old version of ala-bootstrap3.

License

Apache-2.0 © 2020-2021 Living Atlases

Additionally:

• Some html/css/js based in Material Design Lite, Apache License 2.0.
• Bootstrap Material Design, MIT license.

More information

• https://github.com/AtlasOfLivingAustralia/documentation/wiki/Styling-the-web-app