Présentation	Documentation				L'équipe	Sérialisation
		Programmes	Objets	Libs Utilitaires	Libs Internes
		Editeur	Syntaxes	Windows	Versions

SCR/AL1 - TOME III. Les librairies utilitaires

19. Le groupe s_a2m

19.2 A2mToRtf (file s_a2mrtf.c:154)

Syntaxe

A2mToRtf(a2mfile, outfile, wh)
char    *a2mfile, *outfile;
int     wh;

Description

Interprète le contenu d'un fichier a2m et génère un fichier .rtf et éventuellement d'autres pour obtenir un input pour la création d'un fichier d'aide Win32.

• a2mfile = nom du fichier a2m à interpréter
• outfile = nom du fichier rtf à générer
• wh = 1 pour générer un fichier d'aide, 0 pour un fichier rtf normal

Valeur retournée

La fonction retourne 0 si le processus s'est bien déroulé, -1 sinon.

La syntaxe des fichiers a2m est décrite dans un chapitre spécifique.

Fichier a2m.ini

Le fichier a2m.ini (ou un autre) contient des paramètres pour l'impression et la lecture du fichier a2m. Pour que ces paramètres soient pris en compte par le programme A2mToRtf(), il faut appeler la fonction A2mRtfReadIni(filename) avant de lancer la fonction d'interprétation et d'impression.

    #include <s_a2m.h>
 
    A2mRtfReadIni("myfile.ini");
    A2mToRtf("myfile", "test.rtf", 1);

Variables globales

Les variables globales décrites dans le fichier .ini peuvent également être modifiées dans le programme.

Variables influençant la lecture du fichier

Ces variables sont définies dans la secion [A2M] du fichier ini.

• int A2M_ESCCH = caractère d'escape (enrichissements et caractères spéciaux) : '\'par défaut
• int A2M_CMDCH = caractère de commande ('.' par défaut) spéciaux)
• int A2M_DEFCH = caractère préfixant les macros ('&' par défaut)
• int A2M_SEPCH = caractère de séparation des cellules ('&' par défaut)
• int A2M_LFON = conserve les linefeed (1) ou non (0)
• int A2M_BLON = conserve les blancs (1) ou non (0)
• char A2M_CURTAG[41] = paragraphe par défaut ("par_0")

Variables influençant le fichier généré

Ces variables sont définies dans la section [RTF] du fichier .ini.

• int A2M_FONTSIZE = taille par défaut des caractères dans les paragraphes (10 pts par défaut)
• int A2M_FONTFAMILY = police de caractère par défaut ('H', 'T' ou 'C')
• int A2M_FONTINCR = incrément de taille de caractères (2 par défaut)
• int A2M_TFONTSIZE = taille par défaut des caractères dans les tableaux (8 pts par défaut)
• int A2M_TSHADING_COL[2] = couleurs de la brosse de hachurage des titres([0]) et corps([1]) des tableaux
• 0 = noir
• 1 = blanc
• 2 = rouge
• 3 = vert
• 4 = bleu
• 5 = cyan
• 6 = magenta
• 7 = jaune
• int A2M_TSHADING_BRUSH[2] = brosse de hachurage des titres([0]) et corps([1]) des tableaux
• 7 = 50%
• 6 = 25%
• 5 = 12%
• 4 = 6%
• 3 = 3%
• 0-2 = 0%
• int A2M_RTF_TCOLOR = 1 (dft) pour impression en couleur des tableaux, 0 en B/W
• int A2M_RTF_TBORDER = épaisseur des cadres des tableaux (1 par dft)
• U_ch *A2M_RTF_TITLE = titre du fichier d'aide (si wh == 1)
• U_ch *A2M_RTF_COPYRIGHT = texte du Copyright de l'aide (si wh == 1)
• int A2M_RTF_TCOL1 = largeur de la colonne 1 des tableaux en mm (dft 60)
• int A2M_RTF_TCOLN = largeur des autres colonnes des tableaux en mm (dft 15)
• int A2M_RTF_HLINES = 1 pour des lignes horizontales dans les tableaux (dft 0)
• int A2M_RTF_VLINES = 1 pour des lignes verticales dans les tableaux (dft 0) ;

Certains paramètres ne sont pas gérés par le compilateur d'aide de Windows 95, notamment dans les attributs des tableaux.

Générer une aide Windows 95

Si on souhaite générer une aide sous Windows 95, les fichiers suivants sont générés par le programme A2mToRtf() :

• rtf = fichier contenant le texte de l'aide
• cnt = fichier contenant la structure de l'aide (table des matières)
• hpj = fichier contenant les paramètres de génération

Pour construire le fichier d'aide, il faut disposer du compilateur d'aide de Microsot : hcw.exe. Le processus se déroule comme suit :

• créer le ou les fichiers a2m
• contruire l'aide :

    A2mToRtf("myfile.a2m", "myhelp.rtf", 1)

• compiler :

    hcw /A/C myhelp

• tester :

    winhelp myhelp

Valeur retournée

• 0 en cas de succès
• -1 si le fichier ne peut être ouvert
• -2 si les fichiers output n'ont pû être créés

Voir également

A2mRtfReadIni(), A2mToRtf(), A2mToMif(), A2mToHtml(), A2mPrintError()

19.2.1 File s_a2mrtf.c

A2mRtfReadIni(filename)
A2mToRtf(a2mfile, outfile, wh)

[X-ON] [SCR4/AL1]