Description

Need Help? vous permet de donner à vos utilisateurs un accès simplifié aux rubriques d'aide que vous créerez.

Vous pourrez par exemple documenter les commandes de votre chan, vous créer une aide pour l'utilisation des commandes tcl, des aide-mémoire pour vos cours, des résultats sportifs, ou que sais-je encore ?
Les usages possibles sont infinis.

Reportez-vous à la liste des fonctionnalités et à la syntaxe ci-dessous pour des informations plus détaillées.



Fonctionnalités

• Support multilingue (packs de langue français et anglais fournis).
• Fonctionnement intuitif, aide contextuelle sur les commandes du script.
• Messages d'aide multi-lignes / paragraphes.
• Possibilité de définir un message d'aide générique qui s'affichera en tapant la commande d'aide sans arguments.
• Vous pouvez associer un déclencheur à un sujet d'aide (par exemple !admin peut être associé au sujet "liste des administrateurs" pour en afficher le contenu.
• Possibilité de créer des alias (sujets d'aide renvoyant vers le contenu d'un autre).
• Possibilité d'effectuer une recherche ou d'en filtrer les résultats en utilisant des jokers (fonctionnalité disponible en mode consultation et avec les sous-commandes -list -triggerlist et -triggerinfo).
• Lorsqu'un sujet d'aide n'est pas trouvé, suggère des sujets proches (phonétiquement, orthographiquement, mots communs, mots/lettres dans un ordre différent).
• Commande d'aide disponible en public, message privé et partyline (hors déclencheurs).
• Possibilité de définir des sujets globaux (disponibles sur tous les chans) ou locaux (disponibles sur un seul).
• Les sujets d'aide peuvent comporter des espaces ou des caractères spéciaux.
• Fonctionne aussi lorsque la commande est tapée en couleur, gras, etc...
• Filtrage automatique (ou optionnel) des codes de style si le mode +c est détecté sur un chan ou sur le flag +h est défini sur un handle.
• antiflood (ne concerne pas les administrateurs)
• Création quotidienne d'une copie de sauvegarde de la base de données.
• Nombreuses commandes d'administration pour une gestion simplifiée.
  

Syntaxe et documentation des sous-commandes

Pour activer Need Help? sur un chan, vous devez taper ceci en partyline de l'Eggdrop :

et ceci pour le désactiver :

Attention aux majuscules !


!aide -add [-noLF] [-global/#chan] <sujet> <contenu>
Crée un nouveau sujet d'aide ou ajoute du contenu à un sujet existant.
Si le sujet contient des espaces, utilisez des guillemets.
Le paramètre -noLF permet d'ajouter du texte supplémentaire à la suite d'une aide existante sans marquer de saut de ligne.
Utilisez [_SPACE_] si vous avez besoin d'espaces insécables dans le contenu.
Pour définir un message d'aide générique qui s'affichera en tapant !aide sans arguments, utilisez helpmsg comme nom de sujet.
Si le paramètre -global est spécifié, le sujet sera disponible depuis n'importe quel chan.

!aide -del(ete) [-global/#chan] <sujet>
Supprime un sujet d'aide.

!aide -ren(ame) [-global/#chan] <ancien sujet> <nouveau sujet>
Renomme un sujet d'aide.
Si un sujet contient des espaces, utilisez des guillemets.

!aide -repl(ace) [-global/#chan] <sujet> <nouveau contenu>
Remplace le contenu d'un sujet d'aide par un nouveau contenu.
Si le sujet contient des espaces, utilisez des guillemets.
Utilisez [_SPACE_] si vous avez besoin d'espaces insécables dans le contenu.

!aide -copy [-global/#chan] <sujet source> <sujet destination>
Copie le contenu d'un sujet d'aide vers un autre.
Si un sujet contient des espaces, utilisez des guillemets.

!aide -alias [-global/#chan] <sujet source> <sujet lié>
Crée un alias qui renverra au sujet d'aide source.
Si un sujet contient des espaces, utilisez des guillemets.

!aide -list [-global/#chan] [filtre]
Affiche une liste de tous les sujets d'aide.
Vous pouvez spécifier un filtre de recherche en utilisant des jokers (*).
Si aucun emplacement n'est spécifié, la liste les inclura tous.
Les alias sont suivis par le symbole "»" pour faciliter leur identification.

!aide -trig(ger) [-global/#chan] <sujet d'aide> [déclencheur]
Crée un déclencheur personnalisé qui affichera le sujet d'aide spécifié.
Cette sous-commande ne peut être utilisée que depuis un chan.
Ce déclencheur ne fonctionnera que sur le chan sur lequel il a été défini.
Si le paramètre déclencheur est omis, affiche le déclencheur actuel.
Si le sujet contient des espaces, utilisez des guillemets.

!aide -deltrig(ger) [-global/#chan] <sujet d'aide> <déclencheur>
Supprime un déclencheur associé à un sujet d'aide.
Cette sous-commande ne peut être utilisée que depuis un chan.

!aide -trig(ger)info <déclencheur ou filtre>
Affiche des informations concernant le déclencheur spécifié.
Vous pouvez effectuer une recherche en utilisant des jokers (*).
Veuillez noter que si la commande est utilisée depuis un chan, la recherche ne s'effectuera que sur celui-ci, tandis que la commande privée ou en partyline effectuera une recherche dans tous les emplacements.

!aide -trig(ger)list [-global/#chan] [filtre]
Affiche une liste de tous les déclencheurs.
Vous pouvez spécifier un filtre de recherche en utilisant des jokers (*).
Si aucun emplacement n'est spécifié, la liste les inclura tous.

!aide -addtag [-global/#chan] <tag> <sujet> [sujet2] [...]
Ajoute un tag à un ou plusieurs sujets d'aide.
Un sujet d'aide peut avoir plusieurs tags.
Si un sujet d'aide contient des espaces, mettez des guillemets autour.
Le tag ne peut contenir que des caractères alphanumériques, des tirets et des underscores.

!aide -deltag [-global/#chan] <tag> <sujet> [sujet2] [...]
Enlève un tag d'un ou plusieurs sujets d'aide.
Si un sujet d'aide contient des espaces, mettez des guillemets autour.

!aide -taglist
Affiche une liste de tous les tags existants.

!aide -taginfo <tag>
Affiche une liste des sujets d'aide associés au tag spécifié.

!aide -tags [-global/#chan] <sujet>
Affiche une liste des tags associés au sujet d'aide spécifié.

!aide -help <sous-commande>
Affiche de l'aide sur l'utilisation d'une sous-commande.
Les sous-commandes disponibles sont -add, -del(ete), -ren(ame), -repl(ace), -copy, -alias, -list, -trig(ger), -deltrig(ger), -trig(ger)info, -trig(ger)list, -addtag, -deltag, -taglist, -taginfo, -tags ou -help.

!aide <sujet>
Affiche de l'aide sur le sujet spécifié.

!aide <filtre>
Effectue une recherche dans les sujets d'aide disponibles en utilisant un ou plusieurs jokers. Exemple : !aide *quote*
Si vous effectuez une recherche depuis un chan sans préciser d'emplacement, elle se fera dans les sujets qui lui sont liés et dans les sujets globaux.
Si vous effectuez une recherche par message privé sans préciser d'emplacement, elle se fera dans les sujets globaux uniquement.
Si vous effectuez une recherche en partyline sans préciser d'emplacement, elle se fera dans tous les emplacements.

!aide
Affiche un message d'aide générique s'il a été défini, sinon affiche la syntaxe de la commande !aide
La syntaxe affichée est adaptée selon l'accès de celui qui tape la commande, ce qui fait qu'un administrateur verra la syntaxe spécifique aux administrateurs et un simple utilisateur verra la syntaxe destinée aux utilisateurs.

La commande !aide possède également son équivalent en partyline (.aide) et par message privé avec l'Eggdrop (aide)

Lorsque vous utilisez les sous-commandes d'administration, l'emplacement sur lequel l'opération s'est effectuée est indiqué au début de chaque message du script afin d'éviter les méprises.



Quelques exemples pour vous lancer...

<MenzAgitat> !aide -add "test 1" ceci est un test
<Eggdrop> [#testchan] Ajout d'aide pour le sujet test 1. Total : 1 ligne.

<MenzAgitat> !aide -add -noLF "test 1" [_SPACE_]et on écrit à la suite
<Eggdrop> [#testchan] Ajout d'aide pour le sujet test 1. Total : 1 ligne.

<MenzAgitat> !aide -add "test 1" et maintenant sur une nouvelle ligne
<Eggdrop> [#testchan] Ajout d'aide pour le sujet test 1. Total : 2 lignes.

<MenzAgitat> !aide test 1
<Eggdrop> ceci est un test et on écrit à la suite
<Eggdrop> et maintenant sur une nouvelle ligne


<MenzAgitat> !aide -trigger "test 1" !test
<Eggdrop> [#testchan] Le déclencheur !test a été associé au sujet test 1.

<MenzAgitat> !test
<Eggdrop> ceci est un test et on écrit à la suite
<Eggdrop> et maintenant sur une nouvelle ligne


<MenzAgitat> !aide -add helpmsg Vous êtes perdu ? C'est par là --> http://www.ma-page-d-aide.com
<Eggdrop> [#testchan] Ajout d'informations dans l'aide générique. Total : 1 ligne.

<MenzAgitat> !aide -add helpmsg Pour avoir de l'aide sur une commande précise, tapez !aide [commande]
<Eggdrop> [#testchan] Ajout d'informations dans l'aide générique. Total : 2 lignes.

<MenzAgitat> !aide
<Eggdrop> Vous êtes perdu ? C'est par là --> http://www.ma-page-d-aide.com
<Eggdrop> Pour avoir de l'aide sur une commande précise, tapez !aide [commande]


<MenzAgitat> !aide -add !quote Syntaxe : !quote [#chan] | Affiche la citation dont vous avez spécifié le numéro.
<Eggdrop> [#testchan] Ajout d'aide pour le sujet "!quote". Total : 1 ligne.

<MenzAgitat> !aide -addtag citations !addquote !citations !delquote !findquote !lastquote !quote !quoteinfo !randquote !votequote
<Eggdrop> [#testchan] Le tag "citations" a été ajouté aux sujets d'aide suivants : !addquote / !citations / !delquote / !findquote / !lastquote / !quote / !quoteinfo / !randquote / !votequote

<MenzAgitat> !aide !quote
<Eggdrop> Syntaxe : !quote [#chan] | Affiche la citation dont tu as spécifié le numéro.
<Eggdrop> Voir aussi : !addquote | !citations | !delquote | !findquote | !lastquote | !quoteinfo | !randquote | !votequote

Changelog

v1.0

• 1ère version
  

v1.01

• Correction : le découpage des lignes trop longues en plusieurs parties ne fonctionnait pas lors de l'utilisation d'un trigger.
  

v1.1

• Modification : abandon de MenzAgitat's Soundex au profit de HaploPhone.
• Modification : le script Related Differential Report v1.2 est désormais requis si vous activez les suggestions.
• Modification : l'algorithme qui régit la proposition de suggestions a été majoritairement revu afin d'améliorer la pertinence des résultats.
• Ajout : nouveau paramètre de configuration public_help_display_mode.
• Quelques optimisations du code.
  

v2.0

• Correction : dans certaines circonstances, le contenu d'une base de données pouvait être perdu.
• Correction : les alias n'étaient pas supprimés automatiquement lors de la suppression du sujet lié.
• Correction : la recherche de sujet d'aide avec !aide n'affichait pas les alias.
• Correction : il n'est plus possible d'ajouter un sujet d'aide contenant le caractère "*" car sa consultation serait impossible en raison de l'interprétation de ce caractère comme joker.
• Correction : les emplacements analysés lors d'une recherche de sujet d'aide avec !aide n'étaient pas toujours appropriés.
• Correction : sur certains Eggdrops, les caractères unicodes / accentués pouvaient ne pas s'afficher correctement.
• Correction : la syntaxe affichée pour les versions msg et dcc de la commande "!aide -add" était incorrecte.
• Correction : la syntaxe affichée pour la version publique des commandes "!aide -del", "!aide -rename" et "!aide -replace" était incorrecte.
• Correction : les conditions pour que la syntaxe des commandes !aide -list et !aide -triggerlist n'étaient jamais remplies puisqu'elles acceptent l'absence d'arguments. Elle s'affiche maintenant si le nombre d'arguments est incorrect.
• Correction : le message d'erreur affiché si vous tentiez de supprimer un déclencheur d'un alias était incorrect.
• Modification : pour des raisons de souplesse, le paramètre "-noLF" n'ajoute désormais plus d'espace entre le texte existant et l'ajout.
• Modification : le symbole permettant de reconnaître les alias dans les résultats de la commande "!aide -list" a été remplacé par "»" pour une meilleure lisibilité.
• Modification : si vous choisissez "help" comme commande d'aide, la commande de partyline deviendra automatiquement .help! afin d'éviter d'entrer en conflit avec la commande .help native de l'Eggdrop.
• Modification : afin d'éviter les conflits et la confusion, il n'est désormais plus possible d'avoir un déclencheur portant le même nom qu'un sujet d'aide ou qu'un alias.
• Modification : les paramètres de configuration du script et le changelog se trouvent maintenant dans des fichiers séparés, situés dans le répertoire need_help par défaut.
• Ajout : nouvelle sous-commande -help permettant d'afficher de l'aide sur l'utilisation des sous-commandes.
• Ajout : il est maintenant possible d'attribuer des tags aux sujets d'aide et d'afficher des suggestions de sujets connexes.
  Les sous-commandes -addtag, -deltag, -taglist, -taginfo et -tags ont été ajoutées, ainsi que le paramètre de configuration show_related_topics.
• Ajout : vous pouvez maintenant utiliser [_SPACE_] dans le contenu d'un sujet d'aide lorsque vous avez besoin d'espaces insécables.
• Ajout : Need Help? utilise désormais des packs de langue pour l'affichage des messages du script.
  Des fichiers pour la langue française et la langue anglaise sont fournis.
  Un nouveau paramètre de configuration permettant de contrôler la langue a été ajouté.
• Ajout : un en-tête est maintenant ajouté aux bases de données afin de permettre d'en vérifier la version. Ces en-têtes comportent également un rappel de la structure des bases de données.
• Nombreuses optimisations du code.
  

v2.01

• Correction : erreur au démarrage du script en raison d'un c/c malencontreux.

Notes de mise à jour

Si vous mettez à jour le script depuis une version antérieure à la 2.0, veuillez noter que tous les fichiers annexes du script (documentation, bases de données, changelog, ...) se trouvent désormais dans le répertoire need_help (cf. changelog de la v2.0).
Si vous souhaitez conserver vos anciennes bases de données, veuillez les placer au bon endroit.

Téléchargement

Need Help? v2.01

Laissez vos commentaires / questions / suggestions / rapports de bugs ici.