Вики-файлы и структура файлов
Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019
Узнайте о файлах и структуре файлов для вики-сайтов проекта и кодовых вики-сайтов. Следующие рекомендации могут указывать вики-сайты кода, но это относится к обоим типам вики-сайта.
При создании командного проекта вики-сайт по умолчанию не создается. Дополнительные сведения см. в разделе Создать вики-, Создать README-или подготовленные вики-сайты или опубликованный код в форме вики-.
Каждый код вики управляется репозиторием Git в серверной системе. Этот репозиторий хранит страницы Markdown, изображения, вложения и последовательность страниц и подстраниц. Вы создаете вики-сайт с помощью пользовательского интерфейса Azure DevOps, а затем можете изменить вики-сайт с помощью URL-адреса репозитория Git. Дополнительные сведения о публикации вики с кодом см. в статье Публикация репозитория Git в вики.
Структура вики-файла и папки
Репозитории Git вики-проектов команды назначаются следующими метками.
- Вики-репозиторий для командного проекта:
ProjectName.wiki - Основная ветвь:
wikiMain
Управляйте вашим вики-репозиторием так же, как и любым другим репозиторием Git, определяя политики веток на основной ветке вики. Но вы можете внести изменения в локальную ветку wikiMain и отправить их непосредственно в удаленную ветку без определения каких-либо политик.
В вики-репозитории находятся следующие файлы и папки:
- Файл для каждой страницы Markdown, введенной на корневом уровне
- Файл с меткой
.orderв корне и под каждой папкой - Папка для каждой страницы, у которой есть подстраницы
-
.attachmentsпапка, в которой хранятся все файлы вики
Соглашения об именовании файлов
Для каждого файла в заголовке страницы необходимо использовать дефисы вместо пробелов. Например, Как внести название страницы соответствует имени файла How-to-contribute.md. Имя страницы добавляется в URL-адрес. Это гарантирует, что ссылки, которыми вы делитесь, останутся неизменными по мере изменения вики-сайта с течением времени.
Каждая вики-страница соответствует файлу в вики-репозитории Git. Имена, назначаемые заголовку вики-страницы, должны соответствовать следующим ограничениям.
| Тип ограничения | Ограничение |
|---|---|
| Имя файла | Полный путь к странице не должен превышать 235 символов. |
| Уникальность | Названия страниц учитывают регистр букв и должны быть уникальными в иерархии вики. |
| Специальные символы | — Не должно содержать управляющих символов Юникода или суррогатных символов. — не должен содержать следующие печатные символы: / \ #— не должно начинаться или заканчиваться периодом .. |
| Размер файла | Размер не должен превышать максимального значения в 18 МБ. |
| Размер вложенного файла | Размер не должен превышать максимальное значение в 19 МБ. |
Специальные символы в заголовках вики-страниц
Вы можете указать заголовки страницы, содержащие один или несколько этих специальных символов : < > * ? | -. Например, можно назвать файл Markdown как "Часто задаваемые вопросы" или "Руководство по настройке". Символы имеют следующие строки в кодировке URI:
| Персонаж | Закодированная строка |
|---|---|
: |
%3A |
< |
%3C |
> |
%3E |
* |
%2A |
? |
%3F |
| |
%7C |
- |
%2D |
" |
22 % |
файл .order
Файл .order определяет последовательность страниц в вики-сайте. В следующем визуальном элементе показан пример вики-toC и соответствующий файл .order.
| Вики Оглавление | .order file |
|---|---|
|
|
Иерархия по умолчанию находится в алфавитном порядке, однако эту иерархию можно изменить в файле .order. Дополнительные сведения о переупорядочении вики-страниц см. в разделе Добавление и изменение вики-страниц, изменение порядка страниц вики-страницы.
Удалите файл .order, чтобы вернуться к алфавитной сортировке
Если файла .order нет, страницы сортируются по алфавиту. Чтобы вернуться к алфавитной сортировке, сделайте следующее:
- Скопируйте URL-адрес клона для вики-сайта и откройте его в браузере. При этом открывается репозиторий Git (концентратор файлов), который поддерживает вики-сайт.
- Перейдите к файлу .order и удалите его. Файл автоматически (пере)создается после удаления, например, при перетаскивании в статье.