Rédiger et organiser les articles

À quoi ça sert

L'administration du centre d'aide est l'écran où l'on écrit les guides et les articles que les utilisateurs consultent. On y crée une entrée, on lui donne un contenu, on la range sous une rubrique et on décide si elle est visible.

Deux points à connaître avant d'écrire :

• Les articles sont globaux. Ils ne sont rattachés à aucune organisation : un article publié est visible par tous les clients de Deltia dont le module Support est activé. Ce n'est pas l'endroit où documenter vos procédures internes.
• L'écran n'a pas d'entrée de menu, pas plus que le centre d'aide lui-même. On l'ouvre en saisissant son adresse, /support/aide/admin. Il est réservé aux administrateurs du module Support.

Concepts clés

• Entrée — l'objet que l'on crée ici. Selon qu'elle a un contenu ou non, elle se comporte comme un article ou comme une rubrique.
• Catégorie racine — une entrée sans guide parent. Elle apparaît au premier niveau du menu du centre d'aide.
• Guide parent — l'entrée sous laquelle celle-ci est rangée dans le menu.
• Slug — la suite de mots qui identifie l'article dans son adresse. « Phrase courte, sans espace, utilisée dans l'URL, pour identifier l'article du support ».
• Statut — « Brouillon », « Publié » ou « Archivé ». Seul « Publié » rend l'entrée visible dans le centre d'aide.
• Ordre — le nombre qui décide de la position de l'entrée parmi celles de son niveau, du plus petit au plus grand.
• Extrait — la phrase de résumé affichée sous le titre, dans l'article et sur l'accueil du centre d'aide.
• Section — un bloc titré ajouté à la suite du contenu principal. Chaque section a une ancre, qui « permet de créer un lien direct vers une partie précise de l'article du support ».

Comment faire

Ouvrir l'administration des articles

1. Dans la barre d'adresse de votre navigateur, ajoutez /support/aide/admin à l'adresse de votre Deltia.

La page « Gestion des articles du Support » s'affiche, avec la « Liste des articles » et le nombre d'entrées à côté du titre. Tant qu'aucune entrée n'existe, la page affiche « Aucun article trouvé. » et « Commencez par ajouter votre premier article. »

Créer un article

1. Cliquez sur « Ajouter un article ».
2. Renseignez le « Titre ».
3. Renseignez le « Slug », en minuscules, chiffres et tirets.
4. Rédigez le « Contenu » dans l'éditeur. La mise en forme, les listes et les liens y sont disponibles.
5. Renseignez l'« Extrait » si vous en voulez un.
6. Choisissez le « Statut » : « Publié » pour que l'article paraisse dans le centre d'aide, « Brouillon » ou « Archivé » pour qu'il n'y paraisse pas.
7. Renseignez l'« Ordre ».
8. Dans « Guide parent (optionnel) », choisissez la rubrique sous laquelle ranger l'article, ou laissez « Aucun parent (racine) ».
9. Cliquez sur « Créer ».

Le message « L'entrée a été créée » confirme la création et vous revenez à la liste. Si l'enregistrement échoue : « Impossible de créer l'entrée ».

Le formulaire ne se rouvre pas depuis la liste : le statut et le contenu retenus à la création sont ceux qui restent en ligne.

Créer une rubrique

1. Créez une entrée comme ci-dessus, mais laissez le « Contenu » vide.
2. Créez ensuite les articles qu'elle contiendra, en la choisissant comme « Guide parent ».

Dans le centre d'aide, une entrée sans contenu et avec des articles sous elle n'est pas cliquable : elle déplie et replie sa liste. Une entrée sans contenu et sans article dessous, elle, mène à une page « Article non trouvé » : publiez la rubrique seulement une fois qu'elle contient quelque chose.

Ajouter des sections à un article

1. Dans le formulaire, descendez jusqu'à « Sections ».
2. Cliquez sur « Ajouter une section ».
3. Renseignez le « Titre de la section » et son « Contenu de la section ».
4. Renseignez l'« Ancre de la section », par exemple section-1.
5. Répétez pour chaque section, puis enregistrez.

Les flèches en haut à droite de chaque section la déplacent vers le haut ou vers le bas ; la croix la supprime. L'ordre enregistré est celui de la liste au moment de l'enregistrement. Dans l'article, les sections s'affichent à la suite du contenu principal et alimentent le sommaire de droite.

Supprimer une entrée

1. Dans la liste, ouvrez le menu « Actions » au bout de la ligne.
2. Cliquez sur « Supprimer ».

La suppression est immédiate : aucune confirmation n'est demandée. Le message « Guide supprimé avec succès » s'affiche et la ligne disparaît de la liste. En cas d'échec : « Une erreur est survenue lors de la suppression ».

Retrouver une entrée dans la liste

1. Saisissez quelques lettres dans « Filtrer par titre... ».
2. Utilisez « Précédent » et « Suivant » pour changer de page.
3. Le bouton « Colonnes » masque ou réaffiche les colonnes du tableau.

Référence

Champs d'une entrée

Champs d'une section

Contrôles et messages

Une ancre laissée vide bloque également l'enregistrement : chaque section doit en porter une.

Colonnes de la liste

La liste montre toutes les entrées, quel que soit leur statut. Le centre d'aide, lui, n'affiche que les entrées publiées.

Accès

L'écran est réservé aux administrateurs du module Support. Un utilisateur qui a accès au module sans en être administrateur ne peut pas l'ouvrir. Voir Donner accès aux modules et aux groupes.

Questions fréquentes

Puis-je modifier un article existant ?

Pas depuis cet écran pour l'instant : l'entrée « Modifier » du menu d'une ligne mène à une adresse qui n'existe plus, comme l'entrée « Voir ». Seules la création et la suppression aboutissent depuis la liste.

Un article supprimé est-il récupérable ?

Il n'est plus visible ni dans la liste ni dans le centre d'aide, et l'application n'offre aucun moyen de le restaurer. Considérez la suppression comme définitive.

Qui voit les articles que j'écris ?

Tous les clients de Deltia dont le module Support est activé. Les articles ne sont pas cloisonnés par organisation.

Puis-je réorganiser le menu par glisser-déposer ?

Non. L'ordre se règle entrée par entrée, avec le champ « Ordre » et le « Guide parent ». Seules les sections d'un même article se déplacent avec des flèches.