Page 1 sur 1

Besoin d'aide dans la façon de rédiger un tutoriel

Posté : 11 sept. 2012, 18:11
par schim59
Bonjour,
J'essais de rédiger un tutoriel, car "Ce qui se conçoit bien s'énonce clairement", Mais j'ia un peu de mal à énoncer clairement...

Vous pouvez m'aider dans la façon de rédiger un tuto pour qu'il soit accessible ?

D'avance merci.

Pour le moment j'ai fait çà : http://ilovephp.dedicom.eu/?page_id=10 Et je suis plutot déçu.

Re: Besoin d'aide dans la façon de rédiger un tutoriel

Posté : 11 sept. 2012, 23:09
par moogli
b'soir,

j'ai même pas regardé le code, faut du texte, parle de ce que va expliquer.

Y a pas vraiment d'introduction, aucune explication du code que tu fournis c'est qu'il manque, le code doit servir d'appuis a ton dialogue et non l'inverse.

Par exemple
vous vous être toujours demandé comment afficher une image pendant le chargement de votre page ?
Afficher une petite image pour faire patienter les gens lors d'une requete ajax ?

Vous êtes au bon endroit !

Pré requis ?

Les base de php et javascript avec JQuery ($.post / $.get)
du courage :)

etc etc etc

tu n'es pas obligé d'être aussi verbeux que moi mais un peu quand même :)

Explique pas a pas ce que tu va expliquer et quand tu fournis du code décrit le ;)

regarde différent tuto, même si ce n'est pas du php, et compose ton style a partir de tous ce que tu verras (et évite ceux que tu trouve nul et incompréhensible :) )


@+

Re: Besoin d'aide dans la façon de rédiger un tutoriel

Posté : 12 sept. 2012, 11:08
par sirakawa
Plusieurs choses:
Afficher une image pendant l’exécution du script

Langage(s) : Html/Javascript(AJAX)/PHP(pour le script final)

Objectif : Afficher une image de transition avant l’exécution du script, pour marquer l’exécution de celui ci aux yeux du client.

Fonction(s) : $.post() et sleep()

Le fichier PHP à afficher .
1) L'objectif ne me semble pas d'une clarté éblouissante : du script (non généralisable) ou d'un script (généralisable).
2) Je mettrais la démo en premier.
3) Une explication du fonctionement de l'ensemble du genre:
on demande à l'utilisateur de taper son nom puis il clique.
L'ordinateur affiche une image pendant un temps (qui représente, je suppose, le temps nécessaire à exécuter une tâche)
Après ce délai, l'ordinateur masque l'image et renvoie un message tiré aléatoirement.
puis les fichiers en donnant leurs noms et en expliquant AVANT ce que chacun fait et en les présentant d'un seul tenant contrairement au premier et à waiter.php (quitte à rajouter du blanc ou des traits de commentaire dans le code pour mieux faire ressortir les parties:
[javascript]<!--- partie javascript-->
<script>
barratin jacvascrpt
</script>

<!--partie HTML-->
barratin[/javascript]


Dans l'ensemble les commentaires ne sont pas assez clairs pour un tutoriel. Je ferais un truc dans ce genre.
<!--Ce fichier comprend des fonction javascript et une partie HTML qui assure l'interface avec l'utilisateur-->
<!--Cette déclaration inclut  jquery.js qu' il faut se procurer à .....  et enregistrer à ... Il contient un ensemble de fonctions javascript prédéfines qui sont utilisées ici -->
<script type='text/javascript' src='jquery.js'></script>
<!-- Définition des fonctions originales créées pour cette applicatin-->
<script type='text/javascript'>
/** fonction w1()
	paramètres : aucun
	valeur de retour: rien
	rôle : acquérir la valeur du champ d'identificateur "nom" plus bas. Lancer le script waiter.php qui gère la 
	temporisation. Au retour de ce	script lancer la fonction processResult.
       remarque : pour que les champs input puissent être manipulés par javascript, il faut qu'ils aient un identificateur: id ="nom"... unique.
*/
function w1()
{
	//$("#nom") : c'est quoi?
         var nom=$("#nom").val();// la variable nom contient le texte saisi dans le champ input: 
	//lance la variable vers la page.php appelée waiter.php et demande d'exectuer processResult au retour.
       // fonction jquery, je suppose dont on devrait expliquer les paramètres utilisés
       //$.post(url à exécuter, {variables à utiliser}, fonction à exécuter au retour)
	$.post("http://ilovephp.dedicom.eu/wp-content/themes/twentyeleven/aps/gifchargement/waiter.php",{ 'nom': nom }, processResult);
}

Re: Besoin d'aide dans la façon de rédiger un tutoriel

Posté : 12 sept. 2012, 11:13
par schim59
Merci beaucoup.

Re: Besoin d'aide dans la façon de rédiger un tutoriel

Posté : 14 sept. 2012, 09:35
par schim59
J'ai décidé de commencer plus simple :

Avec les fonctions liées aux dates.

http://ilovephp.dedicom.eu/?page_id=80

Re: Besoin d'aide dans la façon de rédiger un tutoriel

Posté : 14 sept. 2012, 10:49
par Mazarini
Bonjour,

Dans le cas des dates, il me semble important d'expliquer qu'il y a 2 sortes de dates : les timestamp et les dates "normales" sous forme de string en évoquant les différents formatages de date suivant la langue. Surtout, expliquer que les calculs se font avec le format timestamp et la saisie et l'affichage avec le format string.

Puis parler du passage timestamp -> string et du passage string -> timestamp

Enfin parler des opérations sur les dates timestamp.

Re: Besoin d'aide dans la façon de rédiger un tutoriel

Posté : 14 sept. 2012, 11:34
par sirakawa
Bonjour,
Bonjour,

Dans le cas des dates, il me semble important d'expliquer qu'il y a 2 sortes de dates : les timestamp et les dates "normales" sous forme de string en évoquant les différents formatages de date suivant la langue. Surtout, expliquer que les calculs se font avec le format timestamp et la saisie et l'affichage avec le format string.

Puis parler du passage timestamp -> string et du passage string -> timestamp

Enfin parler des opérations sur les dates timestamp.
Absolument, ce qui pose problème à la vue du forum, ce sont les formats.
Plus
Un sujet rémanant, c’est pour cela que je le traite en premier : afficher une date correctement, travailler avec, lui ajouter ou lui retirer une intervalle.
Plus
Je ne suis pas sûr qu'il faille aborder le problème par les fonctions PHP. Il vaudrait mieux, je pense, traiter des cas:
Afficher correctement une date de table MYSQL avec PHP (occasion de parler d etimestamp et de format chaine)
Faire la réciproque
Créer un script qui supprime quelque chose après un temps donné (MAJ de table Mysql par ex.)

Re: Besoin d'aide dans la façon de rédiger un tutoriel

Posté : 17 sept. 2012, 07:57
par schim59
Pour dévelloper un cas pratique j'ai crée ce modèle de bdd :
http://ilovephp.dedicom.eu/?page_id=80

Ca vous semble adapté au projet ?

Pour travailler sur les dates / alertes / gestion d'agenda.

Encore merci pour vos précieux conseils.

Re: Besoin d'aide dans la façon de rédiger un tutoriel

Posté : 17 sept. 2012, 09:13
par Mazarini
Il me semble intéressant d'avoir toujours la date au format timestamp dans les variables PHP.

Ensuite on gère :
- les échanges pour l'affichage et la saisie
- les échanges pour la base de données en lecture et en écriture.
- les calculs PHP en timestamp

Dans les fonctions intéressantes, le calcul du dernier jour du mois.

Re: Besoin d'aide dans la façon de rédiger un tutoriel

Posté : 17 sept. 2012, 09:21
par sirakawa
Bjr,
On voit bien que le souci est de ne pas travailler dans le vide, du,genre de l'imbuvable foo/bar qui submerge trop ,de documentations:
la fonction foo(bar) rend la valeur bar quand on lui passe le paramètre foo.
L'exemple est bien conçu et peut être développé complètement.
Je trouve le schéma un peu compliqué, surtout si on s'adresse à un débutant qui ne connaît pas les formes normales, on en a la preuve assez souvent sur ce forum.
Mais en le présentant plus soigneusement et en le commentant, ça devrait aller:
du genre:
une liste d'amis dont chacun peut adhérer à un ou plusieurs loisirs et/ou participer à un ou plusieurs événements pour chacun de ces loisirs.
puis présenter le schéma en expliquant :
il y a des tables qui contiennent les "descriptions fixes" des loisirs, des amis, des événements:
amis, loisirs, events: dans chacune, il y a un champ unique l'identifiant (expliquer rapidement pk)
il y a des tables qui servent de lien entre les autres: t
adhesion : chaque ami a une ou plusieurs entrées dans cette table, identifiées par un numéro unique d'adhesion, et comportant l'identificateur de l'ami id (on symbolise par 1/* le fait que 1 ami peut avoir plusieurs adhésions.) et l'identificateur du loisir qu'il pratique id_l (on symbolise par */1 le fait qu'il peut y avoir plusieurs adhésions, de plusieurs amis différents, à 1 loisir (expliquer sk)

On veut pouvoir faire à partir de cette base de données :
créer un événement avec sa date
savoir les événements qui ont lieu à une date donnée
savoir les événements qui ont lieu avant/ après une date donnée
savoir les événements qui ont lieu dans une période donnée
: