Commit Graph

18 Commits

Author SHA1 Message Date
Gerald Combs dabb19572d More AsciiDoc → Asciidoctor updates.
Switch from AsciiDoc's smart quotes markup to the quotes themselves. Use
double curly quotes in place of singles.

Switch from XML entities to their direct equivalents where we can.
Switch from hex entities to decimal entities where we can't or it's not
convenient. (Asciidoctor PDF doesn't yet handle hex entities).

Change-Id: Iaf5ec33249e1c91b3d50b5d96251763243b72836
Reviewed-on: https://code.wireshark.org/review/25606
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-05 00:14:05 +00:00
Gerald Combs df088de18b Docs: Make our AsciiDoc markup more compatible with AsciiDoctor.
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>
2018-02-04 22:46:20 +00:00
Gerald Combs af180cc7d0 Update the AsciiDoc button macro name.
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>
2017-08-23 21:48:57 +00:00
Jim Young be6584640e User Guide: Fix two trivial typos
Change-Id: I25bab6eb1072bec102e00a76027c7742a0ea883b
Reviewed-on: https://code.wireshark.org/review/20714
Petri-Dish: Jim Young <jim.young.ws@gmail.com>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Michael Mann <mmann78@netscape.net>
2017-03-26 16:34:49 +00:00
Gerald Combs 8e76cfbf54 Qt: Add selection history navigation.
Add the ability to move back and forth in the packet selection history
similar to GTK+. Update the documentation accordingly.

Change-Id: If1fdc1e59b240c0588c292dc0f7f0a5f083c30e1
Reviewed-on: https://code.wireshark.org/review/20320
Petri-Dish: Anders Broman <a.broman58@gmail.com>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2017-03-03 05:02:14 +00:00
Gerald Combs 4fdc16d8e4 Docbook: Replace "OS X" with "macOS".
Change-Id: Ic2ab4f9050c9c76349d8d872b8fc2bf9feb7827d
Reviewed-on: https://code.wireshark.org/review/20325
Petri-Dish: Anders Broman <a.broman58@gmail.com>
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2017-03-02 11:54:31 +00:00
Gerald Combs 65ab2a9701 AsciiDoc: Create an include file for attributes.
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>
2016-11-11 17:18:25 +00:00
Gerald Combs d390db9818 WSUG: More layout and PDF fixes.
Set variablelist.as.blocks in custom_layer_pdf.xsl so that we don't end
up with list text squeezed into tiny columns on the right. Set column
widths for most of our tables.

Change-Id: I3fe47d945a7945618012c9de1fc0e97b788dea9e
Reviewed-on: https://code.wireshark.org/review/17893
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2016-09-23 16:34:09 +00:00
Gerald Combs 3c163637d6 WSUG: Fixup PDF images.
Pass relative image directory paths to xsltproc. The DocBook documentation
says you can use a URI, but trying to get that to work with CMake
and Windows appears to be a path to tears and undignified wails of
frustration.

Add attributes for our different types of images and use them so that
the PDFs don't scale our screenshots to an unusable size.

Change-Id: I786d09d9ef9be3d423b2af426a8867739ae12c1a
Reviewed-on: https://code.wireshark.org/review/17688
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2016-09-13 21:02:54 +00:00
Gerald Combs 515502fd9b WSUG: Update the statusbar section.
Change-Id: Ib76ddbf98c2ce89285bd00ba039fbf1a0baeb8aa
Reviewed-on: https://code.wireshark.org/review/13177
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2016-01-10 23:54:19 +00:00
Gerald Combs 472c29d18c WSUG: Update the packet details and bytes sections.
Update images and text.

Change-Id: If024a37a01cd7ab40ae2d5f50f26ca41a159fd41
Reviewed-on: https://code.wireshark.org/review/13173
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2016-01-10 19:37:46 +00:00
Gerald Combs f0fd052185 Update the packet list documentation.
Update images and describe related packets and the intelligent
scrollbar. Suggest a way to make it easier to get a screenshot of
related packets.

Change-Id: I5bf27b0c53fb62f3e567765400141a374a465e4e
Reviewed-on: https://code.wireshark.org/review/13159
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2016-01-10 18:43:05 +00:00
Dirk 07f0cf8633 Add menu item for capture comment dialog in GTK+
Qt already has a menu item for this in Statistics -> Capture File Properties

Bug: 9628
Change-Id: I85dd6f85d43fbfb60c2f4db82d9a02d91866127c
Reviewed-on: https://code.wireshark.org/review/12725
Petri-Dish: Michael Mann <mmann78@netscape.net>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Michael Mann <mmann78@netscape.net>
2015-12-19 20:41:14 +00:00
Gerald Combs f015c85317 Update some WSUG screenshots and markup.
Updated the main window and main menu screenshots. Update the markup for
the File and Edit menus.

Change-Id: I31282e3913692895a35e749c54c77c8069c7167a
Reviewed-on: https://code.wireshark.org/review/11487
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-11-02 01:08:50 +00:00
Jeff Morriss d4d03113e1 WSUG: send readers to the wiki's SSL page for help on decryption.
This replaces a question (recently remarked upon on -users) with a link to
someplace where we already have documentation on the subject.

Change-Id: I6c5cf2b0f674c129aaa017da0ca44176c5be665f
Reviewed-on: https://code.wireshark.org/review/10677
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2015-09-28 17:55:53 +00:00
Gerald Combs 04aad36c0e Convert the Lua reference to AsciiDoc.
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>
2014-11-09 05:12:09 +00:00
Gerald Combs d31011572d Convert admon graphics to SVG.
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>
2014-08-24 02:56:35 +00:00
Gerald Combs 02c5a12ee4 WSUG: Convert the "User Interface" chapter to AsciiDoc.
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>
2014-08-23 18:32:51 +00:00