Skip to content
Basic artifacts to build CSS styles based on the CLARIN house style
HTML CSS Shell JavaScript Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.gitignore
.maven-settings.xml
.pre-commit-config.yaml
.travis.yml
CHANGES.md
Makefile
README.md
build.sh
pom.xml

README.md

CLARIN base style

Build Status

A Bootstrap based CLARIN style implementing the CLARIN interface guidelines, which in turn are based on the CLARIN style guide. Additional information about branding and styling in CLARIN can be found on the CLARIN Trac.

Using the CLARIN style

There are various ways of using the CLARIN style, which are described below. Which one is the best choice, depends on the usage context. There are a few important points to take note of regardless of the means of usage:

  • The CLARIN style makes us of a number of open fonts that are part of the CLARIN style guides. Some of the distributions include the required font files. See the fonts section of this document for instructions on how to get the right fonts to be used inside your application.
  • Avoid making changes to the CSS or LESS in your copy of the base style, including the Bootstrap variables. Doing so may make it hard for you to upgrade to future versions of the base style. CSS and LESS have various ways of extending and overriding inherited styles, so please make use of those and do not alter provided 'upstream' stylesheets. If there are fixes or other changes that you think should be included in the next version of the base style, please make an issue or pull request on GitHub.

Compiled CSS output

A compiled CSS file is made available for each release. See releases within the main base_style repository. The best way to use this CSS file in your project, is to use it as is and make any overrides or other adjustments in separate CSS files local to the project. This way you can easily upgrade the CLARIN CSS when a new release is made available.

LESS files

Bootstrap variables

The variables.less file can be obtained form the Git repository and is also made available with each release.

Use this LESS file in place of the supplied file of the same name when building CSS from Bootstrap sources (see Bootstrap's instructions for building CSS).

Additional style classes

The clarin-additions.less file provides additional common CLARIN classes that are not part of Bootstrap.

This LESS file has to be wrapped into a parent LESS file that also includes its Bootstrap dependencies (variables and mixins). There is a wrapper LESS file clarin-bootstrap.less that combines the Bootstrap root less file and the CLARIN additions.

Compiling

Use the wrapp LESS file clarin-bootstrap.less to compile both "CLARIN flavoured" Bootstrap and the CLARIN additional classes into a single CSS file. Place it in the less directory of the Bootstrap source distribution. Alternatively you can use the standard bootstrap.less to skip CLARIN's additional classes.

Make sure to use a compatible version of Bootstrap when compiling! The version for which the style was developed and tested can be found in the Travis configuration file.

As with the CSS file (see above), its best to use it as is (preferably including it build time based on the style's version number) and make any overrides or other adjustments in separate LESS files local to the project. This way you can easily upgrade the CLARIN style when a new release is made available.

Using the style in a Maven project

You can use the following artifact:

<groupId>eu.clarin.style</groupId>
<artifactId>base-style</artifactId>
<version>0.2.0</version>
<!-- available classifiers: 'css-with-bootstrap', 'less-with-bootstrap' and 'less-without-bootstrap' -->
<classifier>css-with-bootstrap</classifier>

This can be used in combination with, for example, the unpack goal of the maven-dependency-plugin so that the CLARIN base style CSS or LESS is included among your resources before compiling or packaging. See the VLO webapp project for an example.

JARs are also bundled with releases, and releases and snapshots are deployed to CLARIN's Nexus repository.

Building the Maven artifacts yourself

Be aware that the POM file was designed to be triggered in the CI process (i.e. by Travis). If you would like to build (one of) these JARs yourself, pass the following parameters:

-Dstyle.version=${STYLE_VERSION}
-Dbootstrap.version=${BOOTSTRAP_VERSION}
-P${PROFILE}

where ${PROFILE} should match one of the classifiers and the style and bootstrap versions should match the respective values specified in .travis.yml

To deploy to Nexus, you can use the maven-deploy script. This requires the STYLE_VERSION environment variable to be set.

Using the style in a drupal website

See the www-clarin-eu_src project. Dependency of alpine-httpd-drupal.

Fonts

The CLARIN style guide specifies that the follow open fonts, all available through Google Fonts, are to be used:

These fonts are included in the base style. However take note that not all distributions include the actual font files. Specifically, the 'without-bootstrap' distribution (see releases page) only includes the .less files that make up the CLARIN base style but none of the dependencies.

Making changes to the CLARIN style

  1. Edit the Less file(s)
  • Make a branch or fork (please don't commit anything not ready for release to master!) of the base_style repository.
  • Make any desired changes to the variables.less file or add new style code to clarin-additions.less as required.
  1. Check the results
  1. Make or request a release
  • IMPORTANT: increase the version number in .travis.yml
  • Merge into 'master' or make a pull request.
  • Make a tag or ask someone with the right permissions. This will trigger a Travis job, which will result in a deployment of the artifacts into a release.
You can’t perform that action at this time.