Quick links: Content - sections - sub sections
EN FR
Quick Search Advanced search
 
Page

  [Opened] Précisions / amélioration tutoriel et documentation

Posted by Romain on 02/07/2007 12:09

Bonjour,

j'ai suivi avec succès le mini-tutoriel d'installation et de test de Jelix 1.0 beta 1. Voici ci-dessous quelques propositions de clarifications et d'améliorations :

  • l'installation est très facile si l'on dispose d'une console, mais existe-t-il une page PHP permettant de faire la même chose que jelix.php via un formulaire HTML ? Le manuel d'installation dit "Si vous comptez utiliser les scripts en ligne de commande ...", mais je n'ai pas encore lu d'explications permettant de faire la même chose autrement (par exemple pour ceux qui ne sont pas à l'aise avec une console) ;
  • en lançant le script jelix.php, j'ai obtenu le message d'erreur :
 Error: command is missing. See 'lib/jelix-scripts/jelix.php help'

et je me suis demandé pendant cinq minutes pourquoi il ne trouvait pas la commande jelix.php :o) c'est vrai que j'ai lu un peu trop rapidement et zappé la deuxième partie du message, mais il serait plus clair de copier les messages des commandes Unix disant :

 "jelix.php : missing command argument. Try 'lib/jelix-scripts/jelix.php help'"



Le mini-tutoriel n'est pas très clair pour les testeurs pressés :

  • au premier abord, j'ai l'impression que la commande 'export/set JELIX_APP_NAME=...' est obligatoire, alors qu'en regardant de plus près, on découvre l'option --nom_application : il serait plus clair de donner l'exemple équivalent à export/set puis de passer à la description de jelix.php ;
  • indiquer que l'on peut exécuter `php lib/jelix-scripts/jelix.php` ou `cd lib/jelix-scripts/jelix.php; php jelix.php` ;
  • le paragraphe "Implémentation d'une action" commence par la phrase "Ouvrez le fichier controllers/default.classic.php et modifiez ce contenu de cette manière :" ; or, ce fichier existe déjà tel quel et la phrase laisse entendre qu'il faut obtenir le résultat suivant (en fait, c'est la suite du texte qui va dire comment modifier le contenu de ce fichier). Mettre par exemple "Ouvrez le fichier controllers/default.classic.php, il contient l'objet suivant :".

Voila, ce sont des modifications assez légères, mais je pense qu'elles sont importantes en tant que blocages possibles pour tous les utilisateurs potentiels de Jelix qui commenceront certainement par ce mini-tutoriel. Des messages et instructions les plus clairs possibles leur donneront une meilleure impression, et les pousseront à aller plus loin.

Pour ma part, je vais continuer à tester Jelix qui m'a l'air plus convivial que Copix.

  [Opened] Re: Précisions / amélioration tutoriel et documentation

Reply #1 Posted by laurentj on 02/08/2007 14:52

l'installation est très facile si l'on dispose d'une console

euh, à ma connaissance, tout système a une console, y compris windows

existe-t-il une page PHP permettant de faire la même chose que jelix.php via un formulaire HTML ?

non, il n'y en a pas. Et je ne pense pas qu'il y en aura. de toute façon, j'ai du mal à comprendre l'intêret de ce genre de formulaire. Faire du développement via un formulaire web, c'est forcément limitatif.

Si tu penses au developpement d'une appli directement sur un compte chez un hebergeur, cela voudrait dire qu'il faille faire des tonnes de formulaires pour créer/modifier/supprimer tous les types de fichiers.

Selon moi, vaut mieux s'installer un serveur en local pour developper et utiliser un vrai editeur et la ligne de commande.

je n'ai pas encore lu d'explications permettant de faire la même chose autrement

L'autre façon est de créer les répertoires et fichiers "à la main", tout simplement. Ce qui est plus fastidieux, certes, mais pas du tout compliqué.

par exemple pour ceux qui ne sont pas à l'aise avec une console

suffit d'un peu de volonté pour s'y mettre ;-)

il serait plus clair de copier les messages des commandes Unix

Oui pourquoi pas. Créé un ticket sur http://dev.jelix.org .

Le mini-tutoriel n'est pas très clair

c'est un wiki. Si des choses te semble à eclaircir, n'hésite pas à t'y inscrire et cliquer sur le bouton "editer la page" ;-)

je vais continuer à tester Jelix qui m'a l'air plus convivial que Copix.

C'est effectivement l'un des objectifs de jelix ;-)

 
Page
  1. Précisions / amélioration tutoriel et documentation