Add abstracts to Npcap Guide, which render to meta description tags.

ivandart · Sep 27, 2018 · a7ad0a0 · a7ad0a0
1 parent a1f0b3a
commit a7ad0a0
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 2 deletions.
diff --git a/docs/npcap-devguide.xml b/docs/npcap-devguide.xml
@@ -1,5 +1,12 @@
 <sect1 id="npcap-devguide">
   <title>Developing software with Npcap</title>
+  <sect1info>
+    <abstract>
+      <para> Writing software that captures or injects network traffic is easy
+        with Npcap.  This guide describes the Npcap SDK, WinPcap compatibility,
+        and the Npcap API.</para>
+    </abstract>
+  </sect1info>
 
   <sect2 id="npcap-development">
     <title>Using the Npcap SDK</title>

diff --git a/docs/npcap-guide-wrapper.xml b/docs/npcap-guide-wrapper.xml
@@ -10,9 +10,12 @@
 ]>
 
 <article id="npcap">
-<artheader>
+<articleinfo>
   <title>Npcap: Nmap Project's packet sniffing library for Windows</title>
-</artheader>
+  <abstract>
+    <para>A guide to Npcap, a packet capture and network analysis framework for Windows, for users and software developers. Npcap is a modern, safe, and compatible update to WinPcap.</para>
+  </abstract>
+</articleinfo>
 <indexterm significance="preferred" class="startofrange" id="npcap-indexterm"><primary>Npcap</primary></indexterm>
 
 &npcap-intro;

diff --git a/docs/npcap-guide.xml b/docs/npcap-guide.xml
@@ -1,5 +1,12 @@
 <sect1 id="npcap-users-guide">
   <title>Npcap Users' Guide</title>
+  <sect1info>
+    <abstract>
+      <para>The Users' Guide covers the basics of installing and removing
+        Npcap, interactions with WinPcap, frequently asked questions,
+        and how to report bugs.</para>
+    </abstract>
+  </sect1info>
 
   <para>Because Npcap is a packet capture architecture, not merely a software
     library, some aspects of installation and configuration may fall to the end

diff --git a/docs/npcap-internals.xml b/docs/npcap-internals.xml
@@ -1,5 +1,11 @@
 <sect1 id="npcap-internals">
   <title>Npcap internals</title>
+  <sect1info>
+    <abstract>
+      <para>Describes the internal structure and interfaces of Npcap: the NPF
+        driver and Packet.dll</para>
+    </abstract>
+  </sect1info>
   <para>This portion of the manual describes the internal structure and
     interfaces of Npcap, starting from the lowest-level module. It is targeted
     at people who must extend or modify this software, or to the ones

diff --git a/docs/npcap-tutorial.xml b/docs/npcap-tutorial.xml
@@ -1,5 +1,11 @@
 <sect1 id="npcap-tutorial">
   <title>Npcap Development Tutorial</title>
+  <sect1info>
+    <abstract>
+      <para>A step-by-step guide to writing software that uses Npcap to list
+        network adapters, capture packets, and send network traffic.</para>
+    </abstract>
+  </sect1info>
 
   <para>This section shows how to use the features of the Npcap API. It is
     organized as a tutorial, subdivided into a set of lessons that will