|||
-|-|-|
| Panoramica | DiscoTOC ti permette di creare una lista di contenuti per il tuo argomento con un clic.
| 
| Anteprima | Beginner's guide to using Discourse Themes (Si prega di accedere al link in una nuova scheda) |
| Link al repository | https://github.com/discourse/DiscoTOC
| Non hai familiarità con i temi di Discourse? | Si prega di visitare la pagina ufficiale per la Guida per principianti all’uso dei temi di Discourse
Esempio
Desktop
Mobile
Caratteristiche
toc = table of contents (indice)
- Crea una lista toc con un clic tramite il pulsante delle impostazioni sopra il menu, in base allo stato del contenuto corrente
- Il Toc sarà sempre visibile nella pagina: lo scorrimento del contenuto e i link all’argomento sono sincronizzati
- Quando scorri oltre l’argomento corrente nella pagina, l’indice corrispondente verrà visualizzato in evidenza (mostrato in verde)
- Aggiungi attributi ai titoli (puoi collegarti a contenuti specifici da altri argomenti/post)
- Cliccando sul link dell’argomento nel toc, il browser navigherà alla posizione corrispondente nel contenuto principale (scorrimento sincronizzato)
- Aggiungi un link copiabile per ogni titolo (naturalmente, se lo desideri)
- Supporto RTL
- Lo schema dei colori si basa sullo schema dei colori attualmente in uso
Come funziona
Per impostazione predefinita, i titoli del contenuto corrente verranno contrassegnati come toc (operazione eseguita tramite il pulsante del composer), e se il tuo tema corrente è contrassegnato, questo verrà anche convertito in toc (questo è correlato al livello del titolo corrente), tutti i titoli del contenuto verranno convertiti in TOC - ciò significa che le impostazioni del titolo del tuo file MD devono essere corrette, se il livello di impostazione del titolo è errato, anche il risultato della conversione sarà errato.
# heading 1
## heading 2
### heading 3
#### heading 4
##### heading 5
###### heading 6
Puoi regolare liberamente i livelli, ma devi assicurarti che i livelli siano corretti.
# heading 2
## heading 3
## heading 3
### heading 4
## heading 3
# heading 2
ecc...
Affinché i link funzionino correttamente, tutti i titoli devono avere un attributo Id.
Questo componente verificherà automaticamente l’Id del titolo; se il titolo esiste, il componente potrà funzionare in modo più efficace. Inoltre, l’Id è più utile quando crei manualmente gli argomenti.
Se il tuo titolo non ha un Id, questo componente creerà automaticamente un Id in base al contenuto del titolo (i caratteri non necessari verranno automaticamente ignorati).
Una volta completato quanto sopra, il TOC creerà un link al contenuto principale in base al titolo, come mostrato di seguito:
Impostazioni
Questo componente ha una sola impostazione, ovvero l’icona del Toc (questa immagine verrà utilizzata nelle impostazioni successive, l’autore sconsiglia di modificare questa icona).
Traduzione e localizzazione
Questo componente richiede pochissime traduzioni, solo i seguenti 3 campi devono essere tradotti.
table_of_contents: "table of contents (indice)"
Questo verrà visualizzato quando si apre il TOC sui dispositivi mobili
insert_table_of_contents: "Insert table of contents (inserisci indice)"
Questo verrà visualizzato quando l’indice viene inserito nella pagina dell’argomento.
topic_will_contain_a_table_of_contents: "This topic will contain a table of contents (questo argomento conterrà un indice)"
Questo contenuto verrà visualizzato nella pagina di anteprima quando si modifica il contenuto dell’argomento e si visualizza l’anteprima sulla destra.
Come creare un titolo
- I titoli del contenuto devono essere creati con la sintassi corretta al momento della creazione.
- Fare clic sull’opzione del menu nella pagina (questo viene visualizzato solo per argomenti e post regolari, questa opzione non verrà visualizzata se si risponde o si invia un messaggio privato).
- Inserisci nella pagina dell’argomento
Cosa succede al widget di progresso di lettura quando usiamo il Toc
Potresti sapere che non è possibile visualizzare contemporaneamente il progresso di lettura e il TOC sulla pagina.
La soluzione ufficiale è che se il TOC è presente durante la lettura del primo post, verrà visualizzato solo il TOC e il widget di progresso di lettura verrà ignorato e non visualizzato.
Quando superi il primo post, il TOC non verrà visualizzato e al suo posto verrà visualizzata una barra di avanzamento dell’intera lettura del contenuto.
In parole povere, il TOC è valido solo per il primo post, i post successivi utilizzeranno la barra di avanzamento della lettura.
La visualizzazione per dispositivi mobili e applicazioni desktop è la stessa.
Ci sono problemi nell’uso di questo componente
Secondo gli autori e l’ufficio, non ci sono stati problemi nell’uso di questo componente.
Tutta la visualizzazione del contenuto viene eseguita sul lato client, in gergo tecnico, tutto il contenuto viene eseguito sul frontend, quindi la fornitura di dati sul backend non è influenzata.
Quando disabiliti questo componente, tutto il contenuto tornerà al suo stato originale.
Limitazioni d’uso
Questo componente utilizza il layout del tema standard.
Se il layout che stai utilizzando ha modificato l’uso dei titoli, questo componente TOC non funzionerà correttamente.
Ad esempio, è noto che se si utilizza il tema Vincent, questo componente non funziona correttamente.
Il supporto per alcuni temi molto popolari sarà la prossima considerazione e inversione per questo plugin ufficiale.
Sviluppatore
L’autore ufficiale si basa sulla libreria tocify.js di Greg Franko per lo sviluppo.
Tuttavia, sfortunatamente, questa libreria non è stata aggiornata per molto tempo, quindi l’autore ha rimosso molti contenuti non necessari, funzionalità e codice non necessari da questa libreria e ha integrato le funzionalità correlate in Discourse.
La dimensione totale del componente è di circa ~ 4kb (con compressione gzip).
L’autore ringrazia anche @erlend_sh per molti ottimi suggerimenti e @david per aver aiutato con la traduzione.
Da migliorare (TODO)
- Visualizzazione TOC in tempo reale durante la modifica (questo potrebbe consumare molte risorse)
- Supporto per alcuni temi popolari per visualizzare il TOC
- Copia automatica negli appunti del link del titolo quando si fa clic sul pulsante del link.
Per quanto riguarda il rilascio di questa versione, l’autore afferma: questo è un rilascio piuttosto precoce, se hai domande o suggerimenti per questo componente, sei invitato a contattare direttamente l’autore originale.
Per le istruzioni ufficiali, i link e le discussioni su questo componente, fare riferimento a: DiscoTOC - automatic table of contents.
Aiuto tecnico (cinese)
Per qualsiasi altra domanda o necessità di aiuto, si prega di visitare il nostro sito web (cinese): iSharkFly - 飞鲨