ドキュメンテーションテーマは、Confluence にセットされているテーマの一つです。ドキュメンテーションテーマには、スペース向けの組み込みの目次、設定可能なヘッダーおよびフッター、ドキュメントに適合したテキストスタイルが用意されています。検索結果を Confluence サイト全体ではなく、現在のスペースに制限するよう設定することもできます。

(warning) ドキュメンテーションテーマは JIRA リンク機能をサポートしていません。

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

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.

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

  • 左パネルにはページツリーがあります。これは、スペース内のページを示す目次です。
  • 左側に矢印記号の付いたページには、子ページがあります。矢印を選択して子ページを表示/非表示にします。
  • ページの幅を変更するには、左パネルとページの間の太い垂直バーをドラッグします。
  • Choose the left-hand panel icon  in the header, next to the search field, to hide or show the left-hand panel.
    Alternatively, press '[' on your keyboard to show/hide the left-hand panel.
  • スペース限定検索のオーバーライド: 検索を現在のスペースに限定するようにテーマを設定している場合、「all:」と入力すると現在の検索語でサイト全体を検索できます。

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

既定のドキュメンテーションテーマ

ドキュメンテーションテーマのカスタマイズ

スペース管理者は、次のようにドキュメンテーションテーマをカスタマイズできます。

  • 左パネルでコンテンツを変更し、ページにヘッダーとフッターを追加します。
  • 検索を制限することで、Confluence サイト全体ではなく、現在のスペースのみの検索結果を表示できます。

For more, see Configuring the Documentation Theme

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

ドキュメンテーションテーマ

スペースまたはサイトの検索

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

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

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

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

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

ヒントとコツ

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

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

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

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

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

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

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

  • スペース管理のセクションで、ホームに指定したページを変更することができます。
  • または、現在のホームのページの子ページにするためにすべてのページをドラッグ&ドロップすることができます。スペースの「参照」画面の「ページ」セクションで、ページをドラッグ&ドロップすることができます。ページの移動と順序変更を参照してください。

原因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.

注意

  • Confluenceのデフォルトのテーマはサイドバーに適用され、ドキュメンテーションテーマでは、左側のパネルが異なります。サイドバーの詳細については、サイドバーを設定する を参照してください。
  • ドキュメンテーションテーマでは、Confluence のヘッダーに閲覧のメニューが表示され、スペースの管理と高度なオプション機能にアクセスできます。
  • ラベルなし