Theme Builder Plugin

[All Adaptavist Apps]

Page tree

  • Created by Unknown User (gfraser), last modified on Nov 12, 2007

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

Compare with Current View Page History

« Previous Version 16 Next »

Options Tab

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

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

Unable to render embedded object: File (manage-layouts-options-tab.png) not found.

Email Notifications

By default, when you edit pages an email notification will be sent to anyone watching the page. The person can manually check the "Minor Edit" text box to prevent notifications from being sent if desired.

The "Check 'minor edit' checkbox by default" option does just that - when someone edits a page the checkbox will automatically be checked. This is useful for spaces where the majority of edits are small and notifications are not generally desired.

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.

To add a link within within your menus, you can use the [compound-menulink macro]:

{compound-menuitem:printableView|icon=printer|caption=Printable View}

If you want to add a simple text link you can use the menulink macro:

{menulink:printableView}Print Version{menulink}

Favourites Icon

The favourites icon appears next to the URL in the web browser toolbar, bookmarks and some browser plugins. This option allows you to customise the favourites icon.

For more information, please see Favourites Icon.

Unknown macro: {menuicon}

System Administrators can set permissions to restrict who can use these options. By default, only Confluence site administrators (confluence-administrators group) can change these options.

Search Engine Optimisation

For more details on the options in this section, please see Search Engine Optimisation.

Unknown macro: {menuicon}

System Administrators can set permissions to restrict who can use these options. By default, only Confluence site administrators (confluence-administrators group) can change these options.

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.

For more information, please see [JavaScript Options].

Unknown macro: {menuicon}

System Administrators can set permissions to restrict who can use these options. By default, only Confluence site administrators (confluence-administrators group) can change these options.

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.

If you don't need this information, de-select the option to reduce page sizes, bandwidth consumption and even a tiny bit of processing time on the server.

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

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"

FAQs

Your site administrator might have restricted to some of the more advanced options (marked with above) using the Global Permissions Tab.

Read Layout Hierarchy to find out

See Also

  • No labels