From 5a649701ee9413a43fe8542e8a8146618464d485 Mon Sep 17 00:00:00 2001
From: Lars Thorsen <lars@erlang.org>
Date: Wed, 7 Dec 2011 13:01:40 +0100
Subject: [erl_docgen] Updated users guide

---
 lib/erl_docgen/doc/src/overview.xml | 72 ++++++-------------------------------
 1 file changed, 11 insertions(+), 61 deletions(-)

(limited to 'lib/erl_docgen/doc/src/overview.xml')

diff --git a/lib/erl_docgen/doc/src/overview.xml b/lib/erl_docgen/doc/src/overview.xml
index f0f97d8d45..2a420c53d9 100644
--- a/lib/erl_docgen/doc/src/overview.xml
+++ b/lib/erl_docgen/doc/src/overview.xml
@@ -1,10 +1,10 @@
-<?xml version="1.0" encoding="latin1" ?>
+<?xml version="1.0" encoding="iso-8859-1" ?>
 <!DOCTYPE chapter SYSTEM "chapter.dtd">
 
 <chapter>
   <header>
     <copyright>
-      <year>1997</year><year>2009</year>
+      <year>1997</year><year>2011</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -20,7 +20,7 @@
       under the License.
     
      </legalnotice>
-    <title>Overview</title>
+    <title>Overview OTP DTDs</title>
     <prepared></prepared>
     <docno></docno>
     <date></date>
@@ -42,7 +42,7 @@
 	  A collection of chapters
 	  (<seealso marker="user_guide_dtds#chapterDTD">chapter</seealso>).
 	</p>
-      </item>
+      </item> 
 
       <tag><em>Reference Manual</em></tag>
       <item>
@@ -72,23 +72,16 @@
       the <c>application</c> or <c>part</c> DTD to write other types
       of documentation for the application.</p>
 
-  </section>
-
-  <section>
-    <title>Structure of Generated HTML</title>
 
-    <p>The generated HTML corresponding to a <c>part</c> or
-      <c>application</c> document is split into a left frame and a right
-      frame. The left frame contains information about the document
-      and links to the included files, that is chapters or manual pages.
-      The right frame is used to display either the front page for
-      the document, or the selected chapter/manual page.</p>
+    <p>The structure of the different documents and the meaning of the 
+    tags are explained. There are numerous examples of documentation 
+    source code.</p>
 
-    <p>The left frame also contains links to a bibliography and a
-      glossary, which are automatically generated.</p>
+    <p>For readability and simplicity, the examples have been kept as
+      short as possible. For an example of what the generated HTML
+      will look like, it is recommended to look at the documentation of 
+      an OTP application.</p>
 
-    <p>In the case of an <c>application</c> document, the left frame
-      also contains a link to an automatically generated index.</p>
   </section>
 
   <section>
@@ -108,48 +101,5 @@
       tags, for example a highlighted word within a paragraph.</p>
   </section>
 
-  <section>
-    <title>About This Document</title>
-
-    <p>In this User's Guide, the structure of the different documents
-      and the meaning of the tags are explained. There are numerous
-      examples of documentation source code.</p>
-
-    <p>For readability and simplicity, the examples have been kept as
-      short as possible. For an example of what the generated HTML
-      will look like, it is recommended to look at the documentation of 
-      an OTP application.</p>
-    <list>
-      <item>This User's Guides are written using the <c>part</c> and
-	<c>chapter</c> DTDs.</item>
-
-      <item>The Reference Manuals are written using
-	the <c>application</c>, <c>appref</c> and <c>erlref</c> DTDs.
-      </item>
-    </list>
-  </section>
-
-  <section>
-    <title>Usage</title>
-
-    <list type="ordered">
-      <item>
-	<p>Create the relevant XML files.</p>
-
-	<p>If there are EDoc comments in a module, the escript 
-	  <!-- seealso marker="xml_from_edoc">xml_from_edoc</seealso -->
-          <c>xml_from_edoc</c>
-	  can be used to generate an XML file according to
-	  the <c>erlref</c> DTD for this module.</p>
-      </item>
-
-      <!-- item>
-	<p>The XML files can be validated using
-	  <seealso marker="docb_xml_check#validate/1">docb_xml_check:validate/1</seealso>.
-	</p>
-      </item -->
-
-    </list>
-  </section>
 </chapter>
 
-- 
cgit v1.2.3