aboutsummaryrefslogtreecommitdiffstats
path: root/docbook/asciidoctor-asciidoc.conf
AgeCommit message (Collapse)AuthorFilesLines
2018-02-11Switch from AsciiDoc to Asciidoctor.Gerald Combs1-401/+0
Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-04Docs: Make our AsciiDoc markup more compatible with AsciiDoctor.Gerald Combs1-0/+1
Start using markup that is preferred by Asciidoctor but compatible with both generators. Add a missing "cpp" attribute and set a couple of Asciidoctor-specific compatibility attributes. Change-Id: Iff4c31362e4493b97a85f46db2c39b18c336536f Reviewed-on: https://code.wireshark.org/review/25600 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-08-23Update the AsciiDoc button macro name.Gerald Combs1-2/+2
Change the name of the button macro to "btn" in order to be compatible with AsciiDoctor. Change-Id: I673e0fe0ae7b343abeb1afba0b9b11402efdf0d6 Reviewed-on: https://code.wireshark.org/review/23187 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-23Windows: Fix AsciiDoc / DocBook builds.Gerald Combs1-13/+15
The "quotes" section of the Asciidoctor compatibility file appears to be incompatible with Cygwin's version of AsciiDoc (8.6.3). Change-Id: Ifd08095effa07bc7277a2fff9de322dda51a8d47 Reviewed-on: https://code.wireshark.org/review/3804 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-23WSUG: Convert the "User Interface" chapter to AsciiDoc.Gerald Combs1-0/+398
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>