docs/old-html/BuildHtmlHelp.cmake

   1 #
   2 # This file is part of the GROMACS molecular simulation package.
   3 #
   4 # Copyright (c) 2013,2014, by the GROMACS development team, led by
   5 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6 # and including many others, as listed in the AUTHORS file in the
   7 # top-level source directory and at http://www.gromacs.org.
   8 #
   9 # GROMACS is free software; you can redistribute it and/or
  10 # modify it under the terms of the GNU Lesser General Public License
  11 # as published by the Free Software Foundation; either version 2.1
  12 # of the License, or (at your option) any later version.
  13 #
  14 # GROMACS is distributed in the hope that it will be useful,
  15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 # Lesser General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU Lesser General Public
  20 # License along with GROMACS; if not, see
  21 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23 #
  24 # If you want to redistribute modifications to GROMACS, please
  25 # consider that scientific software is very special. Version
  26 # control is crucial - bugs must be traceable. We will be happy to
  27 # consider code for inclusion in the official distribution, but
  28 # derived work must not be called official GROMACS. Details are found
  29 # in the README & COPYING files - if they are missing, get the
  30 # official version at http://www.gromacs.org.
  31 #
  32 # To help us fund GROMACS development, we humbly ask that you cite
  33 # the research papers on the package. Check out http://www.gromacs.org.
  34
  35 if (NOT DEFINED OUTPUT_DIR OR NOT DEFINED SOURCE_HTML_DIR)
  36     message(FATAL_ERROR "Required input parameter not set")
  37 endif()
  38
  39 function(PRE_EXPORT_ACTIONS)
  40     file(MAKE_DIRECTORY ${OUTPUT_DIR})
  41     file(MAKE_DIRECTORY ${OUTPUT_DIR}/programs)
  42     file(COPY ${SOURCE_HTML_DIR}/header.html.in DESTINATION .)
  43     file(COPY ${SOURCE_HTML_DIR}/footer.html DESTINATION .)
  44     file(COPY ${SOURCE_HTML_DIR}/links.dat   DESTINATION .)
  45 endfunction()
  46
  47 function(POST_EXPORT_ACTIONS)
  48     # This is generated by gmx help -export html
  49     set(HEADER_FILE header.html)
  50     set(FOOTER_FILE ${SOURCE_HTML_DIR}/footer.html)
  51     file(READ ${HEADER_FILE} HEADER_TEXT)
  52     file(READ ${FOOTER_FILE} FOOTER_TEXT)
  53     set(_title_re "[Tt][Ii][Tt][Ll][Ee]")
  54
  55     function(CREATE_HTML_FILE SOURCE_FILE ROOTPATH)
  56         file(RELATIVE_PATH _rel_path ${SOURCE_HTML_DIR} ${SOURCE_FILE})
  57         file(READ ${SOURCE_FILE} _content)
  58         string(REGEX REPLACE "^ *<${_title_re}>(.*)</${_title_re}>\n" "" _content "${_content}")
  59         set(TITLE "${CMAKE_MATCH_1}")
  60         string(CONFIGURE "${HEADER_TEXT}" _header @ONLY)
  61         set(_content "${_header}${_content}${FOOTER_TEXT}")
  62         file(WRITE ${OUTPUT_DIR}/${_rel_path} "${_content}")
  63     endfunction()
  64
  65     create_html_file(${SOURCE_HTML_DIR}/online.html "")
  66     file(COPY ${SOURCE_HTML_DIR}/images DESTINATION ${OUTPUT_DIR})
  67     file(MAKE_DIRECTORY ${OUTPUT_DIR}/online)
  68     file(COPY ${SOURCE_HTML_DIR}/online/style.css DESTINATION ${OUTPUT_DIR}/online)
  69     file(GLOB _source_files ${SOURCE_HTML_DIR}/online/*.html)
  70     foreach(_file ${_source_files})
  71         create_html_file(${_file} "../")
  72     endforeach()
  73 endfunction()
  74
  75 if (STEP STREQUAL "PRE")
  76     pre_export_actions()
  77 elseif (STEP STREQUAL "POST")
  78     post_export_actions()
  79 else()
  80     message(FATAL_ERROR "Unknown parameter STEP=${STEP}")
  81 endif()