ドキュメンテーションテーマを設定する

The Documentation theme is one of the themes bundled with Confluence. (See availability below). The theme is designed for spaces containing technical documentation, but you may find it useful for other types of content too. It provides an inbuilt table of contents for your wiki space, a configurable header and footer, and text styles suited to documentation. (See features below.)

Quick guide to applying and customising the Documentation theme

Go to 'Space Admin' and click 'Themes'.
Select 'Documentation Theme' and click 'Confirm'.
If you want to customise the theme, click 'Configure theme' and enter the text and wiki markup for your custom header, footer and left-hand panel. Click 'Save'.

このページの残りの部分では、上記の手順を詳しく説明します。

On this page:

Screenshot: A wiki page using the Documentation theme

Applying the Documentation Theme to your Space

You need space administrator permissions to apply a theme to a space.

Follow the steps below to apply the 'Documentation Theme' to your space. All pages in the space will start using the theme immediately.

To apply a theme to a space,

Go to the 'Space Admin' tab of the Browse Space view. To do this:
- Go to a page in the space, open the 'Browse' menu and select 'Space Admin'. The 'Space Administration' view will open.
  'Space Admin' is only displayed if you are a space administrator for that space or you are a Confluence system administrator.
Click 'Themes' in the left-hand panel under the heading 'Look and Feel'. This will bring up a new screen showing all available themes. See screenshot below.
Click a radio button to select a theme.
Click 'Confirm'.

Screenshot : Applying a theme

Applying the theme to your entire Confluence site

If you have site administrator permissions, you can apply the theme at site level. It will then be the default theme for all spaces in the site. See the administrator's guide to applying a theme.

Customising the Documentation Theme

The theme works well without any customisation. If necessary, you can change the left-hand navigation panel and add your own header and footer.

To customise the Documentation theme,

Go to the 'Space Admin' tab of the Browse Space view. To do this:
- Go to a page in the space, open the 'Browse' menu and select 'Space Admin'. The 'Space Administration' view will open.
  'Space Admin' is only displayed if you are a space administrator for that space or you are a Confluence system administrator.
Click 'Themes' in the left-hand panel under the heading 'Look and Feel'.
If the space is not yet using the Documentation theme, apply the theme as described above.
Click 'Configure theme' in the yellow area of the 'Current Theme' section at the top of the page. See screenshot below.
The 'Documentation Theme Configuration' screen appears. See screenshot below.
Select or deselect the 'Page Tree' check box. This determines whether your space will display the default search box and table of contents (page tree) in the left-hand panel.
Enter text, images, macros and other wiki markup into any or all of the three text boxes.
You can use the Include or Excerpt Include to include re-usable content into your footer. See hint below.
- 'Navigation' – This text box contains content for the left-hand panel. If the 'Page Tree' check box is selected, the navigation panel contains the default search box and page tree. Any content you enter into the 'Navigation' text box will appear above the page tree and search box.
  You can include your own content underneath the page tree as well as above. See hint below. In summary: Deselect the 'Page Tree' check box. Insert your own page tree using the Pagetree macro, then add your own content under the macro.
- 'Header' – This text box contains content for a page header that will appear above the page title on all pages in the space. See example screenshot below.
- 'Footer' – This text box contains content for a page footer that will appear after the comments and above the site footer, on all pages in the space. See example screenshot below.
[保存] をクリックします。

スクリーンショット：'テーマの設定' のオプション

スクリーンショット：ドキュメンテーションテーマのカスマイズ

サイトレベルでのテーマのカスマイズ

If you have site administrator permissions, you can apply and customise the theme at site level. The customisation options are the same as the space level options, as described above.

Features of the Documentation Theme

スクリーンショット：カスタマイズされたヘッダー、フッター、および左側のパネル

The above screenshot shows a wiki space with a customised left-hand panel, header and footer.

ここで、ドキュメントのテーマが提供する機能の概要を紹介します。

既定では、左側のパネルには、スペース内のすべてのページを表示する、検索ボックスと目次（ページツリー）が含まれています。具体的には、スペースのホームの子ページのみを検索します。
左側のパネルは、完全にカスタマイズ可能です。検索ボックスとページツリーを含めるか除外するかを選択することができます。独自のテキスト、画像やwikiマークアップを入力することができます。
People viewing the page can drag the thick bar between the left-hand panel and the content, to increase or decrease the width of the panel. They can also remove the panel altogether, by clicking the sidebar icon at top right, next to the search box.
左側と右側のパネルは、互いに独立してスクロールします。
ページタイトルはきちんとページコンテンツの上部にあり、ナビゲーションパネルを挿入することがあるとしても、ナビゲーションパネルの上部で不快ではありません。
左側のパネルはテーマの一部であるため、Confluence をアップグレードするたびに、このパネルもアップグレードされます。左側のナビゲーションバーを独自に追加している場合に行うような、アップグレードごとにカスタマイズを削除してから再適用するといった作業の必要はありません。
テーマはまた、すべてのページの上部と下部に表示されますカスタマイズヘッダーとフッターを提供します。
テキストと見出しスタイルは、ドキュメントのスペースで典型的なコンテンツを強化するために設計されています。
スペースジャンプマクロを使用すると、リンク作成時にページの名前を知らなくても、Wiki スペースのページから別のスペースの同じ名前のページにリンクできます。

Availability of the Theme

Confluence Versions

The Documentation theme is bundled with Confluence 3.2 and later. If you have Confluence 3.1, your Confluence Administrator can download the theme from the Atlassian Plugin Exchange and install it as a plugin.

The theme is not available for versions of Confluence earlier than Confluence 3.1.

ブラウザ

The Documentation theme supports the following browsers:

Firefox
Safari
Internet Explorer 7 and later

Hints and Tips

次に、ドキュメンテーションテーマを使用するときに役立つかもしれないいくつかのヒントを紹介します。

ドキュメンテーションテーマの実用例はどこで見られますか。

Confluence のドキュメントでドキュメンテーションテーマを使用しているスペースアトラシアンの製品ドキュメントWiki で、オンラインでこのドキュメントを読んでいる場合、ドキュメンテーションテーマの作業バージョンを見ています。

ドキュメンテーションテーマの目次にどのページが表示されますか？

テーマはスペースのホームの子ページにあるすべてのページから左側のパネルにページツリーを構築します。各スペースは、[ホーム]ページとして指定された単一のページを持っています。スペースの管理セクションで、ホームのページを指定することができます

ヘルプ！ドキュメンテーションテーマの目次に、私のページが表示されません。

原因1 ：あなたのページには、スペースのホームの配下にはありません。 ページが左側のパネルにページツリーで表示されない一番推測される理由です。テーマはスペースのホームの子ページにあるすべてのページから左側のパネルにページツリーを構築するからです。ページがページツリーのホームの上にある場合は、左側のパネルに表示されません。

問題を解決する方法は二通りあります:

スペース管理のセクションで、ホームに指定したページを変更することができます。
Or you can drag and drop all your pages to make them children of the current home page. You can drag and drop pages in the 'Pages' section of the space 'Browse' screen. See Moving Pages within a Space.

Cause 2: Problem with upgrade from Confluence 3.1, with Documentation theme as plugin, to Confluence 3.2 with Documentation theme bundled. If your existing Confluence installation already has the Documentation theme plugin installed, you may find that after upgrading to Confluence 3.2 the left-hand navigation bar is empty in the spaces that use the theme. The fix is to enable all modules of the Documentation theme plugin. See the knowledge base article.

左パネルが消えてしまったのですが、どうすればいいですか。

If your entire left-hand panel has disappeared when using the Documentation theme, this is probably because you have clicked the sidebar icon at top right, next to the search box. Click the icon again to restore the panel.

Hiding Pages from the Left-Hand Table of Contents

スペースホームのページよりも同じレベル、またそれ以上に配置することでページを「隠す」ことができます。

各スペースは、[ホーム]ページとして指定された単一のページを持っています。スペースの管理セクションで、ホームのページを指定することができます

テーマはスペースのホームの子ページにあるすべてのページから左側のパネルにページツリーを構築します。

ドキュメントページは、スペースのホームのページと同じレベルにある場合は、左側のナビゲーションバーに表示されません。スペースホームのページよりも同じレベル、またそれ以上に配置することでページを「隠す」ことができます。ページが検索結果に表示され、彼らはページを開いた場合、人々は、コンテンツを見ることができますが、ページが左側のパネルに表示されません。

もっと詳しく：目次を生成するには、ページツリーマクロを使用します。ページツリーマクロを入力するときは、ページツリーのトップページを選択することができます。ドキュメンテーションテーマは、トップページとしてスペースのホーム・ページを選択します。

Using reusable Content in your Header, Footer or Left-Hand Panel

テーマのヘッダー、フッター、または左側のパネル内の任意のテキストやwikiマークアップを使用することができます。役立つヒントには、ページを含めるまたは抜粋を含めるのマクロの使用があります。

上記のスクリーンショットには、他のページからコンテンツを含めるために使用されるマクロの例として、テーマのカスタマイズオプションを示しています。また、上記のスクリーンショットの例でもヘッダー、フッターまた、左側のパネルの例を表示しています。

Adding Content Below the Page Tree in your Left-Hand Panel

If you want to include your own content underneath the page tree, you can deselect the 'Page Tree' check box, add your own page tree using the Pagetree macro in the 'Navigation' text box, and then add your own content under the macro.

上記のスクリーンショットには、テーマのカスタマイズオプションが表示されていて、左側のパネルにコンテンツが追加されるとともに、既定のページツリーの選択が解除され、カスタムのページツリーが挿入されています。上記のカスタマイズ例を示すスクリーンショットは、左側パネルのカスタマイズ結果も表示しています。

Adding Underlines to your Links

既定では、ドキュメント用テーマはハイパーリンクに下線を付けません。リンクに下線を付けたい場合は、スペースの CSS スタイルシートを編集し、次の CSS コードを追加します。

.wiki-content a:link, .wiki-content a:visited, .wiki-content a:active {
    text-decoration: underline;
}

To edit a space's CSS style sheets,

Go to the 'Space Admin' tab of the Browse Space view. To do this:
- Go to a page in the space, open the 'Browse' menu and select 'Space Admin'. The 'Space Administration' view will open.
  'Space Admin' is only displayed if you are a space administrator for that space or you are a Confluence system administrator.
Click 'Stylesheet' in the left-hand panel under the heading 'Look and Feel'.
[編集] をクリックします。
カスタムCSSを、テキストフィールドに貼り付けます。
Click 'Save'. The new CSS will be visible on all content pages in the space.

Jumping to the Same Page in Another Space

The {spacejump} macro is provided along with the Documentation theme. You can use space jumping to link from a page in one wiki space to a page with the same name in another space, without knowing the name of the page when you create the link. When a reader is viewing a page and clicks the link provided by the macro, they will go to a page with the same name, but in the space specified in the macro. See more about the Space Jump macro.

ページツリー

ドキュメンテーション テーマを設定する