From 149df874cd88acb3a5f7087f7ed5f6b6dd5ef0a9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Adjemian=20=28Charybdis=29?=
<stephane.adjemian@univ-lemans.fr>
Date: Sat, 15 Jun 2013 15:19:24 +0200
Subject: [PATCH] Added documentation about pre and post dynare preprocessor
hooks.
---
doc/dynare.texi | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/doc/dynare.texi b/doc/dynare.texi
index 6fe06c0c36..b19b462674 100644
--- a/doc/dynare.texi
+++ b/doc/dynare.texi
@@ -160,10 +160,12 @@ Configuration
Running Dynare
* Dynare invocation::
+* Dynare hooks::
* Understanding Preprocessor Error Messages::
Dynare invocation
+* Dynare hooks
* Understanding Preprocessor Error Messages::
The Model file
@@ -638,6 +640,7 @@ required by the user. Its contents is described in @ref{The Model file}.
@menu
* Dynare invocation::
+* Dynare hooks::
* Understanding Preprocessor Error Messages::
@end menu
@@ -814,6 +817,20 @@ during the computation.
Structure containing the various results of the computations.
@end defvr
+
+@node Dynare hooks
+@section Dynare hooks
+
+It is possible to call pre and post dynare preprocessor hooks written as matlab scripts.
+The script @file{@var{FILENAME}_pre_dynare_preprocessor_hook.m} is executed before the
+call to Dynare's preprocessor, and can be used to programatically transform the mod file
+that will be read by the preprocessor. The script @file{@var{FILENAME}_post_dynare_preprocessor_hook.m}
+is executed just after the call to Dynare's preprocessor, and can be used to programatically
+transform the files generated by Dynare's preprocessor before actual computations start. The
+pre and/or post dynare preprocessor kooks are executed if and only if the afordmentionned scripts
+are detected in the same folder as the the model file, @file{@var{FILENAME}.mod}.
+
+
@node Understanding Preprocessor Error Messages
@section Understanding Preprocessor Error Messages
--
GitLab