Istruzioni installazione Plugin

Si trovi il plugin che si vuole installare nell'elenco dei plugin e si legga attentamente la descrizione del plugin. Quindi si faccia riferimento ai dettagli che seguono per installarlo.

La maggior parte dei plugin possono essere installati automaticamente utilizzando il plugin manager. Si veda Installation instructions using the plugin manager. Questo è di gran lunga il modo più rapido e propenso a meno errori per installare plugin.

Esistono alcune circostanze in cui non è possibile utilizzare il plugin manager per installare un plugin:

• ACL non è abilitato. Al plugin manager si accede tramite la finestra di amministrazione che lo rende disponibile solo su wiki con ACL abilitato. Anche in un wiki completamente pubblico può valere la pena abilitare ACL per ottenere l'accesso alle funzioni di amministrazione di DokuWiki, come il gestore plugin.
• Nessun pacchetto di plugin. Il gestore plugin richiede un archivio appositamente preparato contenente i file del plugin.
• Il server web non ha accesso in scrittura alla cartella di DokuWiki lib/plugins. Il gestore plugin deve essere in grado di aggiungere il nuovo plugin a questa cartella.
• Sviluppatori che creano i propri plugin da zero. Gli sviluppatori dovrebbero leggere plugin file structure.

In queste circostanze è necessario installare il plugin manualmente.

Queste istruzioni presuppongono che non si abbia una console di accesso al proprio server e sarà necessario caricare i file usando l'FTP o il file manager nel pannello di controllo del server.

1. Se il plugin ha un pacchetto di file, si scarichi il file sul proprio computer. Se il plugin viene fornito in differenti formati si scelga quello che si adatta meglio (gli utenti Windows preferiranno zip).
2. Si espanda (cioè unzip) il pacchetto (Si veda unpacking per aiuto e utilità). Questo dovrebbe fornire una cartella chiamata come il plugin. All'interno della cartella si vedranno file e cartelle chiamate per tipo di plugin (ad esempio syntax.php or /syntax/).
   • Nota: alcune applicazioni di decompressione collocheranno tutti i file decompressi in una cartella chiamata come l'archivio file originale. Se questo è il caso, sarà necessario salire di una cartella per trovare quella del plugin. Questo potrebbe generare confusione se l'archivio file ha effettivamente anche lo stesso nome del plugin!
   • Nota: molti autori ospitano i loro plugin su github e permettono a github di creare automaticamente un file zip dal più attuale controllo. Thesr crea automaticamente archivi che contengono di solito il nome della cartella sbagliato. E' necessario rinominare la cartella con il nome corretto.
     Esempio: l'estrazione del Gallery Plugin risulterà in una cartella chiamata tipo splitbrain-dokuwiki-plugin-gallery-169c0bb – è necessario rinominarlo in gallery.
     Suggerimento per gli sviluppatori di plugin: si usi il plugin.info.txt, che eviterà questo problema.
3. Usando il proprio caricatore di file (ad esempio FTP o il file manager dal pannello di controllo), si navighi sul server nella cartella di DokuWiki lib/plugins e si carichi la cartella del plugin appena creato (sul proprio computer) insieme a tutto il suo contenuto. Il risultato finale dovrebbe essere una nuova cartella sul server, lib/plugins/<new-plugin-name>, contenente i file e le cartelle del plugin.

Il plugin ora è installato.

Installare un plugin senza un pacchetto continua ad essere abbastanza semplice, specialmente per semplici plugin che consistono di solo pochi file. Tuttavia ci sono più se e senza ma e una maggiore familiarità con DokuWiki e PHP potrebbe essere necessaria se alcune informazioni cruciali non sono chiare dalla documentazione del plugin. Attualmente fare un pacchetto plugin è molto semplice, così se il PHP è completamente sconosciuto si può inviare all'autore del plugin una cortese email chiedendogli se può spedire il pacchetto plugin o almeno chiarire l'esatto nome da usare per il plugin.

Chi ha familiarità con PHP, controlli la pagina del plugin nella sezione sviluppatori, in particolare il plugin file structure.

Queste istruzioni presuppongono che l'autore ha incollato il codice richiesto dal plugin in una pagina web, dove il codice di ogni file è chiaramente identificabile insieme con il nome di ogni file.

1. Si crei una cartella sul proprio computer chiamata come il nome del plugin. Il nome è importante deve corrispondere al nome della “class” usata nei file del plugin.
2. Per ogni file usato dal plugin, si apra un nuovo file in un editore di semplice testo (ed esempio notepad), si copi il contenuto dalla pagina web e lo si incolli nell'editore assicurandosi che non ci siano ulteriori righe bianche sia in cima che in fondo (questo può essere piuttosto importante per i file .php) e si salvi il file con il nome appropriato nella cartella del plugin. Se l'autore ha indicato che un file necessita di trovarsi in una sotto cartella, si crei questa sotto cartella prima di salvare il file.
3. Dopo che tutti i file sono stati creati, si usi il proprio caricatore di file (ad esempio FTP o il File Manager dal pannello di controllo), si navighi sul server nella cartella di DokuWiki lib/plugins e si carichi la cartella del plugin appena creata (sul proprio computer) insieme con tutto il suo contenuto. Il risultato finale deve essere una nuova cartella sul server, lib/plugins/<nome-nuovo-plugin>, che contiene i file e le cartelle del plugin.

Il plugin ora è installato

Se il plugin sembra non funzionare, si controllino le FAQ on plugin problems.