stepan
/
dynare
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reference manual: switch to TeXinfo format

time-shift
Sébastien Villemot 2011-03-17 17:54:00 +01:00
parent 330b11ba48
commit 5f04ed9db7
11 changed files with 5058 additions and 5527 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
.gitignore vendored
View File

@ -41,9 +41,20 @@ ylwrap
*.bbl
*.blg
*.lof
/doc/manual-html/
/doc/manual.texi
/doc/manual.info
/doc/dynare.html
/doc/dynare.info
/doc/dynare.cp
/doc/dynare.fn
/doc/dynare.fns
/doc/dynare.vrs
/doc/dynare.ky
/doc/dynare.pg
/doc/dynare.tp
/doc/dynare.vr
/doc/texinfo.tex
/doc/version.texi
/doc/mdate-sh
/doc/stamp-vti
!/doc/guide.bbl
!/doc/macroprocessor/new-design.pdf
!/doc/macroprocessor/old-design.pdf

43
configure.ac
View File

@ -84,6 +84,8 @@ AC_DEFINE([BOOST_NO_HASH], [], [Don't use deprecated STL hash structures])
AC_CHECK_LIB([dl], [dlopen], [LIBADD_DLOPEN="-ldl"], [])
AC_SUBST([LIBADD_DLOPEN])
AC_CHECK_PROG([MAKEINFO], [makeinfo], [makeinfo])
AC_CHECK_PROG([PDFTEX], [pdftex], [pdftex])
AM_CONDITIONAL([HAVE_PDFTEX], [test "x$PDFTEX" != "x"])
@ -105,6 +107,12 @@ AM_CONDITIONAL([HAVE_PDFLATEX], [test "x$PDFLATEX" != "x"])
AC_CHECK_PROG([BIBTEX], [bibtex], [bibtex])
AM_CONDITIONAL([HAVE_BIBTEX], [test "x$BIBTEX" != "x"])
AC_CHECK_PROG([TEXI2HTML], [texi2html], [texi2html])
AM_CONDITIONAL([HAVE_TEXI2HTML], [test "x$TEXI2HTML" != "x"])
AC_CHECK_PROG([LATEX2HTML], [latex2html], [latex2html])
AM_CONDITIONAL([HAVE_LATEX2HTML], [test "x$LATEX2HTML" != "x"])
if test "x$PDFLATEX" != "x" -a "x$BIBTEX" != "x"; then
AC_MSG_CHECKING([for econometrica BST])
AX_LATEX_BIBTEX_TEST([\documentclass{article}
@ -128,17 +136,6 @@ fi
AM_CONDITIONAL([HAVE_ECONOMETRICA], [test "x$ax_latex_have_econometrica" = "xyes"])
AM_CONDITIONAL([HAVE_BEAMER], [test "x$ax_latex_have_beamer" = "xyes"])
AC_CHECK_PROG([DBLATEX], [dblatex], [dblatex])
AM_CONDITIONAL([HAVE_DBLATEX], [test "x$DBLATEX" != "x"])
AX_PROG_XSLTPROC
AX_CHECK_DOCBOOK_XSLT_MIN(1.69.0)
AM_CONDITIONAL([HAVE_XSLT], [test "x$XSLTPROC" != "x" -a "x$DOCBOOK_XSLT_CURRENT_VERSION" != "xno"])
AC_CHECK_PROG([DOCBOOK2XTEXI], [docbook2x-texi], [docbook2x-texi])
AC_CHECK_PROG([MAKEINFO], [makeinfo], [makeinfo])
AM_CONDITIONAL([HAVE_DOCBOOK2XTEXI_MAKEINFO], [test "x$DOCBOOK2XTEXI" != "x" -a "x$MAKEINFO" != "x"])
AC_CHECK_PROG([DOXYGEN], [doxygen], [doxygen])
AM_CONDITIONAL([HAVE_DOXYGEN], [test "x$DOXYGEN" != "x"])
@ -238,18 +235,6 @@ else
BUILD_DYNAREPLUSPLUS_SRCDOC="no (missing one of: cweave, pdftex, eplain)"
fi
if test "x$XSLTPROC" != "x" -a "x$DOCBOOK_XSLT_CURRENT_VERSION" != "xno"; then
BUILD_DYNARE_HTML_MANUAL="yes"
else
BUILD_DYNARE_HTML_MANUAL="no (missing one of: xsltproc, DocBook stylesheets)"
fi
if test "x$PDFLATEX" != "x" -a "x$DBLATEX" != "x"; then
BUILD_DYNARE_PDF_MANUAL="yes"
else
BUILD_DYNARE_PDF_MANUAL="no (missing one of: pdflatex, dblatex)"
fi
if test "x$PDFLATEX" != "x" -a "x$BIBTEX" != "x" -a "x$ax_latex_have_econometrica" = "xyes"; then
BUILD_DYNARE_USERGUIDE="yes"
else
@ -280,10 +265,18 @@ else
BUILD_DYNARE_INTERNAL_DOC="no (Org export not enabled)"
fi
if test "x$DOCBOOK2XTEXI" != "x" -a "x$MAKEINFO" != "x"; then
if test "x$MAKEINFO" != "x"; then
BUILD_DYNARE_INFO="yes"
if test "x$TEXI2HTML" != "x" -a "x$LATEX2HTML" != "x"; then
BUILD_DYNARE_HTML_MANUAL="yes"
else
BUILD_DYNARE_HTML_MANUAL="yes (but with ugly math formulas, missing texi2html or latex2html)"
fi
BUILD_DYNARE_PDF_MANUAL="yes"
else
BUILD_DYNARE_INFO="no (missing docbook2x-texi and/or makeinfo)"
BUILD_DYNARE_INFO="no (missing makeinfo)"
BUILD_DYNARE_HTML_MANUAL="no (missing makeinfo)"
BUILD_DYNARE_PDF_MANUAL="no (missing makeinfo)"
fi
if test "x$OCTAVE" != "x"; then

46
doc/Makefile.am
View File

@ -1,32 +1,25 @@
SUBDIRS = preprocessor macroprocessor userguide parallel internals gsa
info_TEXINFOS = dynare.texi
if HAVE_TEXI2HTML
if HAVE_LATEX2HTML
html-local: dynare.texi
rm -rf dynare.html
mkdir -p dynare.html
cd dynare.html && $(TEXI2HTML) --l2h --split section --prefix index ../dynare.texi
endif
endif
PDF_TARGETS =
if HAVE_PDFLATEX
PDF_TARGETS += guide.pdf bvar-a-la-sims.pdf dr.pdf
endif
if HAVE_DBLATEX
PDF_TARGETS += manual.pdf
endif
pdf-local: $(PDF_TARGETS)
# We don't use info_TEXINFOS because otherwise it generates a manual.pdf rule
# which conflict with ours. Hence we have to manually specify building rules.
INFO_TARGETS =
if HAVE_DOCBOOK2XTEXI_MAKEINFO
INFO_TARGETS += manual.info
endif
info-local: $(INFO_TARGETS)
if HAVE_XSLT
html-local: manual-html/index.html
endif
EXTRA_DIST = guide.tex guide.bbl bibmad.sty bvar-a-la-sims.tex dr.tex manual.xml dynare_html.xsl dynare.xsl
EXTRA_DIST = guide.tex guide.bbl bibmad.sty bvar-a-la-sims.tex dr.tex
guide.pdf: guide.tex guide.bbl bibmad.sty
$(PDFLATEX) guide
@ -40,18 +33,5 @@ dr.pdf: dr.tex
$(PDFLATEX) dr
$(PDFLATEX) dr
manual-html/index.html: manual.xml dynare_html.xsl dynare.xsl
$(XSLTPROC) -stringparam base.dir ./manual-html/ dynare_html.xsl manual.xml
manual.pdf: manual.xml
$(DBLATEX) manual.xml
manual.texi: manual.xml
$(DOCBOOK2XTEXI) --encoding=utf-8//TRANSLIT --string-param output-file=manual --string-param directory-category=Math --string-param directory-description="A platform for handling a wide class of economic models." $<
manual.info: manual.texi
$(MAKEINFO) $<
clean-local:
rm -f *~ *.pdf *.log *.aux *.out manual.texi manual.info
rm -rf manual-html
rm -f *~ *.pdf *.log *.aux *.out

5009
doc/dynare.texi Normal file
View File

File diff suppressed because it is too large Load Diff

18
doc/dynare.xsl
View File

@ -1,18 +0,0 @@
<?xml version='1.0'?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:fo="http://www.w3.org/1999/XSL/Format"
xmlns:doc="http://nwalsh.com/xsl/documentation/1.0"
exclude-result-prefixes="doc"
version='1.0'>
<xsl:param name="generate.index">1</xsl:param>
<xsl:param name="refentry.generate.name">0</xsl:param>
<xsl:param name="refentry.generate.title">1</xsl:param>
<xsl:param name="section.autolabel" select="1"></xsl:param>
<xsl:param name="biblioentry.item.separator">, </xsl:param>
<xsl:attribute-set name="section.level1.properties">
<xsl:attribute name="break-before">page</xsl:attribute>
</xsl:attribute-set>
</xsl:stylesheet>

12
doc/dynare_html.xsl
View File

@ -1,12 +0,0 @@
<?xml version='1.0'?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:fo="http://www.w3.org/1999/XSL/Format"
xmlns:doc="http://nwalsh.com/xsl/documentation/1.0"
exclude-result-prefixes="doc"
version='1.0'>
<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"/>
<xsl:import href="dynare.xsl"/>
</xsl:stylesheet>

5199
doc/manual.xml
View File

File diff suppressed because it is too large Load Diff

32
license.txt
View File

@ -109,7 +109,7 @@ License: GPL-3+
along with Octave; see the file COPYING. If not, see
<http://www.gnu.org/licenses/>.
Files: doc/manual.xml, doc/*.tex, doc/*.svg, doc/*.dia, doc/*.pdf, doc/*.bib
Files: doc/dynare.texi, doc/*.tex, doc/*.svg, doc/*.dia, doc/*.pdf, doc/*.bib
Copyright: 1996-2011, Dynare Team
License: GFDL-1.3+
Permission is granted to copy, distribute and/or modify this document
@ -231,36 +231,6 @@ License:
permitted in any medium without royalty provided the copyright notice
and this notice are preserved.
Files: m4/ax_check_docbook_xslt_min.m4, m4/ax_prog_xsltproc.m4
Copyright: 2008-2009, Zmanda Inc. <http://www.zmanda.com/>
2008-2009, Dustin J. Mitchell <dustin@zmanda.com>
License: GPL-2+ with special Autoconf exception
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License for more details.
.
You should have received a copy of the GNU General Public License along
with this program. If not, see <http://www.gnu.org/licenses/>.
.
As a special exception, the respective Autoconf Macro's copyright owner
gives unlimited permission to copy, distribute and modify the configure
scripts that are the output of Autoconf when processing the Macro. You
need not follow the terms of the GNU General Public License when using
or distributing such scripts, even though portions of the text of the
Macro appear in them. The GNU General Public License (GPL) does govern
all other use of the material that constitutes the Autoconf Macro.
.
This special exception to the GPL applies to versions of the Autoconf
Macro released by the Autoconf Archive. When you make and distribute a
modified version of the Autoconf Macro, you may extend this special
exception to the GPL to apply to your modified version as well.
Files: m4/ax_compare_version.m4
Copyright: 2008, Tim Toolan <toolan@ele.uri.edu>
License:

108
m4/ax_check_docbook_xslt_min.m4
View File

@ -1,108 +0,0 @@
# ===========================================================================
# http://www.nongnu.org/autoconf-archive/ax_check_docbook_xslt_min.html
# ===========================================================================
#
# SYNOPSIS
#
# AX_CHECK_DOCBOOK_XSLT_MIN(min-xslt-version)
#
# DESCRIPTION
#
# Check that the 'current' version of docbook is at least version
# min-xslt-version. If the test is successful,
# $DOCBOOK_XSLT_CURRENT_VERSION will be set to the current docbook
# version; if not, it will be set to 'no'.
#
# Example:
#
# AX_CHECK_DOCBOOK_XSLT_MIN(1.72.0)
# if test "x$DOCBOOK_XSLT_CURRENT_VERSION" = "xno"; then
# ...
#
# LICENSE
#
# Copyright (c) 2008 Zmanda Inc. <http://www.zmanda.com/>
# Copyright (c) 2008 Dustin J. Mitchell <dustin@zmanda.com>
#
# This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the
# Free Software Foundation; either version 2 of the License, or (at your
# option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
# Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
#
# As a special exception, the respective Autoconf Macro's copyright owner
# gives unlimited permission to copy, distribute and modify the configure
# scripts that are the output of Autoconf when processing the Macro. You
# need not follow the terms of the GNU General Public License when using
# or distributing such scripts, even though portions of the text of the
# Macro appear in them. The GNU General Public License (GPL) does govern
# all other use of the material that constitutes the Autoconf Macro.
#
# This special exception to the GPL applies to versions of the Autoconf
# Macro released by the Autoconf Archive. When you make and distribute a
# modified version of the Autoconf Macro, you may extend this special
# exception to the GPL to apply to your modified version as well.
AU_ALIAS([AC_CHECK_DOCBOOK_XSLT_MIN], [AX_CHECK_DOCBOOK_XSLT_MIN])
AC_DEFUN([AX_CHECK_DOCBOOK_XSLT_MIN],
[
AC_REQUIRE([AX_PROG_XSLTPROC])
AC_CACHE_CHECK([for current Docbook XSLT version], [ac_cv_docbook_xslt_current_version],
[
ac_cv_docbook_xslt_current_version=no
if test -n "$XSLTPROC"; then
cat >conftest.xsl <<EOF
<xsl:stylesheet
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:fm="http://freshmeat.net/projects/freshmeat-submit/"
version="1.0">
<xsl:output method="text"/>
<xsl:template match="fm:project/fm:Version">
<xsl:value-of select="." />
</xsl:template>
<!-- do nothing with any other text -->
<xsl:template match="text()"/>
</xsl:stylesheet>
EOF
echo "Trying '$XSLTPROC $XSLTPROC_FLAGS http://docbook.sourceforge.net/release/xsl/current/VERSION' with input:" >&AS_MESSAGE_LOG_FD
echo "====" >&AS_MESSAGE_LOG_FD
cat conftest.xsl >&AS_MESSAGE_LOG_FD
echo "====" >&AS_MESSAGE_LOG_FD
ac_cv_docbook_xslt_current_version=`$XSLTPROC $XSLTPROC_FLAGS conftest.xsl http://docbook.sourceforge.net/release/xsl/current/VERSION 2>&AS_MESSAGE_LOG_FD`
if test "$?" != 0; then
ac_cv_docbook_xslt_current_version='no'
fi
rm conftest.xsl
fi
])
DOCBOOK_XSLT_CURRENT_VERSION="$ac_cv_docbook_xslt_current_version"
AC_MSG_CHECKING([whether Docbook XSLT version is $1 or newer])
if test x"$DOCBOOK_XSLT_CURRENT_VERSION" = x"no"; then
AC_MSG_RESULT([no])
else
AX_COMPARE_VERSION([$DOCBOOK_XSLT_CURRENT_VERSION], [lt], [$1], [
# version is less than required, so mark it as "no"
DOCBOOK_XSLT_CURRENT_VERSION=no
])
if test x"$DOCBOOK_XSLT_CURRENT_VERSION" = x"no"; then
AC_MSG_RESULT([no])
else
AC_MSG_RESULT([yes ($DOCBOOK_XSLT_CURRENT_VERSION)])
fi
fi
])

95
m4/ax_prog_xsltproc.m4
View File

@ -1,95 +0,0 @@
# ===========================================================================
# http://www.nongnu.org/autoconf-archive/ax_prog_xsltproc.html
# ===========================================================================
#
# SYNOPSIS
#
# AX_PROG_XSLTPROC([default-flags])
#
# DESCRIPTION
#
# Find an xsltproc executable.
#
# Input:
#
# "default-flags" is the default $XSLTPROC_FLAGS, which will be overridden
# if the user specifies --with-xsltproc-flags.
#
# Output:
#
# $XSLTPROC contains the path to xsltproc, or is empty if none was found
# or the user specified --without-xsltproc. $XSLTPROC_FLAGS contains the
# flags to use with xsltproc.
#
# LICENSE
#
# Copyright (c) 2008,2009 Zmanda Inc. <http://www.zmanda.com/>
# Copyright (c) 2008,2009 Dustin J. Mitchell <dustin@zmanda.com>
#
# This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the
# Free Software Foundation; either version 2 of the License, or (at your
# option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
# Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
#
# As a special exception, the respective Autoconf Macro's copyright owner
# gives unlimited permission to copy, distribute and modify the configure
# scripts that are the output of Autoconf when processing the Macro. You
# need not follow the terms of the GNU General Public License when using
# or distributing such scripts, even though portions of the text of the
# Macro appear in them. The GNU General Public License (GPL) does govern
# all other use of the material that constitutes the Autoconf Macro.
#
# This special exception to the GPL applies to versions of the Autoconf
# Macro released by the Autoconf Archive. When you make and distribute a
# modified version of the Autoconf Macro, you may extend this special
# exception to the GPL to apply to your modified version as well.
AU_ALIAS([AC_PROG_XSLTPROC], [AX_PROG_XSLTPROC])
AC_DEFUN([AX_PROG_XSLTPROC],
[
XSLTPROC_FLAGS="$1"
AC_SUBST(XSLTPROC_FLAGS)
# The (lack of) whitespace and overquoting here are all necessary for
# proper formatting.
AC_ARG_WITH(xsltproc,
AS_HELP_STRING([--with-xsltproc[[[[[=PATH]]]]]],
[Use the xsltproc binary in in PATH.]),
[ ac_with_xsltproc=$withval; ],
[ ac_with_xsltproc=maybe; ])
AC_ARG_WITH(xsltproc-flags,
AS_HELP_STRING([ --with-xsltproc-flags=FLAGS],
[Flags to pass to xsltproc (default $1)]),
[ if test "x$withval" == "xno"; then
XSLTPROC_FLAGS=''
else
if test "x$withval" != "xyes"; then
XSLTPROC_FLAGS="$withval"
fi
fi
])
# search for xsltproc if it wasn't specified
if test "$ac_with_xsltproc" = "yes" -o "$ac_with_xsltproc" = "maybe"; then
AC_PATH_PROGS(XSLTPROC,xsltproc)
else
if test "$ac_with_xsltproc" != "no"; then
if test -x "$ac_with_xsltproc"; then
XSLTPROC="$ac_with_xsltproc";
else
AC_MSG_WARN([Specified xsltproc of $ac_with_xsltproc isn't])
AC_MSG_WARN([executable; searching for an alternative.])
AC_PATH_PROGS(XSLTPROC,xsltproc)
fi
fi
fi
])

6
windows/dynare.nsi
View File

@ -120,10 +120,10 @@ SectionEnd
Section "Documentation and examples (Dynare and Dynare++)"
SetOutPath $INSTDIR\doc
File ..\doc\manual.pdf ..\doc\guide.pdf ..\doc\userguide\UserGuide.pdf ..\doc\bvar-a-la-sims.pdf ..\doc\dr.pdf ..\doc\macroprocessor\macroprocessor.pdf ..\doc\preprocessor\preprocessor.pdf ..\doc\parallel\parallel.pdf ..\doc\gsa\gsa.pdf
File ..\doc\dynare.pdf ..\doc\guide.pdf ..\doc\userguide\UserGuide.pdf ..\doc\bvar-a-la-sims.pdf ..\doc\dr.pdf ..\doc\macroprocessor\macroprocessor.pdf ..\doc\preprocessor\preprocessor.pdf ..\doc\parallel\parallel.pdf ..\doc\gsa\gsa.pdf
SetOutPath $INSTDIR\doc\manual-html
File ..\doc\manual-html\*.html
SetOutPath $INSTDIR\doc\dynare.html
File ..\doc\dynare.html\*.html ..\doc\dynare.html\*.png
SetOutPath $INSTDIR\doc\dynare++
File ..\dynare++\doc\dynare++-tutorial.pdf ..\dynare++\doc\dynare++-ramsey.pdf ..\dynare++\sylv\sylvester.pdf ..\dynare++\tl\cc\tl.pdf ..\dynare++\integ\cc\integ.pdf ..\dynare++\kord\kord.pdf