en

Créer un script pour PlayOnMac - Chapitre 9 : Standardisation

La standardisation, qu'est-ce que ce truc encore ?

Afin de faciliter la lecture des scripts, la mise à jour, le débogage et la traduction, les scripts sont standardisés. Cela implique d'ajouter/modifier certaines choses afin d'uniformiser les scripts.

Nous allons voir tout ça, point par point.

Votre script sera aussi disponible sous GNU/Linux avec PlayOnLinux

Il est peut-être utile de préciser (pour ceux qui l'ignorent) que le logiciel PlayOnLinux et le logiciel PlayOnMac ne sont qu'un seul et unique logiciel, avec un code identique. Juste le nom change suivant le système d'exploitation

Lors de l'ajout de votre script, il sera automatiquement disponible dans PlayOnLinux, car si le programme fonctionne sous Mac OS X, alors il fonctionnera sous GNU/Linux (l'inverse n'est pas toujours vrai).

Standardisation, c'est parti

Nous allons maintenant voir plusieurs points pour la standardisation des scripts.

La variable $TITLE

Il est demandé de déclarer la variables $TITLE, avec le nom du script dedans, et d'utiliser cette variable chaque fois que vous avez besoin du nom du script.

Exemple :

#!/bin/bash
[ "$PLAYONLINUX" = "" ] && exit 0
source "$PLAYONLINUX/lib/sources"

TITLE="Mozilla Firefox" # à mettre dans tous les scripts

POL_SetupWindow_Init
...
POL_SetupWindow_presentation "$TITLE" "Mozilla" "http://www.mozilla.com" "VotrePseudo" "MozillaFirefox"
...
POL_Shortcut "firefox.exe" "$TITLE"
...

Adaptez évidemment avec le nom de votre script (qui correspond au nom du logiciel dans la plupart des cas).

La variable $TITLE est nécessaire notamment pour l'utilisation du système de débogage de PlayOnMac.

Utiliser la variable $TITLE comme titre des fenêtres

Afin que l'utilisateur ne soit pas perdu par différents titres de fenêtres, il est recommandé d'utiliser la variable $TITLE comme titre de fenêtre.

Exemple :

POL_SetupWindow_message "Message" "$TITLE"
POL_SetupWindow_browse "Message" "$TITLE"
POL_SetupWindow_wait "Message" "$TITLE"

La variable $PREFIX

Il est recommandé de mettre le nom du préfixe dans la variable $PREFIX, afin de la voir du premier coup d'œil. Cela permet aussi d'éviter de répéter plusieurs fois le nom du préfixe.

Exemple :

#!/bin/bash
[ "$PLAYONLINUX" = "" ] && exit 0
source "$PLAYONLINUX/lib/sources"

TITLE="Mozilla Firefox"
PREFIX="MozillaFirefox"

POL_SetupWindow_Init
...
POL_SetupWindow_presentation "$TITLE" "Mozilla" "http://www.mozilla.com" "VotrePseudo" "$PREFIX"
...
POL_Wine_SelectPrefix "$PREFIX"
...
POL_System_TmpCreate "$PREFIX"
...

Quelques infos sur le script

Il est recommandé de mettre quelques infos sur le script au début, juste après le #!/bin/bash.

Syntaxe :

# Date : (Année-mois-jour heure-minute)
# Last revision : (Année-mois-jour heure-minute)
# Wine version used : 
# Distribution used to test : Distribution
# Author : Votre pseudo

Exemple :

#!/bin/bash
# Date : (2011-11-19 06-39)
# Last revision : (2011-11-19 06-39)
# Wine version used : 1.3.4
# Distribution used to test : Ubuntu 10.04 LTS
# Author : Votre pseudo

Activer le mode de débogage

PlayOnMac dispose d'un mode de débogage pour les scripts, qui doit être activé via une commande.

Il est obligatoire de l'activer, même si vous n'en avez pas besoin. Car si un utilisateur rencontre un problème avec votre script, un rapport de bug pourra être envoyé sur le site de PlayOnMac.

Syntaxe :

POL_Debug_Init

Cette commande doit aller juste après la commande POL_SetupWindow_Init.

Quelques autres informations

Voici quelques autres informations diverses non abordées dans les chapitres précédents, mais que vous devez quand même savoir.

Interdiction d'utiliser sudo

Les commandes sudo, su, gksudo, kdesu, et compagnie sont interdites pour des raisons de sécurité.

Néanmoins, si vous avez absolument besoin de sudo (notamment pour afficher les fichiers cachés des DVD hybrides PC/MAC, via la commande mount), vous pouvez utiliser la commande suivante :

Syntaxe :

POL_Call POL_Function_RootCommand "sudo commande; exit"

Pas d'utilisation de Winetricks dans les scripts

Winetricks, ou tout autre script du genre est interdit dans les scripts PlayOnMac.

À la place, vous pouvez utiliser un système semblable, avec la commande POL_Call.

Syntaxe :

POL_Call Script

Exemple :

POL_Call POL_Install_vcrun6

La liste des commandes possibles est disponible sur cette page.

Traduction des scripts

Nous avons presque terminé avec la standardisation des scripts, il ne manque plus que le système de traduction des scripts à voir. Cela se fait dans le prochain chapitre.

Chapitre précédent - Chapitre suivant

Il n'y a rien à voir ici