Using the Documentation Theme

The Documentation theme is one of the themes bundled with Confluence. It provides an inbuilt table of contents for your wiki space, a configurable header and footer, and text styles suited to documentation. You can also configure it to restrict the search results to the current space, rather than searching the entire Confluence site.

ドキュメント用テーマを既定のテーマにマージする計画の事前警告

This is an advance notice that we plan to merge the functionality of the Confluence Documentation theme with the Confluence default theme. We do not yet have a specific date for this plan, and we are interested in your feedback. The new default theme, introduced with Confluence 5.0, includes a sidebar with contextual navigation. Our plan is to include features from the Documentation theme in the default theme, and then remove the Documentation theme from Confluence.

If you are interested in this change and would like to give us feedback, please add a comment on this blog post: Advance warning of plans to merge Documentation theme with the default theme. We are especially interested to know which features of the Documentation theme you use and value the most.

This page tells you how to view pages in your Confluence space when your space uses the Documentation theme. For the full list of features and instructions on applying the theme to a space, see the guide to configuring the Documentation theme.

ドキュメンテーションテーマを使用するためのクイックガイド

左パネルにはページツリーがあります。これは、スペース内のページを示す目次です。
Click the arrow symbols in the page tree to show and hide child pages.
Drag the thick vertical bar to change the width of the panels.
Show/hide the left-hand panel: Click the sidebar icon at top right, next to the search box, to remove the left-hand panel altogether. Click the icon again to restore the panel.
Alternatively, press '[' on your keyboard to show/hide the left-hand panel.
スペース限定検索のオーバーライド: 検索を現在のスペースに限定するようにテーマを設定している場合、「all:」と入力すると現在の検索語でサイト全体を検索できます。

The rest of this page gives more details of the above guidelines.

On this page:

関連ページ

Using the Documentation theme

By default in a space that uses the Documentation theme, the left-hand panel contains a search box and a table of contents (page tree) showing all the pages in your space. Specifically, it shows the pages that are children of the space's home page.

ダイアグラム: 既定の設定のドキュメンテーションテーマ

A space administrator can customise the Documentation theme as follows:

Change the content in the left-hand panel and add a header and footer to the page. This means that your own pages may look different from the screenshot above.
検索を制限することで、Confluence サイト全体ではなく、現在のスペースのみの検索結果を表示できます。

ダイアグラム: スペース限定検索設定のドキュメンテーションテーマ

Here is a summary of the things you can do on a page that uses the Documentation theme:

Click the plus signs to open and close the branches of the page tree (table of contents) in the left-hand panel.
Drag the thick bar between the left-hand panel and the content, to increase or decrease the width of the panel.
Click the sidebar icon at top right, next to the search box, to remove the left-hand panel. This will remove the panel for you only. Other people will still see it.
Click the sidebar icon again to restore the left-hand panel.
Alternatively, press '[' on your keyboard to show/hide the left-hand panel.
Use the scroll bars to scroll the left-hand and right-hand panels independently of each other.
Search the content of the space or the site. See below.

Searching the space or the site

ドキュメンテーションテーマを使用する場合、Confluence 検索で、以下に示すいくつかのオプションを利用できます。

ページの右上にある検索ボックスを使用する：

デフォルトでは、Confluence の主な検索はConfluence 全体を検索する設定になっています。
- ページの右上の検索ボックスに「Confluence を検索」と表示されます。
- Confluence 検索では Confluence 全体を検索します。これは他のテーマでも既定の挙動です。
スペース管理者は、現在のスペースの検索制限をドキュメンテーションテーマに設定できます。
- ページの右上の検索ボックスに「スペースを検索」と表示されます。
- 現在のスペースからのみ、検索結果が返されます。
- 検索制限は上書きできます。サイト全体を検索するには、「all:」と検索語を入力します。たとえば、サイト全体で「technical writing」を検索するには、ページ右上の検索窓に次のように入力します。
```
all: technical writing
```

左パネルの検索ボックスを使用する：

デフォルトでは、ドキュメンテーションテーマの左パネルには検索ボックスが表示されます。検索ワードを入力し、現在のスペースの検索に制限をかけます。具体的には、スペースホームページの子ページのみを検索します。
管理者が現在のページの主な検索を制限している場合は、左パネルに検索ボックスは表示されません。

ヒントとコツ

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

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

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 a Page.

原因2 ：Confluence 3.1 からのアップグレードで、プラグインのドキュメンテーションテーマをConfluence で使っている3 。2 または、それ以降のドキュメンテーションテーマがセットされた Confluence 既存のConfluenceのインストールが既にインストールされているドキュメンテーションテーマのプラグインを持っている場合は、Confluence3.2 にアップグレードした後に、左側のナビゲーションバーには、テーマを使用したスペースが空になっているかもしれません。この修正には、ドキュメンテーションテーマプラグインの全てのモジュールを有効にします。ナレッジベース記事を参照してください。

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

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.

左側のナビゲーションパネルの既定幅を変更することはできますか？

The Confluence user interface does not offer a way to change the default width of the left-hand navigation panel supplied by the Documentation theme. Users can change the width by dragging the middle bar, but the default width is not configurable. This post on Atlassian Answers gives a way to do it with CSS: Documentation Theme - Default Width (in px) of left panel.

注意

The Confluence default theme supplies a sidebar, which is different to the left-hand panel in the Documentation theme. For information about the sidebar, see Finding Content and Configuring a Sidebar.
ドキュメンテーションテーマでは、Confluence のヘッダーに閲覧のメニューが表示され、スペースの管理と高度なオプション機能にアクセスできます。