confluenceDumpWithPython

تفريغ الالتقاء مع بايثون

تفريغ صفحات التقاء باستخدام Python (الطلبات) بتنسيق HTML وRST، بما في ذلك الصور والمرفقات المضمنة. سيتم تحديث المراجع إلى الملفات التي تم تنزيلها إلى المسار النسبي المحلي الخاص بها.

وصف

ومع ذلك، ستتطلب إعادة البناء ملفين فقط وتقبل وسيطات سطر الأوامر:

• myModules.py : يحتوي على كافة الوظائف المطلوبة.
• confluenceDumpWithPython.py : البرنامج النصي الذي سيتم استخدامه مع وسيطات سطر الأوامر التالية:
  • -m, --mode : وضع التصدير، single ، space ، bylabel ، pageprops (مطلوب).
    • ملحوظة: تم تنفيذ فقط single pageprops space حتى الآن.
  • -S, --site : الموقع الأطلسي (مطلوب).
  • -s, --space : مفتاح المسافة (إذا لزم الأمر).
  • -p, --page : معرف الصفحة (إذا لزم الأمر).
  • -l, --label : تسمية الصفحة (إذا لزم الأمر).
  • -x, --sphinx : يتم وضع المجلدات _images و_ _static في جذر مجلد التصدير، بدلاً من وضعها مع ملفات HTML المصدرة.
  • --notags : لا يضيف توجيهات العلامات إلى الملفات الأولى (عند عدم استخدام الملحق sphinx-tags ).
• updatePageLinks.py : تحديث روابط التقاء عبر الإنترنت للملفات المحلية التي تم تنزيلها حتى الآن.
  • --folder : المجلد الذي يحتوي على الملفات المراد تحديثها.
  • --test : بدلاً من الكتابة فوق ملفات .rst الأصلية، سيتم إنشاء ملفات محدثة باستخدام zout_ كبادئة.
• getPageEditorVersion.py : احصل على إصدار المحرر من صفحات فردية أو من جميع الصفحات في مساحة ما.
  • --site : الموقع الأطلسي (مطلوب).
  • --page : معرف الصفحة (إما/أو)
  • --space : مفتاح المسافة (إما/أو)

بالنسبة لتصميم CSS، يستخدم confluence.css من Confluence الذي يمكن الحصول عليه باستخدام الحل البديل الموضح في: https://jira.atlassian.com/browse/CONFSERVER-40907. ملف site.css المتضمن مع عمليات تصدير Confluence UI HTML ليس مكتملاً مثل الملف أعلاه.

بنية المجلدات والملفات:

• مجلد الإخراج الافتراضي هو output/ ضمن نفس مسار البرنامج النصي.
• سيتم إنشاء مجلد باسم المساحة أو صفحة تقرير خصائص الصفحة أو اسم صفحة واحدة أو اسم تسمية الصفحة ضمن مجلد الإخراج.
• افتراضيًا، سيتم وضع المجلدات _images/ و_ _static/ في مجلد الصفحة|المساحة|pageprops|التسمية.
  • سيضع خيار سطر الأوامر --sphinx هذا المجلد مباشرةً ضمن مجلد الإخراج
• سيتم نسخ الملف styles/confluence.css إلى الملف _static/ المحدد

ماذا يفعل

• الاستفادة من واجهة برمجة تطبيقات Confluence Cloud
• يضع بيانات تعريف Confluence مثل معرف الصفحة وتسميات الصفحة في رؤوس HTML وحقول RST.
• يتم استخدام beautifulsoup لتحليل HTML للحصول على المحتوى وتحديثه، على سبيل المثال. تغيير الروابط البعيدة إلى الروابط المحلية.
• قم بتنزيل كل صفحة وجميع المرفقات والرموز والملفات المضمنة.

متطلبات

• إعلان متغيرات النظام:
  • atlassianAPIToken
  • atlassianUserEmail

التبعيات

• بيثون3
  • طلبات
  • beautifulsoup4
  • وسادة (تعامل مع الصور)
  • باندوك و pypandoc (تحويل إلى RST)
  • يكرر

التثبيت

• استنساخ الريبو.
• تثبيت التبعيات.
• قم بتعريف متغيرات النظام لـ Atlassian API Token.

تنفيذ البرنامج

• كيفية تنزيل صفحة واحدة بناءً على معرفها.

 confluenceDumpWithPython.py -m single -S  -p  [
] [--sphinx]

• كيفية تنزيل خصائص الصفحة وجميع الصفحات المضمنة.

 confluenceDumpWithPython.py -m pageprops -S  -p  [
] [--sphinx]

• كيفية تحميل مساحة كاملة.

 confluenceDumpWithPython.py -m space -S  -s  [
]

يساعد

لا توجد نصيحة خاصة غير:

• تأكد من أن رمز Atlassian API الخاص بك صالح.
• اسم المستخدم لـ Cloud Atlassian API هو عنوان البريد الإلكتروني.

المؤلفون

أسماء المساهمين ومعلومات الاتصال

@ديرنوربيرتو

التحسينات

• إضافة تصدير بناءً على تسمية الصفحة.
• أضف روابط إلى التنزيلات للصفحات المقابلة.
• قم بتحديث جميع الروابط من الصفحات التي تم تنزيلها إلى النسخ المحلية.
• أضف إلى رؤوس الصفحة الأصلية وتسميات الصفحات.
• قم بإنشاء فهرس للصفحات لاستخدامها كجدول محتويات.
• إنشاء تخطيط صفحة لعرض TOC + المقالات.
• انسخ styles/site.css إلى output/styles/ إذا لم يكن موجودًا.
• السماح بالاستخدام مع Confluence Server.

مشاكل

• لا يحب الملفات المرفقة الطويلة جدًا، ستحتاج إلى إعادة تسميتها في Confluence قبل التفريغ.
• قد تواجه الصفحات التي تم ترحيلها سابقًا من Confluence Server مشكلات تتعلق بالرموز القديمة. الأفضل هو تحويل الصفحات إلى المحرر الجديد، الذي سيحل محل الرموز المفقودة.

تاريخ الإصدار

• 1.4
  • إعادة البناء في إعداد ملف أكثر بساطة ( confluenceDumpWithPython.py & myModules.py )
• 1.3
  • تمت إضافة تصدير المساحة (بنية المجلد المسطح)
• 1.2
  • تمت إضافة رأس وتذييل HTML أفضل.
  • تمت إضافة تسميات الصفحة إلى رؤوس HTML.
  • تحسين منطق وسيطة مجلد الإخراج.
• 1.1
  • تمت إضافة تفريغ خصائص Papge وأشياء أخرى أصغر
• 1.0
  • الإصدار الأولي

تراث/ مجلد مع الإصدار السابق من البرامج النصية

الغرض من الملفات:

1. confluenceExportHTMLrequestsByLabel.py : تنزيل مجموعة من الصفحات بناءً على تصنيف صفحة واحد (أو أكثر).
2. confluenceExportHTMLrequestsSingle.py : قم بتنزيل صفحة واحدة عن طريق توفير معرف الصفحة كوسيطة.
3. confluenceExportHTMLrequestsPagePropertiesReport.py : تنزيل خصائص الصفحة وجميع الصفحات الموجودة في التقرير عن طريق توفير معرف الصفحة كوسيطة.
4. confluenceExportHTMLrequestsPagesInSpace.py : تنزيل جميع الصفحات من الفضاء.

رخصة

تم ترخيص هذا المشروع بموجب ترخيص MIT - راجع ملف LICENSE.txt للحصول على التفاصيل

شكر وتقدير