confluenceDumpWithPython

Pertemuan Dump Dengan Python

Buang halaman Confluence menggunakan Python (permintaan) dalam format HTML dan RST, termasuk gambar dan lampiran yang disematkan. Referensi ke file yang diunduh akan diperbarui ke jalur relatif lokalnya.

Keterangan

Meskipun demikian, pemfaktoran ulang hanya memerlukan 2 file dan menerima argumen baris perintah:

• myModules.py : Berisi semua fungsi yang diperlukan.
• confluenceDumpWithPython.py : Skrip untuk digunakan dengan argumen baris perintah berikut:
  • -m, --mode : Mode ekspor, single , space , bylabel , pageprops (wajib).
    • Catatan: Sejauh ini hanya single , pageprops , dan space yang telah diterapkan.
  • -S, --site : Situs Atlassian (wajib).
  • -s, --space : Tombol Spasi (jika diperlukan).
  • -p, --page : ID Halaman (jika diperlukan).
  • -l, --label : Label Halaman (jika diperlukan).
  • -x, --sphinx : Folder _images dan _static ditempatkan di akar folder ekspor, bukan bersamaan dengan file HTML yang diekspor.
  • --notags : Tidak menambahkan arahan tag ke file pertama (bila addon sphinx-tags tidak digunakan).
• updatePageLinks.py : Perbarui tautan pertemuan online ke file lokal yang telah diunduh sejauh ini.
  • --folder : Folder yang berisi file yang akan diperbarui.
  • --test : Alih-alih menimpa file .rst asli, ini akan membuat file yang diperbarui dengan zout_ sebagai awalan.
• getPageEditorVersion.py : Dapatkan versi editor dari satu halaman atau semua halaman dalam satu spasi.
  • --site : Situs Atlassian (wajib).
  • --page : ID Halaman (salah satu/atau)
  • --space : Tombol Spasi (salah satu/atau)

Untuk Styling CSS menggunakan confluence.css dari Confluence yang dapat diperoleh dengan menggunakan Workaround yang dijelaskan di: https://jira.atlassian.com/browse/CONFSERVER-40907. File site.css yang disertakan dengan ekspor HTML Confluence UI tidak selengkap di atas.

Struktur folder dan file:

• Folder keluaran default adalah output/ di jalur yang sama dengan skrip.
• Folder dengan nama Spasi, halaman laporan Properti Halaman, nama halaman tunggal, atau nama Label Halaman akan dibuat di bawah folder keluaran.
• Secara default, folder _images/ dan _static/ akan ditempatkan di folder page|space|pageprops|label.
  • Opsi baris perintah --sphinx akan menempatkan folder tersebut langsung di bawah folder keluaran
• File styles/confluence.css akan disalin ke _static/ yang ditentukan

Apa fungsinya

• Memanfaatkan Confluence Cloud API
• Menempatkan data meta Confluence seperti ID Halaman dan Label Halaman, di header HTML dan bidang RST.
• beautifulsoup digunakan untuk mengurai HTML untuk mendapatkan dan memperbarui konten, mis. mengubah tautan jarak jauh ke tautan lokal.
• Unduh untuk setiap halaman, semua lampiran, emotikon, dan file yang disematkan.

Persyaratan

• mendeklarasikan variabel sistem:
  • atlassianAPIToken
  • atlassianUserEmail

Ketergantungan

• python3
  • permintaan
  • sup indah4
  • Bantal (gambar pegangan)
  • pandoc & pypandoc (konversi ke RST)
  • ulang

Menginstal

• Repo klon.
• Instal dependensi.
• Deklarasikan variabel sistem untuk Atlassian API Token.

Menjalankan program

• Cara mendownload satu halaman berdasarkan ID-nya.

 confluenceDumpWithPython.py -m single -S <site Name> -p <ID of page to dump> [<output folder>] [--sphinx]

• Cara mengunduh Properti Halaman dan semua halaman yang ada di dalamnya.

 confluenceDumpWithPython.py -m pageprops -S <site Name> -p <ID of page properties report page> [<output folder>] [--sphinx]

• Cara mengunduh seluruh Space.

 confluenceDumpWithPython.py -m space -S <site Name> -s <space KEY> [<output folder>]

Membantu

Tidak ada saran khusus selain:

• pastikan Atlassian API Token Anda valid.
• nama pengguna untuk Cloud Atlassian API adalah alamat email.

Penulis

Nama kontributor dan info kontak

@dernorberto

Perbaikan

• Tambahkan ekspor berdasarkan label halaman.
• Tambahkan tautan ke Unduhan untuk halaman terkait.
• Perbarui semua tautan dari halaman yang diunduh ke salinan lokal.
• Tambahkan ke header halaman induk dan label halaman.
• Buat indeks halaman untuk digunakan sebagai TOC.
• Buat tata letak halaman untuk menampilkan TOC + artikel.
• Salin styles/site.css ke output/styles/ jika tidak ada.
• Izinkan penggunaan dengan Confluence Server.

Masalah

• Ia tidak menyukai file lampiran yang sangat panjang, Anda harus mengganti namanya di Confluence sebelum membuangnya.
• Halaman yang sebelumnya dimigrasikan dari Confluence Server mungkin mengalami masalah dengan emotikon lama. Yang terbaik adalah mengonversi halaman ke Editor Baru, yang akan menggantikan emotikon yang hilang.

Riwayat Versi

• 1.4
  • Memfaktorkan ulang menjadi pengaturan file yang lebih sederhana ( confluenceDumpWithPython.py & myModules.py )
• 1.3
  • Menambahkan ekspor Ruang (struktur folder datar)
• 1.2
  • Menambahkan header dan footer HTML yang lebih baik.
  • Menambahkan label halaman ke header HTML.
  • Logika argumen folder keluaran yang ditingkatkan.
• 1.1
  • Menambahkan dump Properti Papge dan hal-hal kecil lainnya
• 1.0
  • Rilis Awal

folder legacy/ dengan skrip versi sebelumnya

Tujuan dari file:

1. confluenceExportHTMLrequestsByLabel.py : mengunduh sekumpulan halaman berdasarkan satu (atau lebih) Label halaman.
2. confluenceExportHTMLrequestsSingle.py : mengunduh satu halaman dengan memberikan ID halaman sebagai argumen.
3. confluenceExportHTMLrequestsPagePropertiesReport.py : mengunduh properti halaman dan semua halaman dalam laporan dengan memberikan ID halaman sebagai argumen.
4. confluenceExportHTMLrequestsPagesInSpace.py : unduh semua halaman dari suatu spasi.

Lisensi

Proyek ini dilisensikan di bawah Lisensi MIT - lihat file LICENSE.txt untuk detailnya

Ucapan Terima Kasih