Confluence 5.0 のサポートは終了しています。
ドキュメントの最新バージョンを確認してください。
ドキュメンテーションテーマは、Confluence にセットされたテーマの一つです。
ドキュメント用テーマを既定のテーマにマージする計画の事前警告
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, to be introduced in Confluence 5.0, includes a sidebar with contextual navigation. (For a preview, see the Confluence 5.0-m9 release notes.) Our plan is to include all the features of the Documentation theme into 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.
The Documentation theme is designed for spaces containing technical documentation, but you may find it useful for other types of content too. It provides an inbuilt table of contents for your wiki space, a configurable header and footer, and text styles suited to documentation. (See features below.)
ドキュメンテーションテーマの適用とカスタマイズするためのクイックガイド
- Go to Space Admin and choose Themes.
- ドキュメンテーションテーマを選択し、確認ボタンを押下します。
- テーマのカスタマイズをしたい場合は、テーマの設定を選択します。
- 既定のページ ツリーを選択または選択解除します。
- スペースの制約検索を選択するか、選択解除します。
- カスタマイズされた左側パネルのヘッダーとフッターにテキストや Wiki マークアップを入力します。
- 保存を選択します 。
このページの残りの部分では、上記の手順を詳しく説明します。
スクリーンショット:ナビゲーションサイドバーに置き換えた空間のサイドバーを示すドキュメントのテーマ。
ドキュメンテーションテーマをスペースに適用する
You need space administrator permissions to apply a theme to a space.
ドキュメンテーションテーマを適用するには、以下の手順に従ってください。スペース内のすべてのページですぐにテーマが有効化されます。
- If this space has the Default theme applied, go to the space and choose Space tools on the sidebar.
- If this space has the Documentation theme applied, go to Browse in the top bar and select Space Admin.
Note: This option appears only if you are a space administrator for the space or you are a super user (a member of the
confluence-administrators
group).- Choose Look and Feel > Themes.
- Select a theme option.
- Choose Confirm.
Screenshot: Applying a theme
スペースでドキュメンテーションテーマを使用している場合:
- Choose Browse > Space Admin at the top of the screen.
Note: The 'Space Admin' option appears only if you are a space administrator for the space or you are a super user (a member of theconfluence-administrators
group). - スペース管理オプションから テーマ を選択します
- Select a theme option.
- 確認を選択します
ドキュメンテーションテーマをサイトに適用する
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.
ドキュメンテーションテーマのカスマイズ
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.
ドキュメンテーションテーマをカスタマイズするには;
- If this space has the Default theme applied, go to the space and choose Space tools on the sidebar.
- If this space has the Documentation theme applied, go to Browse in the top bar and select Space Admin.
Note: This option appears only if you are a space administrator for the space or you are a super user (a member of the
confluence-administrators
group).- 「ルックアンドフィール」という見出しの左パネルで、テーマをクリックします。
- If the space is not yet using the Documentation theme, apply the theme as described above.
- ページの上部にある”現在のテーマ” セクションの黄色のエリアでテーマを設定する選択します。以下のスクリーンショットを参照ください。「ドキュメンテーションテーマの設定」画面が表示されます。以下のスクリーンショットを参照してください。
- ページ ツリーのチェックボックスを選択または選択解除します。これはスペースで、左側のパネル内のコンテンツのデフォルトの検索ボックスとテーブル(ページツリー)を表示するかどうかを決定します。
- 現在のスペースに検索結果の表示件数を制限するのチェックボックスを選択または選択解除する。
- チェックボックスを選択した場合:
- 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 全体を検索します。 これは他のテーマでも既定の挙動です。
- 左側のパネルの既定ページツリーに、検索検索を現在のスペースに制限した、検索ボックスが含まれます。
- チェックボックスを選択した場合:
- 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.
- [保存] を選択します。
スクリーンショット:'テーマの設定' のオプション
スクリーンショット:ドキュメンテーションテーマのカスマイズ
サイトレベルでのテーマのカスマイズ
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.
ドキュメンテーションテーマの機能
スクリーンショット:カスタマイズされたヘッダー、フッター、および左側のパネル
上のスクリーンショットは、カスタマイズされた左側のパネル、ヘッダーとフッターを持つ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.
ヒントとコツ
ドキュメンテーションテーマの実用例はどこで見られますか。
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.
左側の目次からページを隠す
スペースホームのページよりも同じレベル、またそれ以上に配置することでページを「隠す」ことができます。
各スペースは、[ホーム]ページとして指定された単一のページを持っています。スペースの管理セクションで、ホームのページを指定することができます
テーマはスペースのホームの子ページにあるすべてのページから左側のパネルにページツリーを構築します。
ドキュメントページは、スペースのホームのページと同じレベルにある場合は、左側のナビゲーションバーに表示されません。スペースホームのページよりも同じレベル、またそれ以上に配置することでページを「隠す」ことができます。ページが検索結果に表示され、彼らはページを開いた場合、人々は、コンテンツを見ることができますが、ページが左側のパネルに表示されません。
もっと詳しく:目次を生成するには、ページツリーマクロを使用します。ページツリーマクロを入力するときは、ページツリーのトップページを選択することができます。ドキュメンテーションテーマは、トップページとしてスペースのホーム・ページを選択します。
Using reusable content in your header, footer or left-hand panel
テーマのヘッダー、フッター、または左側のパネル内の任意のテキストやwikiマークアップを使用することができます。 役立つヒントには、ページを含めるまたは抜粋を含めるのマクロの使用があります。
上記のスクリーンショットには、他のページからコンテンツを含めるために使用されるマクロの例として、テーマのカスタマイズオプションを示しています。また、上記 のスクリーンショットの例でもヘッダー、フッターまた、左側のパネルの例を表示しています。
Adding content below the page tree in your left-hand panel
ページツリーの下に独自のコンテンツを含める場合は、「ページツリー」チェックボックスの選択を解除し、「ナビゲーション」テキストボックスでページツリーマクロ を使用して、マクロの下に自分のコンテンツを追加します。
上記のスクリーンショットには、テーマのカスタマイズ オプションが表示されていて、左側のパネルにコンテンツが追加されるとともに、既定のページ ツリーの選択が解除され、カスタムのページ ツリーが挿入されています。上記のカスタマイズ例を示すスクリーンショットは、左側パネルのカスタマイズ結果も表示しています。
リンクに下線を追加する
既定では、ドキュメント用 テーマはハイパーリンクに下線を付けません。リンクに下線を付けたい場合は、スペースの CSS スタイルシートを編集し、次の CSS コードを追加します。
.wiki-content a:link, .wiki-content a:visited, .wiki-content a:active { text-decoration: underline; }
- If this space has the Default theme applied, go to the space and choose Space tools on the sidebar.
- If this space has the Documentation theme applied, go to Browse in the top bar and select Space Admin.
Note: This option appears only if you are a space administrator for the space or you are a super user (a member of the
confluence-administrators
group).- Choose Look and Feel > Stylesheet.
- 編集 を選択します 。
- カスタムCSSを、テキストフィールドに貼り付けます。
- 変更を保存します。新しいCSSは、スペース内のすべてのコンテンツページに表示されます。
スペースでドキュメント用テーマを使用している場合:
- Choose Browse > Space Admin at the top of the screen.
Note: The 'Space Admin' option appears only if you are a space administrator for the space or you are a super user (a member of theconfluence-administrators
group). - 「ルックアンドフィール」という見出しの左パネルで、スタイルシートをクリックします。
- 編集 を選択します 。
- カスタムCSSを、テキストフィールドに貼り付けます。
- 変更を保存します。新しいCSSは、スペース内のすべてのコンテンツページに表示されます。
- You need system administrator permissions to edit the CSS for a space or for the site.
- This function is turned off by default. To turn it on, go to Confluence Admin > Security Configuration and choose Custom Stylesheets for Spaces.
別のスペースで同じページにジャンプする
{spacejump}マクロは、ドキュメンテーションテーマに沿って設けられています。スペースジャンプ マクロ を使用すると、 リンク作成時にページの名前を知らなくても、Wiki スペースのページから別のスペースの同じ名前のページにリンクできます。読者がページを閲覧し、マクロによって提供されたリンクを選択した場合、それらは同じ名前のページに移動しますが、マクロで指定されたスペースになります。スペースジャンプマクロの詳細の参照はこちらです 。
左側パネルを完全に非表示にする
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.
注意
- 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 のヘッダーに閲覧のメニューが表示され、スペースの管理と高度なオプション機能にアクセスできます。