Créer des tours d'horizon - plaa/Modular GitHub Wiki
Les tours d'horizon sont un système d'aide interactif à l'intérieur d'OpenRocket. Ils sont conçu comme une suite de "diapositives", dans lesquels chaque diapositive a une image (typiquement une capture d’écran) et un texte explicatif court. Le texte explicatif peut être formaté en utilisant du HTML et également contenir des liens vers d'autres tours d'horizon.
Deux fichiers commun sont utilisés dans le chargement du tour d'horizon:
datafiles/tours/tours.txt contient une liste de tous les fichiers de tour d'horizon, un par ligne. Ils sont liés au répertoire du tour; par exemple "introduction/introduction.tour". Les lignes vides et les lignes commentées sont ignorées.
datafiles/tours/style.css est un fichier de style commun en CSS pour tous les tours d'horizon. Cela fourni une mise en forme plus évoluée du HTML, cependant la mise en forme doit être minimale.
Les tours d'horizons sont composés des fichiers listés dans le fichier tours.txt.
Typiquement un tour d'horizon aura son propre répertoire contenant ses fichiers de définition et ses images.
Le fichier de définition du tour d'horizon est un fichier texte encodé en UTF-8 au format suivant:
''# Dans le fichier, la première ligne non vide et sans commentaire est le titre - celui-ci ne peut pas contenir de HTML'' '''A sample tour''' ''# The lines before the first slide are the tour description'' <p>This is the tour description. <p>It can contain multiple paragraphs using a simple HTML syntax. ''# Slides are started by containing an image name withing brackets'' '''[slide1.png]''' <p>The description for the slide follows. It can contain HTML marking such as '''<b>bold</b>''', '''<i>italics</i>''', <sub>subscripts</sub> or <sup>superscripts</sup>. <p>Each paragraph within the slide should be started with an HTML paragraph element. ''# Next slide, please'' '''[slide2.jpg]''' <p>Slide images can be either PNG or JPG. <p>Slides '''<a href="another_tour">'''can even contain links'''</a>''' to other tours.
Les images sont chargées depuis le même répertoire que celui utilisé pour le fichier de finition du tour d'horizon.
Les tours d'horizon peuvent être internationalisés en créant une version traduite du fichier de définition du tour. Si le fichier de définition de base est "example.tour", la traduction en Allemand se trouvera dans "example_de.tour".
Si des captures d’écrans sont nécessaires dans le cadre de l'internationalisation, les captures d’écrans devraient être mis dans le répertoire du tour d'horizon, et la version internationalisée du fichier de définition doit rediriger vers ces fichiers images. (Les fichiers d'images internationalisés ne sont pas chargés automatiquement - le fichier de définition du tour doit explicitement pointer dessus.)
Pour plus de clarté les captures d'écrans internationalisées devraient être encore nommées de la même façon que le fichier de base avec le code langue approprié attaché ( ex: main_window.png -> main_window_de.png).
Les captures d’écrans ont souvent besoin d’être redimensionnés en fonction de la taille des fenêtres de dialogue et également pour réduire leur taille. Dans certains cas des modifications sont faites aux captures d'ecrans pour mettre en avant des détails (exemple).
Pour conserver la taille d'origine de l'image et pour plus facilement faire des modifications plus tard, l'image source peut être sauvegardée dans datafiles-src/, et automatiquement convertie dans la taille d'image correcte pour les diapositives. Le script datafiles-src/tours/convert-images.sh fait la conversion automatiquement (mais doit être lancé séparément). Il peut convertir les images aux formats PNG et JPEG (avec pour extension *.png et *.jpg) et les fichiers Gimp avec couches (dont les extensions sont *.xcf.gz).
Par exemple l'image datafiles-src/tours/introduction/main_window_top.xcf.gz est convertie automatiquement en datafiles/tours/introduction/main_window_top.jpg.
Les images qui ont pour taille à l'origine 50kB ou moins et qui n'ont pas de modifications significatives devraient être sauvegardées directement dans datafiles/ pour conserver la qualité de l'image.
Le moyen le plus simple pour tester les tours d'horizon pendant le développement est de récupérer le code sur SVN en utilisant Eclipse, d'ajouter les fichiers des tours d'horizon à l’endroit approprié et soit de lancer OpenRocket depuis Eclipse ou en utilisant le script run.sh. Ensuite sélectionnez Aide → Guided Tours. Rappelez vous d'ajouter le nouveau fichier de définition du tour dans tours.txt!
OpenRocket a besoin d’être redémarré chaque fois que des changements sont effectués aux fichiers de tour d'horizon.
Le fichier de définition du tour d'horizon pour une introduction à OpenRocket se trouve dans SVN: datafiles/tours/introduction/introduction.tour
Le répertoire complet avec les images est: datafiles/tours/introduction/
La liste de tous les tours d'horizon est au lien: datafiles/tours/tours.txt
Quelques idées pour les tours d'horizon:
- Introduction (FAIT)
- Créer un projet fusée simple
- Définir les moteurs
- Simuler un vol
- Options de tracé
- Options d'affichage de la fusée
- Rocket design analysis
- Optimisation automatique
- Créer un projet multiple étages
- Créer un projet en cluster