|||
-|-|-|
| Riepilogo | Discourse Doc Categories offre la possibilità di mettere da parte determinate categorie per la documentazione, abilitando funzionalità aggiuntive per esse.
| Link al Repository | https://github.com/discourse/discourse-doc-categories
| Guida all’Installazione | Come installare plugin in Discourse
Nota che questo plugin è in fase di sviluppo attivo e non è ancora completamente terminato.
Funzionalità
Il plugin Discourse Doc Categories ti permette di ospitare documentazione strutturata su un forum Discourse esistente. Funziona mettendo da parte categorie specifiche per la documentazione e fornendo funzionalità per facilitare la ricerca di argomenti di documentazione specifici.
Puoi vederlo in azione nella categoria Documentation.
Quando si contrassegna una categoria come posizione per la documentazione, le seguenti funzionalità vengono abilitate per quella categoria:
- Un argomento specificato da utilizzare come indice per tutti gli argomenti di documentazione nella categoria
- Una nuova barra laterale per navigare tra i diversi argomenti della categoria, incluse funzioni integrate di filtro e ricerca
- Nuovi report per aiutarti a mantenere l’integrità degli argomenti indice
Inoltre, il plugin gestisce i reindirizzamenti per i siti che migrano dal plugin Docs ritirato. I link di documentazione di quel plugin reindirizzeranno ai loro URL di argomento esistenti, e c’è un’impostazione per reindirizzare la tua precedente homepage di documentazione alla tua categoria di documentazione principale.
Configurazione
Le impostazioni di configurazione sono disponibili su example.discourse.com/admin/site_settings/category/doc_categories. Qui troverai le seguenti impostazioni:
doc categories enabled: Seleziona per abilitare il plugin Doc Categories.doc categories docs legacy enabled: Seleziona questa opzione se hai migrato dal plugin Docs deprecato.doc categories homepage: Con l’impostazione precedente abilitata, la pagina di destinazione del plugin Docs deprecato reindirizzerà a questo URL.
Per specificare quali categorie verranno utilizzate per la documentazione, assegna loro un argomento indice. Per fare ciò, apri le impostazioni della categoria cliccando sull’icona 
nella pagina della categoria. Da lì, clicca sul link ‘Impostazioni’ e scorri verso il basso fino alla sezione ‘Modalità documentazione’. Usa il campo ‘Argomento indice’ per specificare l’argomento che verrà utilizzato per l’indice della categoria.
Argomenti indice
Gli argomenti indice per una categoria di documentazione servono a due scopi:
- Sono un elenco centrale di tutti gli argomenti inclusi nella categoria
- La barra laterale inclusa con questo plugin viene popolata dal contenuto dell’argomento indice
Formattazione degli argomenti indice
Gli argomenti indice possono includere qualsiasi contenuto desideri. Affinché la barra laterale funzioni correttamente, devono includere un elenco puntato (o più elenchi puntati) di argomenti di documentazione. Questi possono semplicemente essere gli URL degli argomenti in un elenco, nel qual caso la barra laterale mostrerà il titolo completo per ogni argomento di documentazione.
Avere il titolo completo nella barra laterale potrebbe non essere pratico se i tuoi titoli sono più lunghi di qualche parola, quindi per impostare titoli più brevi per un particolare argomento, precedi l’URL con un titolo abbreviato seguito da due punti (:). Tutto il testo prima dei due punti verrà mostrato nella barra laterale e si collegherà all’URL dell’argomento.
Puoi dividere il tuo argomento indice in sezioni e utilizzare più elenchi con intestazioni (di qualsiasi livello) sopra ciascuno di essi: verranno quindi visualizzati nella barra laterale in queste sezioni.
Ecco un esempio di argomento indice per iniziare:
Puoi iniziare con una descrizione opzionale e breve della categoria.
## Prima sezione
* https://discourse.example.com/t/topic-title/12
* https://discourse.example.com/t/another-topic-title/34
* Titolo breve: https://discourse.example.com/t/topic-with-a-long-title/56
* Un altro titolo: https://discourse.example.com/t/another-topic-with-a-long-title/78
## Seconda sezione
* Titolo argomento: https://discourse.example.com/t/documentation-topic/98
* https://discourse.example.com/t/new-topic/76
Quell’esempio produrrà una barra laterale di documentazione che assomiglia a questa:
Vedi l’indice Documentation > Site Management per un esempio di indice di categoria di documentazione in azione: https://meta.discourse.org/t/site-management-index/308032
Mantenimento degli argomenti indice
Sebbene gli argomenti indice non vengano aggiornati automaticamente man mano che i contenuti nella categoria vengono aggiunti, rimossi o modificati, il plugin include nuovi report che evidenziano le incongruenze all’interno degli argomenti indice.
-
Argomenti non indicizzati:
example.discourse.com/admin/reports/doc_categories_missing_topics
Questo report mostra tutti gli argomenti nelle categorie di documentazione che non sono stati aggiunti all’indice. -
Elementi estranei:
example.discourse.com/admin/reports/doc_categories_extraneous_items
Questo report mostra gli elementi inclusi nell’indice che sembrano non dover esserci. Il report indicherà il motivo per cui l’argomento è stato incluso nel report, ad esempio se è stato eliminato o se si trova in una categoria diversa da quella in cui è incluso l’argomento indice.
Informazioni aggiuntive
Aggiungere la stringa in:docs a un termine di ricerca cercherà in tutte le categorie contrassegnate per la documentazione (cioè, hanno un argomento indice assegnato).
Il numero massimo di elementi nell’indice è impostato dall’impostazione del sito Max oneboxes per post, che per impostazione predefinita è 50. Se hai bisogno di più di 50 elementi indice, aumenta il numero in quell’impostazione.
)
Stavo esplorando la possibilità di spostare la mia documentazione su 
