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.
This commit is contained in:
parent
701d0565c5
commit
cdd6f2ec80
|
@ -11,6 +11,10 @@ FIND_PROGRAM(ASCIIDOCTOR_EXECUTABLE
|
||||||
asciidoctorj
|
asciidoctorj
|
||||||
asciidoctor
|
asciidoctor
|
||||||
asciidoctor.ruby2.1
|
asciidoctor.ruby2.1
|
||||||
|
# Asciidoctor.js releases
|
||||||
|
asciidoctor-linux
|
||||||
|
asciidoctor-macos
|
||||||
|
asciidoctor-win
|
||||||
PATHS
|
PATHS
|
||||||
/bin
|
/bin
|
||||||
/usr/bin
|
/usr/bin
|
||||||
|
|
|
@ -345,7 +345,7 @@ Chocolatey ensures cmake.exe is on your path.
|
||||||
|
|
||||||
==== Install Asciidoctor, Xsltproc, And DocBook
|
==== 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.
|
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.
|
You can install AsciidoctorJ, Xsltproc, and DocBook using Chocolatey.
|
||||||
|
|
|
@ -472,18 +472,15 @@ Release notes text:: Asciidoctor → _HTML_ → html2text.py
|
||||||
|
|
||||||
==== Asciidoctor
|
==== Asciidoctor
|
||||||
|
|
||||||
https://asciidoctor.org/[Asciidoctor] comes in several flavors: a Ruby
|
https://asciidoctor.org/[Asciidoctor] comes in several flavors: a Ruby gem (Asciidoctor), a Java bundle (AsciidoctorJ), and transpiled JavaScript (Asciidoctor.js).
|
||||||
gem (Asciidoctor), a Java bundle (AsciidoctorJ), and transpiled
|
Any of them can be used to build Wireshark’s documentation.
|
||||||
JavaScript (Asciidoctor.js). Only the Asciidoctor and AsciidoctorJ
|
|
||||||
flavors are supported for building the Wireshark documentation and
|
|
||||||
AsciidoctorJ is recommended.
|
|
||||||
|
|
||||||
The guides and release notes were originally written in DocBook (hence the directory name).
|
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.
|
They were later converted to AsciiDoc and then migrated to Asciidoctor.
|
||||||
We currently use Asciidoctor’s modern (>= 1.5.0) syntax.
|
We currently use Asciidoctor’s modern (>= 1.5.0) syntax.
|
||||||
|
|
||||||
PDF output requires Asciidoctor PDF. It is included with AsciidoctorJ
|
PDF output requires Asciidoctor’s PDF backend.
|
||||||
but _not_ with Asciidoctor.
|
It is included with AsciidoctorJ and Asciidoctor.js but _not_ with Asciidoctor.
|
||||||
|
|
||||||
==== DocBook XML and XSL
|
==== DocBook XML and XSL
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue