WSUG: Convert the "User Interface" chapter to AsciiDoc.

Add the "asciidoc.conf" compatibility configuration file from
Asciidoctor. Although we don't use Asciidoctor it gives us macros that
keep us from losing some useful DocBook elements. Update various CMake
files to support multiple AsciiDoc configuration files.

Leave most of the content intact for now. Hopefully the other chapters
aren't as laden with markup.

Change-Id: Id69757342b86abb2b3130cb61e90f5695a26ea8a
Reviewed-on: https://code.wireshark.org/review/3680
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>

2 files changed, 74 insertions, 41 deletions

diff --git a/cmake/modules/FindASCIIDOC.cmake b/cmake/modules/FindASCIIDOC.cmake
index 408f91e872..6850b43cf6 100644
--- a/cmake/modules/FindASCIIDOC.cmake
+++ b/cmake/modules/FindASCIIDOC.cmake
@@ -29,79 +29,113 @@ MARK_AS_ADVANCED(A2X_EXECUTABLE)
 MACRO( ASCIIDOC2HTML _output _asciidocsource _conffile )
     GET_FILENAME_COMPONENT( _source_base_name ${_asciidocsource} NAME_WE )
     set( A2X_HTML_OPTS --stylesheet=ws.css )
+
+    SET( A2X_HTML_OPTS --stylesheet=ws.css )
+    FOREACH( _conf_file ${_conf_files} )
+        SET( _conf_opts_list ${_conf_opts_list} --conf_file=${CMAKE_CURRENT_SOURCE_DIR}/${_conf_file} )
+    ENDFOREACH()
+    STRING( REPLACE ";" " _conf_opts "${_conf_opts_list} )
+
+    FOREACH( _conf_file ${_conf_files} )
+        SET( _conf_deps ${_conf_deps} ${CMAKE_CURRENT_SOURCE_DIR}/${_conf_file} )
+    ENDFOREACH()
+
     ADD_CUSTOM_COMMAND(
-	WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
         OUTPUT
             ${_output}
-	COMMAND ${A2X_EXECUTABLE}
-	    --format=xhtml
-	    --destination-dir=${CMAKE_CURRENT_BINARY_DIR}
-	    --asciidoc-opts="--conf-file=${CMAKE_CURRENT_SOURCE_DIR}/${_conffile}"
-	    --fop
-	    ${A2X_HTML_OPTS}
-	    ${_asciidocsource}
-	# Replacing file with itself will fail
-	# COMMAND mv
-	#     ${CMAKE_CURRENT_BINARY_DIR}/${_source_base_name}.html
-	#     ${CMAKE_CURRENT_BINARY_DIR}/${_output}
+        COMMAND ${A2X_EXECUTABLE}
+            --format=xhtml
+            --destination-dir=${CMAKE_CURRENT_BINARY_DIR}
+            --asciidoc-opts=${_conf_opts}
+            --fop
+            ${A2X_HTML_OPTS}
+            ${_asciidocsource}
+        # Replacing file with itself will fail
+        # COMMAND mv
+        #     ${CMAKE_CURRENT_BINARY_DIR}/${_source_base_name}.html
+        #     ${CMAKE_CURRENT_BINARY_DIR}/${_output}
         DEPENDS
             ${_asciidocsources}
+            ${_conf_deps}
             ${_otherdependencies}
     )
 ENDMACRO()
 
-MACRO( ASCIIDOC2TXT _output _asciidocsource _conffile )
+MACRO( ASCIIDOC2TXT _output _asciidocsource _conf_files )
     GET_FILENAME_COMPONENT( _source_base_name ${_asciidocsource} NAME_WE )
     if( LYNX_EXECUTABLE MATCHES lynx )
-	set( A2X_TEXT_OPTS --lynx )
+        set( A2X_TEXT_OPTS --lynx )
     else()
-	set( A2X_TEXT_OPTS  )
+        set( A2X_TEXT_OPTS  )
     endif()
+
+    SET( A2X_HTML_OPTS --stylesheet=ws.css )
+    FOREACH( _conf_file ${_conf_files} )
+        SET( _conf_opts_list ${_conf_opts_list} --conf_file=${CMAKE_CURRENT_SOURCE_DIR}/${_conf_file} )
+    ENDFOREACH()
+    STRING( REPLACE ";" " _conf_opts "${_conf_opts_list} )
+
+    FOREACH( _conf_file ${_conf_files} )
+        SET( _conf_deps ${_conf_deps} ${CMAKE_CURRENT_SOURCE_DIR}/${_conf_file} )
+    ENDFOREACH()
+
     ADD_CUSTOM_COMMAND(
-	WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
         OUTPUT
             ${_output}
         COMMAND ${A2X_EXECUTABLE}
             --format=text
-	    --destination-dir=${CMAKE_CURRENT_BINARY_DIR}
-	    --asciidoc-opts="--conf-file=${CMAKE_CURRENT_SOURCE_DIR}/${_conffile}"
-	    --fop
+            --destination-dir=${CMAKE_CURRENT_BINARY_DIR}
+            --asciidoc-opts=${_conf_opts}
+            --fop
             ${A2X_TEXT_OPTS}
             --xsltproc-opts '--stringparam generate.toc "article nop"'
             ${_asciidocsource}
-	COMMAND mv
-	    ${CMAKE_CURRENT_BINARY_DIR}/${_source_base_name}.text
-	    ${CMAKE_CURRENT_BINARY_DIR}/${_output}
+        COMMAND mv
+            ${CMAKE_CURRENT_BINARY_DIR}/${_source_base_name}.text
+            ${CMAKE_CURRENT_BINARY_DIR}/${_output}
         DEPENDS
             ${_asciidocsource}
-            ${_conffile}
+            ${_conf_deps}
     )
 ENDMACRO()
 
 # news: release-notes.txt
 #         cp release-notes.txt ../NEWS
 
-MACRO( ASCIIDOC2PDF _output _asciidocsource _conffile _paper )
+MACRO( ASCIIDOC2PDF _output _asciidocsource _conf_files _paper )
     GET_FILENAME_COMPONENT( _source_base_name ${_asciidocsource} NAME_WE )
-    set( A2X_HTML_OPTS --stylesheet=ws.css )
+
+    SET( A2X_HTML_OPTS --stylesheet=ws.css )
+    FOREACH( _conf_file ${_conf_files} )
+        SET( _conf_opts_list ${_conf_opts_list} --conf_file=${CMAKE_CURRENT_SOURCE_DIR}/${_conf_file} )
+    ENDFOREACH()
+    STRING( REPLACE ";" " _conf_opts "${_conf_opts_list} )
+
+    FOREACH( _conf_file ${_conf_files} )
+        SET( _conf_deps ${_conf_deps} ${CMAKE_CURRENT_SOURCE_DIR}/${_conf_file} )
+    ENDFOREACH()
+
     ADD_CUSTOM_COMMAND(
-	WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
         OUTPUT
             ${_output}
-	COMMAND ${A2X_EXECUTABLE}
-	    --format=pdf
-	    --destination-dir=${CMAKE_CURRENT_BINARY_DIR}
-	    --asciidoc-opts="--conf-file=${CMAKE_CURRENT_SOURCE_DIR}/${_conffile}"
-	    --fop
-	    ${A2X_HTML_OPTS}
-	    --xsltproc-opts "--stringparam paper.type ${_paper} --nonet"
-	    --xsl-file=custom_layer_pdf.xsl
-	    ${_asciidocsource}
-	COMMAND mv
-	    ${CMAKE_CURRENT_BINARY_DIR}/${_source_base_name}.pdf
-	    ${CMAKE_CURRENT_BINARY_DIR}/${_output}
+        COMMAND ${A2X_EXECUTABLE}
+            --format=pdf
+            --destination-dir=${CMAKE_CURRENT_BINARY_DIR}
+            --asciidoc-opts=${_conf_opts}
+            --fop
+            ${A2X_HTML_OPTS}
+            --xsltproc-opts "--stringparam paper.type ${_paper} --nonet"
+            --xsl-file=custom_layer_pdf.xsl
+            ${_asciidocsource}
+        COMMAND mv
+            ${CMAKE_CURRENT_BINARY_DIR}/${_source_base_name}.pdf
+            ${CMAKE_CURRENT_BINARY_DIR}/${_output}
         DEPENDS
             ${_asciidocsources}
+            ${_conf_deps}
             ${_otherdependencies}
     )
 ENDMACRO()
diff --git a/cmake/modules/FindXSLTPROC.cmake b/cmake/modules/FindXSLTPROC.cmake
index eef8d3693f..875809b6c0 100644
--- a/cmake/modules/FindXSLTPROC.cmake
+++ b/cmake/modules/FindXSLTPROC.cmake
@@ -69,7 +69,7 @@ MACRO(XML2HTML _validated _output _mode _xmlsources _gfxsources)
             -E copy ${CMAKE_CURRENT_SOURCE_DIR}/ws.css ${_OUTDIR}
         COMMAND ${XSLTPROC_EXECUTABLE}
             --path "${CMAKE_CURRENT_SOURCE_DIR}:${CMAKE_CURRENT_BINARY_DIR}:${CMAKE_CURRENT_BINARY_DIR}/wsluarm_src"
-            --stringparam img.src.path ${CMAKE_CURRENT_SOURCE_DIR}
+            --stringparam img.src.path ${CMAKE_CURRENT_SOURCE_DIR}/
             --stringparam base.dir ${_OUTDIR}/
             --stringparam use.id.as.filename 1
             --stringparam admon.graphics 1
@@ -109,7 +109,7 @@ MACRO(XML2PDF _output _sources _stylesheet _paper)
         COMMAND ${XSLTPROC_EXECUTABLE}
             --path "${CMAKE_CURRENT_SOURCE_DIR}:${CMAKE_CURRENT_BINARY_DIR}:${CMAKE_CURRENT_BINARY_DIR}/wsluarm_src"
             --stringparam paper.type ${_paper}
-            --stringparam img.src.path ${CMAKE_CURRENT_SOURCE_DIR}
+            --stringparam img.src.path ${CMAKE_CURRENT_SOURCE_DIR}/
             --stringparam base.dir ${_OUTDIR}/
             --stringparam use.id.as.filename 1
             --stringparam admon.graphics 1
@@ -126,4 +126,3 @@ MACRO(XML2PDF _output _sources _stylesheet _paper)
             ${_stylesheet}
     )
 ENDMACRO(XML2PDF)
-