Vos Tutos Offline

Vos Tutos Offline est un logiciel multiplateforme développé par l'équipe du Site du Zéro pour vous permettre de rédiger vos tutos... offline c'est à dire sans passer par le site Internet. Son interface est intuitive et ses fonctionnalités vous seront détaillées plus bas. Vous ne serez pas perdus car l'interface reprend le concept de la zform que l'on retrouve partout sur ce site.

Vos Tutos Offline (VTO) a été réalisé en Java (langage de programmation) pour permettre une portabilité immédiate afin de ne privilégier aucune système d'exploitation et de permettre au plus grand nombre d'entre vous de l'utiliser. Il est donc nécessaire d'avoir installé la machine virtuelle Java sur votre ordinateur (car Java est un langage semi-interprété). Si vous pensez ne pas avoir Java sur votre ordinateur, il est donc temps de le télécharger sans quoi VTO ne marchera pas.

Nous vous rappelons que VTO n'est pas un logiciel commercial ni professionnel et qu'il n'est là que pour vous faciliter la rédaction de vos tutos. Soyez donc indulgents s'il ne correspond pas tout à fait à vos attentes et sachez formuler des demandes soignées sur les forums si vous avez des idées que vous pensez intéressantes pour une version future.

Prêt à tenter l'expérience VTO ? C'est parti !

• Téléchargement
• Interface
• Interaction avec le site
• Images
• Designs
• F.A.Q

Téléchargement

• Pour les utilisateurs de Linux : VTO requiert GTK et Mozilla (ou Mozilla Firefox). Vérifiez et/ou modifiez le script launch_linux_gtk.sh pour que la variable MOZILLA_FIVE_HOME pointe bien vers votre installation de Mozilla ou Firefox. Généralement il s'agit de /usr/lib/mozilla-firefox/, /usr/lib/firefox/, ou encore /usr/lib/mozilla/.

• Pour les systèmes particuliers (OS non listé, Linux 64 bits), vous pouvez télécharger SWT sur le site d'Eclipse et adapter le script de lancement de l'application (voir launch_linux_gtk.sh dans VosTutosOffline-Linux-GTK.tar.gz).

Interface

L'interface de VTO est assez simple, on distingue trois parties :

1. L'explorateur de Tuto : c'est une fonctionnalité propre à VTO. Elle vient représenter de façon logique la structure de votre tuto. Vous pouvez ainsi très facilement vous repérer dans les parties, chapitres, sous parties, etc. Son utilisation sera détaillée tout de suite après.
2. L'édition : reprise à l'identique de la zform du site avec :
   • Une barre de boutons
   • Le champ d'édition
   • La prévisualisation temps réel (que vous pouvez désactiver en décochant "Aperçu")
3. La visualisation : vous permet de visualiser votre tuto dans son intégralité (dans la cas d'un BigTuto, le sommaire ou le minituto courant est affiché (en fonction de ce qui est sélectionné dans l'explorateur).

L'explorateur

L'explorateur possède 4 boutons avec lesquels vous pouvez modifier la structure de votre tuto :

• Nouveau : c'est LE bouton important. Quand vous sélectionnez un élement de votre tuto, ce bouton permet de lui créer un enfant. Exemple : ici une partie est sélectionnée, cliquer sur nouveau créera donc un chapitre. Je vous renvoie vers le tuto de M@teo sur comment créer un tuto pour bien vous familiariser avec la structure d'un tuto.
  Si vous êtes en train d'éditer une sous-partie d'un minituto et que vous voulez en créer une nouvelle, il vous faudra d'abord cliquer sur le minituto puis sur nouveau pour respecter la logique "création d'enfants".
• Monter : pour monter l'élement sélectionné dans le tuto (relativement à son parent). Exemple : changer l'ordre d'une partie dans le bigtuto, d'un chapitre dans une partie, d'une souspartie dans un minituto, etc.
• Descendre : même chose que Monter mais... dans l'autre sens.
• Supprimer : supprime l'élement sélectionné

Correcteur d'orthographe

Pour vous aider dans la rédaction de vos tutos, Vos Tutos Offline intègre un correcteur d'orthographe. Il est disponible dans la barre d'icônes principale :

Son utilisation est très simple et similaire à ce que vous pouvez avoir déjà rencontré dans d'autres éditeurs de texte. La correction d'orthographe n'affecte que la sous-partie courante et ne recherche donc pas dans l'intégralité de votre tuto.

Le dictionnaire de mots initialement fourni ne contient peut-être pas les mots techniques que vous comptez utiliser dans vos tutos donc n'hésitez pas à lui rajouter des mots (en cliquant sur "ajouter au dictionnaire" quand un mot inconnu est détecté).

Interaction avec le site

Il faut bien garder en tête que le Site du Zéro est avant tout un site web et donc que Vos Tutos Offline ne vient communiquer avec lui qu'avec les mêmes moyens que vous pouvez utiliser manuellement : l'exportation/importation XML. Les fichiers permettant l'échange sont des fichiers XML portant l'extension .tuto (sous Windows le setup vous permet d'associer les .tuto à Vos Tutos Offline).

Exportation

Si vous avez déjà un tuto en ligne et que vous souhaitez continuer sa rédaction offline ou tout simplement en faire une sauvegarde par sécurité vous pouvez exporter un tuto lors de :

• L'édition d'un bigtuto :
  
  
• L'édition d'un minituto/chapitre :

Importation

De la même manière, les .tuto modifiés ou créés avec Vos Tutos Offline peuvent être utilisés pour importer votre tuto sur le site :

• A la racine de la section "Mes Tutos" :
  
  
• Lors de l'édition d'une partie :

Quel que soit l'endroit où vous décidez d'importer le tuto, vous devez ensuite sélectionner (avec le bouton "Parcourir") le .tuto que vous souhaitez envoyer. Pas besoin de copier/coller le texte xml dans le champ précédent, l'utilisation du fichier directement est bien plus pratique :

Si vous exportez un .tuto depuis le site et que vous le modifiez dans VTO, importer la nouvelle version du .tuto viendra modifier la version sur le site. Cependant si le fichier a été créé à partir de zéro sur VTO, cela viendra rajouter un tuto et en aucun cas modifier un de vos tutos existants.

Non. Le fichier .tuto ne contient que la version texte de votre tuto. Les images sont donc à envoyer manuellement après l'importation du tuto. Dans la section juste en dessous, vous trouverez la présentation d'un outil de VTO qui facilite cette étape. De même quand vous exportez un tuto, vous ne récupérez que la version texte.

Images

• Chemins : Lorsque vous utilisez des images dans votre tuto, les chemins sont relatifs au fichier .tuto de votre tuto. Si on considère par exemple l'arborescence suivante de mon tuto :
  
  Pour insérer l'image "vs.jpg" il me suffit d'utiliser dans mon tuto : Code : Zcode
  <image>vs.jpg</image>
• Lister les images : Une fois le tuto uploadé sur le Site du Zéro via le fichier .tuto, il faut aussi uploader manuellement les images. Pour faciliter cette tâche vous pouvez utiliser la fonctionnalité , pour retrouver plus facilement dans quelles parties uploader quelles images. Pour mon tuto bidon cela me donne :
  
  Il vous faudra remplacer vous-même dans le texte les images par leur nouveau chemin sur le Site du Zéro.

Les designs du site dans Vos Tutos Offline

La partie d'édition de Vos Tutos Offline reproduit plus ou moins à l'identique la zform du site. Pour garder la diversité d'apparence du site, elle est personnalisable dans le menu Options > Changer de design... L'apparence choisie affecte à la fois les boutons de la zform et la visualisation (temps réel ou non) qui utilisera alors le design sélectionné pour donner un rendu proche de celui que vous auriez eu sur le site.

Voici par exemple la barre de boutons sur 2 designs différents : No-hell et Light Flight

Le rendu s'adapte aussi au design choisi :

Ajouter un nouveau design

Vous pouvez avoir envie d'utiliser un design non inclu à l'origine, comme les designs non compatibles IE. Ils n'ont pas été incorporés à la base pour mettre tout le monde sur un pied d'égalité. En effet sur Windows, Vos Tutos Offline utilise le moteur de rendu html d'Internet Explorer, certains designs ne rendraient donc pas bien chez tout le monde.

Ajouter un design existant sur le site

Il vous suffit de dézipper le zip du design de votre choix dans le repertoire de Vos Tutos Offline. En redémarrant le logiciel, vous serez alors en mesure de le choisir dans le menu Options > Changer de design...

Ajouter un design manuellement

Pour rajouter un nouveau design il suffit tout simplement de copier :

• Les css tels quels dans le repertoire [repertoire_de_vos_tutos_offline]/data/css/[numero_du_design]/
• Les images dans [repertoire_de_vos_tutos_offline]/data/images/designs/[numero_du_design]/
• Et de créer un fichier [numero_du_design].design dans [repertoire_de_vos_tutos_offline]/data/conf/ pour le paramétrer. Vous pouvez y spécifier :
  • le nom du design, grâce à l'attribut name
  • si nécessaire une couleur de fond spécifique pour la prévisualisation temps réel avec preview.r preview.g preview.b
  • si nécessaire une couleur de fond pour la zform en général avec zform.r zform.g zform.b
  Exemple pour le design 6 (Light Flight) : Code : data/conf/6.design
  name = Light Flight
  preview.r = 225
  preview.g = 251
  preview.b = 221
  zform.r = 225
  zform.g = 251
  zform.b = 221
  Lors de la visualisation du tuto, le bloc dans lequel est rendu le contenu du tuto peut nécessiter un ajustement CSS (de marge par exemple). Si on prend notamment le design SdZv1, à cause de la bordure orange sur la gauche, il faut décaler le contenu sur la droite. Pour ce faire on utilise, toujours dans le fichier [numero_du_design].design, la propriété custom_css qui permet de définir 1 ligne de CSS qui s'appliquera au contenu uniquement : Code : data/conf/9.design
  name = SdZv1
  custom_css = margin-left: 130px;

Se référer aux designs existants pour des exemples concrets.

F.A.Q

1. Question : J'avais vu des screens où c'était plus joli, chez moi les boutons sont trop normaux et moches.
   Réponse : Vos Tutos Offline utilise le look fourni par votre système. Si vous le trouvez moche, il serait temps de skinner un peu votre système et d'installer un thème graphique plus alléchant.

2. Question : Ca bug, y a pas la coloration syntaxique dans la prévisualisation !
   Réponse : La coloration syntaxique n'est à l'heure actuelle implémentée ni dans la prévisualisation temps réel ni dans la visualisation générale. Pour l'instant nous ne l'estimons pas indispensable et l'implémenterons si elle s'avère nécessaire.

3. Question : Je me suis amusé avec les fichiers de configuration du programme et il ne se lance plus.
   Réponse : La configuration normale est accessible via l'interface (design / langue / police de la zform). Le reste est visible pour les curieux qui se demandent comment un tel programme marche, mais surtout pour nous faciliter l'internationalisation et la création de nouvelles balises dans le zcode. Réinstalle donc une version propre et tout ira mieux.

4. Question : J'ai copié le design que j'utilise sur le site dans Vos Tutos Offline mais certains trucs sont mals rendus. J'ai pourtant Firefox sous Windows.
   Réponse : Sous Windows, Vos Tutos Offline utilise le moteur de rendu html d'Internet Explorer. Il est donc normal que certains designs non-compatibles IE donne des visualisations bizarres sous Vos Tutos Offline.

5. Question : Je suis sous Windows et ça me fait un son dès que j'appuie sur une touche quand je rédige mon tuto. C'est normal ?
   Réponse : Oui c'est parce que Windows joue par défaut un son dès qu'une fenêtre html est rafraichie (ici la prévisualisation temps réel). Il suffit de désactiver les sons Windows (tous ou juste celui en question) dans le panneau de configuration.

6. Question : C'est nul, pourquoi ça ajoute pas les images tout seul sur le site ?
   Réponse : Cette remarque ne concerne pas seulement Vos Tutos Offline mais bien une fonctionnalité du site pour l'instant inexistante. Nous réfléchirons dans le futur à une solution plus automatisée mais cela engendrerait de trop gros changements dans les scripts du site et pour l'instant cela n'est pas dans nos priorités. En attendant, reportez vous à la section images de cette page pour connaître la marche à suivre.

7. Question : On peut voir le code source ?
   Réponse : Pas pour l'instant. Après une certaine durée de vie (= plus de corrections à apporter), le code sera nettoyé pour être lisible et compréhensible et sera téléchargeable ici.

8. Question : Mouais, bof je préfère écrire mes tutos sur le site.
   Réponse : Bien sûr Vos Tutos Offline ne vient pas remplacer le site pour ce qui concerne la création de tutos. C'est un outil supplémentaire que nous vous fournissons et que vous n'êtes pas obligés d'utiliser.

Change your template | Learn more about NP | Site map | Terms of use | Rules | RSS feed | XHTML 1.0 | CSS 2.0
Powered by Simple IT SARL: Contact us

There is nothing else to read, you have to go up now !

Do you want to be published here? Contact us.

3 Newbies Connected | 2 Requests | 0.093s (0.0363s)