如何為 ONLYOFFICE 文檔創(chuàng)建您自己的插件
摘要：在本文中，您將學(xué)習(xí)如何為 ONLYOFFICE Docs 創(chuàng)建自己的插件以及如何將其發(fā)布到自 7.2 版本以來(lái)可用的官方插件價(jià)格。
解析和轉(zhuǎn)換PDF文件等等。
不過(guò)，有一種方法可以讓ONLYOFFICE變得更強(qiáng)大。這里指的是第三方插件，即增強(qiáng)套件高級(jí)功能的附加軟件。例如，插件可以鏈接第三方服務(wù)或添加新的用戶界面。
如何為 ONLYOFFICE 文檔創(chuàng)建插件
在開(kāi)始為 ONLYOFFICE Docs 創(chuàng)建自己的插件之前，您需要確保您擁有 GitHub 文檔。
創(chuàng)建插件的過(guò)程可以分為七個(gè)步驟，您應(yīng)該仔細(xì)遵循這些步驟：
的
第一個(gè)活動(dòng)。
代碼的編碼。
改變插件風(fēng)格。
位置狀態(tài)（可選）。
準(zhǔn)備。
測(cè)試。
發(fā)布到插件市場(chǎng)。
的
讓我們更深入地了解插件開(kāi)發(fā)。
首先，您需要登錄 GitHub 帳戶，如果沒(méi)有，則創(chuàng)建一個(gè)帳戶。之后，您需要?jiǎng)?chuàng)建位于以下 URL 地址的 ONLYOFFICE 插件零售商店分支：
https://github.com/ONLYOffice/onlyoffice.github.io。
因此，您將擁有另一個(gè)存儲(chǔ)庫(kù)，其 URL 地址如下所示：
https://github.com/YOUR-USERNAME/ONLYOFFICE/onlyoffice.github.io
如果成功分叉插件市場(chǎng)存儲(chǔ)庫(kù)，您需要從此存儲(chǔ)庫(kù)創(chuàng)建一個(gè) GitHub Pages 站點(diǎn)以用于測(cè)試目的。如果您不知道如何操作，請(qǐng)參閱官方 GitHub 指南。
現(xiàn)在您已經(jīng)有了自己的 GitHub Pages 站點(diǎn)，是時(shí)候在您的計(jì)算機(jī)上克隆 fork 了。
最后，您需要為未來(lái)的插件創(chuàng)建一個(gè)文件夾：
onlyoffice.github.io/sdkjs-plugins/content/。
就是這樣。您剛剛完成了所需的所有初始任務(wù)，可以繼續(xù)下一步。
您不需要非常擅長(zhǎng)編碼，但您絕對(duì)需要一些基本的編碼知識(shí)來(lái)為 ONLYOFFICE Docs 創(chuàng)建自己的插件。
簡(jiǎn)而言之，ONLYOFFICE插件是一個(gè)包含許多文件的文件夾。您需要?jiǎng)?chuàng)建三個(gè)文件才能使插件正常工作：
的
config.json – 這是插件配置文件，包含有關(guān)所有重要數(shù)據(jù)的信息。在此文件中，有一些在 ONLYOFFICE 編輯器中注冊(cè)插件所需的參數(shù)。請(qǐng)參閱官方 API 文檔中的此頁(yè)面以閱讀每個(gè)參數(shù)的完整說(shuō)明。
插件代碼（.js 文件）——這是插件文件本身，其中包含插件的 JavaScript 代碼。該文件描述了插件執(zhí)行的功能以及它們的執(zhí)行方式。閱讀此 API 指南以了解其工作原理。
index.html – 這是鏈接到 config.json 和 plugin.js 文件的插件條目。查看此示例以了解它應(yīng)該是什么樣子。
的
除了這些必需文件之外，插件文件夾還可能包含其他文件。例如，圖標(biāo)、插件樣式、自述文件、第三方服務(wù)等。您將在下面找到有關(guān)這些文件的更多信息。
要為您的插件編寫(xiě)良好的工作代碼，您需要知道需要哪些事件。
為您的插件編寫(xiě)代碼是不夠的。您還應(yīng)該自定義其樣式，使其看起來(lái)像 ONLYOFFICE 編輯器的一個(gè)組成部分。為此，只需將 ONLYOFFICE 樣式表添加到上述 index.html 文件中即可：
<link rel="stylesheet" href="https://onlyoffice.github.io/sdkjs-plugins/v1/plugins.css">
您可以添加按鈕、輸入控件、信號(hào)控件、加載程序等。
例如，要向插件添加組合框，您可以使用 select2 函數(shù)：
<select id="select_example" class="" ></select>
$('#select_example').select2({
data : [{id:0, text:'項(xiàng)目 1'}, {id:1, text:'項(xiàng)目 2'}, {id:2, text:'項(xiàng)目 3'}],
搜索的最小結(jié)果：無(wú)窮大，
寬度：'120px'
});
嵌入的組合框?qū)⑷缦滤荆?/span>
您可以在此處找到有關(guān) ONLYOFFICE 風(fēng)格單品的更多信息。
如果您要?jiǎng)?chuàng)建僅適用于英語(yǔ)使用者的插件，則可以跳過(guò)此步驟。但是，如果您希望您的插件支持其他語(yǔ)言，您可以在插件文件夾中創(chuàng)建翻譯文件夾，并上傳您想要使用的所有語(yǔ)言的 .json 文件。
請(qǐng)閱讀官方 API 文檔，了解如何在此處正確集中您的插件。
要在 ONLYOFFICE 市場(chǎng)上提供插件之前清理插件的外觀，您需要添加一個(gè)“關(guān)于”窗口，其中包含您的插件、版本、公司名稱(chēng)等的簡(jiǎn)短描述。
例如，這是照片編輯器插件中的“關(guān)于”窗口：
要為您的插件創(chuàng)建這樣的窗口，請(qǐng)按照以下說(shuō)明操作。
此外，您需要為插件創(chuàng)建圖像并將其上傳到資源文件夾。一般來(lái)說(shuō)，您需要 8 分才能使您的插件在 ONLYOFFICE 插件市場(chǎng)上表現(xiàn)良好：淺色和深色界面主題需要 4 分（125%、150%、175% 和 200% 成功）。
此外，您可以創(chuàng)建一個(gè)自述文件并將其上傳到主插件文件夾。該文件可以包含您希望其他用戶了解的任何信息 - 插件主要功能的描述、安裝說(shuō)明、已知問(wèn)題和錯(cuò)誤等。
現(xiàn)在您的插件已準(zhǔn)備就緒，您可以在將其發(fā)布到市場(chǎng)之前對(duì)其進(jìn)行徹底測(cè)試。
現(xiàn)在是時(shí)候?qū)⒛鶕?jù)上面的說(shuō)明創(chuàng)建的所有文件放入插件文件夾中了。然后將插件文件夾推送到遠(yuǎn)程存儲(chǔ)庫(kù)并在 ONLYOFFICE 桌面編輯器中測(cè)試該插件。為此，您可以在調(diào)試模式下運(yùn)行該軟件。
在 Linux 上，您可以使用 CTRL+ALT+T 打開(kāi)終端。之后，輸入 ONLYOFFICE Desktop Editors 的路徑，添加一個(gè)空格，然后輸入--ascdesktop-support-debug-info：
“/opt/onlyoffice/desktopeditors/DesktopEditors”--ascdesktop-support-debug-info
測(cè)試您的插件及其組件。
如果一切正常，您還可以在 ONLYOFFICE 套件的網(wǎng)頁(yè)版 ONLYOFFICE Docs 中測(cè)試您的插件。換句話說(shuō)，您的插件可以作為新插件添加。
要?jiǎng)?chuàng)建有效的插件，您需要打開(kāi) onlyoffice.github.io/store/plugin-dev/extension/inject.js 文件，并在 URL_TO_PLUGIN 變量中指定 GitHub Pages 站點(diǎn)上插件的路徑：
var URL_TO_PLUGIN = "https://您的用戶名.github.io/onlyoffice.github.io/sdkjs-plugins/content/your-plugin/"
onlyoffice.github.io/store/plugin-dev/extension 文件夾是您需要的擴(kuò)展。只需將其安裝在您的網(wǎng)絡(luò)瀏覽器上即可，如何將插件添加到網(wǎng)絡(luò)瀏覽器。
如果您的插件按預(yù)期工作，您可以繼續(xù)執(zhí)行最后一步。
我們要祝賀你！您已經(jīng)完成了插件創(chuàng)建過(guò)程，現(xiàn)在您可以將您的插件提供給其他用戶。為此，您可以從您的分支向以下 ONLYOFFICE 存儲(chǔ)庫(kù)發(fā)出拉取請(qǐng)求：
https://github.com/ONLYOffice/onlyoffice.github.io
如果您的插件表現(xiàn)良好，ONLYOFFICE工作人員將批準(zhǔn)您的拉取請(qǐng)求，您的插件將出現(xiàn)在ONLYOFFICE插件市場(chǎng)中。在這種情況下，第三方只需點(diǎn)擊幾下即可手動(dòng)安裝。
我們希望這篇文章對(duì)您有所幫助。不要忘記在下面的評(píng)論中分享您的想法。