Wiki ファイルとファイル構造

  • [アーティクル]

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

プロジェクト Wiki とコード Wiki のファイルとファイル構造について説明します。 次のガイダンスでは、コード Wiki を指定できますが、両方の種類の Wiki に適用されます。

チーム プロジェクトを作成する場合、Wiki は既定では作成されません。 詳細については、「Wiki の作成、README の作成、またはプロビジョニングされた Wiki と Wiki として発行されたコードの比較」を参照してください。

各コード Wiki には、バックエンドの Git リポジトリが用意されています。 このリポジトリには、Markdown ページ、画像、添付ファイル、およびページとサブページのシーケンスが格納されます。 Azure DevOps ユーザー インターフェイスを使用して Wiki を作成し、 Git リポジトリの URL パスを使用して Wiki を編集できます。 コード Wiki の発行の詳細については、「 Git リポジトリを Wiki に発行する」を参照してください。

Wiki ファイルとフォルダーの構造

チーム プロジェクト Wiki Git リポジトリには、次のラベルが割り当てられます。

  • チーム プロジェクトの Wiki リポジトリ: ProjectName.wiki
  • メイン ブランチ: wikiMain

wikiMain ブランチでブランチ ポリシーを定義することで、他の Git リポジトリを管理するのと同じ方法で Wiki リポジトリを管理します。 ただし、ローカル wikiMain ブランチに変更を加え、ポリシーを定義せずにリモート ブランチに直接プッシュすることができます。

Wiki リポジトリには、次のファイルとフォルダーがあります。

  • ルート レベルで入力された各 Markdown ページのファイル
  • ルートと各フォルダーの下にラベルが付いた .order ファイル
  • サブページがある各ページのフォルダー
  • .attachments フォルダー、Wiki のすべての添付ファイルを格納する

ファイルの名前付け規則

各ファイルでは、ページ タイトルにスペースではなくハイフンを使用する必要があります。 たとえば、[投稿方法] ページのタイトルはファイル名にHow-to-contribute.md対応します。 ページ名が URL に追加され、時間が経って Wiki が変化しても、共有するリンクはそのまま残ります。

各 Wiki ページは、Wiki Git リポジトリ内のファイルに対応しています。 Wiki ページのタイトルに割り当てる名前は、次の制限に従う必要があります。

制限の種類 Restriction
ファイル名 完全修飾ページ パスは、235 文字を超えてはなりません。
一意性 ページ タイトルは大文字と小文字が区別され、Wiki 階層内で一意である必要があります。
特殊文字 - Unicode 制御文字またはサロゲート文字を含めてはなりません。
- 次の印刷可能な文字を含めてはいけません: / \ #。
- ピリオド .で開始または終了することはできません。
ファイル サイズ 最大 18 MB を超えてはなりません。
添付ファイルのサイズ 最大 19 MB を超えてはなりません。

Wiki ページ タイトルの特殊文字

これらの特殊文字の 1 つ以上を含むページ タイトルを : < > * ? | -指定できます。 たとえば、Markdown ファイルに "FAQ" または "セットアップ ガイド" という名前を付けることができます。 文字には、次の URI でエンコードされた文字列があります。

文字 エンコードされた文字列
: %3A
< %3C
> %3E
* %2A
? %3F
| %7C
- %2D
" %22

.order ファイル

.order ファイルは、Wiki 内のページのシーケンスを定義します。 次のビジュアルは、Wiki TOC の例を示しており、対応する .order ファイルです。

Wiki TOC .order ファイル
Wiki TOC の例のスクリーンショット。 Wiki の注文例ファイルのスクリーンショット。

既定の階層はアルファベット順ですが、この階層は .order ファイルで変更できます。 Wiki ページの並べ替え方法の詳細については、「Wiki ページ の追加と編集」、「Wiki ページの並べ替え」を参照してください。

.order ファイルを削除してアルファベット順の並べ替えに戻す

.order ファイルがない場合、ページはアルファベット順に並べ替えられます。 アルファベット順の並べ替えに戻すには、次の手順を実行します。

  1. Wiki の複製 URL をコピーし、ブラウザーで開きます。 これにより、Wiki をサポートする Git リポジトリ (ファイル ハブ) が開きます。
  2. .order ファイルに移動して削除します。 削除後、たとえばアーティクルのドラッグ アンド ドロップ アクションで、ファイルが自動的に作成 (再作成) されます。