aboutsummaryrefslogtreecommitdiffstats
path: root/docbook/user-guide.asciidoc
AgeCommit message (Collapse)AuthorFilesLines
2019-02-15Rename our .asciidoc files to .adocGerald Combs1-57/+0
As noted in "AsciiDoc Recommended Practices" at https://asciidoctor.org/docs/asciidoc-recommended-practices/, the AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a file extension and that's the one preferred by the Asciidoctor project. Update our filenames to match. Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c Reviewed-on: https://code.wireshark.org/review/32037 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>
2018-07-20AsciiDoctor markup updates.Gerald Combs1-0/+18
Separate includes by blank lines as recommended in https://asciidoctor.org/docs/user-manual/#include-directive. Separate block attributes as well. Change-Id: I933917a14eae6d1fe1879372917ab2208755f470 Reviewed-on: https://code.wireshark.org/review/28769 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>
2018-07-19WSUG: Update the Statistics chapter to match current Qt UIMoshe Kaplan1-0/+1
Hide the Compare option, reorder the chapters to match the current Qt order and move the Wireless menu to a new chapter. Change-Id: I7f0eeb45f4894f66a9c91d62d7d43db775f469e5 Reviewed-on: https://code.wireshark.org/review/28761 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-06-19Documentation: Add version to GuidesJaap Keuter1-1/+1
Previously, before the AsciiDoc conversion, the Users' and Developers' Guide used to carry version information on the title page. This seems to have been dropped, for reasons unknown to me. At least AsciiDoctor allows to add a subtitle, so the wireshark-version attribute can be expanded into it. Change-Id: Ib0a90393aff1a323b7026c49e2aa11f5115b3ec7 Signed-off-by: Jaap Keuter <jaap.keuter@xs4all.nl> Reviewed-on: https://code.wireshark.org/review/28330 Reviewed-by: Gerald Combs <gerald@wireshark.org> Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com> Petri-Dish: Alexis La Goutte <alexis.lagoutte@gmail.com> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-05-29Add the MATE documentation chapter to the User GuideJaap Keuter1-0/+1
With MATE being an integral part of Wireshark for a long time now and its documentation being part of the Wiki for a while it is time to move it into the Wireshark Users Guide. All credits go to Luis Ontanon for creating MATE and the Wiki pages, the various contributors to those pages and especially Pavel Sindelka for the creation of the graphics. This change merely incorporates the contents of the Wiki pages into an asciidoc file for processing into documentation output. It is in no way a claim to knowledge of or deep insight in the workings of MATE on my part. Change-Id: Id9c60fd3ba4a52aafb988370ea7d658907970ccd Reviewed-on: https://code.wireshark.org/review/27894 Petri-Dish: Anders Broman <a.broman58@gmail.com> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-02-05More AsciiDoc → Asciidoctor updates.Gerald Combs1-1/+1
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>
2017-08-23Docbook: Fix a couple of include paths.Gerald Combs1-1/+1
Change-Id: I1b06658f516a17516782df57943d7082badba755 Reviewed-on: https://code.wireshark.org/review/23182 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-08-22WSUG+WSDG: Add a typographic conventions section.Gerald Combs1-0/+2
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>
2016-11-11AsciiDoc: Create an include file for attributes.Gerald Combs1-0/+1
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>
2015-11-12Put back ' in user guide namePascal Quantin1-1/+1
CMake generated CHM supports it properly, contrary to NMake. As this is the future, let's put it back! Change-Id: Ifc5ea84942043c04808546df75ae956effa16747 Reviewed-on: https://code.wireshark.org/review/11763 Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com>
2015-11-11Update user guide for development releasePascal Quantin1-1/+1
Change-Id: I9b4c5ab2e98ad6daa618bcda20b53a23467e16e0 Reviewed-on: https://code.wireshark.org/review/11734 Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com>
2014-11-10Finish converting the User's Guide to AsciiDoc.Gerald Combs1-0/+34
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>