Aracılığıyla paylaş

Git'te wiki dosyası ve klasör yapısı

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

Bu makale, sağlanan wiki'ler ile kod şeklinde yayımlanan wiki'ler için dosya ve klasör yapısını açıklamaktadır. Her iki wiki türü için de dosyalar git deposunda depolanır. Dosyalar Markdown sayfalarını, kodu, resimleri, ekleri veya diğer yapıtları içerebilir. Git, dosyaların sunu sırasını oluşturmak için her depo klasörüne özel bir dosya (.order) ekler.

Proje oluşturduğunuzda, varsayılan olarak wiki oluşturulmaz. Wiki sağlayabilir, BENİOKU oluşturabilir veya proje kodunu wiki olarak yayımlayabilirsiniz.

Wiki'nizi Azure DevOps kullanıcı arabirimini kullanarak oluşturursunuz. Ardından Wiki'yi Git depoNUZUN URL yolundan düzenleyebilirsiniz.

Depo dosyaları ve klasör yapısı

Wiki için Git deposunda iki adlandırma kuralı vardır:

  • Wiki deposu adı, <ProjectName>.wiki<ProjectName> projenizin adıdır.
  • Wiki deposunun kök dalının adı şeklindedir wikiMain.

Wiki deposunu, wikiMain dalında dal politikalarını tanımlayarak diğer Git depolarını yönettiğiniz gibi yönetirsiniz. Ayrıca, herhangi bir ilke tanımlamadan yerel wikiMain dalınızda değişiklik yapabilir ve bunları doğrudan uzak dala gönderebilirsiniz.

Wiki deposu aşağıdaki dosya ve klasörlerden oluşur:

  • Kök düzeyde bulunan her Markdown sayfası için bir dosya
  • Kök düzeyde ve aynı zamanda her alt klasörde bulunan .order adlı bir dosya
  • Alt sayfaları olan her wiki sayfası için bir alt klasör
  • Wiki'de kullanılan tüm ekleri depolamak için .attachments adlı bir klasör

Dosya adlandırma kuralları

Her wiki sayfasının dosya adı wiki sayfası başlığına karşılık gelir. Dosya adında, kısa çizgi (-), sayfa başlığındaki bir boşluğu temsil eder. Örneğin, "Katkıda bulunma" sayfa başlığı How-to-contribute.md dosya adına karşılık gelir. Wiki sayfasının URL yolu dosya adını içerir. Örneğin, https://github.com/ExampleWiki/How-To/How-to-contribute.md. Bu yaklaşım, wiki zaman içinde değiştikçe sayfaya yer işareti bağlantılarının bozulmadan kalmasını sağlamaya yardımcı olur.

Her wiki sayfası, wiki Git deposundaki bir dosyaya karşılık gelir. Sayfa dosyası adları ve dosya boyutu için aşağıdaki kısıtlamalar geçerlidir:

  • Dosya adı: Sayfa dosyası için bir ad seçerken, dosyanın tam yolunun 235 karakter veya daha az olması gerektiğini unutmayın. Sayfanın tam yolu depo URL'sini, sayfa dosyasının klasör yolunu ve sayfa dosyası adından oluşur. Örneğin, https://github.com/ExampleWiki/Contributors/Code/How-to-add-code-to-the-project.md.

  • Benzersizlik: Sayfa dosyası adı, wiki deposu hiyerarşisindeki klasör konumu içinde benzersiz olmalıdır. İsim büyük/küçük harfe duyarlıdır.

  • Özel karakterler: Sayfa dosyası adında aşağıdaki özel karakterlerle ilgili kısıtlamalar vardır:

    • Unicode denetim karakteri veya vekil karakter yok
    • Yazdırılabilir karakter yok: eğik çizgi /, ters eğik çizgi \, kare #
    • Adın başında veya sonunda nokta . simgesi yok

  • Dosya boyutu: En fazla sayfa dosyası boyutu 18 MB'tır.

  • Ek dosyası boyutu: Bir sayfa dosyasına ek için en büyük boyut 19 MB'tır.

İzin verilen özel karakterler

Sayfa dosyası adında, iki nokta : ve kısa çizgi - gibi birkaç özel karaktere izin verilir. Örneğin, Markdown dosyasını SSS:0525 veya Kurulum Kılavuzu olarak adlandırabilirsiniz.

Önemli

Sayfa söz diziminde ve tarayıcı gezintisinde hatalardan kaçınmak için, sayfa dosyası adlarında boşluk karakterini ( ) kullanmayın. Sayfa dosyalarınızı sayfa başlığına göre adlandırıyorsanız, sayfa başlığındaki boşlukları dosya adında bir kısa çizgi (-) ile değiştirin.

Aşağıdaki tabloda, wiki sayfası dosya adlarında izin verilen özel karakterler ve buna karşılık gelen URI kodlanmış dize listelenir:

Karakter Sembol URI dizesi
İki Nokta : %3A
Sol açılı ayraç < %3C
Sağ açılı ayraç > %3E
Yıldız işareti (joker karakter) * %2A
Soru işareti ? %3F
Boru | %7C
Kısa çizgi (çizgi) - %2D
Çift tırnak işareti " %22

Örneğin, SSS:0525 dosya adı olarak FAQ%3A0525kodlanmıştır.

Sayfa dizisi ve .order dosyası

.order dosyası wiki sayfası sırasını tanımlar. Git, dosyaları bu konumda sunma sırasını belirlemek için her klasörde bu dosyayı arar. Varsayılan sayfa dizisi, dosya adına göre alfabetik sıradadır (A'da Z' ye).

Özel sayfa dizisi tanımlama

Bir klasörde .order dosyası olmadığında Git varsayılan alfabetik sırayı kullanır.

Kök düzeyinde de dahil olmak üzere klasördeki .order dosyasını güncelleştirerek herhangi bir klasör için özel bir sıra tanımlayabilirsiniz.

Aşağıdaki görselde bir wiki içindekiler tablosu (İçindekiler) örneği ve içindekiler tablosunu oluşturan ilgili .order dosyası gösterilmektedir.

Wiki İçindekiler tablosu web tarayıcısında görüntülenir

Alt klasörleri gösterecek şekilde genişletilmiş birkaç klasör içeren bir wiki için İçindekiler tablosu ekran görüntüsü.

.order dosyası, İçindekiler sayfası sırasını tanımlar

Git deposundaki wiki klasörünün ve dosya listesinin ekran görüntüsü. .order dosyası açıktır ve İçindekiler tablosu sayfa dizisinin tanımını gösterir.

.order dosyası sırayı alfabetikten "Pazarlama" ve ardından "Fabrikam Fiber" olarak değiştirir.

Wiki sayfalarını yeniden sıralama hakkında daha fazla bilgi için bkz. Wiki sayfalarını ekleme, düzenleme ve yeniden sıralama.

Alfabetik sırayı geri yükleme

Bir klasörün özel sırası varsa, aşağıdaki adımları izleyerek sıralama yöntemini alfabetik olarak geri döndürebilirsiniz:

  1. Wiki'nin kopya URL'sini kopyalayın ve tarayıcıda açın. Wiki için Git deposu açılır.

  2. Geri döndürmek istediğiniz .order dosyasına gidin ve dosyayı silin. Dosya silindikten sonra Git bu konum için otomatik olarak yeni bir .order dosyası oluşturur. Yeni dosya varsayılan diziyi kullanır.

İlgili içerik