Automatisation de la documentation avec Code Diary

Ce script charge les macros nécessaires (`code_diary` et `convert_markdown_to_html`), crée des tables de configuration (alias, ordre, en-têtes, exclusions) à l'aide de `datalines`, puis exécute les macros pour analyser le fichier `project_main.sas^©` et convertir le résultat en HTML.

Analyse des données

Type : CREATION_INTERNE

Les données de configuration (alias, ordre, en-têtes) sont créées directement dans le script via des étapes DATA avec DATALINES.

1 Bloc de code

INCLUDE

Explication :
Inclusion des fichiers de macros externes nécessaires au traitement.

Copié !

1	%include "&MACRO_ROOT.code_diary.sas";
2	%include "&MACRO_ROOT.convert_markdown_to_html.sas";
3

2 Bloc de code

DATA STEP Data

Explication :
Création des tables de configuration (`work.alias_list`, `work.order_list`, `work.header_list`, `work.scrub_list`) définissant les règles de génération de la documentation (alias, ordre des sections, titres, éléments à masquer).

Copié !

1	DATA work.alias_list;
2	INFILE DATALINES;
3	INPUT short_keyword $1-10 long_keyword $11-50;
4	DATALINES;
5	excl exclusion
6	stat statistics
7	;
8
9	DATA work.order_list;
10	INFILE DATALINES;
11	INPUT keyword $1-20 order_no 21-25;
12	DATALINES;
13	todo -30
14	exclusion -20
15	exclusion.time -19
16	exclusion.person -18
17	methods -10
18	no_keyword 0
19	;
20
21	DATA work.header_list;
22	INFILE DATALINES;
23	INPUT keyword $1-15 header $16-50;
24	DATALINES;
25	exclusion Exclusion criteria
26	person Subjects
27	time Time periods
28	todo Task list
29	;
30
31	DATA work.scrub_list;
32	INFILE DATALINES;
33	INPUT keyword $1-15;
34	DATALINES;
35	todo
36	regex
37	;

3 Bloc de code

MACRO CALL

Explication :
Appel de la macro `%code_diary` pour analyser le fichier source `project_main.sas` et générer les fichiers de sortie Markdown en utilisant les tables de configuration créées précédemment.

Copié !

1	%code_diary(
2	input_main_file = &DEMO_ROOT.project_main.sas,
3	out_dir = &DEMO_ROOT,
4	out_file = OUTPUT-coder.md,
5	out_file_scrubbed = OUTPUT-for-all.md,
6	debug_mode = 0,
7	section_aliases = work.alias_list,
8	section_order = work.order_list,
9	section_headers = work.header_list,
10	sections_scrubbed = work.scrub_list
11	);

4 Bloc de code

MACRO CALL

Explication :
Conversion du fichier Markdown épuré (`output-for-all.md`) en fichier HTML pour la publication.

Copié !

1	%convert_markdown_to_html(
2	in_file_md = "&DEMO_ROOT.output-for-all.md",
3	out_file_html = "&DEMO_ROOT.output-for-all.htm",
4	debug_mode = 0
5	);

Ce matériel est fourni "tel quel" par We Are Cas. Il n'y a aucune garantie, expresse ou implicite, quant à la qualité marchande ou à l'adéquation à un usage particulier concernant le matériel ou le code contenu dans les présentes. We Are Cas n'est pas responsable des erreurs dans ce matériel tel qu'il existe maintenant ou existera, et We Are Cas ne fournit pas de support technique pour celui-ci.

Retour à la liste