mirror of
https://github.com/saitohirga/WSJT-X.git
synced 2025-10-08 08:17:55 -04:00
c197d216b3
These documentation source files are not the one true version, just a copy for testing purposes. DO NOT EDIT THESE FILES. To use this on Windows you will need a working asciidoc installation and the path to it must be included in your CMAKE_PREFIX_PATH (probably via a local CMake tool chain file). At the time of writing the official asciidoc package does not work on Windows. The latest development master does however work, it can be downloaded as a snapshot ZIP archive from here: https://github.com/asciidoc/asciidoc/archive/master.zip git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5316 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
133 lines
4.5 KiB
CMake
133 lines
4.5 KiB
CMake
set (UG_SRCS
|
|
user_guide/acknowledgements.adoc
|
|
user_guide/install-from-source.adoc
|
|
user_guide/rig-config-drake.adoc
|
|
user_guide/settings-radio.adoc
|
|
user_guide/compiling.adoc
|
|
user_guide/install-linux.adoc
|
|
user_guide/rig-config-elecraft.adoc
|
|
user_guide/settings-reporting.adoc
|
|
user_guide/config-details.adoc
|
|
user_guide/install-mac.adoc
|
|
user_guide/rig-config-flexrad.adoc
|
|
user_guide/settings-txmacros.adoc
|
|
user_guide/controls-functions-center.adoc
|
|
user_guide/install-windows.adoc
|
|
user_guide/rig-config-icom.adoc
|
|
user_guide/system-requirements.adoc
|
|
user_guide/controls-functions-left.adoc
|
|
user_guide/introduction.adoc
|
|
user_guide/rig-config-kenwood.adoc
|
|
user_guide/transceiver-setup.adoc
|
|
user_guide/controls-functions-main-window.adoc
|
|
user_guide/jt65-jt9-differences.adoc
|
|
user_guide/rig-config-main.adoc
|
|
user_guide/tutorial-example1.adoc
|
|
user_guide/controls-functions-menus.adoc
|
|
user_guide/jt65-protocol.adoc
|
|
user_guide/rig-config-softrock.adoc
|
|
user_guide/tutorial-example2.adoc
|
|
user_guide/controls-functions-messages.adoc
|
|
user_guide/jt9-protocol.adoc
|
|
user_guide/rig-config-template.adoc
|
|
user_guide/tutorial-main-window.adoc
|
|
user_guide/controls-functions-status-bar.adoc
|
|
user_guide/make-qso.adoc
|
|
user_guide/rig-config-tentec.adoc
|
|
user_guide/tutorial-wide-graph-settings.adoc
|
|
user_guide/controls-functions-wide-graph.adoc
|
|
user_guide/platform-dependencies.adoc
|
|
user_guide/rig-config-yaesu.adoc
|
|
user_guide/tx-rx.adoc
|
|
user_guide/coop-prgrms.adoc
|
|
user_guide/rig-config-adat.adoc
|
|
user_guide/settings-audio.adoc
|
|
user_guide/utilities.adoc
|
|
user_guide/faq.adoc
|
|
user_guide/rig-config-alinco.adoc
|
|
user_guide/settings-frequencies.adoc
|
|
user_guide/wsjtx-main.adoc
|
|
user_guide/font-sizes.adoc
|
|
user_guide/rig-config-aor.adoc
|
|
user_guide/settings-general.adoc
|
|
)
|
|
|
|
set (UG_IMGS
|
|
user_guide/images/130610_2343-wav-80.png
|
|
user_guide/images/freemsg.png
|
|
user_guide/images/misc-main-ui.png
|
|
user_guide/images/r4148-rpt-ui.png
|
|
user_guide/images/status-bar-a.png
|
|
user_guide/images/MacAppMenu.png
|
|
user_guide/images/help-menu.png
|
|
user_guide/images/mode-menu.png
|
|
user_guide/images/r4148-txmac-ui.png
|
|
user_guide/images/traditional-msg-box.png
|
|
user_guide/images/RadioTab.png
|
|
user_guide/images/keyboard-shortcuts.png
|
|
user_guide/images/new-msg-box.png
|
|
user_guide/images/save-menu.png
|
|
user_guide/images/tx-macros.png
|
|
user_guide/images/band-settings.png
|
|
user_guide/images/log-qso.png
|
|
user_guide/images/r3666-config-screen-80.png
|
|
user_guide/images/settings-audio.png
|
|
user_guide/images/view-menu.png
|
|
user_guide/images/decode-menu.png
|
|
user_guide/images/main-ui-1.4.png
|
|
user_guide/images/r3666-main-ui-80.png
|
|
user_guide/images/settings-ui.png
|
|
user_guide/images/wide-graph-controls.png
|
|
user_guide/images/decodes.png
|
|
user_guide/images/main-ui-controls.png
|
|
user_guide/images/r4148-cat-ui.png
|
|
user_guide/images/setup-menu.png
|
|
user_guide/images/file-menu.png
|
|
user_guide/images/misc-controls-center.png
|
|
user_guide/images/r4148-freq-ui.png
|
|
user_guide/images/special-mouse-commands.png
|
|
)
|
|
|
|
find_program (ASCIIDOC NAMES asciidoc asciidoc.py)
|
|
if (NOT ASCIIDOC)
|
|
message (FATAL_ERROR "Asciidoc is required to build the documentation")
|
|
endif (NOT ASCIIDOC)
|
|
|
|
include (CMakeParseArguments)
|
|
|
|
# generate an HTML document from asciidoc text files(s)
|
|
#
|
|
# HTML - variable for output file ${CMAKE_CURRENT_BINARY_DIR}/`$basename ${SOURCE}`.html
|
|
# SOURCE - top level asciidoc file
|
|
# ASCIIDOC_OPTIONS - asciidoc command options
|
|
# DEPENDS - dependent files
|
|
function (html_document)
|
|
cmake_parse_arguments (args "" "SOURCE;HTML" "ASCIIDOC_OPTIONS;DEPENDS" ${ARGN})
|
|
get_filename_component (_output_name_we ${args_SOURCE} NAME_WE)
|
|
get_filename_component (_path ${args_SOURCE} PATH)
|
|
set (_xml_file ${CMAKE_CURRENT_BINARY_DIR}/${_output_name_we}.xml)
|
|
set (_doc_file ${CMAKE_CURRENT_BINARY_DIR}/${_output_name_we}.html)
|
|
add_custom_command (
|
|
OUTPUT ${_doc_file} ${_xml_file}
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/${path}
|
|
COMMAND ${ASCIIDOC} ARGS ${args_ASCIIDOC_OPTIONS} -o ${CMAKE_CURRENT_BINARY_DIR}/${_output_name_we}.html ${args_SOURCE}
|
|
DEPENDS ${args_DEPENDS}
|
|
COMMENT "Generating ${_doc_file}"
|
|
)
|
|
set (${args_HTML} ${_doc_file} PARENT_SCOPE)
|
|
endfunction (html_document)
|
|
|
|
html_document(
|
|
HTML user_guide
|
|
SOURCE user_guide/wsjtx-main.adoc
|
|
ASCIIDOC_OPTIONS -a data-uri -a toc2 -a max-width=1024px -b xhtml11
|
|
DEPENDS ${UG_SRCS} ${UG_IMGS}
|
|
)
|
|
add_custom_target (docs ALL DEPENDS ${user_guide})
|
|
|
|
install (FILES
|
|
${user_guide}
|
|
DESTINATION ${WSJT_SHARE_DESTINATION}/${WSJT_DOC_DESTINATION}
|
|
#COMPONENT runtime
|
|
)
|