From 013e3840532b16308f4bfcf22bde0e6de8d064b2 Mon Sep 17 00:00:00 2001
From: Lars Thorsen <lars@erlang.org>
Date: Fri, 18 Nov 2011 12:39:57 +0100
Subject: [erl_docgen] Add an application ref page

---
 lib/erl_docgen/doc/man3/.gitignore        |  0
 lib/erl_docgen/doc/man6/.gitignore        |  0
 lib/erl_docgen/doc/src/Makefile           | 18 ++++-----
 lib/erl_docgen/doc/src/book.xml           |  3 ++
 lib/erl_docgen/doc/src/erl_docgen_app.xml | 64 +++++++++++++++++++++++++++++++
 lib/erl_docgen/doc/src/ref_man.xml        |  2 +-
 6 files changed, 77 insertions(+), 10 deletions(-)
 delete mode 100644 lib/erl_docgen/doc/man3/.gitignore
 create mode 100644 lib/erl_docgen/doc/man6/.gitignore
 create mode 100644 lib/erl_docgen/doc/src/erl_docgen_app.xml

(limited to 'lib/erl_docgen/doc')

diff --git a/lib/erl_docgen/doc/man3/.gitignore b/lib/erl_docgen/doc/man3/.gitignore
deleted file mode 100644
index e69de29bb2..0000000000
diff --git a/lib/erl_docgen/doc/man6/.gitignore b/lib/erl_docgen/doc/man6/.gitignore
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/lib/erl_docgen/doc/src/Makefile b/lib/erl_docgen/doc/src/Makefile
index 1845f57fad..a546d8da33 100644
--- a/lib/erl_docgen/doc/src/Makefile
+++ b/lib/erl_docgen/doc/src/Makefile
@@ -1,7 +1,7 @@
 #
 # %CopyrightBegin%
 #
-# Copyright Ericsson AB 1997-2010. All Rights Reserved.
+# Copyright Ericsson AB 2011-2011. All Rights Reserved.
 #
 # The contents of this file are subject to the Erlang Public License,
 # Version 1.1, (the "License"); you may not use this file except in
@@ -36,8 +36,8 @@ RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN)
 # Target Specs
 # ----------------------------------------------------
 XML_APPLICATION_FILES = ref_man.xml
-XML_REF3_FILES = \
-	docgen_xml_check.xml
+XML_REF6_FILES = \
+	erl_docgen_app.xml
 
 XML_PART_FILES = \
 	part.xml
@@ -54,7 +54,7 @@ XML_CHAPTER_FILES = \
 
 BOOK_FILES = book.xml
 
-XML_FILES = $(BOOK_FILES) $(XML_APPLICATION_FILES) $(XML_REF3_FILES) \
+XML_FILES = $(BOOK_FILES) $(XML_APPLICATION_FILES) $(XML_REF6_FILES) \
             $(XML_PART_FILES) $(XML_CHAPTER_FILES) 
 
 TECHNICAL_DESCR_FILES = 
@@ -73,7 +73,7 @@ HTML_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \
 
 INFO_FILE = ../../info
 
-MAN3_FILES = $(XML_REF3_FILES:%.xml=$(MAN3DIR)/%.3)
+MAN6_FILES = $(XML_REF6_FILES:%_app.xml=$(MAN6DIR)/%.6)
 
 HTML_REF_MAN_FILE = $(HTMLDIR)/index.html
 
@@ -104,12 +104,12 @@ html: gifs examples $(HTML_REF_MAN_FILE)
 
 clean clean_docs:
 	rm -rf $(HTMLDIR)/*
-	rm -f $(MAN3DIR)/*
+	rm -f $(MAN6DIR)/*
 	rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo)
 	rm -f errs core *~
 	rm -f $(JD_HTML) $(JD_PACK)
 
-man: $(MAN3_FILES)
+man: $(MAN6_FILES)
 
 gifs: $(GIF_FILES:%=$(HTMLDIR)/%)
 
@@ -129,7 +129,7 @@ release_docs_spec: docs
 	$(INSTALL_DATA) $(HTMLDIR)/* \
 		$(RELSYSDIR)/doc/html
 	$(INSTALL_DATA) $(INFO_FILE) $(RELSYSDIR)
-	$(INSTALL_DIR) $(RELEASE_PATH)/man/man3
-	$(INSTALL_DATA) $(MAN3DIR)/* $(RELEASE_PATH)/man/man3
+	$(INSTALL_DIR) $(RELEASE_PATH)/man/man6
+	$(INSTALL_DATA) $(MAN6DIR)/* $(RELEASE_PATH)/man/man6
 
 release_spec:
diff --git a/lib/erl_docgen/doc/src/book.xml b/lib/erl_docgen/doc/src/book.xml
index 1eef9a621b..73bfb7916d 100644
--- a/lib/erl_docgen/doc/src/book.xml
+++ b/lib/erl_docgen/doc/src/book.xml
@@ -35,6 +35,9 @@
   <parts lift="no">
     <xi:include href="part.xml"/>
   </parts>
+  <applications>
+    <xi:include href="ref_man.xml"/>
+  </applications>
   <releasenotes>
     <xi:include href="notes.xml"/>
   </releasenotes>
diff --git a/lib/erl_docgen/doc/src/erl_docgen_app.xml b/lib/erl_docgen/doc/src/erl_docgen_app.xml
new file mode 100644
index 0000000000..25c473bb7e
--- /dev/null
+++ b/lib/erl_docgen/doc/src/erl_docgen_app.xml
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="latin1" ?>
+<!DOCTYPE appref SYSTEM "appref.dtd">
+
+<appref>
+  <header>
+    <copyright>
+      <year>2011</year><year>2011</year>
+      <holder>Ericsson AB. All Rights Reserved.</holder>
+    </copyright>
+    <legalnotice>
+      The contents of this file are subject to the Erlang Public License,
+      Version 1.1, (the "License"); you may not use this file except in
+      compliance with the License. You should have received a copy of the
+      Erlang Public License along with this software. If not, it can be
+      retrieved online at http://www.erlang.org/.
+
+      Software distributed under the License is distributed on an "AS IS"
+      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+      the License for the specific language governing rights and limitations
+      under the License.
+
+    </legalnotice>
+
+    <title>erl_docgen</title>
+    <file>erl_docgen_app.xml</file>
+  </header>
+  <app>erl_docgen</app>
+  <appsummary>
+    The erl_docgen application is used to produce the OTP documentation.
+  </appsummary>
+  
+    <description>
+      <p>
+	The application consists of the following parts
+	<taglist>
+	  <tag>XSL</tag>
+	  <item>
+	    <p>
+	      A number of XSL files that is used to transform the xml files to html, pdf or man pages.
+	    </p>
+	  </item>
+	  <tag>DTDs</tag>
+	  <item>
+	    <p>
+	      The DTDs used for the OTP documentation.
+	    </p>
+	  </item>
+	  <tag>escripts</tag>
+	  <item>
+	    <p>
+	      Some scripts that is used to produce xml files according to OTP DTDs from some different input.
+	    </p>
+	  </item>
+	  <tag>misc</tag>
+	  <item>
+	    <p>
+	      Erlang logo, javascripts and css stylesheets used in the documentation.
+	    </p>
+	  </item>
+	</taglist>
+      </p>
+    </description>
+
+</appref>
diff --git a/lib/erl_docgen/doc/src/ref_man.xml b/lib/erl_docgen/doc/src/ref_man.xml
index a92ab6c805..a2bc1a10a0 100644
--- a/lib/erl_docgen/doc/src/ref_man.xml
+++ b/lib/erl_docgen/doc/src/ref_man.xml
@@ -31,6 +31,6 @@
   <description>
     <p>The <em>erl_docgen</em> supports the OTP documentation build.</p>
   </description>
-  <xi:include href="docgen_xml_check.xml"/>
+  <xi:include href="erl_docgen_app.xml"/>
 </application>
 
-- 
cgit v1.2.3