|||
-|-|-|
| Aperçu | DiscoTOC vous permet de créer une liste de contenu pour votre sujet en un clic.
| : eyeglasses: | Prévisualisation | Beginner's guide to using Discourse Themes (Veuillez visiter le lien dans un nouvel onglet) |
| Lien du dépôt | https://github.com/discourse/DiscoTOC
| Pas familier avec les thèmes Discourse ? | Veuillez visiter la page Web officielle concernant le Guide pour débutants sur l’utilisation des thèmes Discourse.
Exemple
Bureau
Mobile
Caractéristiques
toc = table des matières
- Créez une liste toc en un clic via le bouton de réglage au-dessus du menu, en fonction de l’état du contenu actuel.
- La table des matières sera toujours affichée sur la page - le défilement du contenu et les liens du sujet sont synchronisés.
- Lorsque vous faites défiler le sujet dans la page actuelle, la liste de contenu correspondante sera affichée en surbrillance (affichée en vert).
- Ajoutez des attributs aux titres (vous pouvez lier à un contenu spécifique à partir d’autres sujets/messages).
- En cliquant sur le lien du sujet de la table des matières, le navigateur naviguera jusqu’à la position correspondante dans le contenu principal (défilement synchronisé).
- Ajoutez un lien copiable pour chaque titre (bien sûr, si vous le souhaitez).
- Prise en charge RTL.
- Le schéma de couleurs est basé sur le schéma de couleurs que vous utilisez actuellement.
Comment ça marche
Par défaut, le titre du contenu actuel sera marqué comme toc (via le bouton compositeur pour effectuer l’opération ci-dessus), et si votre sujet actuel est marqué, il sera également converti en toc (cela dépend du niveau du titre actuel), tous les titres de contenu seront convertis en TOC - cela signifie que le réglage de votre titre de fichier MD doit être correct, si le niveau de votre réglage de titre est erroné, le résultat de la conversion sera également erroné.
# heading 1
## heading 2
### heading 3
#### heading 4
##### heading 5
###### heading 6
Vous pouvez ajuster le niveau comme vous le souhaitez, mais vous devez assurer l’exactitude du niveau.
# heading 2
## heading 3
## heading 3
### heading 4
## heading 3
# heading 2
etc...
Pour que les liens fonctionnent, tous les titres doivent avoir un attribut Id.
Ce composant vérifiera automatiquement l’Id du titre. Si le titre existe, le composant pourra fonctionner plus efficacement. L’Id est également plus utile lorsque vous créez manuellement des sujets.
Si votre titre n’a pas d’Id, ce composant créera automatiquement un Id en fonction du contenu du titre (les caractères indésirables seront automatiquement ignorés).
Une fois tout ce qui précède terminé, la TOC créera un lien vers le contenu principal en fonction du titre, comme indiqué ci-dessous :
Paramètres
Ce composant n’a qu’un seul réglage, qui est l’icône de la table des matières (cette image sera utilisée dans les réglages suivants, le fabricant ne recommande pas de modifier cette icône.)
Traduction et localisation
Ce composant nécessite très peu de traduction, seuls les 3 champs suivants doivent être traduits.
table_of_contents: "table of contents (liste de contenu)"
Ceci s’affichera lors de l’ouverture de la TOC sur mobile.
insert_table_of_contents: "Insert table of contents (Insérer la liste de contenu)"
Ceci s’affichera lorsque la liste de contenu sera insérée dans la page du sujet.
topic_will_contain_a_table_of_contents: "This topic will contain a table of contents (Ce sujet contiendra une liste de sujets)"
Ce contenu s’affichera dans la page de prévisualisation lors de l’édition du contenu du sujet, dans la prévisualisation à droite.
Comment créer un titre
- Les titres du contenu doivent être créés avec la syntaxe correcte lors de la création.
- Cliquez sur l’option de menu dans la page (cela ne s’affiche que pour les sujets et les messages réguliers, cette option ne s’affichera pas si vous répondez ou envoyez un message privé).
- Insérez dans la page du sujet.
Que se passe-t-il avec le widget de progression de lecture lorsque nous utilisons la TOC ?
Vous savez peut-être qu’il est impossible d’afficher simultanément la progression de lecture et la TOC sur la page.
La solution officielle est que si la TOC existe lors de la lecture du premier message, seule la TOC sera affichée sur la page, et le widget de progression de lecture sera ignoré et non affiché.
Lorsque votre lecture dépasse le premier message, la TOC ne sera pas affichée, et à la place, une barre de progression de lecture de tout le contenu sera affichée.
En bref, la TOC n’est valable que pour le premier message, les messages suivants utiliseront la barre de progression de lecture.
L’affichage pour mobile et bureau est le même.
Quels sont les problèmes lors de l’utilisation de ce composant ?
Selon les auteurs et le fabricant, aucun problème n’a été rencontré lors de l’utilisation de ce composant.
Tout le rendu du contenu est effectué côté client, en termes techniques, tout le contenu est effectué côté client, donc la fourniture de données côté serveur n’est pas affectée.
Lorsque vous désactivez ce composant, tout le contenu reviendra à son état d’origine.
Limitations d’utilisation
Ce composant utilise la mise en page standard du thème.
Si votre mise en page a modifié l’utilisation des titres, ce composant TOC ne fonctionnera pas correctement.
Par exemple, il est connu que ce composant ne fonctionne pas correctement avec le thème Vincent.
Le support pour certains thèmes très populaires sera la prochaine considération et le retour pour ce plugin officiel.
Développeur
L’auteur officiel est basé sur la bibliothèque tocify.js de Greg Franko.
Cependant, malheureusement, cette bibliothèque n’a pas été mise à jour depuis longtemps, l’auteur a donc supprimé de nombreux contenus inutiles, des fonctionnalités et du code inutiles de cette bibliothèque et a intégré les fonctionnalités associées dans Discourse.
La taille totale du composant est d’environ ~ 4 Ko (avec compression gzip).
L’auteur remercie également @erlend_sh pour ses excellentes suggestions et @david pour son aide à la traduction.
À améliorer (TODO)
- Affichage en temps réel de la TOC lors de l’édition (cela pourrait consommer beaucoup de ressources)
- Prise en charge de certains thèmes grand public pour afficher la TOC
- Copier automatiquement le lien du titre dans le presse-papiers en cliquant sur le bouton du lien du titre.
Concernant la sortie de cette version, l’auteur déclare : cette sortie est une version très précoce, si vous avez des questions ou des suggestions d’amélioration pour ce composant, n’hésitez pas à contacter directement l’auteur original.
Pour les instructions officielles, les liens et les discussions concernant ce composant, veuillez vous référer à la page : DiscoTOC - automatic table of contents.
Aide technique (chinois)
Si vous avez d’autres questions ou besoin d’aide, veuillez visiter notre site Web (chinois) : iSharkFly - 飞鲨