mirror of
https://github.com/Unidata/netcdf-c.git
synced 2024-11-21 03:13:42 +08:00
Merging Jen's new search option for releases into user documentation.
This commit is contained in:
Ward Fisher
parent
e75678cd33
commit
b26598c833
@ -873,12 +873,21 @@ IF(ENABLE_DOXYGEN)
|
||||
SET(BUILD_INTERNAL_DOCS NO CACHE STRING "")
|
||||
ENDIF()
|
||||
|
||||
OPTION(DOXYGEN_ENABLE_SERVER_SIDE_SEARCH "Enable doxygen server-side search. This is of interest to developers only." OFF)
|
||||
IF(DOXYGEN_ENABLE_SERVER_SIDE_SEARCH)
|
||||
SET(SERVER_SIDE_SEARCH YES CACHE STRING "")
|
||||
###
|
||||
#
|
||||
# If we are building release documentation, we need to set some
|
||||
# variables that will be used in the Doxygen.in template.
|
||||
###
|
||||
OPTION(ENABLE_DOXYGEN_BUILD_RELEASE_DOCS "Build release documentation. This is of interest only to the netCDF developers." OFF)
|
||||
IF(ENABLE_DOXYGEN_BUILD_RELEASE_DOCS)
|
||||
SET(DOXYGEN_CSS_FILE "${CMAKE_SOURCE_DIR}/docs/release.css" CACHE STRING "")
|
||||
SET(DOXYGEN_HEADER_FILE "${CMAKE_SOURCE_DIR}/docs/release_header.html" CACHE STRING "")
|
||||
SET(DOXYGEN_SEARCHENGINE "NO" CACHE STRING "")
|
||||
ELSE()
|
||||
SET(SERVER_SIDE_SEARCH NO CACHE STRING "")
|
||||
ENDIF()
|
||||
SET(DOXYGEN_CSS_FILE "" CACHE STRING "")
|
||||
SET(DOXYGEN_HEADER_FILE "" CACHE STRING "")
|
||||
SET(DOXYGEN_SEARCHENGINE "YES" CACHE STRING "")
|
||||
ENDIF(ENABLE_DOXYGEN_BUILD_RELEASE_DOCS)
|
||||
# Option to turn on the TODO list in the doxygen-generated documentation.
|
||||
OPTION(DOXYGEN_ENABLE_TASKS "Turn on test, todo, bug lists in documentation. This is of interest to developers only." OFF)
|
||||
IF(DOXYGEN_ENABLE_TASKS)
|
||||
@ -920,7 +929,7 @@ ENDIF()
|
||||
# Set some of the options as advanced.
|
||||
MARK_AS_ADVANCED(ENABLE_INTERNAL_DOCS VALGRIND_TESTS ENABLE_PNETCDF ENABLE_COVERAGE_TESTS)
|
||||
MARK_AS_ADVANCED(ENABLE_DAP_REMOTE_TESTS ENABLE_DAP_LONG_TESTS USE_REMOTE_CDASH)
|
||||
MARK_AS_ADVANCED(DOXYGEN_ENABLE_SERVER_SIDE_SEARCH DOXYGEN_ENABLE_TASKS)
|
||||
MARK_AS_ADVANCED(ENABLE_DOXYGEN_BUILD_RELEASE_DOCS DOXYGEN_ENABLE_TASKS)
|
||||
################################
|
||||
# Option checks
|
||||
################################
|
||||
|
||||
@ -1096,7 +1096,7 @@ HTML_FILE_EXTENSION = .html
|
||||
# of the possible markers and block names see the documentation.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_HEADER = header.html
|
||||
HTML_HEADER = docs/extra_header.html
|
||||
|
||||
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
|
||||
# generated HTML page. If the tag is left blank doxygen will generate a standard
|
||||
@ -1129,7 +1129,7 @@ HTML_STYLESHEET =
|
||||
# see the documentation.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_EXTRA_STYLESHEET = extra.css
|
||||
HTML_EXTRA_STYLESHEET = docs/extra.css
|
||||
|
||||
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
|
||||
# other source files which should be copied to the HTML output directory. Note
|
||||
|
||||
@ -7,6 +7,8 @@ IF(ENABLE_DOXYGEN)
|
||||
FILE(GLOB COPY_FILES ${CMAKE_CURRENT_SOURCE_DIR}/*.html ${CMAKE_CURRENT_SOURCE_DIR}/images ${CMAKE_CURRENT_SOURCE_DIR}/*.doc ${CMAKE_CURRENT_SOURCE_DIR}/*.xml ${CMAKE_CURRENT_SOURCE_DIR}/*.m4 ${CMAKE_CURRENT_SOURCE_DIR}/*.texi)
|
||||
FILE(COPY ${COPY_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/)
|
||||
|
||||
|
||||
|
||||
# Set abs_top_srcdir to work with the autotools
|
||||
# doxyfile template.
|
||||
SET(abs_top_srcdir ${CMAKE_SOURCE_DIR})
|
||||
@ -16,7 +18,6 @@ IF(ENABLE_DOXYGEN)
|
||||
CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
|
||||
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
|
||||
|
||||
|
||||
# Create auth.md by combining auth.md.in and oc2/ocauth.md
|
||||
|
||||
ADD_CUSTOM_TARGET(auth_doc ALL
|
||||
|
||||
@ -1120,7 +1120,7 @@ HTML_FILE_EXTENSION = .html
|
||||
# of the possible markers and block names see the documentation.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_HEADER =
|
||||
HTML_HEADER = @DOXYGEN_HEADER_FILE@
|
||||
|
||||
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
|
||||
# generated HTML page. If the tag is left blank doxygen will generate a standard
|
||||
@ -1142,7 +1142,7 @@ HTML_FOOTER = @abs_top_srcdir@/docs/footer.html
|
||||
# obsolete.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_STYLESHEET =
|
||||
HTML_STYLESHEET = @DOXYGEN_CSS_FILE@
|
||||
|
||||
# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
|
||||
# defined cascading style sheet that is included after the standard style sheets
|
||||
@ -1550,7 +1550,7 @@ MATHJAX_CODEFILE =
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
SEARCHENGINE = YES
|
||||
SEARCHENGINE = @DOXYGEN_SEARCHENGINE@
|
||||
|
||||
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
|
||||
# implemented using a web server instead of a web client using Javascript. There
|
||||
@ -1562,7 +1562,7 @@ SEARCHENGINE = YES
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag SEARCHENGINE is set to YES.
|
||||
|
||||
SERVER_BASED_SEARCH = @SERVER_SIDE_SEARCH@
|
||||
SERVER_BASED_SEARCH = NO
|
||||
|
||||
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
|
||||
# script for searching. Instead the search results are written to an XML file
|
||||
|
||||
29
docs/release.css
Normal file
29
docs/release.css
Normal file
@ -0,0 +1,29 @@
|
||||
.tabs {
|
||||
width: 100% !important;
|
||||
}
|
||||
|
||||
.tabs ul.tablist {
|
||||
width: 100% !important;
|
||||
}
|
||||
|
||||
.tabs ul.tablist li.linkMenu select#versions {
|
||||
vertical-align: middle;
|
||||
height: ;
|
||||
margin: 8px 0 0 10px !important;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
.tabs ul.tablist li.searchForm {
|
||||
float: right;
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.tabs ul.tablist li.searchForm form#cse-search-box {
|
||||
float: right;
|
||||
margin: 8px 10px 0 0;
|
||||
}
|
||||
.tabs ul.tablist li.searchForm form#cse-search-box input#search {
|
||||
border-radius: 5px;
|
||||
margin: 0 5px 0 0;
|
||||
}
|
||||
@ -17,32 +17,32 @@ $mathjax
|
||||
$extrastylesheet
|
||||
<script type="text/javascript">
|
||||
$( document ).ready(function() {
|
||||
var $searchForm = "<form name=\"google\" action=\"http://www.unidata.ucar.edu/search.jsp\" id=\"cse-search-box\">" +
|
||||
" <input type=\"hidden\" name=\"locationName\" value=\"NetCDF Documentation\"></input>" +
|
||||
" <input type=\"hidden\" name=\"hq\" value=\"site:www.unidata.ucar.edu/software/netcdf/docs\"></input>" +
|
||||
" <input type=\"hidden\" name=\"cx\" value=\"008424664622949020059:afj38jxaljc\"></input>" +
|
||||
var $searchForm = "<form name=\"google\" action=\"http://www.unidata.ucar.edu/search.jsp\" id=\"cse-search-box\">" +
|
||||
" <input type=\"hidden\" name=\"locationName\" value=\"NetCDF Documentation\"></input>" +
|
||||
" <input type=\"hidden\" name=\"hq\" value=\"site:www.unidata.ucar.edu/software/netcdf/docs\"></input>" +
|
||||
" <input type=\"hidden\" name=\"cx\" value=\"008424664622949020059:afj38jxaljc\"></input>" +
|
||||
" <input type=\"hidden\" name=\"cof\" value=\"FORID:9\"></input>" +
|
||||
" <input type=\"hidden\" name=\"ie\" value=\"UTF-8\"></input>" +
|
||||
" <input type=\"text\" autocomplete=\"on\" name=\"q\" maxlength=\"255\" id=\"search\"></input>" +
|
||||
" <input type=\"submit\" name=\"sa\" value=\"search\" id=\"form_submit\"></input>" +
|
||||
"</form>";
|
||||
" <input type=\"hidden\" name=\"ie\" value=\"UTF-8\"></input>" +
|
||||
" <input type=\"text\" autocomplete=\"on\" name=\"q\" maxlength=\"255\" id=\"search\"></input>" +
|
||||
" <input type=\"submit\" name=\"sa\" value=\"search\" id=\"form_submit\"></input>" +
|
||||
"</form>";
|
||||
|
||||
var $linkMenu = "<select id=\"versions\">" +
|
||||
" <option value=\"http://www.unidata.ucar.edu\">$projectnumber</option>" +
|
||||
" <option value=\"http://www.unidata.ucar.edu/software/netcdf\">some other project number</option>" +
|
||||
"</select>";
|
||||
var $linkMenu = "<select id=\"versions\">" +
|
||||
" <option value=\"http://www.unidata.ucar.edu\">$projectnumber</option>" +
|
||||
" <option value=\"http://www.unidata.ucar.edu/software/netcdf\">some other project number</option>" +
|
||||
"</select>";
|
||||
|
||||
$("#navrow1 ul.tablist").append('<li class=\"linkMenu\"><span class="tab">' + $linkMenu + '</span></li>');
|
||||
$("#navrow1 ul.tablist").append('<li class=\"searchForm\"><span class="tab">' + $searchForm + '</span></li>');
|
||||
$("#navrow1 ul.tablist").append('<li class=\"linkMenu\"><span class="tab">' + $linkMenu + '</span></li>');
|
||||
$("#navrow1 ul.tablist").append('<li class=\"searchForm\"><span class="tab">' + $searchForm + '</span></li>');
|
||||
|
||||
$("#versions").change(function() {
|
||||
window.location.href = $(this).val();
|
||||
});
|
||||
$("#versions").change(function() {
|
||||
window.location.href = $(this).val();
|
||||
});
|
||||
});
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
|
||||
<!--BEGIN TITLEAREA-->
|
||||
<div id="titlearea">
|
||||
Loading…
Reference in New Issue
Block a user