[All Adaptavist Apps]

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Options Tab

The Options tab lets you tweak various settings such as breadcrumbs, printable layout, JavaScript libraries, etc.

This tab is accessed from the Layout Manager in Theme Builder 3.0 and above.

Breadcrumbs

These options allow you to optionally hide any of the first three links on the breadcrumb trail.

The breadcrumb trail is added to a layout by placing the builder-breadcrumbs macro in one of the layout panels using the Panel Editor.

If you want to add some custom links to the start of the breadcrumb trail, e.g. your own custom Dashboard link having hidden the default Dashboard link, you can do so using the following syntax:

{span:class=breadcrumbs}{menulink:home|space=Dashboard}Dashboard{menulink} > {span}{builder-breadcrumbs}

The span macro is used to apply the breadcrumbs class to the custom Dashboard link (which is added using the menulink macro) to ensure that it looks the same as the other links in the breadcrumb trial.

Page Alignment

This option sets the horizontal alignment of the page panel to either Left, Center or Right aligned.

For this setting to have effect, the width of the page panel must be less than 100%.

Printable Layout

This setting allows you to choose which layout is used when the printable view of a page is shown.

To set the printable layout, enter the Layout ID for the layout you wish to use in to the text box. The ID for a layout is shown on the Overview Tab.

If no ID is specified, the current layout will be used for the printable view.

You can add a link to the printable view using the menulink macro with a location of "printableView" and optionally include an icon using the menuicon macro:

{menulink:printableView}{menuicon:printer} Print Version{menulink}

Page Title

(info) System Administrators can set permissions to restrict who can use this option.

This option allows you to customise the page title that is shown in the web browser title bar.

The default page title is:

{builder-pagetitle} - {builder-spacetitle} {builder-spacetitle:sitetitle=true|global=false|prefix=- }

You can use any macro, including User Macros or third-party macros, as well as basic wiki notation. Please ensure that there is no HTML or line breaks in the rendered page title as these will cause problems with the browser.

JavaScript Options

These options allow you to remove certain JavaScript libraries from the theme - this is sometimes useful if you are using your own libraries or want to minimise bandwidth consumption.

Enable PNG alpha-transparency support in Internet Explorer

Internet Explorer versions prior to 7.0 did not handle alpha transparency in PNG images properly. By default, Theme Builder includes a JavaScript library that fixes this problem in Internet Explorer 5.5 to 6.x.

If you don't use PNG images and want to reduce page load times, you can turn off this feature.

Note: The menuicon macro will automatically output the appropriate image format (either PNG or GIF) based on this setting.

Enable script.aculo.us effects

(info) System Administrators can set permissions to restrict who can use this option.

By default, Confluence includes a JavaScript library called script.aculo.us which has all kinds of useful features for JavaScript developers.

The library is used for a wide range of Confluence macros including the Calendar macro, the builder-labels macro and even parts of the Confluence user interface.

If you are not using anything that requires this library, you can turn it off using this option (not recommended).

Debug

By popular demand we've added two optional "debug" options to Theme Builder...

Display debug comment

This option, when selected, will output a comment in the HTML source of web pages that use the layout:

<!-- main.vmd
  themebuilder : 'com.adaptavist.confluence.builder.theme.VelocityHelper@5ab51e'
  layout : 'com.adaptavist.confluence.builder.layouts.model.Layout@1ac00fe'
  spaceKey : 'sw'
  currentURL : '/pages/viewpage.action?spaceKey=sw&title=Home'
  contextPath : ''
  spaceName : 'Simon'
  printable : 'false'
  mode : 'view'
  context : 'page'
  decorator : '$decorator'
-->

This information is useful if you've encountered a problem with a layout and require online support but there are a few very useful bits of information for theme designers in there as well...

The decorator, context and mode values provide a quick way to determine settings for the builder-show macro and builder-hide macro.

Values starting with a $ indicate that the property is undefined for whatever page you are looking at.

Display Confluence and Theme Builder version number in footer

This option, when selected, will show the version numbers of Theme Builder and Confluence at the bottom of pages.

This is often useful for support, especially in large organisations where internal policies would make this information otherwise difficult to find.

HTML Tag

(info) System Administrators can set permissions to restrict who can use this option.

This option allows you to add attributes to the <HTML> tag for all pages viewed with the layout.

The primary purpose of this option is to add a VML namespace when using things like the Google Maps API:

xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-microsoft-com:vml"
  • No labels