เปิดใช้งานการพัฒนาและการดีบักปลั๊กอิน ONLYOFFICE Desktop

คุณไม่จำเป็นต้องเปิดใช้งานสวิตช์การพัฒนาปลั๊กอินแยกต่างหากใน ONLYOFFICE Desktop Editors สร้างปลั๊กอิน ติดตั้ง.pluginแพ็กเกจผ่าน Plugin Manager และเรียกใช้แอปพลิเคชันเดสก์ท็อป--ascdesktop-support-debug-infoเมื่อคุณต้องการเครื่องมือดีบัก โปรแกรมแก้ไขบนเดสก์ท็อปและเว็บใช้ขั้นตอนการโหลดที่แตกต่างกัน ดังนั้นให้เริ่มต้นด้วยขั้นตอนการทำงานเฉพาะสำหรับเดสก์ท็อปด้านล่าง

เตรียมโปรเจ็กต์ปลั๊กอินขนาดเล็ก

คำแนะนำเหล่านี้ใช้ได้กับ ONLYOFFICE Desktop Editors บน Windows, macOS และ Linux โปรดใช้การติดตั้งเดสก์ท็อปเวอร์ชันล่าสุดและโปรแกรมแก้ไขโค้ดสำหรับไฟล์ข้อความธรรมดา เอกสารอย่างเป็นทางการถือว่าการติดตั้งปลั๊กอินด้วยตนเองและการดีบักของนักพัฒนาเป็นคุณสมบัติที่แยกจากกัน ไม่จำเป็นต้องใช้ Plugin Marketplace ในการพัฒนาและทดสอบปลั๊กอินในเครื่อง ตัวอย่าง Hello World เป็นตัวอย่างการตรวจสอบเบื้องต้นที่มีประโยชน์ เนื่องจากแยกการโหลดปลั๊กอินออกจากบริการที่ซับซ้อนกว่า

1. สร้างโฟลเดอร์ต้นทาง

สร้างโฟลเดอร์ชื่อhello-world-plugin. เพิ่มไฟล์config.jsonmanifest และindex.htmlentry point เข้าไป หากไฟล์ manifest อ้างอิงถึงไฟล์ใดไฟล์หนึ่ง คุณสามารถเพิ่มicon.pngรูปภาพเข้าไปได้ เก็บโฟลเดอร์นี้ไว้นอกไดเร็กทอรีที่ติดตั้งแอปพลิเคชัน เพื่อป้องกันไม่ให้การอัปเดตซอฟต์แวร์เขียนทับไฟล์งานของคุณ

2. กำหนดค่า manifest และสร้าง GUID ของคุณเอง

ไฟล์ manifest จะบอก ONLYOFFICE ว่าควรโหลดไฟล์ HTML ใด และโปรแกรมแก้ไขใดบ้างที่สามารถใช้งานปลั๊กอินได้ ตัวอย่างต่อไปนี้รองรับโปรแกรมแก้ไขเอกสาร แทนที่ GUID ตัวอย่างด้วย UUID ที่สร้างขึ้นใหม่ก่อนการติดตั้ง: เรียกใช้New-Guidใน Windows PowerShell หรือuuidgenบน macOS หรือ Linux จากนั้นจัดรูปแบบค่าเป็นasc.{YOUR-UUID}. ปลั๊กอินแต่ละตัวต้องการตัวระบุเฉพาะของตนเอง

{
  "name": "Hello World",
  "guid": "asc.{12345678-1234-1234-1234-1234567890AB}",
  "version": "1.0.0",
  "variations": [{
    "url": "index.html",
    "icons": ["icon.png"],
    "isViewer": false,
    "EditorsSupport": ["word"]
  }]
}

ใช้ JSON ที่ถูกต้อง: ห้ามมีเครื่องหมายจุลภาคปิดท้าย วงเล็บปีกกาต้องตรงกัน และต้องเป็นไฟล์จริงสำหรับทุกจุดเริ่มต้นหรือไอคอนที่อ้างอิง สำหรับปลั๊กอินสเปรดชีตหรือการนำเสนอ ให้ใช้ค่าที่เหมาะสมEditorsSupportแทนที่จะสมมติว่าปลั๊กอินสำหรับเอกสารเท่านั้นปรากฏอยู่ทุกที่ เปรียบเทียบโครงสร้างกับคู่มือเริ่มต้นใช้งานฉบับย่อ "Hello World"อย่าง เป็นทางการ

3. ดำเนินการสร้างจุดเริ่มต้น

ในindex.htmlไฟล์ ให้โหลดไลบรารี API ของปลั๊กอิน ONLYOFFICE เพิ่มปุ่ม และกำหนดให้ปุ่มเรียกใช้เมธอด `getLayout()` ตัวอย่างการเริ่มต้นใช้งานอย่างรวดเร็วwindow.Asc.plugin.executeMethod("PasteText", ["Hello World!"])จากผู้ผลิตมีโค้ด HTML และ URL ของไลบรารีที่ใช้งานได้สมบูรณ์ การคัดลอกตัวอย่างนั้นปลอดภัยกว่าการเดาการเริ่มต้นหรือไวยากรณ์ API บันทึกไฟล์เป็น UTF-8 หากคุณวางแผนที่จะทำงานแบบออฟไลน์ โปรดจำไว้ว่าหน้าเว็บที่นำเข้าไลบรารีปลั๊กอินหรือสินทรัพย์อื่นๆ จาก URL ออนไลน์ยังคงต้องการทรัพยากรเหล่านั้นในการโหลด

ติดตั้งและเรียกใช้ปลั๊กอินสำหรับการพัฒนาของคุณ

4. สร้างไฟล์เก็บถาวร .plugin

เลือกไฟล์ภายในโฟลเดอร์ต้นทาง บีบอัดไฟล์เหล่านั้นเป็นไฟล์ ZIP และเปลี่ยนชื่อนามสกุลของไฟล์ ZIP จาก . .zipzip เป็น.plugin.zip รูทของไฟล์ ZIP ควรมี . config.jsonzip และ . index.htmlzip ไม่ใช่มีhello-world-pluginโฟลเดอร์อื่นมาครอบทับอีก บน Windows ให้เปิดใช้งานนามสกุลไฟล์ใน File Explorer เพื่อป้องกันการสร้างนามสกุลไฟล์hello-world.plugin.zip. zip โดยไม่ตั้งใจ คำแนะนำในการติดตั้ง Desktop Editors อย่างเป็นทางการ ระบุว่ารองรับการติดตั้งด้วยตนเองโดยไม่ต้องเชื่อมต่อกับ Marketplace

5. นำเข้าแพ็กเกจจากตัวจัดการปลั๊กอิน

เปิดเอกสารที่แก้ไขได้ใน ONLYOFFICE Desktop Editors เลือกPlugins > Plugin Manager > My plugins > Install plugin manuallyหน้าตาของตัวจัดการปลั๊กอินอาจแตกต่างกันไปในแต่ละเวอร์ชัน แต่ขั้นตอนนี้คือวิธีการติดตั้งด้วยตนเองตามที่ระบุไว้ ไม่ใช่การตั้งค่า URL สำหรับนักพัฒนาซอฟต์แวร์ใน Marketplace

6. เลือกไฟล์และตรวจสอบรายการในเมนู

เลือกhello-world.pluginไฟล์เก็บถาวรของคุณในกล่องโต้ตอบไฟล์แล้วเปิดขึ้นมา ปลั๊กอินที่ติดตั้งแล้วควรจะปรากฏให้เห็นในแท็บปลั๊กอิน หากไม่พบ ให้ตรวจสอบไฟล์ manifest, GUID, ประเภทตัวแก้ไขที่รองรับ และไดเร็กทอรีรากของไฟล์เก็บถาวรก่อนที่จะเปลี่ยนการตั้งค่าแอปพลิเคชัน ลองเปิดเอกสารอีกครั้งหลังจากติดตั้งหากเมนูไม่รีเฟรชทันที

7. ทดสอบปลั๊กอินในเอกสารชั่วคราว

เปิดเอกสารทดสอบเปล่า เรียกใช้ ปลั๊กอิน Hello Worldจากแท็บ Plugins แล้วกดปุ่มที่ปรากฏ ตรวจสอบว่าข้อความHello World!ปรากฏในเอกสาร การตรวจสอบนี้ไม่ได้เป็นการตรวจสอบการติดตั้งเพียงอย่างเดียว แต่ยังเป็นการยืนยันว่าอินเทอร์เฟซของปลั๊กอินโหลดแล้ว และการเรียกใช้ API ของตัวแก้ไขได้ส่งไปถึงเอกสารแล้ว ห้ามทดสอบปลั๊กอินที่เปลี่ยนแปลงเนื้อหาในไฟล์ที่ไม่สามารถทดแทนได้

เปิดใช้งานการดีบักสำหรับการพัฒนาปลั๊กอิน

8. รีสตาร์ทโปรแกรมแก้ไขบนเดสก์ท็อปโดยเปิดใช้งานแฟล็กดีบัก

ปิดโปรแกรม ONLYOFFICE Desktop Editors ให้สนิท จากนั้นเริ่มโปรแกรมจากเทอร์มินัลโดยใช้แฟล็กดีบักอย่างเป็นทางการ ใช้คำสั่งที่เหมาะสมกับระบบปฏิบัติการและตำแหน่งที่ติดตั้งโปรแกรมของคุณ:

• พร้อมท์คำสั่ง Windows: "%ProgramFiles%\ONLYOFFICE\DesktopEditors\DesktopEditors" --ascdesktop-support-debug-info
• ลินุกซ์ (ตำแหน่งแพ็กเกจมาตรฐาน): "/opt/onlyoffice/desktopeditors/DesktopEditors" --ascdesktop-support-debug-info
• macOS: "/Applications/ONLYOFFICE.app/Contents/MacOS/ONLYOFFICE" --ascdesktop-support-debug-info

คำสั่ง Windows ด้านบนใช้การขยายตัวแปรของ Command Prompt ไม่ใช่ไวยากรณ์ของ PowerShell ใน PowerShell ให้เรียกใช้ไฟล์ปฏิบัติการด้วยพาธแบบเต็มที่แก้ไขแล้ว หากแอปของคุณติดตั้งอยู่ในตำแหน่งที่ไม่ใช่ตำแหน่งมาตรฐาน ให้แทนที่ด้วยพาธของไฟล์ปฏิบัติการจริง คุณยังสามารถเพิ่มแฟล็กไปยังฟิลด์ Target ของทางลัดบนเดสก์ท็อป Windows ได้ โปรดดูคำสั่งโหมดดีบักบนเดสก์ท็อป ของ ONLYOFFICE สำหรับรายละเอียดเกี่ยวกับแพลตฟอร์ม

เมื่อเปิดเอกสารแล้ว ให้คลิกในพื้นที่แก้ไขของเอกสารแล้วกดF1หรือคลิกขวาที่ช่องแถบเครื่องมือที่แก้ไขได้แล้วเลือกInspect Elementใน DevTools ให้เลือก iframe ของปลั๊กอินเพื่อตรวจสอบโค้ดอินเทอร์เฟซและบันทึกของปลั๊กอิน โค้ดที่ส่งผ่านจะcallCommandทำงานในframeEditorบริบทแทน ดังนั้นให้สลับเฟรมเมื่อจำเป็น เอกสารอ้างอิงการดีบักปลั๊กอินอธิบายความแตกต่างนี้และวิธีการใช้เบรกพอยต์ การดีบักอาจเปิดเผยเนื้อหาของเอกสารและรายละเอียดขณะทำงาน อย่าแชร์บันทึกดิบโดยไม่ตรวจสอบก่อน

ลดระยะเวลาการทดสอบแก้ไขโดยไม่ต้องแก้ไขปลั๊กอินในตัว

หลังจากการติดตั้งด้วยตนเอง ONLYOFFICE จะคัดลอกปลั๊กอินไปยังไดเร็กทอรีที่มีชื่อเป็น GUID ภายใต้โปรไฟล์ผู้ใช้ของคุณ ตำแหน่งที่ระบุไว้คือ%LOCALAPPDATA%\ONLYOFFICE\DesktopEditors\data\sdkjs-plugins\บน Windows, ~/Library/Application Support/asc.onlyoffice.ONLYOFFICE/data/sdkjs-plugins/macOS และ~/.local/share/onlyoffice/desktopeditors/sdkjs-plugins/Linux โฟลเดอร์ที่มีชื่อเป็น GUID จะละเว้นส่วนนำหน้าที่asc.ใช้ในไฟล์ manifest

เพื่อหลีกเลี่ยงการสร้างไฟล์เก็บถาวรใหม่ทุกครั้งที่มีการเปลี่ยนแปลง นักพัฒนาสามารถปิดแอปพลิเคชัน เปลี่ยนโฟลเดอร์ปลั๊กอินที่ติดตั้งไว้เองด้วยลิงก์สัญลักษณ์ไปยังโฟลเดอร์ซอร์สโค้ดที่กำลังทำงานอยู่ แล้วเปิดเอกสารอีกครั้งหลังจากแก้ไขเสร็จ วิธีนี้เป็นทางเลือก และคำสั่งสร้างลิงก์ที่แน่นอนจะแตกต่างกันไปตามระบบปฏิบัติการ โปรดปฏิบัติตามคำแนะนำการพัฒนาบนเดสก์ท็อปอย่างเป็นทางการก่อนดำเนินการ อย่าเปลี่ยนโฟลเดอร์ปลั๊กอินที่รวมมาด้วย/ค่าเริ่มต้น หรือแก้ไขแพ็กเกจแอปพลิเคชัน macOS: ผู้จำหน่ายเตือนว่าการลบปลั๊กอินเริ่มต้นอาจทำให้ความสมบูรณ์ของแพ็กเกจเสียหายและทำให้แอปพลิเคชันหยุดทำงานได้

ตรวจสอบการตั้งค่าการพัฒนา

การตรวจสอบสามอย่างนี้บ่งชี้ว่าเวิร์กโฟลว์พร้อมใช้งานแล้ว: ปลั๊กอินแบบกำหนดเองจะปรากฏภายใต้Plugins , การทดสอบ Hello World จะแทรกข้อความลงในเอกสารใหม่ และ DevTools จะเปิดขึ้นหลังจากเรียกใช้ด้วยแฟล็กดีบัก หากอินเทอร์เฟซว่างเปล่าหรือการติดตั้งล้มเหลว ให้ตรวจสอบว่า manifest ถูกแยกวิเคราะห์เป็น JSON, GUID ขึ้นต้นด้วยasc., index.htmlอยู่ในพาธสัมพัทธ์ที่ประกาศไว้ และมีทรัพยากรที่จำเป็นทั้งหมดอยู่คู่มือข้อผิดพลาดของปลั๊กอิน อย่างเป็นทางการ ครอบคลุมความล้มเหลวทั่วไปเหล่านี้ การติดตั้งปลั๊กอินไม่ได้หมายความว่าทุกฟีเจอร์ที่ใช้งานได้จะทำงานได้อย่างถูกต้อง ให้ทำการตรวจสอบซ้ำอีกครั้งหลังจากการเปลี่ยนแปลงโค้ดแต่ละครั้ง