Ce service web vous permet d'assister la rédaction d'un fichier .mktutrc pour l'utiliser ensuite dans Tutosuite. L'écriture d'un tel fichier n'est en soi pas très complexe, mais plutôt fastidieuse : il faut respecter une certaine syntaxe, faire attention aux échappements des apostrophes, etc. Tout ceci vous est évité avec mktutrc Editor qui s'occupe de formater correctement votre fichier. De plus, l'interface réalisée en Javascript vous permet une édition simple et intuitive de vos chapitres et autres paramètres.
Un fichier .mktutrc contient l'ensemble de la structure de votre tutoriel, qu'il soit big ou mini. Il contient entre autres le titre et surtout la composition des chapitres et sous-parties. Dans le cas d'un mini-tuto, il s'agit simplement de plusieurs sous-parties qui s'enchaînent sur une unique page. Dans le cas d'un big-tuto, il s'agit cette fois de plusieurs chapitres, regroupant chacun un ensemble de sous-parties ; un chapitre est en fait un mini-tuto, et un big-tuto est un collage de plusieurs minis-tutos.
Le fichier mktutrc ne contient pas le texte de votre tutoriel. C'est seulement un fichier qui sert de squellette au logiciel Tutosuite. Le contenu lui-même de votre tutoriel, les textes, doit être rédigé dans des fichiers à part. Pour plus d'informations, consultez la page dédiée à Tutosuite.
La rédaction d'un fichie mktutrc pour les minis-tutos n'a rien de compliqué.
Lorsque vous êtes sur le formulaire de rédaction, commencez par indiquer le titre de votre tutoriel. Attribuez-lui le pourcentage de progression avec la poignée movible rouge (ce pourcentage ne peut s'exprimer que de cinq en cinq). Il n'est actuellement pas possible de définir une icône pour votre tutoriel, car cette fonctionnalité n'est pas encore implémentée dans Tutosuite.
Le contenu du tutoriel étant écrit dans des fichiers à part, vous avez sûrement attribué à ces fichiers une extension spécifique de votre choix. Pour éviter de la rajouter à chaque champs, il est possible de la définir une bonne fois pour toutes dans le champs Extension des fichiers. Remarque : n'insérez pas de point, il est ajouté automatiquement.
Définissez le nom des fichiers d'introduction et de conclusion de votre tutoriel dans les champs suivants.
Lorsque tout ceci est fait, vous pouvez passer à la déclaration de vos différentes sous-parties. Pour cela,
remplissez les deux champs Titre et Fichier associé dans la partie Ajouter une sous-partie
et validez avec la touche ENTREE. La sous-partie s'ajoute dans la liste, vous pouvez dès lors
modifier l'ordre de vos sous-parties en effectuant un drag&drop avec l'icône en forme de croix,
éditer la partie avec l'icône du crayon ou supprimer la partie avec l'icône rouge.
Au final, choisissez un nom pour le fichier de sortie (c'est-à-dire le .tuto qui sera importé sur le Site du Zéro) avec l'extension de votre choix (même si .tuto est la plus courante).
Cliquez sur Générer le fichier : le contenu de votre fichier apparaît dans une zone de texte ; vous pouvez alors le copier/coller dans un fichier de votre ordinateur et en faire ce que bon vous semble.
Le paramètre facultatif Commande de préprocession est une commande shell qui sera ajoutée au fichier Makefile. À utiliser seulement si vous êtes initié.
La rédaction de fichiers mktutrc pour les bigs-tutos n'est pas encore disponible.