Commit Graph

12 Commits

Author SHA1 Message Date
Chuck Craft f07ff72f90 WSDG/WSUG: add missing asciidoc admonition icons
Closes #17474
2022-02-14 18:24:17 +00:00
Martin Mathieson 43a85d674e Fix more spelling errors in the docbook folder.
There are some lines that show as changed in 'git gui', will see how
they look in gitlab..
2020-09-06 12:11:09 +00:00
Dario Lombardo 5f23791f82 docbook: put a space after PS prompts.
Change-Id: I7e55471b19a3dd526d1de1269062853a72e75dec
Reviewed-on: https://code.wireshark.org/review/35226
Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2019-11-27 01:35:58 +00:00
Gerald Combs fb5a029e47 Docbook: Fixup our table delimiters.
Update our table delimiters to match the Asciidoctor documentation.

Change-Id: I87a6834f2889e175236aa609984a9bc4dd9d3b8e
Reviewed-on: https://code.wireshark.org/review/34544
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-09-16 17:35:49 +00:00
Peter Wu c88e525168 Documentation: convert http URLS to https
Remove some dead links or point them to archive.org while at it. All
updated links have been verified.

Change-Id: Icf02167a13d5fe9dfce39ea57525b3f185554c9d
Reviewed-on: https://code.wireshark.org/review/34028
Petri-Dish: Peter Wu <peter@lekensteyn.nl>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-07-20 20:51:30 +00:00
Gerald Combs b658de2fa7 Rename our .asciidoc files to .adoc
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>
2019-02-15 05:17:26 +00:00
Gerald Combs 4adb67fc16 AsciiDoc: Convert some comments.
Convert some passthrough XML comments left over from the DocBook →
AsciiDoc conversion to AsciiDoc / Asciidoctor comments.

Change-Id: Iaf44bcf0b8a3a383e735b2b4394722cbbb2bdff3
Reviewed-on: https://code.wireshark.org/review/25615
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-02-05 17:02:27 +00:00
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
Gerald Combs f61c45acf1 Fix a typo.
Change-Id: I26fb82c00ef3ac1343930e473294a3aa338f3f96
Reviewed-on: https://code.wireshark.org/review/23164
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-08-22 17:56:15 +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