Use MathJax for rendering the math formulae (#455)
authorAlpar Juttner <alpar@cs.elte.hu>
Wed, 19 Dec 2012 15:37:12 +0100
changeset 120860c0c3ed8d11
parent 1207 3ab825f5fab0
child 1209 0b0327c9b3ef
Use MathJax for rendering the math formulae (#455)
INSTALL
doc/CMakeLists.txt
doc/Doxyfile.in
     1.1 --- a/INSTALL	Wed Dec 19 15:37:12 2012 +0100
     1.2 +++ b/INSTALL	Wed Dec 19 15:37:12 2012 +0100
     1.3 @@ -106,6 +106,34 @@
     1.4    Build shared library instead of static one. Think twice if you
     1.5    really want to use this option.
     1.6  
     1.7 +-DLEMON_DOC_SOURCE_BROWSER=YES
     1.8 +
     1.9 +  Include the browsable cross referenced LEMON source code into the
    1.10 +  doc. It makes the doc quite bloated, but may be useful for
    1.11 +  developing LEMON itself.
    1.12 +
    1.13 +-DLEMON_DOC_USE_MATHJAX=YES
    1.14 +
    1.15 +  Use MathJax (http://mathjax.org) for rendering the math formulae in
    1.16 +  the doc.  It of much higher quality compared to the default LaTeX
    1.17 +  generated static images and it allows copy&paste of the formulae to
    1.18 +  LaTeX, Open Office, MS Word etc. documents.
    1.19 +
    1.20 +  On the other hand, it needs either Internet access or a locally
    1.21 +  installed version of MathJax to properly render the doc.
    1.22 +
    1.23 +-DLEMON_DOC_MATHJAX_RELPATH=DIRECTORY
    1.24 +  
    1.25 +  The location of the MathJax library. It defaults to
    1.26 +  http://www.mathjax.org/mathjax, which necessitates Internet access
    1.27 +  for proper rendering. The easiest way to make it usable offline is
    1.28 +  to set this parameter to 'mathjax' and copy all files of the MathJax
    1.29 +  library into the 'doc/html/mathjax' subdirectory of the build
    1.30 +  location.
    1.31 +
    1.32 +  See http://docs.mathjax.org/en/latest/installation.html for more details.
    1.33 +
    1.34 +  
    1.35  -DGLPK_ROOT_DIR=DIRECTORY
    1.36  -DCOIN_ROOT_DIR=DIRECTORY
    1.37  -DCPLEX_ROOT_DIR=DIRECTORY
     2.1 --- a/doc/CMakeLists.txt	Wed Dec 19 15:37:12 2012 +0100
     2.2 +++ b/doc/CMakeLists.txt	Wed Dec 19 15:37:12 2012 +0100
     2.3 @@ -4,6 +4,8 @@
     2.4  SET(abs_top_builddir ${PROJECT_BINARY_DIR})
     2.5  
     2.6  SET(LEMON_DOC_SOURCE_BROWSER "NO" CACHE STRING "Include source into the doc (YES/NO).")
     2.7 +SET(LEMON_DOC_USE_MATHJAX "NO" CACHE STRING "Use MathJax to display math formulae (YES/NO).")
     2.8 +SET(LEMON_DOC_MATHJAX_RELPATH "http://www.mathjax.org/mathjax" CACHE STRING "MathJax library location.")
     2.9  
    2.10  CONFIGURE_FILE(
    2.11    ${PROJECT_SOURCE_DIR}/doc/Doxyfile.in
     3.1 --- a/doc/Doxyfile.in	Wed Dec 19 15:37:12 2012 +0100
     3.2 +++ b/doc/Doxyfile.in	Wed Dec 19 15:37:12 2012 +0100
     3.3 @@ -182,8 +182,8 @@
     3.4  EXT_LINKS_IN_WINDOW    = NO
     3.5  FORMULA_FONTSIZE       = 10
     3.6  FORMULA_TRANSPARENT    = YES
     3.7 -USE_MATHJAX            = NO
     3.8 -MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
     3.9 +USE_MATHJAX            = @LEMON_DOC_USE_MATHJAX@
    3.10 +MATHJAX_RELPATH        = @LEMON_DOC_MATHJAX_RELPATH@
    3.11  SEARCHENGINE           = YES
    3.12  SERVER_BASED_SEARCH    = NO
    3.13  #---------------------------------------------------------------------------