diff options
| author | Gerald Combs <gerald@wireshark.org> | 2021-06-22 14:42:09 -0700 |
|---|---|---|
| committer | Wireshark GitLab Utility <gerald+gitlab-utility@wireshark.org> | 2021-06-23 05:28:55 +0000 |
| commit | cdd6f2ec801a11e045b766eead04241230f7eb41 (patch) | |
| tree | ab9eb84f4ed2bb6f939df105994dfc2445dd98d3 /docbook/wsdg_src | |
| parent | 701d0565c5efe828817f37edee1fc519c702c456 (diff) | |
| download | wireshark-cdd6f2ec801a11e045b766eead04241230f7eb41.tar.gz wireshark-cdd6f2ec801a11e045b766eead04241230f7eb41.tar.bz2 wireshark-cdd6f2ec801a11e045b766eead04241230f7eb41.zip | |
CMake+docs: Use Asciidoctor.js if it's available.
Add the executables shipped by the Asciidoctor.js project to
FindAsciidoctor.cmake, and update the Developer's Guide to match.
Diffstat (limited to 'docbook/wsdg_src')
| -rw-r--r-- | docbook/wsdg_src/WSDG_chapter_quick_setup.adoc | 2 | ||||
| -rw-r--r-- | docbook/wsdg_src/WSDG_chapter_tools.adoc | 11 |
2 files changed, 5 insertions, 8 deletions
diff --git a/docbook/wsdg_src/WSDG_chapter_quick_setup.adoc b/docbook/wsdg_src/WSDG_chapter_quick_setup.adoc index f3f7ec33db..9cc39ebed4 100644 --- a/docbook/wsdg_src/WSDG_chapter_quick_setup.adoc +++ b/docbook/wsdg_src/WSDG_chapter_quick_setup.adoc @@ -345,7 +345,7 @@ Chocolatey ensures cmake.exe is on your path. ==== Install Asciidoctor, Xsltproc, And DocBook -https://asciidoctor.org/[Asciidoctor] can be run directly as a Ruby script or via a Java wrapper (AsciidoctorJ). +https://asciidoctor.org/[Asciidoctor] can be run directly as a Ruby script or via a Java wrapper (AsciidoctorJ) or JavaScript (Asciidoctor.js). It is used in conjunction with Xsltproc and DocBook to generate the documentation you're reading and the User’s Guide. You can install AsciidoctorJ, Xsltproc, and DocBook using Chocolatey. diff --git a/docbook/wsdg_src/WSDG_chapter_tools.adoc b/docbook/wsdg_src/WSDG_chapter_tools.adoc index 1e8c84d65b..7949646f31 100644 --- a/docbook/wsdg_src/WSDG_chapter_tools.adoc +++ b/docbook/wsdg_src/WSDG_chapter_tools.adoc @@ -472,18 +472,15 @@ Release notes text:: Asciidoctor → _HTML_ → html2text.py ==== Asciidoctor -https://asciidoctor.org/[Asciidoctor] comes in several flavors: a Ruby -gem (Asciidoctor), a Java bundle (AsciidoctorJ), and transpiled -JavaScript (Asciidoctor.js). Only the Asciidoctor and AsciidoctorJ -flavors are supported for building the Wireshark documentation and -AsciidoctorJ is recommended. +https://asciidoctor.org/[Asciidoctor] comes in several flavors: a Ruby gem (Asciidoctor), a Java bundle (AsciidoctorJ), and transpiled JavaScript (Asciidoctor.js). +Any of them can be used to build Wireshark’s documentation. The guides and release notes were originally written in DocBook (hence the directory name). They were later converted to AsciiDoc and then migrated to Asciidoctor. We currently use Asciidoctor’s modern (>= 1.5.0) syntax. -PDF output requires Asciidoctor PDF. It is included with AsciidoctorJ -but _not_ with Asciidoctor. +PDF output requires Asciidoctor’s PDF backend. +It is included with AsciidoctorJ and Asciidoctor.js but _not_ with Asciidoctor. ==== DocBook XML and XSL |