OTP-8512 Add Erlangish MarkDown to Erlangish XML support

The INSTALL.md, INSTALL-CROSS.md, and INSTALL-WIN32.md "readme files" are now included in both the HTML and the PDF documentation.
author: Rickard Green <[email protected]> 2010-03-22 10:24:35 +0000
committer: Erlang/OTP <[email protected]> 2010-03-22 10:24:35 +0000
commit: d041cab91829ebacbd35ce2c5927f6ebe69b417a (patch)
tree: a3b40b6db27323c8ee10f8b873e4e03cbe7906cf /system
parent: 14801bff88836ad47850c91287b3126f132b5d65 (diff)
download: otp-d041cab91829ebacbd35ce2c5927f6ebe69b417a.tar.gz
otp-d041cab91829ebacbd35ce2c5927f6ebe69b417a.tar.bz2
otp-d041cab91829ebacbd35ce2c5927f6ebe69b417a.zip
5 files changed, 54 insertions, 45 deletions
diff --git a/system/doc/installation_guide/Makefile b/system/doc/installation_guide/Makefile
index 854025765c..a47d77604d 100644
--- a/system/doc/installation_guide/Makefile
+++ b/system/doc/installation_guide/Makefile
@@ -31,6 +31,7 @@ APPLICATION=otp-system-documentation
 # Release directory specification
 # ----------------------------------------------------
 RELSYSDIR = $(RELEASE_PATH)/doc/installation_guide
+REDIRECT_HTML_RELSYSDIR = $(RELSYSDIR)/source
 
 # ----------------------------------------------------
 # Target Specs
@@ -54,14 +55,11 @@ XML_FILES = \
 	$(XML_PART_FILES) 
 
 # ----------------------------------------------------
-# Install readme files
-# ----------------------------------------------------
-SOURCE_INSTALL_READMES = \
-	$(ERL_TOP)/INSTALL.html \
-	$(ERL_TOP)/INSTALL-CROSS.html \
-	$(ERL_TOP)/INSTALL-WIN32.html
+GENERATED_XML_FILES = \
+	INSTALL.xml \
+	INSTALL-CROSS.xml \
+	INSTALL-WIN32.xml
 
-SOURCE_RELSYSDIR = $(RELSYSDIR)/source
 # ----------------------------------------------------
 
 HTML_FILES = \
@@ -71,6 +69,12 @@ HTMLDIR = ../html/installation_guide
 
 HTML_UG_FILE = $(HTMLDIR)/users_guide.html
 
+REDIRECT_HTML_DIR = $(HTMLDIR)/source
+REDIRECT_HTML_FILES = \
+	$(REDIRECT_HTML_DIR)/INSTALL.html \
+	$(REDIRECT_HTML_DIR)/INSTALL-CROSS.html \
+	$(REDIRECT_HTML_DIR)/INSTALL-WIN32.html
+
 # ----------------------------------------------------
 # FLAGS 
 # ----------------------------------------------------
@@ -80,15 +84,32 @@ DVIPS_FLAGS +=
 # ----------------------------------------------------
 # Targets
 # ----------------------------------------------------
-docs: html
+
+%.xml: $(ERL_TOP)/%.md $(ERL_TOP)/make/emd2exml
+	$(ERL_TOP)/make/emd2exml $< $@
+
+$(REDIRECT_HTML_DIR)/%.html: Makefile
+	test -d $(REDIRECT_HTML_DIR) || $(INSTALL_DIR) $(REDIRECT_HTML_DIR)
+	echo "<html><head><meta HTTP-EQUIV=\"REFRESH\"" > $@
+	echo " content=\"5; url=../"$(notdir $@)"\">" >> $@
+	echo "<title>This page has moved</title></head><body>" >> $@
+	echo "<h1>This page has moved</h1>" >> $@
+	echo "<p>You will be automatically redirected to its new" >> $@
+	echo "location in 5 seconds." >> $@
+	echo "This <a href=\"../"$(notdir $@)"\">link</a> will" >> $@
+	echo "take you there immediately.</p></body></html>" >> $@
+
+docs: $(GENERATED_XML_FILES) html
 
 local_docs: PDFDIR=../../pdf
+local_docs: $(GENERATED_XML_FILES)
 
-html: $(GIF_FILES) $(HTML_UG_FILE)
+html: $(REDIRECT_HTML_FILES) $(GENERATED_XML_FILES) $(GIF_FILES) $(HTML_UG_FILE)
 
-debug opt: 
+debug opt:
 
 clean clean_docs:
+	rm -f $(GENERATED_XML_FILES)
 	rm -rf $(HTMLDIR)
 	rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo)
 	rm -f errs core *~ 
@@ -102,8 +123,8 @@ include $(ERL_TOP)/make/otp_release_targets.mk
 release_docs_spec: docs
 	$(INSTALL_DIR) $(RELSYSDIR)
 	$(INSTALL_DATA) $(GIF_FILES) $(HTMLDIR)/*.html $(RELSYSDIR)
-	$(INSTALL_DIR) $(SOURCE_RELSYSDIR)
-	$(INSTALL_DATA) $(SOURCE_INSTALL_READMES) $(SOURCE_RELSYSDIR)
+	$(INSTALL_DIR) $(REDIRECT_HTML_RELSYSDIR)
+	$(INSTALL_DATA) $(REDIRECT_HTML_FILES) $(REDIRECT_HTML_RELSYSDIR)
 
 release_spec:
 
diff --git a/system/doc/installation_guide/install.xml b/system/doc/installation_guide/install-binary.xml
index c1b930a4bd..ac4192586d 100644
--- a/system/doc/installation_guide/install.xml
+++ b/system/doc/installation_guide/install-binary.xml
@@ -21,7 +21,7 @@
 
     </legalnotice>
 
-    <title>Installation</title>
+    <title>Installing the Binary Release</title>
     <prepared>Peter H&ouml;gfeldt</prepared>
     <responsible>Peter H&ouml;gfeldt</responsible>
     <docno></docno>
@@ -29,27 +29,10 @@
     <checked></checked>
     <date>1997-05-26</date>
     <rev>C</rev>
-    <file>install.xml</file>
+    <file>install-binary.xml</file>
   </header>
 
   <section>
-    <title>Source</title>
-      <p>This document describes installation procedures for
-         binary releases. Documentation of build and installation
-	 procedures for the source release can be found in the source
-	 tree at the following locations:</p>
-      <taglist>
-	 <tag>Building and Installing Erlang/OTP</tag>
-         <item><url href="source/INSTALL.html"><c>$ERL_TOP/INSTALL.md</c></url></item>
-	 <tag>Cross Compiling Erlang/OTP</tag>
-         <item><url href="source/INSTALL-CROSS.html"><c>$ERL_TOP/INSTALL-CROSS.md</c></url></item>
-	 <tag>How to Build Erlang/OTP on Windows</tag>
-         <item><url href="source/INSTALL-WIN32.html"><c>$ERL_TOP/INSTALL-WIN32.md</c></url></item>
-      </taglist>
-      <p>Where <c>$ERL_TOP</c> is the top directory in the source tree.</p>
-  </section>
-
-  <section>
     <title>UNIX</title>
 
     <section>
@@ -73,7 +56,7 @@
         which is <c><![CDATA[<PREFIX>.tar.gz]]></c>, where <c><![CDATA[<PREFIX>]]></c> is a string
         denoting the particular Erlang/OTP release, e.g.
         <c>otp_LXA_11930_sunos5_R9B</c>.</p>
-      <p>Wherever the string <c><![CDATA[<PREFIX>]]></c> is used below, it should 
+      <p>Wherever the string <c><![CDATA[<PREFIX>]]></c> is used below, it should
         be replaced by the actual name prefix of the compressed tar file.</p>
       <p>The tape archive file does not have one single directory in which
         all other files are rooted. Therefore the tape archive file must be
@@ -162,4 +145,3 @@ ln -s /usr/local/erlang/otp_r7b/bin/erl /usr/local/bin/erl </pre>
     </section>
   </section>
 </chapter>
-
diff --git a/system/doc/installation_guide/make.dep b/system/doc/installation_guide/make.dep
index 3d1477935d..3878f4ac9d 100644
--- a/system/doc/installation_guide/make.dep
+++ b/system/doc/installation_guide/make.dep
@@ -9,5 +9,5 @@
 # TeX files that the DVI file depend on
 # ----------------------------------------------------
 
-book.dvi: book.tex install.tex part.tex verification.tex
+book.dvi: book.tex install-binary.tex part.tex verification.tex
 
diff --git a/system/doc/installation_guide/part.xml b/system/doc/installation_guide/part.xml
index 3019d2e118..fceacdd8f6 100644
--- a/system/doc/installation_guide/part.xml
+++ b/system/doc/installation_guide/part.xml
@@ -4,7 +4,7 @@
 <part xmlns:xi="http://www.w3.org/2001/XInclude">
   <header>
     <copyright>
-      <year>2000</year><year>2009</year>
+      <year>2000</year><year>2010</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -13,12 +13,12 @@
       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>Installation Guide</title>
@@ -31,7 +31,10 @@
   <description>
     <p>How to install Erlang/OTP on UNIX or Windows.</p>
   </description>
-  <xi:include href="install.xml"/>
+  <xi:include href="install-binary.xml"/>
   <xi:include href="verification.xml"/>
+  <xi:include href="INSTALL.xml"/>
+  <xi:include href="INSTALL-CROSS.xml"/>
+  <xi:include href="INSTALL-WIN32.xml"/>
 </part>
 
diff --git a/system/doc/installation_guide/xmlfiles.mk b/system/doc/installation_guide/xmlfiles.mk
index 7e1235b64d..dee67b3c70 100644
--- a/system/doc/installation_guide/xmlfiles.mk
+++ b/system/doc/installation_guide/xmlfiles.mk
@@ -1,21 +1,24 @@
 #
 # %CopyrightBegin%
-# 
-# Copyright Ericsson AB 2009. All Rights Reserved.
-# 
+#
+# Copyright Ericsson AB 2009-2010. 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
 # 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.
-# 
+#
 # %CopyrightEnd%
 #
 INST_GUIDE_CHAPTER_FILES = \
-	install.xml \
-	verification.xml
+	install-binary.xml \
+	verification.xml \
+	INSTALL.xml \
+	INSTALL-CROSS.xml \
+	INSTALL-WIN32.xml
author	Rickard Green <[email protected]>	2010-03-22 10:24:35 +0000
committer	Erlang/OTP <[email protected]>	2010-03-22 10:24:35 +0000
commit	d041cab91829ebacbd35ce2c5927f6ebe69b417a (patch)
tree	a3b40b6db27323c8ee10f8b873e4e03cbe7906cf /system
parent	14801bff88836ad47850c91287b3126f132b5d65 (diff)
download	otp-d041cab91829ebacbd35ce2c5927f6ebe69b417a.tar.gz otp-d041cab91829ebacbd35ce2c5927f6ebe69b417a.tar.bz2 otp-d041cab91829ebacbd35ce2c5927f6ebe69b417a.zip