Confluence Docs 3.3 : Customising Layouts
This page last changed on May 18, 2010 by alui.
Confluence's look and feel can be modified by editing the 'decorator' (layout) files. Modifying these files allows you to change the look and feel of:
This page tells you how to customise the layout files for your Confluence site as a whole. These customisations:
You can also customise the layout files for a given space only. For more information, refer to Customising Layouts for a Space.
Confluence is built on top of the open source SiteMesh library, a web-page layout system. Read more on the SiteMesh website. To edit the layout of Confluence, you will need to modify these decorator files. A decorator file is a .vmd file and is written in a very simple programming language called Velocity. You can learn more from the Velocity User Guide. Once you are familiar with Velocity, you can edit the decorator files to personalise the appearance of Confluence. The decorator files are grouped into:
Editing a site decorator file
Using Velocity macrosWhen editing Custom Decorator Templates, there are a number of macros available to define complex or variable parts of the page such as menus and breadcrumbs. You may insert these macros anywhere in your templates. More information on Working With Decorator Macros. For advanced usersThe velocity directory is at the front of Confluence's velocity template search path. As such, you can override any of Confluence's velocity templates by placing an identically named file in the right place. While we don't recommend you do this unless you know exactly what you're doing, it does give you complete control over the look of every aspect of Confluence. It also means that you can edit your templates in a text-editor if you wish, rather than through the web interface.
In Confluence 2.6 and later, some Velocity files are located inside the Confluence JAR file that can be found at confluence/WEB-INF/lib/confluence-x.x.x.jar. To override files inside this JAR (which you can open with any ZIP tool like WinZip or 7-Zip), put your customised file in the same directory structure under confluence/WEB-INF/classes/. For example, the file templates/macros/alphaindex.vm inside confluence.jar can be replace by putting your custom file in WEB-INF/classes/templates/macros/alphaindex.vm. You do not need to modify the file inside the JAR. See also Editing Files within JAR Archives. RELATED TOPICS
|
![]() |
Document generated by Confluence on Jul 09, 2010 01:09 |