The Lua documentation has class names at its third level which is quite useful
to discover its documentation.
This reverts commit f5cd52c0fb.
Change-Id: I2a2e82041ac46a1a9974727bbb1d5cbf6855a878
Reviewed-on: https://code.wireshark.org/review/26814
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
Reduce the TOC depth so that it's not quite so huge.
Change-Id: I5748edf0e715961da57eff7e0ade6fad175ab24b
Reviewed-on: https://code.wireshark.org/review/26110
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Use tools/html2text.py to convert HTML to text.
Remove some now-obsolete documentation.
Change-Id: Ib21a1ab10c789182da5fcc68e98917a00f2fa650
Reviewed-on: https://code.wireshark.org/review/25733
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
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>
Generate a single PA4-sized PDF. PA4 is the approximate intersection of
A4 and Letter[1]. This gives us one less file to build and distribute.
If you're printing out hard copies of the guides this wastes a few pages
compared to an A4-sized PDF, but if you're printing out hard copies of
the guides you've already made a strong commitment to waste paper.
Page counts:
Guide Size Pages
WSDG A4 203
WSDG Letter 217
WSDG PA4 217
WSUG A4 192
WSUG Letter 204
WSUG PA4 205
[1] https://en.wikipedia.org/wiki/Paper_size#PA4_or_L4
Change-Id: If43d4b19947c77a51b3943a2b329dbab45025d79
Reviewed-on: https://code.wireshark.org/review/25438
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Replace the GPLv2+ blurbs in the doc and docbook directories with SPDX
headers as appropriate. This includes example code such as
packet-PROTOABBREV.c.
Remove dfilter2pod.pl and dfilter2xml.pl. We haven't used them since
2010.
Change-Id: I4adec02a9a4bc3e71e32bdf89f2754edaf696938
Reviewed-on: https://code.wireshark.org/review/24343
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
Bug: 14152
Change-Id: If1d89afd5dbf62adae4cd84e3fc44bd37a8a2176
Reviewed-on: https://code.wireshark.org/review/24221
Petri-Dish: Michael Mann <mmann78@netscape.net>
Tested-by: Petri Dish Buildbot
Reviewed-by: Michael Mann <mmann78@netscape.net>
Installs the WSUG to $docdir, unless the --disable-guides option is given
to the configure script.
This will open the Help->Contents menu action using the locally installed
guide. It will also point to the correct version for this Wireshark release.
The wireshark.org link only provides the guide for the master branch.
Change-Id: I9dd539c737cb3777dc1351707b9e45a3a6764aaa
Reviewed-on: https://code.wireshark.org/review/23906
Petri-Dish: João Valverde <j@v6e.pt>
Reviewed-by: João Valverde <j@v6e.pt>
Tested-by: João Valverde <j@v6e.pt>
Reviewed-by: Michael Mann <mmann78@netscape.net>
Add a CMake target that dumps the help output for our command line tools
to individual files. Include those files in the tools appendix instead
of pasting them in manually.
Fixup the output of some tools so that they pass the pre-commit checks.
Change-Id: I925f24818422a190927a96531c21f4d16d3fe5b5
Reviewed-on: https://code.wireshark.org/review/23737
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Create a common_src directory for common guide content. Add a
typographic convention section. Update some of the content accordingly.
Change-Id: I4f69c0f52a985c48e07fa0628b19734ec691f74e
Reviewed-on: https://code.wireshark.org/review/23131
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
Move the replacement definitions in asciidoc.conf to
attributes.asciidoc. This makes the markup a bit cleaner and is more
compatible with AsciiDoctor. Use a standard naming scheme for URLs.
Change-Id: Ica73aaadb013be2a4e6a3963fb54e6db6e02e98f
Reviewed-on: https://code.wireshark.org/review/18655
Reviewed-by: Peter Wu <peter@lekensteyn.nl>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Adjust the column widths of some tables to that they render more cleanly
and without FOP warnings. Move some table content to plain text instead
of trying to shove it into table cells. Fix some other layout and
formatting.
Change-Id: I40e40fd7ca5c3cc594ea30c8b1ad233afd4cdca4
Reviewed-on: https://code.wireshark.org/review/17880
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Now that nmake build system has been removed they are not needed anymore.
Change-Id: I88075f955bb4349185859c1af4be22e53de5850f
Reviewed-on: https://code.wireshark.org/review/16050
Petri-Dish: João Valverde <j@v6e.pt>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: João Valverde <j@v6e.pt>
We need to point xsltproc to the images directories.
The bigger images have scaling problems but at least they're
there now.
This is already done in cmake.
Change-Id: I260a8f3e335b9f5726811bcd6811f6c5b9f3a6b2
Reviewed-on: https://code.wireshark.org/review/15408
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
We neeed to set the build directory (because that's where the wslua stuff gets
put).
Also fix up wslua dependencies:
- It's needed (only) for the asciidoc->XML step
- It's not needed for the wsug any more
Change-Id: Ic1231a964b1edfb7d2eeacc5cc1c3fdda6969f21
Reviewed-on: https://code.wireshark.org/review/15407
Petri-Dish: Jeff Morriss <jeff.morriss.ws@gmail.com>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Jeff Morriss <jeff.morriss.ws@gmail.com>
Let the make recipe fail if a dependency is missing. That is more user-friendly
(a2x: command not found) than an empty target and having to re-run configure.
Test for both w3m and lynx when generating text files. If neither is available
skip it.
Add an explicit target to build pdf documentation.
Change-Id: I760475acd7278f5ab5a782c1828a134c58cf7b42
Reviewed-on: https://code.wireshark.org/review/15229
Petri-Dish: João Valverde <j@v6e.pt>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: João Valverde <j@v6e.pt>
Remove dependencies on xmllint. We don't write DocBook by hand any more
and we haven't used it in a long time in the CMake builds.
Change-Id: Ic07f03b00c4554c058eece0462b0925d565b6da1
Reviewed-on: https://code.wireshark.org/review/14506
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Remove check_git_version.sh and its associated targets. We haven't used
git_version.xml since the AsciiDoc conversion.
Change-Id: I480f0094c4355d71201f2dd285198581bbbfc415
Reviewed-on: https://code.wireshark.org/review/8104
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
A recent commit broke compilation with Python 3. The original author of
html2text.py is deceased and the fork has increased the number of files
for this "simple" helper.
The html2text.py script in this patch was rewritten and its output
matches with lynx (except for a few newlines around lists). This means
that indentation has been added for headings, paragraphs and lists.
Also, since it was written from scratch, a new license could be chosen
that matches Wireshark.
Since now the in-tree html2text.py script provides nicer output, remove
detection of the alternative programs (elinks, links). lynx/w3m is
somehow still necessary for asciidoc though.
(I also looked into reusing html2text.py for the release notes to
replace asciidoc, but the --format=html output produces different output
(HTML adds a ToC and section numbers). For now still require lynx for
release notes)
Tested with Python 2.6.6, 2.7.9, 3.2.6 and 3.4.3 under LC_ALL=C and
LC_ALL=en_US.UTF-8 on Linux. Tested reading from stdin and file, writing
to file, pipe and tty. Tested with cmake (Ninja) and autotools on Arch
Linux x86_64. Test:
# For each $PATH per python version, execute (with varying LC_ALL)
help/faq.py -b | tools/html2text.py /dev/stdin | md5sum
help/faq.py -b | tools/html2text.py | md5sum
help/faq.py -b | tools/html2text.py
help/faq.py -b | tools/html2text.py >/dev/null
Change-Id: I6409450a3e6c8b010ca082251f9db7358b0cc2fd
Reviewed-on: https://code.wireshark.org/review/7779
Petri-Dish: Peter Wu <peter@lekensteyn.nl>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
As with the Developer's Guide, add user-guide-docinfo.xml, which lets us
carry over DocBook front matter. Remove the meta_info chapter. Most of
its contents are now in user-guide-docinfo.xml. Add a DocBook revision
history based on hints from the Git/SVN/CVS revision history.
Remove the various makefile targets for converting AsciiDoc files to
DocBook chapters. Remove GPL_appendix.xml. We use the AsciiDoc version.
Change-Id: I543fa2a92f2c735c5f00c97ec65cff2187e09e3a
Reviewed-on: https://code.wireshark.org/review/5216
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Leave most of the content intact for now.
Change-Id: I78f47b8310cb41ac5a07d352e56ec907b36665f8
Reviewed-on: https://code.wireshark.org/review/5209
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Move it to the Developer's Guide while we're here.
Nudge the markup in epan/wslua where needed. Note that we should
probably convert it to AsciiDoc (if we're going to keep it in the DG) or
Doxygen.
Change-Id: Ie175111043f98b7a37eeeb8d185a833d8e866f8b
Reviewed-on: https://code.wireshark.org/review/5203
Reviewed-by: Gerald Combs <gerald@wireshark.org>
because of different timezones.
Change-Id: I93809447db29c2cc5f848edb438ee16372b57453
Reviewed-on: https://code.wireshark.org/review/3824
Reviewed-by: Jörg Mayer <jmayer@loplof.de>
Fix --asciidoc-opts in Makefile.am.
Add borders around menu and keycap markup. I like the latter but the
former could probably use more work.
Change-Id: If02e3d00875106d6b8f8bcf01cd52b1df4f9b6c8
Reviewed-on: https://code.wireshark.org/review/3817
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Use a common set of SVG files for AsciiDoc / DocBook admonition
graphics. Put them in a common directory. According to
http://caniuse.com/svg all common browsers have had SVG support for
a while now.
The graphics themselves were created with Inkscape. If you would like
to refine them further you are more than welcome.
Use variables to assemble xsltproc commands in Autotools and Nmake
while we're here.
Try to update Debian rules to reflect ga92c3fb.
Change-Id: If82647af27a60117c517125dff0aca81c033be72
Reviewed-on: https://code.wireshark.org/review/3206
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Fix a typo in the generation of top_srcdir NEWS.
Change-Id: I20a140a68b9afca5096d33d99a3ea5d24e776f05
Reviewed-on: https://code.wireshark.org/review/3626
Tested-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Michael Mann <mmann78@netscape.net>
Copy the built file into the source directory (since it's generated but checked
in). Don't fail to build, though, if we can't do that copy.
Change-Id: Ia94a19b6f813ee78b191cd09d51198462f95b223
Reviewed-on: https://code.wireshark.org/review/3425
Reviewed-by: Jeff Morriss <jeff.morriss.ws@gmail.com>
(Using sed : sed -i '/^\# \$Id\$/,+1 d') (start with dash)
Change-Id: Ia4b5a6c2302f6a531f6a86c1ec3a2f8205c8c2dd
Reviewed-on: https://code.wireshark.org/review/881
Reviewed-by: Anders Broman <a.broman58@gmail.com>
There have been discussions on -dev about removing this and I believe I was the last holdout. Finally convinced that I should just have a local copy (ignored by git)
Change-Id: Ic72a22baf58e3412023cf851f0fce16eb07113b0
Reviewed-on: https://code.wireshark.org/review/681
Reviewed-by: Michael Mann <mmann78@netscape.net>
Reviewed-by: Evan Huus <eapache@gmail.com>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
Add a Git+Gerrit command line example to the Developer's Guide. Convert
some Subversion text to Git.
Skip building the Developer's Guide if we don't have a2x.
Change-Id: I62e9e71eb3ffc07d8677df35b4b197f53f77b4f2
Reviewed-on: https://code.wireshark.org/review/384
Reviewed-by: Gerald Combs <gerald@wireshark.org>
rule specific to wsug_src similar to the nmake change in gedc06c1.
Change-Id: I6d4bffc5391bd84a83fca8acb6a3688805e05de6
Reviewed-on: https://code.wireshark.org/review/179
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Add developer-guide-docinfo.xml, which lets us carry over DocBook front
matter. Remove the meta_info chapter. Most of its contents are now in
developer-guide-docinfo.xml. Add a DocBook revision history based on
hints from the Git/SVN/CVS revision history.
Comment out or note makefile content that's no longer necessary for
converting the Developer's Guide but will be useful for converting the
User's Guide. Fix building the release notes with CMake. Other minor
changes. Tested with Autotools, nmake, and CMake.
Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a
Reviewed-on: https://code.wireshark.org/review/155
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Gerald Combs <gerald@wireshark.org>
chapter (WSDG_chapter_sources) has been converted.
Conversion was done using the script in
https://code.wireshark.org/review/#/c/9/ along with manual cleanup.
Changes are mostly limited formatting.
It's helpful to have a copy of the pre-conversion guide for comparison.
I've placed a chunked copy online at
http://www.wireshark.org/~gerald/wsdg_html_2014_01/ .
Tested under Autotools. Nmake and CMake will likely break. I'll take a
look shortly. If only we had documention adding a feature branch to
Gerrit and using it to test different platforms...
svn path=/trunk/; revision=54945
Docbook was done using Pandoc and cleaned up by hand. Add an
asciidoc.conf which contains macros for linking to Wireshark bugs and
CVE IDs.
Remove the release-notes.chm target. I don't think we ever used it and
we're probably better off generating PDF or HTML if we need something
fancier than plain text.
In configure.ac, consolidate program path discovery a bit and add a2x
discovery.
svn path=/trunk/; revision=48307
Peter Wu