Archivos wiki y estructura de archivos

  • Artículo

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

Obtenga información sobre los archivos y la estructura de archivos para wikis de proyectos y wikis de código. Las instrucciones siguientes pueden especificar wikis de código, pero se aplica a ambos tipos de wiki.

Al crear un proyecto de equipo, una wiki no se crea de forma predeterminada. Para obtener más información, vea Crear una wiki, Crear un ARCHIVO LÉAME o Wikis aprovisionadas frente al código publicado como wiki.

Cada wiki de código se basa en un repositorio de Git en el back-end. Este repositorio almacena las páginas, imágenes, datos adjuntos de Markdown y la secuencia de páginas y subpáginas. Cree la wiki a través de la interfaz de usuario de Azure DevOps y, a continuación, puede editar la wiki a través de la ruta de dirección URL del repositorio de Git. Para obtener más información sobre cómo publicar wikis de código, consulte Publicación de un repositorio de Git en una wiki.

Estructura de archivos y carpetas wiki

A los repositorios de Git wiki del proyecto de equipo se les asignan las siguientes etiquetas.

  • Repositorio wiki para un proyecto de equipo: ProjectName.wiki
  • Rama principal: wikiMain

Administre el repositorio wiki de la misma manera que administra cualquier otro repositorio de Git mediante la definición de directivas de rama en la rama wikiMain. Sin embargo, puede realizar cambios en la rama wikiMain local e insertarlos directamente en la rama remota sin definir ninguna directiva.

El repositorio wiki tiene los siguientes archivos y carpetas:

  • Archivo para cada página markdown especificada en el nivel raíz
  • Archivo etiquetado .order en la raíz y en cada carpeta
  • Carpeta para cada página que tiene subpáginas
  • .attachments carpeta, almacenando todos los datos adjuntos de la wiki

Convenciones de nomenclatura de archivos

Cada archivo requiere el uso de guiones en lugar de espacios en el título de la página. Por ejemplo, el título de la página Cómo contribuir corresponde al nombre de How-to-contribute.md archivo. El nombre de la página se agrega a la dirección URL, lo que garantiza que los vínculos que comparte permanezcan intactos a medida que cambia la wiki a lo largo del tiempo.

Cada página wiki corresponde a un archivo dentro del repositorio de Git de la wiki. Los nombres que asigne a un título de página wiki deben cumplir las siguientes restricciones.

Tipo de restricción Restricción
Nombre de archivo La ruta de acceso de la página completa no debe superar los 235 caracteres.
Unicidad Los títulos de página distinguen mayúsculas de minúsculas y deben ser únicos dentro de la jerarquía wiki.
Caracteres especiales - No debe contener ningún carácter de control Unicode ni caracteres suplentes.
- No debe contener los siguientes caracteres imprimibles: / \ #.
- No debe comenzar ni terminar con un punto ..
Tamaño de archivo No deben superar el máximo de 18 MB.
Tamaño del archivo adjunto No debe superar el máximo de 19 MB.

Caracteres especiales en títulos de página wiki

Puede especificar títulos de página que contengan uno o varios de estos caracteres : < > * ? | -especiales. Por ejemplo, puede asignar un nombre a un archivo Markdown como "P+F" o "Guía de configuración". Los caracteres tienen las siguientes cadenas codificadas en URI:

Carácter Cadena codificada
: %3A
< %3C
> %3E
* %2A
? %3F
| %7C
- %2D
" %22

Archivo .order

El archivo .order define la secuencia de páginas dentro de la wiki. En el objeto visual siguiente se muestra un ejemplo de un archivo TOC wiki y su archivo .order correspondiente.

Wiki TOC Archivo .order
Captura de pantalla del ejemplo de WIKI TOC. Captura de pantalla del archivo de pedido de ejemplo wiki.

La jerarquía predeterminada está en secuencia alfabética, pero puede cambiar esta jerarquía en el archivo .order . Para obtener más información sobre cómo reordenar páginas wiki, vea Agregar y editar páginas wiki, Reordenar una página wiki.

Elimine el archivo .order para revertir a la ordenación alfabética.

Cuando no hay ningún archivo .order , las páginas se ordenan alfabéticamente. Para revertir a la ordenación alfabética, siga estos pasos:

  1. Copie la dirección URL de clonación de la wiki y ábrala en un explorador. Al hacerlo, se abre el repositorio de Git (centro de archivos), que respalda la wiki.
  2. Vaya al archivo .order y elimínelo. El archivo se crea automáticamente (re)después de la eliminación, por ejemplo, en una acción de arrastrar y colocar en un artículo.