Wiki dosyaları ve dosya yapısı

Azure DevOps Services | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018

Proje wiki'leri ve kod wiki'leri için dosyalar ve dosya yapısı hakkında bilgi öğrenin. Aşağıdaki kılavuzda kod wiki'leri belirtebilirsiniz, ancak her iki wiki türü için de geçerlidir.

Takım projesi oluşturulduğunda, varsayılan olarak bir wiki oluşturulmaz. Wiki oluşturma hakkında daha fazla bilgi için bkz. Projeniz için wiki oluşturma.

Her kod wiki'si arka uçta bir Git deposu tarafından güçlendirilmiştir. Bu depo Markdown sayfalarını, görüntülerini, eklerini ve sayfa ve alt sayfa dizisini depolar. Wiki'nizi kullanıcı arabirimi Azure DevOps ve ardından Git deposu URL yolunuz aracılığıyla wiki'yi düzenleyebilirsiniz. Kod wiki'lerini yayımlama hakkında daha fazla bilgi için bkz. Wiki'de Git deposu yayımlama.

Wiki dosyası ve klasör yapısı

Takım projesi wiki Git depoları aşağıdaki etiketlere atanır.

  • Takım projesi için Wiki repo: ProjectName.wiki
  • Ana dal: wikiMain

Not

wikiMain dalı üzerinde dal ilkeleri tanımlayarak wiki deponuza diğer Git depolarını da yönetmenizle aynı şekilde yönetabilirsiniz. Ancak, yerel wikiMain dalda değişiklik yapabilirsiniz ve herhangi bir ilke tanımlamadan doğrudan uzak dala itebilirsiniz.

Wiki deposunda aşağıdaki dosyalar ve klasörler bulunur:

  • Kök düzeyde girilen her Markdown sayfası için dosya
  • Kökte ve her klasörün altında .order etiketli dosya
  • Alt sayfaları olan her sayfanın klasörü
  • .attachments klasörü, wiki'nin tüm eklerini depolar

Dosya adlandırma kuralları

Her dosya, sayfa başlığında boşluk yerine tire kullanmayı gerektirir. Örneğin, "Nasıl katkıda bulunabilirsiniz" sayfa başlığı, dosyanın How-to-contribute.md karşılık gelen addır. Sayfa adı URL'ye eklenir ve wiki zaman içinde değiştiklerine göre paylaşımda bulunarak bağlantıların değişmeden kalmasını sağlar.

Her wiki sayfası, wiki Git depos içindeki bir dosyaya karşılık gelen bir sayfadır. Bir wiki sayfası başlığına atadığınız adların aşağıdaki kısıtlamalara uyması gerekir.

Kısıtlama türü Kısıtlama
Dosya adı Tam sayfa yolu 235 karakteri aşmamalıdır.
Benzer -siz Sayfa başlıkları büyük/büyük/büyük harfe duyarlıdır ve wiki hiyerarşisinde benzersiz olmalıdır.
Özel karakterler
  1. Hiçbir Unicode denetim karakteri veya vekil karakter içermemalıdır
  2. Şu yazdırılabilir karakterleri içermemalıdır: / \ #
  3. Bir nokta (.) ile başlamalı veya bitmamalı.
Dosya boyutu En fazla 18 MB'yi aşmamalı
Ek dosyası boyutu En fazla 19 MB'yi aşmamalı

Wiki sayfası başlıklarında özel karakterler

Bu özel karakterlerden birini veya daha fazlasını içeren sayfa başlıklarını : < > * ? | - belirtebilirsiniz. Örneğin, bir Markdown dosyasını "SSS" veya "Ayarlama kılavuzu" olarak ad veebilirsiniz. Karakterler aşağıdaki URI kodlanmış dizelere sahip:

Karakter Kodlanmış dize
: %3A
< %3C
> %3E
* %2A
? %3F
| %7C
- %2D
" %22
Kısıtlama türü Kısıtlama
Dosya adı Tam sayfa yolu 235 karakteri aşmamalıdır.
Benzer -siz Sayfa başlıkları büyük/büyük/büyük harfe duyarlıdır ve wiki hiyerarşisinde benzersiz olmalıdır.
Özel karakterler
  1. Hiçbir Unicode denetim karakteri veya vekil karakter içermemalıdır
  2. Şu yazdırılabilir karakterleri içermesi gerekir: / : < \ * ? \ | - #
  3. Bir nokta (.) ile başlamalı veya bitmamalı.
  4. Çevrimdışı eklenen sayfaların başlıkları boş alan içermez.
Dosya boyutu En fazla 18 MB'yi aşmamalı
Ek dosyası boyutu En fazla 19 MB'yi aşmamalı

.order dosyası

.order dosyası, wiki içindeki sayfa dizisini tanımlar. Aşağıdaki görselde wiki toC örneği ve buna karşılık gelen .order dosyası yer atır.

Wiki TOC .order dosyası
Wiki TOC örneği ekran görüntüsü. Wiki örneği .order dosyası ekran görüntüsü.

Varsayılan hiyerarşi alfabetik sıradadır, ancak bu hiyerarşiyi .order dosyasında değiştirebilirsiniz. Wiki sayfalarını yeniden sıralama hakkında daha fazla bilgi için bkz. Wiki sayfası ekleme ve düzenleme, Wiki sayfasını yeniden sıralama.

Alfabetik sıralamaya dönmek için .order dosyasını silin

.order dosyası olduğunda sayfalar alfabetik olarak sıralanır. Alfabetik sıralamaya dönmek için aşağıdaki adımları uygulayın:

  1. Wiki'nin kopya URL'sini kopyalayın ve tarayıcıda açın. Bunu yapmak, wiki'yi geri alan Git deposunu (dosya hub'ı) açar.
  2. .order dosyasına gidin ve silin. .order dosyası silme işleminin ardından (örneğin, bir makaledeki sürükle ve bırak eylemde) otomatik olarak oluşturulur (yeniden oluşturulur).