Yöneticiler, ürün belgelerini Markdown belgeleri ve görsellerden oluşan tek bir ZIP dosyasıyla Bilgi Bankasına aktarabilir. Aynı ZIP'i daha sonra yeniden içe aktarmak makaleleri günceller.
Nerede bulunur: İçerik → Bilgi Bankası, Belgeleri içe aktar düğmesi (yalnızca yöneticiler).
Başlamadan önce
- Sunucunuzun PHP yükleme sınırlarını kontrol edin.
upload_max_filesizevepost_max_sizedeğerleri ZIP dosyasından büyük olmalıdır. Kurulum → Sistem → Araçlar altındaki Genel Bakış paneli her iki değeri de gösterir. - Kategori yollarınızı planlayın: bir ürün ve bölümleri, örneğin
Ticketix/Getting Started,Ticketix/FeaturesveTicketix/FAQ.
ZIP'in içinde neler bulunur
Bu sayfadaki örnekler, aynı şekilde içe aktarılan bu belgelerin yapısını kullanır:
categories.json
articles/
ticketix-introduction.md
ticketix-install.md
images/
ticketix-ai-connections-screenshot.webp
categories.json(isteğe bağlı) kategorileri listeler..mddosyaları makalelerdir. Herhangi bir klasörde olabilirler; adı_ile başlayan dosyalar veREADME.mddosyaları atlanır.- Görseller herhangi bir klasörde olabilir. Her makale bunlara kendi
.mddosyasına göre göreli bir yolla başvurur.
Bir klasörü sıkıştırdığınızda her şey o tek klasörün içinde kalırsa, Ticketix onun altındaki dosyaları okur.
categories.json
Bir kategori listesi. path zorunludur; diğer alanlar isteğe bağlıdır.
[
{"path": "Ticketix", "slug": "ticketix", "description": "Documentation for Ticketix.", "order": 100},
{"path": "Ticketix/Getting Started", "slug": "ticketix-getting-started", "description": "Install and set up Ticketix.", "order": 10}
]
path,/ile ayrılmış bir ürün ve bölümüdür. Eksik üst kategoriler oluşturulur.slug,descriptionveorderyolun son kısmına uygulanır. Düşükorderdeğerleri önce gelir.
Makale front matter bilgisi
Her .md dosyası iki --- satırı arasındaki front matter ile başlar, ardından Markdown gövdesi gelir:
---
title: Install Ticketix
slug: ticketix-install
category: Ticketix/Getting Started
order: 30
excerpt: Upload the installation package and run the setup.
tags: install, setup
status: published
visibility: public
---
The body of the article starts here.
| Alan | Zorunlu | Anlamı |
|---|---|---|
| title | Evet | Makale başlığı |
| category | Evet | Kategori yolu, örneğin Ticketix/Getting Started; yoksa oluşturulur |
| slug | Hayır | Makalenin adresi; boşsa dosya adından alınır |
| order | Hayır | Kategori içindeki sıra |
| excerpt | Hayır | Düz metin özet |
| tags | Hayır | Virgülle ayrılmış etiketler |
| status | Hayır | published (varsayılan) veya draft |
| visibility | Hayır | public (varsayılan) veya internal |
| lang | Hayır | Makalenin dili, örneğin en, tr veya de (aşağıdaki "Çevirileri içe aktarın" bölümüne bakın) |
Kullanabileceğiniz Markdown
#ile başlıklar. Makale başlığı sayfa başlığıdır, bu nedenle#ve##her ikisi de bölüm başlığı olur.- Paragraflar,
**bold**,*italic*ve satır içi kod. - Üç ters tırnak arasındaki kod blokları.
- Tek düzeyli madde işaretli listeler ve numaralı listeler.
|sütunlu tablolar.- Satır başında
>bulunan notlar. - Yatay çizgiler.
- Bağlantılar. Başka bir makaleye
kb:ve slug ile bağlantı verin, örneğin[Write and publish Knowledge Base articles](kb:ticketix-knowledge-base). .mddosyasına göre göreli yol içeren görseller, örneğin.
Görseller PNG, JPEG, GIF veya WebP biçiminde ve her biri en fazla 5 MB olmalıdır. Makalelerde yalnızca Ticketix tarafından depolanan görseller gösterilir, bu nedenle her görseli ZIP'e ekleyin. Aynı görsel, birden fazla makale kullansa bile bir kez depolanır.
İçe aktarmayı çalıştırın
- İçerik → Bilgi Bankası'nı açın ve Belgeleri içe aktar düğmesine tıklayın.
- Varsayılan dil ayarını kontrol edin: dil belirtmeyen dosyaların dili (başka bir dil seçmediğiniz sürece İngilizce). ZIP dosyasını pencereye bırakın veya seçin. Henüz hiçbir şey değişmez.
- Ticketix ZIP dosyasını kontrol eder ve ne olacağını gösterir: Yeni, Güncellendi ve Değişmedi makalelerin, Kategoriler ve Görseller sayısı, her dil için aynı sayılar, Oluşturulacak veya güncellenecek makaleler ve içe aktarılamayan dosyalar ile nedeni, örneğin eksik bir görsel veya eksik bir
title. - Değişiklikleri yazmak için … değişikliği içe aktar düğmesine ya da İptal düğmesine tıklayın.
- Sonucu okuyun, örneğin "İçe aktarma tamamlandı: 19 oluşturuldu, 0 güncellendi, 0 değişmedi, 4 kategori değişti, 20 yeni görsel."
Bir dosyadaki hata diğerlerini durdurmaz. Dosyayı düzeltin ve ZIP'i yeniden içe aktarın. Kontrolden sonra çok uzun beklerseniz Ticketix dosyayı yeniden seçmenizi ister.
Belgeleri güncelleyin
ZIP'in yeni sürümünü içe aktarın. Makaleler kısa ad ve dile göre eşleştirilir:
- Yeni bir slug yeni bir makale oluşturur.
- Mevcut bir kısa ad, aynı dildeki makaleyi günceller. Önceki metin, "Şuradan içe aktarıldı" değişiklik notu ve dosya adıyla birlikte revizyon geçmişinde kalır.
- İçeriği değişmeyen bir makale değişmedi olarak sayılır.
İçe aktarma hiçbir şeyi silmez. Bir makaleyi kaldırmak için makale listesinde veya sayfasında arşivleyin.
Çevirileri içe aktarın
Bir çeviri, İngilizce orijinaliyle aynı kısa ada (slug) ve farklı bir dile sahiptir. Çevirileri İngilizce belgelerden sonra, kendilerine ait bir ZIP ile içe aktarın, örneğin:
de_DE/
categories.json
articles/
ticketix-install.md
images/
ticketix-ai-connections-screenshot.webp
- Bir dosyanın dili,
lang:satırıdır, örneğinlang: de; bu yoksa ZIP'in en üstündeki dil klasörüdür (tr/,tr_TR/vede_DE/,trvedeverir); bu da yoksa içe aktarmanın Varsayılan dil ayarıdır. İngilizce, Arapça, Türkçe, Japonca ve Almanca dışındaki herhangi bir dil, o dosyanın hata vermesine neden olur. - Bir çeviri, İngilizce orijinalinin kategorisini ve sırasını alır; dosyanın
categoryveordersatırları kullanılmaz.visibilitysatırı olmayan bir çeviri, orijinali yalnızca personele açıksa o da yalnızca personele açıktır. İngilizce makale değişmez. - İngilizce orijinali olmayan bir çeviri bağımsız bir makale olarak içe aktarılır ve kontrol bunu bir uyarı olarak listeler.
- Bir dil klasöründeki ya da tüm makaleleri İngilizce dışındaki tek bir dilde olan bir ZIP'in en üstündeki
categories.jsondosyası, her kategoriyi İngilizcepathdeğeriyle bulur ve yalnızca o dildeki adı (title, isteğe bağlı) vedescriptiondeğerini yazar. İngilizce ad, sıra ve üst kategori olduğu gibi kalır. - Çevrilmiş makalelerin kullandığı görselleri de ekleyin. Örneğin İngilizce belgelerden zaten depolanmış bir görsel yeniden depolanmaz.
Çevrilmiş bir categories.json girdisi:
[
{"path": "Ticketix/Getting Started", "slug": "ticketix-getting-started", "title": "Erste Schritte", "description": "Ticketix installieren und einrichten."}
]
Ziyaretçilerin ne gördüğü için Diller ve çevrilmiş içerik sayfasına bakın.
Sınırlar
| Sınır | Değer |
|---|---|
| ZIP'teki dosyalar | En fazla 2.000 |
| Açıldıktan sonraki toplam boyut | En fazla 200 MB |
| Görsel boyutu | Görsel başına en fazla 5 MB |
| Görsel türleri | PNG, JPEG, GIF ve WebP |
Güvenlik için Ticketix, mutlak yollar veya .. içeren yollar barındıran bir ZIP'i reddeder.