Accueil Site internet Index

Modèles de rapport

Le dossier Report Templates contient des fichiers HTML (et d'autres formats) permettant de personnaliser l'apparence et le contenu des rapports de Simon. Ce dossier se trouve dans le dossier de données de Simon, à cet endroit "~/Library/Application Support/Dejal/Simon/". Vous pouvez y accéder rapidement à l'aide du bouton Afficher dans le Finder dans la page Options du panneau Informations Rapport.

Vous n'avez pas besoin d'éditer les modèles (ni même d'y jeter un oeil) pour utiliser Simon. Simon comporte un certain nombre de modèles utiles, qui seront automatiquement installés dans le dossier Report Templates lorsque Simon 2.1 ou une version ultérieure est lancé la première fois. Le site internet de Simon héberge également des modèles mis à jour ou réalisé par des utilisateurs : vérifiez-le sur la page Simon Extras . Cependant, si vous le souhaitez, vous pouvez modifier les modèles pour qu'ils correspondent à vos besoins, voir en créer de nouveaux. Si vous créez ou modifiez un modèle et pensez que d'autres pourront le trouver utile, apportez votre contribution sur la page Simon Extras vous y trouverez les instructions nécessaires.

Le dosier Report Templates contient des sous-dossiers pour chaque modèle. À l'intérieur de ces dossiers se trouvent certains ou tous les éléments suivants :

• Un fichier ayant pour nom index ou summary, avec une extension quelconque. Ce fichier contient le code HTML pour la page de résumé, listant tous les tests inclus dans le rapport.
• Un fichier ou un dossier ayant pour nom detail. Si c'est un fichier, il peut avoir une extension. Si c'est un dossier, il doit comporter un fichier ayant pour nom index et avec une extension quelconque. Dans tous les cas, ce fichier a le code HTML pour les pages détaillées. Le fichier ou le dossier detail est copié pour chacune des pages détaillés, en utilisant un petit formulaire pour chaque nom de test.
• Un dossier images. Ce dossier est optionnel. S'il est présent, lui et son contenu sont générés tel quel. Un endroit idéal pour les fichiers graphiques.
• Un dossier resources. Ce dossier est également optionnel et généré tel s'il est présent. Un endroit idéal pour d'autres fichiers, comme des fichiers CSS (cascading style sheet), des scripts PHP supplémentaires, des pages de formulaire, etc.
• Tout autre fichier sera ignoré, aussi soyez libres d'ajouter des fichiers Lisez-moi, etc. dans les dossiers Modèle.

La plupart des modèles utilisent le formatage HTML, mais cela n'est pas une exigence. Tout format à base de texte peut être utilisé. Par exemple, l'utilisation du XML pour un flux RSS et de texte tabulé.

De plus, les fichiers modèles utilisent des balises Simon spécifiques, qui sont remplacées par les tests, les vérifications, les modifications, les échecs, et l'activité de Simon, plus d'autres valeurs. Ces balises utilisent des conventions pratiquement similaires au code HTML conventionnel, mais avec des délimiteurs spécifiques. Il existe deux types de balise principalement - bloc et variable :

Les balises Bloc:

• Matérialisées par des crochets, par exemple [test].
• Elle comporte des balises fermantes, par exemple [/test], comme en HTML.
• Agit comme un périmètre pour les variables incluses.
• Englobe le code HTML devant être répété pour chaque ligne, par exemple pour chaque test sur la page de résumé ou chaque vérification sur une page détaillée.
• Peut avoir des paramètres. Actuellement le seul pris en charge est count, pour limiter le nombre de ligne utilisé.

Les balises Variable:

• Matérialisées par des parenthèses, sans balise fermante séparée, par exemple {name}.
• Comporte un nom de variable, et optionnellement des paramètres, par exemple {date type="absolute"}.
• Les valeurs des paramètres doivent être encadrées par des doubles guillemets.
• Il ne doit y avoir aucun espace entre le nom du paramètre, le signe égal, les guillemets et la valeur.
• Plusieurs paramètres peuvent être utilisés, ou omis pour utiliser les valeurs par défaut.

Les balises des blocs et des variables et leurs paramètres ne sont pas sensibles à la casse, vous pouvez donc librement mélanger les casses pour les rendre plus lisibles.

La page Résumé comporte deux blocs - le document lui-même, et le bloc de test. Cliquez sur les variables pour plus d'information sur chaque type de bloc :

• Document: Le document HTML prend en charge plusieurs variables qui peuvent être utilisées partout dans le document.
• Test: Comporte le modèle pour un simple test, qui est répété pour chacun des tests inclus dans le résumé.

Les pages Détaillée prennent en charge plusieurs types de blocs :

• Document: Comme pour la page de Résumé, les pages Détaillées prennent aussi en charge les variables de niveau document.
• Test: Dans ce cas, le bloc comporte des informations sur le test sur la page détaillée.
• Vérification: Comporte le modèle pour une seule vérification. Il est répété à chaque vérification.
• Modification: Comporte le modèle pour une seule modification. Il est répété à chaque modification.
• Échec: Comporte le modèle pour un seul échec. Il est répété à chaque échec.
• Activité:Comporte le modèle pour une seule activité. Il est répété à chaque activité.

Veuillez vous reporter à la page paramètres pour obtenir des informations sur les paramètres disponibles.

Veuillez vous reporter aux pages ci-dessus pour plus d'informations, et les exemples de modèle fournis en exemples.