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

このページの内容

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

ドキュメンテーション テーマは Confluence 6.0 にはありません。
この変更に関する詳細を読む 

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

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

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

  • 左パネルにはページツリーがあります。これは、スペース内のページを示す目次です。
  • 左側に矢印記号の付いたページには、子ページがあります。矢印を選択して子ページを表示/非表示にします。
  • ページの幅を変更するには、左パネルとページの間の太い垂直バーをドラッグします。
  • 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.
  • Overriding a space-restricted search: If your theme is configured to restrict the search to the current space, you can enter 'all:' and your search term to search the entire site.

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

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

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

For more, see Configure the Documentation Theme

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

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

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

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

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

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

ヒントとコツ

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

The Confluence documentation uses the Documentation theme. If you are reading this documentation online on the Atlassian documentation wiki, you are seeing a working version of the Documentation theme.

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

The theme constructs the page tree in the left-hand panel from all pages that are child pages of the space’s home page. Each space has a single page designated as the 'Home' page. You can specify the home page in the space administration section.

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

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

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

  • You can change the designated space home page in the space administration section.
  • 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 Move and Reorder Pages.

Cause 2: Problem with upgrade from Confluence 3.1, with Documentation theme as plugin, to Confluence 3.2 or later 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.

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

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 Configure the Sidebar.
  • ドキュメンテーションテーマでは、Confluence のヘッダーに閲覧のメニューが表示され、スペースの管理と高度なオプション機能にアクセスできます。

最終更新日: 2015 年 12 月 2 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.