Skip to end of metadata
Go to start of metadata

The Skin Editor Options screen lets you tweak various settings such as Fav Icon, Page Title, SEO settings and Cache Control

Options Settings

Switchable Skins

Add a list of skin ids in this field to restrict the skins that can be used with the 'use-skin' macro and the 'skin=' URL parameter. Leave empty to allow all skins to be switched to.

Note

If you add a skin which has its own list of skins, or an empty field, then that skin's switching rules apply when switched to.

Page Options

Favourites Icon

Add the location of a custom favourites icon (favicon). The link can be to a web location, an image on a Confluence page, or ThemeBuilder resource

To use the default Confluence favicon use the relative location of the icon eg    /favicon.ico

Other Examples

Confluence Page: SpaceKey:page^attachment

ThemeBuilder Resource: SkinID:ResourceName

Page Title

This option allows you to customise the page title that is shown in the web browser title bar (the <title> element in the HTML <head> section) which is useful if you are optimising your wiki for search engines like Google.

The default wiki markup is

{panel-info:type=page.title} - {panel-show:space=@global,@personal}{panel-info:type=space.name} - {panel-show}{panel-info:type=site.name}

This can be changed using the options from the 'panel-info' macro, or 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.

You should always show the most microscopic information first (eg. page title) and more macroscopic information later (eg. space title followed by site title). As well as improving search results, this will also make tabbed browsing easier for end-users.

Search Engine Optimisation

Automatically Generate Meta Data

Although meta tags are generally no longer used by most search engines, they are still commonly used by Intranet search appliances. These three options allow you to automatically generate meta tags on all applicable pages viewed using the skin.

Meta Tag

Default

Notes

Keywords

(tick)

Generates a keywords meta tag based on content labels. Simply add the labels to your wiki page or blog posts:
 
Theme Builder will generate the keywords meta tag:

<meta name="KEYWORDS" content="options, seo, search, engines">

When you change the labels on a page, the meta tag is automatically updated to reflect the changes.

Description

(error)

Generates a description meta tag based on the content excerpt, for example:

<meta name="DESCRIPTION" content="Theme Builder provides a number of options that...">

You can customise the excerpt for a page or blog post using the excerpt macro. If no excerpt is specified, a short abstract taken from the opening text on the page will be used.

Author

(error)

Generates an author meta tag based on the person who created the content, for example:

<meta name="AUTHOR" content="Guy Fraser">


Custom Meta Tags

To add custom meta tags, use the "Custom HTML" feature in the Confluence administration console. Note, however, that this will apply the custom meta tags to all pages in Confluence, regardless of which theme or skin is selected.

Using meta tags will slightly increase page size and therefore download times. On busy servers, the overheads of automatically generating meta tags may have a slight performance impact.

Search Engines

Most search engines (Google, Yahoo, etc) allow sites to alter the way they are indexed and how search results are shown. Each of the following options determines what search engines should do:

Option

Default

Notes

Use public directories

(error)

Search Engines will often use snippets from a directory service (Open Directory Project for Google/Microsoft/Yahoo, Yahoo! Directory for Yahoo) in preference to whatever is in the page itself. By default this option is disabled, forcing search engines to take excerpts from your wiki rather than external directories (more information).

Include pages in index

(tick)

By default, search engines will index your site and include it in their search results. You can de-select this option to prevent most popular search engines and appliances from indexing pages themed with the skin.

Follow links to other pages

(tick)

By default, when a search engine indexes a page it will also index all pages which that page links to. Disable this option to reduce the likelihood of search engines indexing linked pages.

Archive pages

(tick)

By default, many search engines will archive pages and make cached versions available. You can de-select this option to prevent them from doing so.

Display summaries in results

(tick)

By default search results will include a short summary of your content - this helps the end-user decide if the result is relevant to what they are searching for. If you don't want summaries to be displayed you can de-select this option.

For a much more detailed overview of what these options do, please see this Search Engine Land article.

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.

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.

Debug

This option allows additional "debug" information to be output in the HTML of pages using the skin.

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


 

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

The decorator, context and mode values provide a quick way to determine settings for the panel-show macro and panel-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.

Note

You will need to click the 'Save' button to apply any changes made in the 'Options' screen.


  • No labels