# HG changeset patch # User Alpar Juttner # Date 1355927832 -3600 # Node ID 60c0c3ed8d110ae98e6e24afa36a76abba50a3ee # Parent 3ab825f5fab00a0b2c912dca0c2eb3ab5ad8e005 Use MathJax for rendering the math formulae (#455) diff -r 3ab825f5fab0 -r 60c0c3ed8d11 INSTALL --- a/INSTALL Wed Dec 19 15:37:12 2012 +0100 +++ b/INSTALL Wed Dec 19 15:37:12 2012 +0100 @@ -106,6 +106,34 @@ Build shared library instead of static one. Think twice if you really want to use this option. +-DLEMON_DOC_SOURCE_BROWSER=YES + + Include the browsable cross referenced LEMON source code into the + doc. It makes the doc quite bloated, but may be useful for + developing LEMON itself. + +-DLEMON_DOC_USE_MATHJAX=YES + + Use MathJax (http://mathjax.org) for rendering the math formulae in + the doc. It of much higher quality compared to the default LaTeX + generated static images and it allows copy&paste of the formulae to + LaTeX, Open Office, MS Word etc. documents. + + On the other hand, it needs either Internet access or a locally + installed version of MathJax to properly render the doc. + +-DLEMON_DOC_MATHJAX_RELPATH=DIRECTORY + + The location of the MathJax library. It defaults to + http://www.mathjax.org/mathjax, which necessitates Internet access + for proper rendering. The easiest way to make it usable offline is + to set this parameter to 'mathjax' and copy all files of the MathJax + library into the 'doc/html/mathjax' subdirectory of the build + location. + + See http://docs.mathjax.org/en/latest/installation.html for more details. + + -DGLPK_ROOT_DIR=DIRECTORY -DCOIN_ROOT_DIR=DIRECTORY -DCPLEX_ROOT_DIR=DIRECTORY diff -r 3ab825f5fab0 -r 60c0c3ed8d11 doc/CMakeLists.txt --- a/doc/CMakeLists.txt Wed Dec 19 15:37:12 2012 +0100 +++ b/doc/CMakeLists.txt Wed Dec 19 15:37:12 2012 +0100 @@ -4,6 +4,8 @@ SET(abs_top_builddir ${PROJECT_BINARY_DIR}) SET(LEMON_DOC_SOURCE_BROWSER "NO" CACHE STRING "Include source into the doc (YES/NO).") +SET(LEMON_DOC_USE_MATHJAX "NO" CACHE STRING "Use MathJax to display math formulae (YES/NO).") +SET(LEMON_DOC_MATHJAX_RELPATH "http://www.mathjax.org/mathjax" CACHE STRING "MathJax library location.") CONFIGURE_FILE( ${PROJECT_SOURCE_DIR}/doc/Doxyfile.in diff -r 3ab825f5fab0 -r 60c0c3ed8d11 doc/Doxyfile.in --- a/doc/Doxyfile.in Wed Dec 19 15:37:12 2012 +0100 +++ b/doc/Doxyfile.in Wed Dec 19 15:37:12 2012 +0100 @@ -182,8 +182,8 @@ EXT_LINKS_IN_WINDOW = NO FORMULA_FONTSIZE = 10 FORMULA_TRANSPARENT = YES -USE_MATHJAX = NO -MATHJAX_RELPATH = http://www.mathjax.org/mathjax +USE_MATHJAX = @LEMON_DOC_USE_MATHJAX@ +MATHJAX_RELPATH = @LEMON_DOC_MATHJAX_RELPATH@ SEARCHENGINE = YES SERVER_BASED_SEARCH = NO #---------------------------------------------------------------------------