Theme Builder Plugin

[All Adaptavist Apps]

Page tree

Versions Compared

Old Version 27

changes.mady.by.user Unknown User (gfraser)

Saved on

compared with

New Version Current

changes.mady.by.user Sharon Hinde

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

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, etc.

Image Added

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.

Image Added

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.

Image Added

The breadcrumb trail is added to a layout by placing the

No Format
[builder-breadcrumbs macro]

in one of the layout panels using the Panel Editor.

Expand
How do I add custom links to the breadcrumb trail?
How do I add custom links to the breadcrumb trail?
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 [USERGUIDE: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}

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

{span:class=breadcrumbs}{menulink:home|space=Dashboard}Dashboard{menulink} > {span}{builder-breadcrumbs}
{code} The [USERGUIDE:span macro] is used to apply the breadcrumbs class to the custom Dashboard link (which is added using the [USERGUIDE: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 [USERGUIDE: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 [USERGUIDE:compound-menulink macro]: {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.
Page Alignment
This option sets the horizontal alignment of the page panel to either Left, Center or Right aligned.
Image Added
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.
Image Added
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?
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

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

{code}


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


{
 Code Block
}

{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.
Image Added
For more information, please see Favourites Icon.
 Image Added 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.
Image Added
Image Added 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.
HTML Tag
Image Added 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.
This option allows you to add attributes to the <HTML> tag for all pages viewed with the layout.
Image Added
 Expand
Why would I want to do this?
Why would I want to do this?
The primary purpose of this option is to add a VML namespace when using things like the Google Maps API:
 Code Block

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

HTML Cache Control
This option allows you to customise the cache settings for the HTML output by the wiki, enabling external caches and the browser cache to heavily cache pages for greater performance.
Image Added
When using this option, changes and comments will generally not appear during the cache period unless a user clears their browser cache. If you allow public caching of the page, ISPs and proxy servers can also cache the page preventing end-users from receiving a new copy of the page until the cache expires.
This option is particularly useful in situations where your wiki is remotely accessed from an office in a different country with limited bandwidth - it allows changes to still propagate through to the other office, albeit delayed, whilst significantly reducing bandwidth consumption and load on your wiki server.
NB: In some server/network configurations Internet Explorer has issues with the "may be cached but not archived" setting which leads to the css being truncated and the display breaking. This setting should be avoided if you expect a large number of IE6 users.
Debug
These options allow additional "debug" information to be output in the HTML of pages using the layout.
Image Added
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...
Click to display example...
{code}
{quote}{expand}

h2. Page Title

This setting allows you to customise the page title element {{<title>}} in the HTML {{<head>}} section.

For more details on the Page Title option and it's settings, please see [USERGUIDE: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.

(i) To change the title shown in the web page use the [Layout Tab] and [Panel Editor] to edit the wiki content of the "Title" panel.

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 [USERGUIDE: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 [USERGUIDE: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 [USERGUIDE: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}
 Code Block

<!-- 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'
-->

{code}
{quote}{expand}

This information is useful if 
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.
FAQs
 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 Image Added above) using the Global Permissions Tab.
 Expand
How do I quickly get an uncached version of a page?
How do I quickly get an uncached version of a page?
If the page is only cached by your web browser, clicking the refresh button will usually load a new version. Alternatively you could clear your browser cache to get new versions of all pages and files.
If the page has been cached by a public cache, eg. your ISP or a proxy server, clearing the browser cache will have little effect as you'll just get the publicly cached version.
On trick that we use is to add a question mark to the end of the URL followed by a random number. The caches see this as a new page ensuring you get the most recent version while Confluence will just ignore the question mark and the number after it. A key benefit of this approach is that only the HTML gets reloaded - all images and other files will remain cached.
 Expand
What are the "Use Default..." links?
What are the "Use Default..." links?
Read Layout Hierarchy to find out (smile)
See Also