wiki:DeveloperGuidelines/Themes/SCSS

Version 11 (modified by Dominic König, 6 years ago) ( diff )

--

Creating new Themes with Foundation and SCSS

Table of Contents

  1. Creating the Theme
    1. CSS/SCSS Files and Folders
    2. Copying from Skeleton
  2. Building the Theme
    1. Developer Preview
    2. Production
  3. Using the Theme in a Template
    1. Adding Foundation to layout.html
      1. Base Styles
      2. Scripts
    2. Adding Theme Styles to css.cfg

Creating the Theme

CSS/SCSS Files and Folders

themes/THEME                    Base folder
|
+---theme.css                       the theme's SCSS-built parts
+---style.css                       the theme's additional CSS (optional)
+---eden.min.css                    css.cfg-built, minified CSS
+---*.css                           any additional injectable CSS (s3.stylesheets)

themes/THEME/foundation         The theme's Foundation base stylesheets
|
+---foundation.css                  the theme's foundation stylesheet for Left-to-Right writing direction
+---foundation.rtl.css              the theme's foundation stylesheet for Right-to-Left writing direction
+---foundation.min.css              minified versions of the above
+---foundation.rtl.min.css          "

themes/THEME/img                Image folder of the theme
themes/THEME/js                 Script folder of the theme (injected scripts)
themes/THEME/favicon.ico        The bookmark icon of the theme

themes/THEME/scss               the SCSS folder of the theme
|
+---_settings.scss                  the theme's foundation SCSS settings (=> falls back to default/scss/_settings.scss if not present)
+---foundation.scss                 the theme's foundation SCSS imports
+---foundation.rtl.scss             the theme's foundation SCSS RTL overrides
+---theme.scss                      the theme's SCSS imports
|
+---theme/                      the theme's SCSS sources
    |
    +---_base.scss                  the theme's SCSS base (required)
    +---_config.scss                the theme's Sahana-specific SCSS settings
    +---_*.scss                     the individual SCSS sources (=> fall back to the corresponding default/scss/theme/*.scss)

Copying from Skeleton

Building the Theme

Developer Preview

Production

Using the Theme in a Template

Adding Foundation to layout.html

Base Styles

Foundation-based themes must include the Foundation base stylesheets, ahead of any Sahana style sheets:

  • static/themes/foundation/normalize.css
  • static/themes/THEME/foundation/foundation.css
  • static/themes/THEME/foundation/foundation.rtl.css

Note that only one of foundation.css or foundation.rtl.css is loaded, depending on the writing direction for the current UI language (Left-To-Right or Right-To-Left).

The sequence to include Foundation base styles is encoded in a view template views/foundation.css.html, so it can easily be added to layout.html: 

...
{{for sheet in s3.external_stylesheets:}}
 <link href="{{=sheet}}" rel="stylesheet" type="text/css" media="screen" charset="utf-8" />
{{pass}}

{{include "foundation.css.html"}}    <--- Foundation base styles are loaded here

{{for sheet in s3.stylesheets:}}
 <link href="/{{=appname}}/static/styles/{{=sheet}}" rel="stylesheet" type="text/css" media="screen" charset="utf-8" />
{{pass}}
{{if s3.debug:}}{{=s3base.s3_include_debug_css()}}{{else:}}
 {{# Built by /static/scripts/tools/build.sahana.py }}
 <link href="/{{=appname}}/static/themes/{{=theme}}/eden.min.css" rel="stylesheet" type="text/css" />
{{pass}}
...

Scripts

Additionally, Foundation requires loading and initialization of some scripts at the end of the <body>. The corresponding sequence is also encoded in a view template views/foundation.js.html, so it can easily be added to layout.html: 

...
{{include "foundation.js.html"}}    <--- this loads and initializes Foundation scripts
</body>
</html>

Adding Theme Styles to css.cfg

The SCSS-built theme.css style sheet is included at the end of css.cfg: 

...
../themes/THEME/theme.css
#../themes/THEME/style.css
# Final line required for parsing

It can be followed by an optional THEME/style.css to add CSS for template-specific elements as well as final overrides. The style.css style sheet is not built from SCSS, so it can be edited directly.

Note: See TracWiki for help on using the wiki.