Les pages web JMRI et les écrans d'aide sont écrits dans un sous-ensemble simple de HTML. La langue qui alimente le web. La partie la plus importante du contenu est le texte brut que les gens lisent, et les informations de formatage supplémentaires sont gardées au minimum. Pour mettre à jour une page Web JMRI, vous modifiez celle-ci directement sur GitHub sur le web ou sur votre ordinateur avec un éditeur de texte brut.
Utilisation de MS Word ou Front Page pour éditer ces documents .shtml n'est pas une bonne idée car ils ajouteront probablement leurs propres codes de formatage ce qui va gâcher les choses, peut-être même au point d'être inutilisable par JMRI. En outre, ne renommer pas les fichiers, ou apporter des modifications à l'information de formatage en haut ou en bas. Ainsi vous pouvez vous concentrer sur les changements de texte dans le corps principal du fichier, ce qui est vraiment ce que à quoi les lecteurs doivent accorder une attention toute particulière.
Pour commencer, vous pouvez naviguer à l'intérieur du dossier du manuel DecoderPro et des fichiers de programme JMRI de
votre ordinateur.
Sur un système Windows, l'emplacement de ce dossier
ressemble à ceci - C: \ProgramFiles\JMRI\help\fr\manuel
.
Dans ce dossier il y a un fichier appelé index.shtml
. Ouvrez ce fichier avec
un éditeur de texte
et regarder autour. Si vous modifiez quelque chose, vous pouvez alors
ouvrir la page dans le système d'aide JMRI et voir à quoi elle ressemble
(soit conserver une sauvegarde au cas où vous
souhaitez revenir à la page originale ,
ou vous pouvez réinstaller JMRI pour le restaurer)
Les changements les plus simples sont justes dans le texte lui-même. Pour ajouter une phrase ou corriger un libellé, vous pouvez le faire avec l'éditeur. Pour ajouter une pause entre les paragraphes, par exemple, pour ajouter un nouveau paragraphe, vous insérez une "balise" qui indique au navigateur JMRI où insérer une rupture de paragraphe: <p>.
<Alt>
et la clé <Impr écran>
en même
temps. (Note: En fonction de votre clavier, vous pourriez avoir besoin d'appuyer sur le
<Fn>
ou <Function-Lock>
clé.) Ceci
met l'image sur votre "presse-papiers" et vous pouvez la coller dans un
programme d'édition d'image comme Paint de Windows ou Photoshop.
Si vous comprenez cela, vous êtes prêt à nous aider à mettre à jour de nombreux documents JMRI que nous utilisons à la fois pour le site JMRI et pour les fichiers d'aide dans le logiciel de la prochaine génération.
Lorsque vous envoyez vos modifications pour qu'elles soient incluses dans les versions JMRI à venir, elles sont soumises à une vérification rapide et ensuite fusionnées avec le contenu précédent. La vérification est effectuée en utilisant les outils GitHub pour trouver les pièces des fichier qui ont été modifiées.
Le type de fichier correct à utiliser pour JMRI a l'extension. shtml. Si vous avez fait un .html ou .htm, vous pouvez changer l'extension de vous-même en .shtml. Ne pas utiliser d'espaces ou de majuscules dans vos noms de fichiers. Si vous ne changez pas ou n'ajouter pas d'images, il suffit de sauvegarder le fichier avec son nom d'origine, exemple: <index.shtml>, dans un emplacement où vous pouvez le trouver facilement quand vous êtes prêt à le copier sur GitHub.
Vous pouvez voir le répertoire JMRI actuel sur GitHub. Pour apprendre comment faire des changements et se connecter à GitHub, SVP Lire Utilisation de Git.