Het forum

Documentation

pour aider les nouveaux scripteurs

Auteur Antwoorden
Tutul Zondag 3 October 2010 om 21:06
Tutul
Moderator

J'ai remarqué que la documentation sur l'accueil n'est pas disponible. Comme on m'a dit que certaine commande était différente je me dis que cela devient urgent pour que de nouveaux scripteurs vous aident.

Ou il faudrait mettre un dictionnaire des commandes de POM pour les scripteurs car, lorsque je regarde ceratin script, je voit beaucoup de commande qui me sont inconnues et d'autre qui sont précédées de # afin de les rendre invisible. Dans le but de permettre à plus de scripteur d'apparaître et de mettre leurs scripts. Au plaisir d'avoir une réponse à cela.
;-)

Aangepast door Tutul


Gentils modérateur dans mes bon jours - Attention, à tenir hors de portée des enfants. En cas de contact, veuillez immédiatement rincer à l'eau clair. Peut provoquer des sueurs froide !
newikator Vrijdag 6 Mei 2011 om 14:05
newikator

Bonjour,

Je suis nouveau, et à vrai dire un peu noob sur POM.
Je souhaite apprendre a me servir de POM et il est vrai que la documentation
aurai été bien pour moi.

Savez vous ou je peut me documenter pour apprendre ?

Merci beaucoup

N

Newikator


Viens me défier en quelques clics !!
http://newikator.labrute.com
Tutul Vrijdag 6 Mei 2011 om 19:57
Tutul
Moderator

La documentation est principalement pour les scripteurs.
Si tu veux tu peux aller voir c'est lien la (c'est pour POL mais cela reste valable pour POM) :
-http://www.playonlinux.com/fr/page-1-Documentation.html
-http://www.playonlinux.com/en/page-19-PlayOnLinux_script_functions_reference.html
:sunglasses:
Pour d'autre info, demandes nous :sunglasses:

Aangepast door Tutul


Gentils modérateur dans mes bon jours - Attention, à tenir hors de portée des enfants. En cas de contact, veuillez immédiatement rincer à l'eau clair. Peut provoquer des sueurs froide !
newikator Dinsdag 10 Mei 2011 om 10:41
newikator

En faite, ayant tester d'abord quelques mois sur Linux, puis sur mac,
avec de nombreux logiciels, j'ai des millier de questions :/
(entre gestion de souris, les bugs de fenêtres, les polices, ...)
je pense que je vais d'abord lire tout ce qu'il y a sur ton lien, et on verra après.

Merci Tutul !

Newikator


Viens me défier en quelques clics !!
http://newikator.labrute.com
TonyFlow Maandag 20 Mei 2013 om 2:41
TonyFlow

Bonjour à tous et avant tout, merci à tous ceux qui contribuent à ce projet.

Après avoir eu le plaisir d'installer quelques jeux facilement et proprement grace aux scripts disponibles, voici venu le temps pour moi de mettre les mains dedans ! Je suis donc allé sur le site à la recherche d'infos, suite à ma quête, voici mes remarques...

  • Sur la page d'accueil, je vais voir à "J'aimerais aider le projet PlayOnLinux". Je lis "Proposer vos scripts d'installation" mais malheureusement aucun lien pour aller plus loin (dommage c'était mon 1er réflexe, c'est frustrant :p)
  • Bon okay je vais de moi-même voir dans la partie "Documentation" et trouve avec joie la documentation du scripteur. Je parcours le tuto rapidement, j'apprécie au passage le chapitre 8 qui me donne un exemple concret, en attendant d'aller voir la doc de références de toutes ses commandes que j'ai vu passer...
  • Je tombe alors sur l'annexe (http://www.playonlinux.com/fr/dev-documentation-11.html) à laquelle il manque un sommaire (pour avoir une liste des commandes en haut de la page) mais qui ne semble pas contenir tout ce que j'ai aperçu précédemment
  • A ce stade je me retrouve un peu perdu, je reparcours un peu les autres chapitres et je tombe sur le lien d'une autre page avec d'autres commandes (http://www.playonlinux.com/repository/?cat=100)
  • Et c'est seulement en lisant cette discution que je prends connaissance de cette page de références (http://www.playonlinux.com/fr/page-19-PlayOnLinux_script_functions_reference.html) indiquée par Tutul


Bref, je me retrouve avec 3 pages de docs sur les fonctions de POL, trouvées plus ou moins facilement... Cela mériterait d'être mis au clair avec tous les liens utiles présentés directement sur la page de la documentation (http://www.playonlinux.com/fr/documentation.html)


Aussi j'aime bien apprendre par l'exemple, donc m'inspirer de l'expérience des autres scripteurs. J'ai fini par trouver qu'en suivant le lien "Logiciels supportés" du menu de gauche, on a la liste des applis avec accès à leur scripts. Mais ça pourrait aussi être mis davantage en avant dans la doc pour scripteurs (ou sinon proposer une sélection de scripts, montrant des cas intéressants et approuvés comme étant à jour, histoire d'avoir les bonnes méthodes)


A moins que ce ne soit une stratégie subtile de sélection naturelle pour s'assurer les services de contributeurs débrouillards et motivés ;)

SuperPlumus Maandag 20 Mei 2013 om 9:42
SuperPlumusAnonymous
Admin

Bonjour,

Alors d'abord, merci pour les remerciements. :)

Ensuite, pour la doc, il est vrai que ça n'a jamais été parfait. Elle a toujours été en retard sur le logiciel.

Je l'ai réécrite à plusieurs reprises, mais beaucoup de nouvelles fonctions qu'on ajoute dans PlayOnLinux/PlayOnMac ne sont pas ajoutées à la doc.

L'une des raisons est que peu de personnes en dehors de l'équipe font des scripts actuellement. L'autre raison est l'oubli/le manque de temps.

Un lien pour proposer un script est présent en page "Logiciels supportés".

Pour la doc de référence, je viens d'aller vérifier, et visiblement il manque plusieurs commandes, effectivement. Il faut savoir que j'ai fait cette page petit à petit, et que entre temps on travaillait sur une nouvelle version de PlayOnLinux/PlayOnMac.

Pour la page
[url]http://www.playonlinux.com/repository/?cat=100[/url]
il s'agit des fonctions utilisées par POL_Call. (un peu à la manière de winetricks).
(cela permet d'ajouter des fonctions utilisables dans les scripts sans avoir besoin de modifier le code de PlayOnLinux/PlayOnMac)

Quand à
[url]http://www.playonlinux.com/fr/page-19-PlayOnLinux_script_functions_reference.html[/url]
il s'agit d'une documentation [u]obsolète[/u], il ne faut plus l'utiliser.

Tu peux aussi regarder le code source de POL/POM pour la liste des fonctions, elles sont écrites en bash, comme les scripts. Mais pas mal de ces fonctions ne sont pas utilisées directement dans les scripts.

Mais on est ouvert avec grand plaisir à toute remarque pour l'améliorer et/ou corriger ce qui manque.

Aangepast door SuperPlumus

TonyFlow Maandag 20 Mei 2013 om 19:17
TonyFlow

Bonjour Plumus (à moins que tu préfères que je t'appelle Super, pas de chichi hein)

pour la doc, il est vrai que ça n'a jamais été parfait. Elle a toujours été en retard sur le logiciel.

Je l'ai réécrite à plusieurs reprises, mais beaucoup de nouvelles fonctions qu'on ajoute dans PlayOnLinux/PlayOnMac ne sont pas ajoutées à la doc.

L'une des raisons est que peu de personnes en dehors de l'équipe font des scripts actuellement. L'autre raison est l'oubli/le manque de temps.

Quote from SuperPlumus

Je comprends bien ce genre de problème, maintenir une doc à jour c'est galère. Dans ce cas, autant s'en faire une raison et poser les bons éléments, quels qu'ils soient :
- annoncer clairement que les fonctions sont en constantes évolutions
- proposer les liens vers le code source qui fait référence
- si possible supprimer les infos obsolètes pour ne pas mettre les gens dans l'erreur

Je pense que pour la plupart des scripteurs potentiels, se référer à un code source plutot qu'à une doc html n'est pas un gros obstacle. Bon, en espérant que ce soit codé clairement et avec quelques commentaires (nan pas encore regardé) :p

Sinon vous avez déjà envisagé une génération de doc automatique ? Du genre javadoc ou doxygen... C'est sans doute une bonne piste pour maintenir à jour sans trop d'effort une doc, surtout lorsqu'il s'agit d'un ensemble du type API.

Tu peux aussi regarder le code source de POL/POM pour la liste des
fonctions, elles sont écrites en bash, comme les scripts. Mais pas mal
de ces fonctions ne sont pas utilisées directement dans les scripts.

Quote from SuperPlumus


Alors je suggère pour la page "Documentation" :

- ajouter un lien "Liste des fonctions pour POL_Call" vers http://www.playonlinux.com/repository/?cat=100
- ajouter un(des) lien(s) vers les sources de POL/POM (directement vers les fichiers contenant le codes des fonctions, moi là comme ça... je me vois pas fouiller le git pour trouver mon bonheur)
- ajouter un lien vers le forum, en particulier ce post http://www.playonlinux.com/fr/topic-4254-A_propos_des_scripts.html que je n'ai découvert qu'après
- expliquer comment faire pour proposer un script (se créer un compte, poster dans le forum, lien "nouvel installeur" sur la page "Logiciels supportés")

Et sur la page d'accueil, mettre un lien pour "Proposer vos scripts d'installation", qui peut se contenter de pointer vers la page documentation (surtout si celle-ci est bien complété avec le dernier point évoqué).


Un lien pour proposer un script est présent en page "Logiciels supportés".

Quote from SuperPlumus

Je me rends compte que cette page est vraiment centrale. Elle ne permet pas seulement de voir la liste des apps supportées, elle donne aussi l'accès au code source des scripts (ya un autre moyen sinon pour les voir !?).
En plus il y a cette option qui m'avait complétement échappé pour proposer un script (je n'avais pas encore de compte, donc je n'avais pas cette option).

Du coup je trouve qu'elle est peu mise en avant sur le site : juste un petit lien dans le menu de gauche, rien à voir avec les liens du haut bien plus visibles. Mais forcément, difficile de rajouter un lien de plus en haut...

Par contre cette page pourrait au moins être davantage citée dans les autres sections :
- sur la page documentation comme je disais, à la fois pour sa fonction d'ajout de scripts, que pour les possibilités de consulter les scripts existants.
- sur la page téléchargements pourquoi pas ? avec une dernière section "Scripts" (à moins qu'il y ait un meilleur moyen d'accéder aux scripts dispo).

Voila quelques pistes à creuser ;)

Aangepast door TonyFlow

Je bent hier: Index > Site Internet > Documentation