Getting Started | Halogy User Guide

Getting Started With Halogy

What is Halogy?

Halogy is a simple, easy-to-use and modern publishing platform or 'CMS' (Content Management System). It has lots of modules that you can enable or disable such as Blog and Shop and gives website owners a lot of control over their websites.


Halogy uses templates to construct it's pages. Those templates work off a powerful system which converts raw HTML and {tags} in to dynamic web pages.


Tags (or 'curly brackets' to you and me) are where non-static content is inserted. For example static content would be some HTML, but with the addition of a dynamic area such as {navigation} you can insert aspects of Halogy in to your pages (such as the Navigation).


Includes are chunks of code that you can insert in to your pages. They can be either HTML snippets (containing tags if you wish), CSS code or Javascript code. You reference the includes in your templates using a curly bracket {include:my-reference}. For CSS and Javascript you an access these via the URLs /css and /js.


Blocks are editable regions used within pages. So your template might consist of Includes for the header and footer, some dynamic areas for things like navigation and finally it would need Blocks for the editable regions inside pages.

The way Halogy is built means that you can build a set templates which form the construct of your site, and then create a new permission group that only allows the users access to the pages (with their Blocks or editable regions) and not the templates. This gives content managers a lot of power and it can be very useful for larger sites.

Blocks use a syntax called Markdown which makes Halogy different from most other CMS out there. In other CMS you might find a clunky rich text editor within the Edit Page window. In Halogy this is removed and you simply just type in the text with basic formatting should you need it.

Why do we not use rich text editors? Because the rich text editors often used can be slow, cumbersome, large and also tend to produce horrible markup (HTML code) used in websites - which we really don't like. It also means you can edit lots of regions in a single page very quickly. How cool.


Modules in Halogy are what really add the power. As good as the CMS might be, what really makes things useful is when you can easily drop in a Forum for community discussions, or maybe sell products using the Shop. The modules in Halogy all work together and are easily configurable.

What's more, the modules in Halogy are fully customizable through the template system. You can make everything look and feel just as you like with your own HTML/CSS.

Modules are all installed by default and can be accessed by going to /shop, /blog, or /events (etc). If you want to disable modules selectively you can do this from the Site manager (accessible only to superusers).


Images can be uploaded via the admin system and then referenced using the {image:REFERENCE} syntax. All images can also be found using /images or /gfx followed by the reference of your image (and then the extension).

For example say you uploaded an image and called it My Logo. The reference would get automatically made as "my-logo" and the file was a JPEG. You can then insert the image either by {image:my-logo} or you can use your own custom HTML and find the image under "/images/my-logo.jpg".