osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity
wireshark/docbook/user-guide.asciidoc

38 lines
1.2 KiB
Plaintext
Raw Normal View History

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-04 23:15:02 +00:00
= Wireshark User’s Guide
Finish converting the User's Guide to AsciiDoc. 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>
2014-11-10 02:13:57 +00:00
//v1.0, February 2014: Finished conversion from DocBook to AsciiDoc
:doctype: book
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-01 21:35:29 +00:00
include::attributes.asciidoc[]
Finish converting the User's Guide to AsciiDoc. 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>
2014-11-10 02:13:57 +00:00
[[Preface]]
["preface",id="Preface"]
== Preface
include::wsug_src/WSUG_preface.asciidoc[]
WSUG+WSDG: Add a typographic conventions section. 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>
2017-08-18 19:32:17 +00:00
include::common_src/typographic_conventions.asciidoc[]
Finish converting the User's Guide to AsciiDoc. 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>
2014-11-10 02:13:57 +00:00
// Chapters
include::wsug_src/WSUG_chapter_introduction.asciidoc[]
include::wsug_src/WSUG_chapter_build_install.asciidoc[]
include::wsug_src/WSUG_chapter_use.asciidoc[]
include::wsug_src/WSUG_chapter_capture.asciidoc[]
include::wsug_src/WSUG_chapter_io.asciidoc[]
include::wsug_src/WSUG_chapter_work.asciidoc[]
include::wsug_src/WSUG_chapter_advanced.asciidoc[]
include::wsug_src/WSUG_chapter_statistics.asciidoc[]
include::wsug_src/WSUG_chapter_telephony.asciidoc[]
include::wsug_src/WSUG_chapter_customize.asciidoc[]
// Needs to be reworked
//include::wsug_src/WSUG_chapter_troubleshoot.asciidoc[]
// Appendices
include::wsug_src/WSUG_app_messages.asciidoc[]
include::wsug_src/WSUG_app_files.asciidoc[]
include::wsug_src/WSUG_app_protocols.asciidoc[]
// Needs to be reworked
//include::wsug_src/WSUG_app_howitworks.asciidoc[]
include::wsug_src/WSUG_app_tools.asciidoc[]
// License
Docbook: Fix a couple of include paths. Change-Id: I1b06658f516a17516782df57943d7082badba755 Reviewed-on: https://code.wireshark.org/review/23182 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-08-23 18:49:28 +00:00
include::common_src/GPL_appendix.asciidoc[]