ドキュメンテーションテーマは、Confluence にセットされたテーマの一つです。

The Documentation theme is designed for spaces containing technical documentation, but you may find it useful for other types of structured content. It provides a table of contents for your space, a configurable header and footer, and text styles suited to documentation. (See features below.)

ドキュメンテーションテーマの適用とカスタマイズするためのクイックガイド

  • テーマを選択します。
  • ドキュメンテーションテーマを選択し、確認ボタンを押下します。
  • テーマのカスタマイズをしたい場合は、テーマの設定を選択します。
    • 既定のページ ツリーを選択または選択解除します。
    • スペースの制約検索を選択するか、選択解除します。
    • カスタマイズされた左側パネルのヘッ​​ダーとフッターにテキストや Wiki マークアップを入力します。
    • 保存を選択します 。

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

On this page:

関連ページ

スクリーンショット:ナビゲーションサイドバーに置き換えた空間のサイドバーを示すドキュメントのテーマ。

ドキュメンテーションテーマをスペースに適用する

ドキュメンテーションテーマを適用するには、以下の手順に従ってください。スペース内のすべてのページですぐにテーマが有効化されます。

スペースにテーマを適用する方法


  1. テーマ を選択し、テーマオプションを選択します
  2. Choose Confirm

    Screenshot: Applying a theme

スペースでドキュメンテーションテーマを使用している場合:

  1. スペース管理オプションから テーマ を選択します
  2. テーマオプションを選択します
  3. 確認 を選択します

ドキュメンテーションテーマをサイトに適用する

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.

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

テーマは、カスタマイズしなくとも、動作します。必要に応じて、検索を1スペースだけのように制限することができ、左側のナビゲーションパネルの内容を変更し、独自のヘッダーとフッターを追加します。以下の手順では、ドキュメンテーションテーマを既に適用していると仮定します。

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

  1. 「ルックアンドフィール」という見出しの左パネルで、テーマをクリックします。
  2. Choose 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.
  3. ページ ツリーのチェックボックスを選択または選択解除します。これはスペースで、左側のパネル内のコンテンツのデフォルトの検索ボックスとテーブル(ページツリー)を表示するかどうかを決定します。
  4. 現在のスペースに検索結果の表示件数を制限するのチェックボックスを選択または選択解除する。
  5. Enter text, images, macros and other wiki markup into any or all of the three text boxes.
    (info) You can use the Include or Excerpt Include to include re-usable content into your footer. See hint below.
  6. [保存] を選択します。

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



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


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

サイト管理者権限 を持っている場合、 サイトレベルでテーマのカスタマイズと適用ができます。カスタマイズオプションは、上記で記載した、スペースレベルのオプションと同じです。

ドキュメンテーションテーマの機能

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


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

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

 

ヒントとコツ

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

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

Each space has a single page designated as the 'Home' page. You can specify the home page in the space administration section.

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

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

More detail: The theme uses the Pagetree macro to produce the table of contents. When entering the Pagetree macro, you can choose the top page in the page tree. The Documentation theme chooses the space home page as the top page.

ヘッダー、フッターやサイドバーに再利用可能なコンテンツを使用する

You can use any text or wiki markup in your theme header, footer or left-hand panel. One useful hint is to use the Include or Excerpt Include to include re-usable content into your footer.

The screenshot above shows the theme customisation options, with examples of the macros used to include content from other pages. And the example screenshot also above shows the resulting header, footer and 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.

The screenshot above shows the theme customisation options, with the default page tree deselected and a custom page tree inserted, along with additional content in the left-hand panel. The example screenshot also above shows the resulting left-hand panel.

すべてのバージョン展開のセクションをサイドバーに追加する

If you want to include a an expanding list of links to other spaces, as we have included in this space (see 'Docs for all Confluence releases' in the sidebar), you can use an Expand Macro and an Include Page Macro in the 'Navigation' text box.   For example:

*[Docs for all Confluence releases|_Latest Versions of Confluence Documentation]*
{expand:Choose a version...}
{include:_Latest Versions of Confluence Documentation}
{expand}

If you would like this to display below the page tree, follow the steps above.

リンクに下線を追加する

既定では、ドキュメント用 テーマはハイパーリンクに下線を付けません。リンクに下線を付けたい場合は、スペースの 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 chooses 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: 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.

注意