bonsoir,
Il y a t-il quelque-part une description de normes à respecter pour l'ecriture des doc squeak. par exemple : - utilisation du gras-italique-souligné - nommage des pages, - comment référencer une classe ou un mot clé dont on sait qu'un jour il y aura une page dédiée (euh... pas clair... par exemple : j'écris dans ma doc PluggableTextMorph, c'est le nom d'une classe et on peut espérer qu'un beau jour, il y aura une page de référence pour cette classe. J'utilise quoi ? [[PluggableTextMorph]] ou encore [[Classe-PluggableTextMorph|PluggableTextMorph]] ....) - comment doit-on présenter le code d'une méthode : PluggableTextMorph>>update: aSymbol ... ou update: aSymbol ... la première solution est plus explicite, la seconde permet le copier/coller. - comment nomme t-on un message (#update: ou update)
merci
alain
Le 11 mai 06 à 23:44, Alain Plantec a écrit :
bonsoir,
Il y a t-il quelque-part une description de normes à respecter pour l'ecriture des doc squeak. par exemple :
- utilisation du gras-italique-souligné
- nommage des pages,
- comment référencer une classe ou un mot clé dont on sait qu'un
jour il y aura une page dédiée (euh... pas clair... par exemple : j'écris dans ma doc PluggableTextMorph, c'est le nom d'une classe et on peut espérer qu'un beau jour, il y aura une page de référence pour cette classe. J'utilise quoi ? [[PluggableTextMorph]] ou encore [[Classe-PluggableTextMorph|PluggableTextMorph]] ....)
- comment doit-on présenter le code d'une méthode :
PluggableTextMorph>>update: aSymbol ... ou update: aSymbol ... la première solution est plus explicite, la seconde permet le copier/coller.
- comment nomme t-on un message (#update: ou update)
Les règles ne sont pas explicités clairement pour l'instant même si j'en utilise certaines pour les articles que j'ai mis en ligne. Je propose de mettre les règles ici : http://community.ofset.org/wiki/ Conventions_typographiques_pour_les_pages_Squeak et d'en discuter sur la page discussion associé.
-- oooo Dr. Serge Stinckwich OOOOOOOO Université de Caen>CNRS UMR 6072>GREYC>MAD OOESUGOO http://purl.org/net/SergeStinckwich oooooo Smalltalkers do: [:it | All with: Class, (And love: it)] \ / ##
On 11 mai 06, at 23:44, Alain Plantec wrote:
bonsoir,
Il y a t-il quelque-part une description de normes à respecter pour l'ecriture des doc squeak. par exemple :
- utilisation du gras-italique-souligné
- nommage des pages,
- comment référencer une classe ou un mot clé dont on sait qu'un
jour il y aura une page dédiée (euh... pas clair... par exemple : j'écris dans ma doc PluggableTextMorph, c'est le nom d'une classe et on peut espérer qu'un beau jour, il y aura une page de référence pour cette classe. J'utilise quoi ? [[PluggableTextMorph]] ou encore [[Classe-PluggableTextMorph|PluggableTextMorph]] ....)
- comment doit-on présenter le code d'une méthode :
PluggableTextMorph>>update: aSymbol
toujours PluggableTextMorph>>update: sinon le lecteur peut se perdre
... ou update: aSymbol ... la première solution est plus explicite, la seconde permet le copier/coller.
- comment nomme t-on un message (#update: ou update)
merci
alain
Squeak-fr mailing list Squeak-fr@lists.squeakfoundation.org http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/squeak-fr
Salut,
Le 12 mai 06, à 08:41, stéphane ducasse a écrit :
- comment doit-on présenter le code d'une méthode :
PluggableTextMorph>>update: aSymbol
toujours PluggableTextMorph>>update: sinon le lecteur peut se perdre
Note : Dans Squeak, l'expression suivante retourne la méthode en question (instance de CompiledMethod). PluggableTextMorph>>#update:
Je pense qu'il faut utiliser cette expression lorsqu'on référence une méthode dans un texte.
Par ailleurs, il nous faut une expression symétrique pour définir simplement une méthode dans Squeak qu'on utiliserait également pour donner les définitions de méthodes dans des articles.
Dans mon projet NewFileInOutFormat, j'ai introduit une nouvelle méthode dans le noyau Squeak pour faire cela : Il s'agit de <<.
Ainsi, je peux définir la méthode précédente comme suit :
PluggableTextMorph << #(update: aSymbol aSymbol ifNil: [^self]. aSymbol == #flash ifTrue: [^self flash]. ... "Reste du code de la méthode" )
Cela me semble pas mal. Mais, pour l'instant, mon implantation est simple. Je perd tout le formatage et les commentaires...
Pour ceux que cela intéresse, elle est dispo sur SqueakSource http://www.squeaksource.com/NewFileInOutFormat.html
Noury -------------------------------------------------------------- Dr. Noury Bouraqadi - Enseignant/Chercheur Ecole des Mines de Douai - Dept. G.I.P http://csl.ensm-douai.fr/noury
European Smalltalk Users Group Board http://www.esug.org
Squeak: an Open Source Smalltalk http://www.squeak.org --------------------------------------------------------------
On 11 mai 06, at 23:44, Alain Plantec wrote:
bonsoir,
Il y a t-il quelque-part une description de normes à respecter pour l'ecriture des doc squeak. par exemple :
- utilisation du gras-italique-souligné
- nommage des pages,
- comment référencer une classe ou un mot clé dont on sait qu'un
jour il y aura une page dédiée (euh... pas clair... par exemple : j'écris dans ma doc PluggableTextMorph, c'est le nom d'une classe et on peut espérer qu'un beau jour, il y aura une page de référence pour cette classe. J'utilise quoi ? [[PluggableTextMorph]] ou encore [[Classe-PluggableTextMorph|PluggableTextMorph]] ....)
- comment doit-on présenter le code d'une méthode :
PluggableTextMorph>>update: aSymbol
toujours PluggableTextMorph>>update: sinon le lecteur peut se perdre
... ou update: aSymbol ... la première solution est plus explicite, la seconde permet le copier/coller.
- comment nomme t-on un message (#update: ou update)
merci
alain
Squeak-fr mailing list Squeak-fr@lists.squeakfoundation.org http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/squeak-fr
squeak-fr@lists.squeakfoundation.org
-
Alain Plantec -
Noury Bouraqadi -
Serge Stinckwich -
stéphane ducasse