= Introduction = This directory contains the source files needed to build the: - Wireshark User's guide - Wireshark Developer's Guide - Release notes (NEWS) - Lua Reference To build everything, just run `make` (for Windows see README.cmake). Requirements are listed below. The guides and release notes are written in AsciiDoc (http://asciidoc.org), but use many Asciidoctor (http://asciidoctor.org/) markup extensions which are provided in asciidoctor-asciidoc.conf. The documentation toolchain may switch exclusively to Asciidoctor at some point in the future. See the AsciiDoctor section at the end of this document for details. To get HTML, PDF or other output formats, conversions are done using XSL stylesheets, which provides a flexible way for these conversions. By default the Makefile generates HTML in single page and multiple (chunked) formats and two PDF's. Requirements: ------------- AsciiDoc -------- Text documentation format and conversion suite: http://asciidoc.org/ DocBook XML DTD --------------- DocBook "official" XML DTD V4.5: http://www.oasis-open.org/docbook/xml/ (available as a package for Linux / Cygwin) DocBook XSL ----------- The "official" XSL stylesheets from Norman Walsh: http://docbook.sourceforge.net/ (available as a package for Linux / Cygwin) xsltproc -------- The XSL processor xsltproc. Part of libxslt: http://xmlsoft.org/xslt/ Available as a package for Linux / Cygwin. Supplied with Mac OS X Panther and later. FOP processor (for PDF generation only) --------------------------------------- FOP processor from the apache project: http://xml.apache.org/fop/ FOP is a Java program, so you need to have a Java environment installed. The makefiles look for fop-2.1 in the docbook directory. You can change this location by setting the FOP environment variable. FOP might return an OutOfMemoryException. You can limit its memory usage by adding " -Xmx256m" to the FOP_OPTS environment variable. The Windows makefile does this by default. Hyphenation Patterns -------------------- Hyphenation patterns for FOP can be found at http://offo.sourceforge.net/hyphenation/. Different pattern files have different licenses. The English patterns may have restrictions on commercial use. AsciiDoc Notes -------------- AsciiDoc can use either w3m (default) or Lynx for plain text output. We use AsciiDoc for the Developer's Guide, User's Guide, and for the release notes. Lynx is used to render the official plaintext release announcements. The AsciiDoc files have been converted from DocBook. In a lot of cases the markup is wrong, inconsistent, or both. Use the following markup conventions for any new or revised text: - Window and dialog box names should be in ``curly quotes''. - Use Asciidoctor compatibility macros for buttons, keys, and menus: The button:[Start] button Press kbd:[Shift+Ctrl+P] to open the preferences dialog. Select menu:File[Open] from the main menu. This ensures that UI elements are shown consistently and lets us apply styles to each type of element. - Command line examples should reflect the OS: ---- $ echo Linux and UNIX ---- ---- C:\> echo Windows ---- Admonitions ([NOTE], [TIP], and [WARNING]) can be used to highlight important information. Keep in mind that they interrupt the flow of text by design. Too many (especially in a row) are distracting and annoying. Lynx ---- Text based web browser which can convert HTML to plain text. (Alternatives: w3m and elinks) dblatex ------- DocBook to LaTeX converter. Required for AsciiDoc PDF conversion on Win32. Win32 only: HTML help compiler (for .chm generation only) --------------------------------------------------------- HTML Help Compiler (hhc.exe) from Microsoft: http://www.microsoft.com/en-us/download/details.aspx?id=21138 Packages for Win32 ------------------ Installing the asciidoc package will pull in almost all the other required Cygwin packages. You may need to run "build-docbook-catalog" from a Cygwin bash prompt in order to register your catalog properly. Tool/File Cygwin Package Opt./Mand. Comments --------- -------------- ---------- -------- asciidoc Doc/asciidoc M cygwin python is a dependency and will also be installed (if not installed) xsltproc: Libs/libxslt M xsl stylesheets: Text/docbook-xsl M docbook.xsl, chunk.xsl and htmlhelp.xsl docbookx.dtd: Text/docbook-xml42 M a later version may be required (e.g. Doc/docbook-xml45), depending on your asciidoc installation docbookx.dtd: Text/docbook-xml45 M current asciidoc installations require this lynx: Web/lynx M dblatex Text/dblatex O A number of dependencies will also be installed fop: - O URL: http://xml.apache.org/fop/ - install it into docbok\fop-1.x or wireshark_lib_dir\fop-1.x hhc: - O URL: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp zip: Archive/zip O getopt: Base/util-linux O Required to run "build-docbook-catalog" Packages for Suse 9.3 --------------------- Tool/File Package Opt./Mand. Comments --------- ------- ---------- -------- xsltproc: libxslt M xsl stylesheets: docbook-xsl-stylesheets M docbook.xsl and chunk.xsl docbookx.dtd: docbook_4 M fop: fop O Packages for Gentoo ------------------- Like with all packages do ... Check dependencies: emerge -p Install it: emerge Tool/File Package Opt./Mand. Comments --------- ------- ---------- -------- xsltproc: libxslt M xsl stylesheets: docbook-xsl-stylesheets M docbook.xsl and chunk.xsl Necessary docbook catalogs are built automatically by portage in /etc/xml and /etc/sgml docbook.xsl and chunk.xsl using "/usr/bin/build-docbook-catalog". So docbook runs out of the box on Gentoo. docbookx.dtd: docbook-xml-dtd M fop: fop O Has a lot of JAVA dependencies. Quanta+ quanta or kdewebdev O Nice HTML/XML/SGML and Docbook editor with Syntaxhighlighting, Autocompletion, etc. Tip: The actual DTD version of Gentoo is 4.4, but wireshark docs still use 4.2. To be able to generate the docs, change the version in the second line of developer-guide.xml or install an older version of the DTD. See into the Gentoo handbook howto unmask old versions. Packages for Fedora ------------------- Tool/File Package Opt./Mand. Comments --------- ------- ---------- -------- xsltproc: libxslt M xsl stylesheets: docbook-style-xsl M docbook.xsl and chunk.xsl docbookx.dtd: docbook-dtds M provides v4.1, v4.2, v4.3, v4.4 DTDs asciidoc: ascidoc M fop: fop O See above Note: There are required dependencies (such as xml-common and sgml-common); yum is your friend for doing package installs including required dependencies. Packages for Debian ------------------- Tool/File Package Opt./Mand. Comments --------- ------- ---------- -------- xsltproc: libxslt M xsl stylesheets: docbook-xsl M chunk.xsl: docbook-xsl M htmlhelp.xsl: docbook-xsl M docbookx.dtd: docbook-xml M fop: fop O See above Makefile: -------------------------- There are several ways and tools to do these conversion, following is a short description of the way the makefile targets are doing things and which output files required for a release in that format. all Will generate both guides in all available output formats (see below). make wsug Will generate Wireshark User's Guide in all available output formats. make wsug_html The HTML file is generated using xsltproc and the XSL stylesheets from Norman Walsh. This is a conversion into a single HTML page. output: wsug_html make wsug_html_chunked The HTML files are generated using xsltproc and the XSL stylesheets from Norman Walsh. This is a conversion into chunked (multiple) HTML pages. output: wsug_html_chunked make wsug_pdf_us make wsug_pdf_a4 The PDF is generated using an intermediate format named XSL-FO (XSL formatting objects). xsltproc converts the XML to a FO file, and then FOP (Apache's formatting object processor) is used to generate the PDF document, in US letter or A4 paper format. Tip: You will get lot's of INFO/WARNING/ERROR messages when generating PDF, but the conversion works just fine. output: user-guide-us.pdf user-guide-a4.pdf make wsug_chm On Win32 platforms, the "famous" HTML help format can be generated by using a special HTML chunked conversion and then use the htmlhelp compiler from Microsoft. output: htmlhelp.chm Using the prefix wsdg_ instead of wsug_ will build the same targets but for the Wireshark Developer's Guide. The makefile is written to be run with make on UNIX/Linux platforms. AsciiDoctor ----------- At the time of this writing (November 2016) the AsciiDoctor project is much more active than AsciiDoc. At some point it might be worth the effort to migrate to AsciiDoctor. To do so we'd have to do the following at a minimum: - Require Ruby + AsciiDoctor or Java + AsciiDoctorj to build the documentation. - Either port the macros in asciidoc.conf to AsciiDoctor or stop using them. - Restrict ourselves to decimal entities since the PDF renderer doesn't support hexadecimal ones: https://github.com/asciidoctor/asciidoctorj/issues/439 - Choose a "compat" mode: http://asciidoctor.org/docs/migration/