Getting organized

Before diving in and writing themes, you need to get your starting materials organised and work out how you are going to tackle the theme.

It makes sense to put all the things you need for a theme into a single folder. If you are building a full theme, within this folder you will need a theme style node, a theme brand node, and a theme assembler node. Use this theme folder template to create a theme folder. (This link will open in a new window and create a theme folder in the Sandbox. Move it somewhere more sensible.)

If you want your theme to be publically available, grant the Anonymous user Page administer permission over the folder. This doesn't actually allow anonymous to administer the folder, its just a shorthand for giving all users read access.

You might have some existing components - for example Bootstrap CSS themes or new JavaScript libraries. Arrange these into a series of related zip files, and upload these to your folder.

You will need to write some CSS or JavaScript yourself. If you prefer to do your editing outside of Metrici, edit the files on your PC and upload them using the standard File type. If you would prefer to edit them using the editors built into Metrici, use the Content File type. See Theme files comparison for a discussion of the different ways of holding files.

If you are creating both a visual style and adding UI components to support a product, you need to make sure that:

  • Your style can be used with other products.
  • Your product can be used with other styles.

To achieve this, you need to split your theme development into two streams. One stream builds the style and branding, and tests that on normal Metrici pages. Another stream builds the product theme components, and tests them using an unstyled theme. When you are satisfied that the style works well on normal Metrici pages, and your product components work well using an unstyled theme, you can combine the two.