Commit Graph

8 Commits

Author SHA1 Message Date
Roland Knall 645b9ab7f4 Qt6: Adapt various docs 2022-08-23 10:37:14 +00:00
Gerald Combs fad709a582 Docs: Use modern Asciidoctor section IDs.
Change our legacy block anchors to section IDs as described at

https://docs.asciidoctor.org/asciidoc/latest/sections/custom-ids/
2022-01-17 18:56:26 +00:00
Gerald Combs 3600de75c1 Docbook: Make our prefaces self-contained. 2021-12-26 09:52:18 -08:00
Jaap Keuter 8f901b0b79 EPUB: Add cover page and some document meta data
If only someone could create a proper cover page
2021-08-03 19:42:02 +00:00
Chuck Craft fd99368364 WSDG: Update Qt and MSVC versions 2021-05-05 21:46:50 +00:00
Gerald Combs fcd51deb99 Docbook: Fix an unterminated tag, other updates.
Remove nested example tags from the dissection chapter, including and
unbalanced one. Mark our source blocks with [source,c].

Enable syntax highlighting in the Developer's and User's guides. This
isn't supported in the DocBook backend (which we use to generate the
HTML guides), but it is in the PDF backend.

Add a comment about failing on warnings when we generate our guides.

Change-Id: Ieee29fe75364ca23769aa997f90126e31b72cc8b
Reviewed-on: https://code.wireshark.org/review/36767
Petri-Dish: Guy Harris <gharris@sonic.net>
Tested-by: Petri Dish Buildbot
Reviewed-by: Guy Harris <gharris@sonic.net>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2020-04-09 22:07:57 +00:00
Gerald Combs 8bf6c7b3bf WSDG: Migrate the asn2wrs content from the wiki.
Asn2wrs generates quite a bit of our dissector code, so convert some of
our asn2wrs wiki pages to a WSDG chapter. Conversion was done using the
script below and editing as needed.

----
OUT_ADOC="docbook/wsdg_src/WSDG_chapter_asn2wrs.adoc"

cp /dev/null "$OUT_ADOC"

PAGES="
    Asn2wrs
    Asn2wrs_Handmassaging_the_ASN_file
    ASN1_sample
    Asn2wrsAuxiliary
    #.END
    #.EXPORTS
    #.FN_BODY
    #.INCLUDE
    #.MODULE_IMPORT
    #.NO_EMIT
    #.PDU
    #.PDU_NEW
    #.REGISTER
    #.REGISTER_NEW
    #.USER_DEFINED
"

for PAGE in $PAGES ; do
    PAGE=${PAGE/\#/%23}
    curl "https://wiki.wireshark.org/$PAGE" \
        | xmllint --html --format --xpath '//div[@id="content"]' - \
        | pandoc -f html -t asciidoctor \
        | sed -e 's/\[\#[^ ][^ ]* .anchor\]##*//g' -e 's/\[content\]//g' \
        | cat -s \
        >> "$OUT_ADOC"
done
----

Change-Id: Ibc02b7b463dfc37abf5c2fd0a4e66f6161d290f6
Reviewed-on: https://code.wireshark.org/review/36707
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>
2020-04-05 07:02:42 +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