Archivos wiki y estructura de archivos
Azure DevOps Services | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018
Obtenga información sobre los archivos y la estructura de archivos para wikis de proyecto y wikis de código. La siguiente guía podría especificar wikis de código, pero se aplica a ambos tipos de wiki.
Al crear un proyecto de equipo, no se crea una wiki de forma predeterminada. Para obtener más información sobre cómo crear wikis, consulte Creación de una wiki para el proyecto.
Cada wiki de código cuenta con la tecnología de un repositorio de Git en el back-end. Este repositorio almacena las páginas, imágenes, datos adjuntos y la secuencia de páginas y subpáginas de Markdown. Puede crear la wiki a través de Azure DevOps interfaz de usuario y, a continuación, puede editar la wiki a través de la ruta de acceso url del repositorio de Git. Para más información sobre la publicación de 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 de wiki del proyecto de equipo se les asignan las siguientes etiquetas.
- Repositorio wiki para un proyecto de equipo: ProjectName.wiki
- Rama principal: wikiMain
Nota
Puede administrar el repositorio wiki de la misma manera que 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 directivas.
El repositorio wiki tiene los siguientes archivos y carpetas:
- Archivo para cada página de Markdown especificada en el nivel raíz
- Archivo con la etiqueta .order en la raíz y en cada carpeta
- Carpeta para cada página que tiene subpáginas
- Carpeta .attachments, que almacena 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 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 la wiki cambia con el tiempo.
Cada página wiki corresponde a un archivo dentro del repositorio de Git de wiki. Los nombres que asigne a un título de página wiki deben cumplir las restricciones siguientes.
| Tipo de restricción | Restricción |
|---|---|
| Nombre de archivo | La ruta de acceso de 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 |
|
| Tamaño de archivo | No debe superar el máximo de 18 MB |
| Tamaño del archivo de datos adjuntos | No debe superar el máximo de 19 MB |
Caracteres especiales en los 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 nombrar 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 |
| Tipo de restricción | Restricción |
|---|---|
| Nombre de archivo | La ruta de acceso de 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 |
|
| Tamaño de archivo | No debe superar el máximo de 18 MB |
| Tamaño del archivo de datos adjuntos | No debe superar el máximo de 19 MB |
Archivo .order
El archivo .order define la secuencia de páginas dentro de la wiki. En el siguiente objeto visual se muestra un ejemplo de una tabla de contenido wiki y su archivo .order correspondiente.
| Wiki TOC | Archivo .order |
|---|---|
|
|
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.
Eliminación del 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:
- 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 hace una copia de seguridad de la wiki.
- Vaya al archivo .order y elimínelo. El archivo .order se crea automáticamente (se vuelve a crear) después de la eliminación, por ejemplo, en una acción de arrastrar y colocar en un artículo.