Commit Graph

7 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 41d94798a9 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:50:13 +00:00
Gerald Combs a34445c1cf 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-22 10:44:50 +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
Pascal Quantin 7309217ed8 Put back ' in user guide name
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-12 09:45:14 +00:00
Pascal Quantin fb3d38225e Update user guide for development release
Change-Id: I9b4c5ab2e98ad6daa618bcda20b53a23467e16e0
Reviewed-on: https://code.wireshark.org/review/11734
Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com>
2015-11-11 17:31:31 +00:00
Gerald Combs 62289300d6 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 05:30:10 +00:00