João Valverde 91366f56f2 WSDG: Minor logging documentation enhancements 2023-02-23 09:13:07 +00:00
asciidoctor-macros Docs+Packaging: Convert our man pages to Asciidoctor. 2021-10-01 16:42:34 +00:00
common_src Docs: Rename our guide source files 2023-01-30 20:05:06 +00:00
wsdg_src WSDG: Minor logging documentation enhancements 2023-02-23 09:13:07 +00:00
wsug_src doc: Remove stray word in statistics chapter 2023-02-16 18:42:01 +00:00
CMakeLists.txt Docbook: Reorganize our guide directories 2023-02-11 21:09:46 +00:00
README.adoc WSDG/WSUG: add missing asciidoc admonition icons 2022-02-14 18:24:17 +00:00
attributes.adoc WSUG: (PDF) add fallback font for missing up/down arrows 2022-12-06 19:18:14 -06:00
custom_layer_single_html.xsl Switch from AsciiDoc to Asciidoctor. 2018-02-11 18:22:09 +00:00
faq.adoc FAQ: Fix some markup 2023-01-09 18:00:11 +00:00
logray-quick-start.adoc Rename Logwolf to Logray 2022-07-06 15:04:25 +00:00
make-wsluarm.py docbook: Add file comments to wsluarm. 2022-07-24 17:11:57 +00:00
release-notes.adoc Enable rpathification and working relocation on Linux (take 3) 2023-02-13 00:24:21 +00:00
ws.css docbook: Fix our admon image widths. 2021-07-16 07:00:45 +00:00


This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

= Introduction

This directory contains the source files needed to build the:

- Wireshark Users Guide
- Wireshark Developers Guide
- Release notes (NEWS)
- Lua Reference

To build everything, build the `all_guides` target, e.g. `ninja
all_guides` or `msbuild all_guides.vcxproj`. Requirements are listed

The guides and release notes are written in
https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[Asciidoctor syntax].
For more information see https://asciidoctor.org.

== Requirements

Ultimately we'd like to reduce the toolchain requirements to AsciidoctorJ alone, but that's not yet possible.
Additional tooling is required for the HTML and HTMLHelp targets.
See the https://www.wireshark.org/docs/wsdg_html_chunked/ChToolsDocumentationToolchain.html[Developer's Guide] for instructions on installing required packages for your platform.

== Asciidoctor Markup

The Users and Developers Guides were originally written in DocBook and
were later converted to https://asciidoc.org/[AsciiDoc]. We subsequently
switched from AsciiDoc to Asciidoctor. As a result we currently use
https://asciidoctor.org/docs/migration/[compat mode], but may switch
to Asciidoctors modern markup at a later date.

Please use the following conventions when writing documentation:

- Window and dialog box names should be in “curly quotes”.

- Use Asciidoctor macros for buttons, keys, and menus. Note that these
  are currently experimental:

** The btn:[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], [IMPORTANT], [CAUTION] 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.

== Custom Asciidoctor Macros

The following custom macros are available in `docbook/asciidoctor-macros`:

Sorts a list of items and separates them with commas with an "and" preceding the last item.

Links a CVE ID to cve.mitre.org.

Ensures that individual arguments don't wrap in order to improve readability.

Links an issue number to gitlab.org/wireshark/wireshark/-/issues.

Links a security advisory to www.wireshark.org.

== Asciidoctor Live Preview

The Asciidoctor project provides a JavaScript version of Asciidoctor
(asciidoctor.js), which enables live previews in many web browsers and
text editors. See the
Preview] documentation for more information.

Note that our documentation depends on attributes defined in
_attributes.adoc_. The Users Guide and Developers Guide are split
across several files, and only the top-level _user-guide.adoc_ and
_developer-guide.adoc_ include _attributes.adoc_. As a result,
some markup will be incomplete. You can work around this somewhat by
adding some attributes such as `compat-mode experimental` to your Live
Preview settings.

= HTML Help Alternatives

Ideally we would ship documentation with Wireshark that is pleasant to
read, browsable, and searchable. Unfortunately we don't have an easy way
to do this. The closest we've been able to come is by shipping an HTML
Help (.chm) file on Windows. However, HTML Help a) is limited to Windows,
b) crusty on normal displays, and c) really crusty on HiDPI displays.

The following alternative formats are available, each with advantages
and disadvantages:

== WebHelp

https://en.wikipedia.org/wiki/Web_help[WebHelp] has three main

- DocBook XSL, including...
- webhelpindexer.jar
- The user's local web browser

This format generates both HTML pages and JavaScript, which might not run
reliably on end user machines.

== PDF

PDF output is page oriented, with static page sizes. This _usually_ isn't
a problem with modern reader software. However it doesn't look like we
can reliably load a PDF file and jump to specific section on some
platforms. For example, loading +++file:///path/to/user_guide.pdf#location+++
works in Firefox & Chrome, but not in Safari, Preview, or Internet Explorer.

== Qt Help

Qt provides an extensive https://doc.qt.io/qt-5/qthelp-framework.html[help system].
However, to use it we need to generate a Qt Help Project (.qhp) file,
which isn't currently supported by Asciidoctor or via DocBook XSL.

The default help application (Qt Assistant) is ugly. We'd probably want
to write our own help viewer app or integrate help directly via