[All Adaptavist Apps]

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
h1. Options Tab

...



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

...



{excerpt

...

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

...

Image Removed

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.

 etc.{excerpt}

!manage-layouts-options-tab.png|align=center!

h2. 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.

h2. 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|Layout Tab] using the [Panel Editor].

{expand:How do I add custom links to the breadcrumb trail?}
{quote}
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:

{code}
{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.

Expand
How do I add custom links to the breadcrumb trail?How do I add custom links to the breadcrumb trail?

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:

Code Block

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.

{code}

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.
{quote}
{expand}

h2. Page Alignment

This option sets the horizontal alignment of the [page panel|Layout Tab] to either Left, Center or Right aligned.

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

h2. 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.

{expand:How do I create a link to the printable view?}{quote}
To add a link within within your [menus|Menus Tab], you can use the [compound-menulink macro]:

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

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


{code
}
{menulink:printableView}Print Version{menulink}
{code}
Expand
How do I create a link to the printable view?How do I create a link to the printable view?

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

Code Block

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.

Search Engine Optimisation

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

(info) 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.

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) to reduce page load times.

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.

{quote}{expand}

h2. 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].

{menuicon:key} System Administrators can set [permissions|Global Permissions Tab] to restrict who can use these options. By default, only Confluence site administrators ({{confluence-administrators}} group) can change these options.

h2. Search Engine Optimisation

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

{menuicon:key} System Administrators can set [permissions|Global Permissions Tab] to restrict who can use these options. By default, only Confluence site administrators ({{confluence-administrators}} group) can change these options.

h2. 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].

{menuicon:key} System Administrators can set [permissions|Global Permissions Tab] to restrict who can use these options. By default, only Confluence site administrators ({{confluence-administrators}} group) can change these options.

h2. Debug

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

h3. Display debug comment

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

{expand:Click to display example...}
{quote}
{code}
<!-- 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'
-->
Expand
Click to display example...Click to display example...
Code Block

...

{code}
{quote}
{expand}

This information is useful if you've encountered a problem with a layout and require [online support|https://support.adaptavist.com] 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.

...



h3. 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.

...



h2. HTML

...

(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.

What are the "Use
 Tag

(i) System Administrators can set [permissions|Global Permissions Tab] 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.

{expand:Why would I want to do this?}
{quote}
The primary purpose of this option is to add a VML namespace when using things like the [Google Maps API|http://www.google.com/apis/maps/documentation/index.html#XHTML_and_VML]:

{code}
xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-microsoft-com:vml"
Expand
Why would I want to do this?Why would I want to do this?
Expand
Some of the options are missing - why?Some of the options are missing - why?

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

Expand

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

Code Block

FAQs

...

links?

{code}
{quote}
{expand}

h2. FAQs

{expand:Some of the options are missing - why?}
{quote}
Your site administrator might have restricted to some of the more advanced options (marked with (i) above) using the [Global Permissions Tab].
{quote}
{expand}

{expand:What are the "Use Default..."
What are the "Use Default..." links?

Read Layout Hierarchy to find out (smile)

See Also

 links?}
{quote}
Read [Layout Hierarchy] to find out :)
{quote}
{expand}

h2. See Also

* [builder-breadcrumbs macro] - this macro inserts the breadcrumb trail in to your layout and is affected by the Breadcrumbs options on the Options tab.
* [builder-pagetitle macro], [builder-spacetitle macro] - these macros can be used in the Page Title setting of the Options tab
* [menuicon macro] - this option can be used to add icons to menus and content and is affected by the "Enable PNG alpha-transparency" setting on the Options tab