summaryrefslogtreecommitdiff
path: root/docbook
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>2016-09-22 15:43:37 -0700
committerGerald Combs <gerald@wireshark.org>2016-09-22 22:48:01 +0000
commite0bc5b1c3e167a29d383c4f010ce91b57dc58a63 (patch)
treef39abd0d8c457f07a206526bf337aaa6b36267c3 /docbook
parenteeb4361e57e01d03a655433c9e75388d93bb9f6f (diff)
downloadwireshark-e0bc5b1c3e167a29d383c4f010ce91b57dc58a63.tar.gz
WSDG: Adjust markup and fix FOP warnings
Wrap monospace text in our PDF output. Fix the formatting of a list. Fix an anchor reference. Change-Id: Id9433f3e3462569299e6702b4a4e137481ad80c4 Reviewed-on: https://code.wireshark.org/review/17877 Reviewed-by: Gerald Combs <gerald@wireshark.org>
Diffstat (limited to 'docbook')
-rw-r--r--docbook/custom_layer_pdf.xsl4
-rw-r--r--docbook/wsug_src/WSUG_chapter_advanced.asciidoc23
-rw-r--r--docbook/wsug_src/WSUG_chapter_statistics.asciidoc8
3 files changed, 19 insertions, 16 deletions
diff --git a/docbook/custom_layer_pdf.xsl b/docbook/custom_layer_pdf.xsl
index 24f3e9a504..e656490ef4 100644
--- a/docbook/custom_layer_pdf.xsl
+++ b/docbook/custom_layer_pdf.xsl
@@ -53,8 +53,12 @@
</xsl:attribute-set>
<!-- reduce the size of programlisting to make them fit the page -->
+<!-- We might want to set the hyphenation character to "\":
+ http://www.sagehill.net/docbookxsl/FittingText.html
+-->
<xsl:attribute-set name="monospace.verbatim.properties">
<xsl:attribute name="font-size">80%</xsl:attribute>
+ <xsl:attribute name="wrap-option">wrap</xsl:attribute>
</xsl:attribute-set>
</xsl:stylesheet>
diff --git a/docbook/wsug_src/WSUG_chapter_advanced.asciidoc b/docbook/wsug_src/WSUG_chapter_advanced.asciidoc
index 6f517082db..396060e318 100644
--- a/docbook/wsug_src/WSUG_chapter_advanced.asciidoc
+++ b/docbook/wsug_src/WSUG_chapter_advanced.asciidoc
@@ -128,34 +128,35 @@ You can choose to decode the data from one of the following formats:
You can choose to view the data in one of the following formats:
-. __ASCII__: In this view you see the bytes as ASCII.
+[horizontal]
+*ASCII*:: In this view you see the bytes as ASCII.
All control characters and non-ASCII bytes are replaced by dot.
-. __ASCII & Control__: In this view all control characters are shown using a
+*ASCII & Control*:: In this view all control characters are shown using a
UTF-8 symbol and all non-ASCII bytes are replaced by dot.
-. __C Array__: This allows you to import the field data into your own C program.
+*C Array*:: This allows you to import the field data into your own C program.
-. __EBCDIC__: For the big-iron freaks out there.
+*EBCDIC*:: For the big-iron freaks out there.
-. __HEX Dump__: This allows you to see all the data. This will require a lot of
+*HEX Dump*:: This allows you to see all the data. This will require a lot of
screen space and is best used with binary protocols.
-. __HTML__: This allows you to see all the data formatted as a HTML document.
+*HTML*:: This allows you to see all the data formatted as a HTML document.
The HTML supported is what's supported by the Qt QTextEdit class.
-. __Image__: This will try to convert the bytes into an image.
+*Image*:: This will try to convert the bytes into an image.
Images supported are what's supported by the Qt QImage class.
-. __ISO 8859-1__: In this view you see the bytes as ISO 8859-1.
+*ISO 8859-1*:: In this view you see the bytes as ISO 8859-1.
-. __Raw__: This allows you to load the unaltered stream data into a different
+*Raw*:: This allows you to load the unaltered stream data into a different
program for further examination. The display will show HEX data, but
``Save As'' will result in a binary file.
-. __UTF8__: In this view you see the bytes as UTF-8.
+*UTF8*:: In this view you see the bytes as UTF-8.
-. __YAML__: This will show the bytes as a YAML binary dump.
+*YAML*:: This will show the bytes as a YAML binary dump.
[[ChAdvExpert]]
diff --git a/docbook/wsug_src/WSUG_chapter_statistics.asciidoc b/docbook/wsug_src/WSUG_chapter_statistics.asciidoc
index f1ba386374..daa00ca62b 100644
--- a/docbook/wsug_src/WSUG_chapter_statistics.asciidoc
+++ b/docbook/wsug_src/WSUG_chapter_statistics.asciidoc
@@ -132,7 +132,7 @@ protocols will carry more than one IP header.
A network conversation is the traffic between two specific endpoints. For
example, an IP conversation is all the traffic between two IP addresses. The
description of the known endpoint types can be found in
-<<ChStatEndpointDefinition>>.
+<<ChStatEndpoints>>.
[[ChStatConversationsWindow]]
@@ -165,7 +165,7 @@ will show the stream contents as described in <<ChAdvFollowStream>> dialog. The
button:[Graph...] button will show a graph as described in <<ChStatIOGraphs>>.
button:[Conversation Types] lets you choose which traffic type tabs are shown.
-See <<ChStatEndpointDefinition>> for a list of endpoint types. The enabled types
+See <<ChStatEndpoints>> for a list of endpoint types. The enabled types
are saved in your profile settings.
[TIP]
@@ -181,8 +181,6 @@ it before (or while) you are doing a live capture.
=== Endpoints
-[[ChStatEndpointDefinition]]
-
A network endpoint is the logical endpoint of separate protocol traffic of a
specific protocol layer. The endpoint statistics of Wireshark will take the
following endpoints into account:
@@ -270,7 +268,7 @@ The button:[Copy] button will copy the list values to the clipboard in CSV
endpoints mapped in your web browser.
button:[Endpoint Types] lets you choose which traffic type tabs are shown. See
-<<ChStatEndpointDefinition>> above for a list of endpoint types. The enabled
+<<ChStatEndpoints>> above for a list of endpoint types. The enabled
types are saved in your profile settings.
[TIP]