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

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.

Applying the Documentation Theme to your 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 restrict the search to just one space, change the content of the left-hand navigation panel and add your own header and footer.

ドキュメンテーションテーマをカスタマイズするには；

1. Choose Browse > Space Admin.
   Note: 'Space Admin' is displayed only if you are a space administrator for that space, or you are a super user (a member of the confluence-administrators group).
2. Click'Themes in the left-hand panel under the heading 'Look and Feel'.
3. If the space is not yet using the Documentation theme, apply the theme as described above.
4. 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.
5. ページ ツリーのチェックボックスを選択または選択解除します。これはスペースで、左側のパネル内のコンテンツのデフォルトの検索ボックスとテーブル（ページツリー）を表示するかどうかを決定します。
6. Select or deselect the Limit search results to the current spacecheck box.
   • チェックボックスを選択した場合：
     • The Confluence search will look for matches only in the current space by default. Users can override this restriction when entering their search term. See Using the Documentation Theme.
     • 左側のパネルの既定ページツリーには検索ボックスは含まれません。
   • チェックボックスを選択しない場合：
     • Confluence 検索では Confluence 全体を検索します。 これは他のテーマでも既定の挙動です。
     • 左側のパネルの既定ページツリーに、検索検索を現在のスペースに制限した、検索ボックスが含まれます。
7. 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.
   • 「ナビゲーション」 - このテキストボックスには、左側のパネルのためのコンテンツが含まれています。
     • ページ ツリー チェックボックスが選択されている場合、ナビゲーションパネルには既定の検索ボックス、ページ ツリーが含まれます。「ナビゲーション」テキストボックスに入力した内容はすべて 上記の ページ ツリーと検索ボックスに表示されます。
     • 上記だけでなく、ページツリーの下に独自のコンテンツを含むことができます。 下記のヒントを参照してください。
       要点としましては、ページ ツリーチェックボックスの選択解除します。ページツリーマクロを使用した、独自のページツリーを挿入し、 マクロの下に独自のコンテンツを追加します。
   • 「ヘッダー」 - このテキストボックスには、スペース内のすべてのページのページタイトルの上に表示されるページのヘッダの内容が含まれています。以下 のサンプルのスクリーンショットを参照してください。
   • 「フッター」 - このテキストボックスには、スペース内のすべてのページで、コメントの後に、サイトのフッターの上に表示されますページのフッターのコンテンツが含まれています。 以下のサンプルのスクリーンショットを参照してください。。
8. 保存をクリックします。

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

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

Customising the Theme at Site Level

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

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

上のスクリーンショットは、カスタマイズされた左側のパネル、ヘッダーとフッターを持つWikiスペースを示しています。

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

• 既定では、左側のパネルには、スペース内のすべてのページを表示する、検索ボックスと目次（ページツリー）が含まれています。具体的には、スペースのホームの子ページのみを検索します。
• 左側のパネルは、完全にカスタマイズ可能です。検索ボックスとページツリーを含めるか除外するかを選択することができます。独自のテキスト、画像や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 スペースのページから別のスペースの同じ名前のページにリンクできます。
• You can limit the Confluence search results to the current space. If you choose this option, the Confluence search will look for matches only in the current space by default. Users can override the restriction. See Using the Documentation Theme.

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.

Hints and Tips

左側の目次からページを隠す

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

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

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

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

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

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.

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

リンクに下線を追加する

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

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

別のスペースで同じページにジャンプする

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.

左側パネルを完全に非表示にする

It's not possible to remove the left-hand panel entirely, using the user interface supplied by the theme. There is an improvement request here: CONF-25923 - Getting issue details... STATUS If you like, you can comment on and/or vote for that request. In the meantime, Atlassian Answers is a good place to ask the question and see if other people can help you with custom code to remove the panel.

関連トピック

Using the Documentation Theme
Space Jump Macro
Applying a Theme to a Space
Applying a Theme to a Site
Editing a Space's Colour Scheme
Customising the Look and Feel of a Confluence Space

Take me back to Confluence User's Guide