Home
» PC Tips
»
Abilita lo sviluppo e il debug dei plugin desktop di ONLYOFFICE
Abilita lo sviluppo e il debug dei plugin desktop di ONLYOFFICE
Non è necessario attivare un interruttore separato per lo sviluppo di plugin negli editor desktop di ONLYOFFICE. Crea un plugin, installa il relativo .pluginpacchetto tramite Gestione plugin e avvia l'applicazione desktop --ascdesktop-support-debug-infoquando hai bisogno degli strumenti di debug. Gli editor desktop e web utilizzano procedure di caricamento diverse, quindi inizia con il flusso di lavoro specifico per desktop descritto di seguito.
Prepara un piccolo progetto di plugin
Queste istruzioni si applicano agli editor desktop ONLYOFFICE su Windows, macOS e Linux. Utilizzare un'installazione desktop aggiornata e un editor di codice per i file di testo semplice. La documentazione ufficiale considera l'installazione manuale dei plugin e il debug da parte dello sviluppatore come funzionalità separate; il Marketplace dei plugin non è necessario per sviluppare e testare un plugin locale. Un esempio "Hello World" è un utile primo controllo perché isola il caricamento dei plugin da servizi più complessi.
1. Crea la cartella sorgente
Crea una cartella denominata hello-world-plugin. Aggiungi un config.jsonmanifest e un index.htmlentry point. Facoltativamente, aggiungi icon.pngun'immagine se il tuo manifest ne fa riferimento. Mantieni la cartella al di fuori della directory di installazione dell'applicazione, in modo che gli aggiornamenti software non sovrascrivano i tuoi file di lavoro.
Mantieni il manifesto del plugin e il relativo file HTML di ingresso nella stessa cartella di sviluppo; un'icona locale è facoltativa.
2. Definisci il manifesto e genera il tuo GUID
Il manifesto indica a ONLYOFFICE quale file HTML caricare e quali editor possono eseguire il plugin. L'esempio seguente supporta l'editor di documenti. Sostituire il GUID di esempio con un UUID appena generato prima dell'installazione: eseguire New-Guidin Windows PowerShell o uuidgensu macOS o Linux, quindi formattare il valore come asc.{YOUR-UUID}. Ogni plugin distinto necessita di un proprio identificatore.
Utilizza JSON valido: niente virgole finali, parentesi graffe corrispondenti e un file reale per ogni punto di ingresso o icona a cui si fa riferimento. Per un plugin per fogli di calcolo o presentazioni, utilizza i valori appropriati EditorsSupportinvece di presumere che un plugin solo per documenti appaia ovunque. Confronta la struttura con la guida rapida ufficiale "Hello World" .
Il file manifest config.json identifica il plugin e ne limita l'utilizzo agli editor supportati.
3. Implementare il punto di ingresso
Nel file index.html, carica la libreria API del plugin ONLYOFFICE, aggiungi un pulsante e fai in modo che il pulsante chiami la funzione . L' esempio di avvio rapidowindow.Asc.plugin.executeMethod("PasteText", ["Hello World!"]) del produttore fornisce l'HTML completo e funzionante e l'URL della libreria; copiare quell'esempio è più sicuro che indovinare l'inizializzazione o la sintassi dell'API. Salva il file come UTF-8. Se prevedi di lavorare offline, ricorda che una pagina che importa la sua libreria di plugin o altre risorse da un URL online ha comunque bisogno di tali risorse per essere caricata.
Il file di ingresso contiene l'interfaccia e la chiamata JavaScript che l'editor utilizza quando il plugin è in esecuzione.
Installa ed esegui il tuo plugin di sviluppo
4. Crea l'archivio .plugin
Seleziona i file all'interno della cartella sorgente, comprimili in un archivio ZIP e rinomina l'estensione ZIP da .zipa .plugin. La directory principale dell'archivio dovrebbe contenere config.jsone index.html, non una seconda hello-world-plugindirectory contenitore. Su Windows, abilita le estensioni dei nomi file in Esplora file per evitare di creare accidentalmente hello-world.plugin.zip. Le istruzioni di installazione ufficiali di Desktop Editors supportano esplicitamente l'installazione manuale senza una connessione al Marketplace.
Prima di rinominare il file ZIP con l'estensione .plugin, archivia il contenuto della cartella del plugin, non della cartella che lo contiene.
5. Importa il pacchetto da Gestione plugin
Apri un documento modificabile in ONLYOFFICE Desktop Editors. Seleziona Plugin > Gestione plugin > I miei plugin > Installa plugin manualmente . L'aspetto esatto della gestione potrebbe variare a seconda della versione, ma questa procedura rappresenta il percorso di installazione manuale documentato. Non si tratta dell'impostazione separata dell'URL sviluppatore del Marketplace.
All'interno di un documento, apri Plugin, quindi Gestione plugin e passa a I miei plugin per accedere all'installazione manuale.
6. Seleziona il file e controlla la relativa voce di menu
Seleziona l' hello-world.pluginarchivio nella finestra di dialogo File e aprilo. Il plugin installato dovrebbe essere disponibile nella scheda Plugin. Se non è presente, controlla il manifesto, il GUID, il tipo di editor supportato e la directory principale dell'archivio prima di modificare le impostazioni dell'applicazione. Se il menu non si aggiorna immediatamente, prova a riaprire un documento dopo l'installazione.
Nella finestra di dialogo di selezione file, selezionare l'archivio .plugin; non selezionare la cartella sorgente originale.
7. Testa il plugin in un documento temporaneo
Apri un documento di prova vuoto, avvia "Hello World" dalla scheda Plugin e usa il relativo pulsante. Verifica che la scritta "Hello World!" appaia nel documento. Questo controllo va oltre la semplice installazione: conferma che l'interfaccia del plugin è stata caricata e che la chiamata API dell'editor ha raggiunto il documento. Non testare plugin che modificano il contenuto su un file insostituibile.
Esegui il plugin installato all'interno di un documento temporaneo e verifica il contenuto del documento risultante.
Abilita il debug per lo sviluppo di plugin
8. Riavviare gli editor desktop con il flag di debug
Chiudi completamente ONLYOFFICE Desktop Editors, quindi avvia l'applicazione da un terminale con il flag di debug ufficiale. Utilizza il comando appropriato per il tuo sistema operativo e la posizione di installazione:
Prompt dei comandi di Windows:"%ProgramFiles%\ONLYOFFICE\DesktopEditors\DesktopEditors" --ascdesktop-support-debug-info
Linux (posizione standard dei pacchetti):"/opt/onlyoffice/desktopeditors/DesktopEditors" --ascdesktop-support-debug-info
Il comando Windows sopra riportato utilizza l'espansione delle variabili del prompt dei comandi, non la sintassi di PowerShell; in PowerShell, richiama l'eseguibile con il suo percorso completo risolto. Se l'app è stata installata in una posizione non standard, sostituisci il percorso con quello effettivo dell'eseguibile. Puoi anche aggiungere il flag al campo Destinazione di un collegamento sul desktop di Windows. Per i dettagli sulla piattaforma, consulta i comandi della modalità di debug del desktop di ONLYOFFICE .
Una volta aperto il documento, fai clic nell'area di modifica e premi F1 oppure fai clic con il pulsante destro del mouse su un campo modificabile della barra degli strumenti e scegli Ispeziona elemento . In DevTools, seleziona l'iframe del plugin per ispezionare il codice dell'interfaccia del plugin e i log. Il codice passato viene callCommandeseguito nel frameEditorcontesto, quindi cambia frame quando necessario. La documentazione di debug del plugin spiega questa distinzione e come utilizzare i breakpoint. Il debug può esporre il contenuto del documento e i dettagli di runtime; non condividere i log non elaborati senza averli prima controllati.
Dopo aver abilitato il debug, esamina l'iframe del plugin pertinente negli Strumenti per sviluppatori; i messaggi della console qui visualizzati sono a scopo illustrativo.
Riduci i tempi del ciclo di modifica e test senza modificare i plugin integrati.
Dopo l'installazione manuale, ONLYOFFICE copia un plugin in una directory denominata GUID all'interno del profilo utente. I percorsi documentati sono %LOCALAPPDATA%\ONLYOFFICE\DesktopEditors\data\sdkjs-plugins\su Windows, ~/Library/Application Support/asc.onlyoffice.ONLYOFFICE/data/sdkjs-plugins/su macOS e ~/.local/share/onlyoffice/desktopeditors/sdkjs-plugins/su Linux. La cartella denominata GUID omette il prefisso asc.utilizzato nel manifesto.
Per evitare di creare un nuovo archivio per ogni modifica, gli sviluppatori possono chiudere l'app, sostituire la cartella dei plugin installati con un collegamento simbolico alla cartella sorgente di lavoro e riaprire il documento dopo la modifica. Questa operazione è facoltativa e i comandi esatti per il collegamento variano a seconda del sistema operativo. Prima di procedere, seguire le istruzioni ufficiali per lo sviluppo desktop . Non sostituire le cartelle dei plugin predefiniti/inclusi né modificare il pacchetto dell'app per macOS: il fornitore avverte che la rimozione dei plugin predefiniti può compromettere l'integrità del pacchetto e causare arresti anomali.
Verifica la configurazione di sviluppo
Tre controlli indicano che il flusso di lavoro è pronto: il plugin personalizzato appare in Plugin , il test Hello World inserisce del testo in un nuovo documento e DevTools si apre dopo l'avvio con il flag di debug. Se l'interfaccia è vuota o l'installazione fallisce, verificare che il manifest venga analizzato come JSON, che il GUID inizi con asc., index.htmlche esista nel percorso relativo dichiarato e che tutte le risorse necessarie siano presenti. La guida ufficiale agli errori dei plugin illustra questi errori comuni. Un plugin installato non garantisce che tutte le funzionalità implementate funzionino correttamente; ripetere lo stesso controllo dopo ogni modifica al codice.