* Move LaTeX docs into a tex/ subdirectory of the doc/ dir
authorRussell Bryant <russell@russellbryant.com>
Mon, 2 Jul 2007 22:27:46 +0000 (22:27 +0000)
committerRussell Bryant <russell@russellbryant.com>
Mon, 2 Jul 2007 22:27:46 +0000 (22:27 +0000)
* Add a Makefile in doc/tex/ for generating PDF and HTML
* Add a README.txt file to doc/tex/ to document which tools are used and what
  web sites to visit for getting them.
* Update build_tools/prep_tarball to put the proper Asterisk version string
  in the automatically generated PDF for release tarballs

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@72982 65c4cc65-6c06-0410-ace0-fbb531ad65f3

40 files changed:
Makefile
build_tools/prep_tarball
doc/tex/Makefile [new file with mode: 0644]
doc/tex/README.txt [new file with mode: 0644]
doc/tex/ael.tex [moved from doc/ael.tex with 100% similarity]
doc/tex/ajam.tex [moved from doc/ajam.tex with 100% similarity]
doc/tex/app-sms.tex [moved from doc/app-sms.tex with 100% similarity]
doc/tex/ast_agi_commands.tex [moved from doc/ast_agi_commands.tex with 100% similarity]
doc/tex/ast_appdocs.tex [moved from doc/ast_appdocs.tex with 100% similarity]
doc/tex/ast_cli_commands.tex [moved from doc/ast_cli_commands.tex with 100% similarity]
doc/tex/ast_funcdocs.tex [moved from doc/ast_funcdocs.tex with 100% similarity]
doc/tex/ast_manager_actiondocs.tex [moved from doc/ast_manager_actiondocs.tex with 100% similarity]
doc/tex/asterisk-conf.tex [moved from doc/asterisk-conf.tex with 100% similarity]
doc/tex/asterisk.tex [moved from doc/asterisk.tex with 98% similarity]
doc/tex/billing.tex [moved from doc/billing.tex with 100% similarity]
doc/tex/cdrdriver.tex [moved from doc/cdrdriver.tex with 100% similarity]
doc/tex/chaniax.tex [moved from doc/chaniax.tex with 100% similarity]
doc/tex/channelvariables.tex [moved from doc/channelvariables.tex with 100% similarity]
doc/tex/cliprompt.tex [moved from doc/cliprompt.tex with 100% similarity]
doc/tex/configuration.tex [moved from doc/configuration.tex with 100% similarity]
doc/tex/dundi.tex [moved from doc/dundi.tex with 100% similarity]
doc/tex/enum.tex [moved from doc/enum.tex with 100% similarity]
doc/tex/extensions.tex [moved from doc/extensions.tex with 100% similarity]
doc/tex/freetds.tex [moved from doc/freetds.tex with 100% similarity]
doc/tex/hardware.tex [moved from doc/hardware.tex with 100% similarity]
doc/tex/ices.tex [moved from doc/ices.tex with 100% similarity]
doc/tex/imapstorage.tex [moved from doc/imapstorage.tex with 100% similarity]
doc/tex/jitterbuffer.tex [moved from doc/jitterbuffer.tex with 100% similarity]
doc/tex/localchannel.tex [moved from doc/localchannel.tex with 100% similarity]
doc/tex/manager.tex [moved from doc/manager.tex with 100% similarity]
doc/tex/misdn.tex [moved from doc/misdn.tex with 100% similarity]
doc/tex/mp3.tex [moved from doc/mp3.tex with 100% similarity]
doc/tex/odbcstorage.tex [moved from doc/odbcstorage.tex with 100% similarity]
doc/tex/privacy.tex [moved from doc/privacy.tex with 100% similarity]
doc/tex/qos.tex [moved from doc/qos.tex with 100% similarity]
doc/tex/queuelog.tex [moved from doc/queuelog.tex with 100% similarity]
doc/tex/queues-with-callback-members.tex [moved from doc/queues-with-callback-members.tex with 100% similarity]
doc/tex/realtime.tex [moved from doc/realtime.tex with 100% similarity]
doc/tex/security.tex [moved from doc/security.tex with 100% similarity]
doc/tex/sla.tex [moved from doc/sla.tex with 100% similarity]

index fb54046..be1830f 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -699,22 +699,4 @@ menuselect-tree: $(foreach dir,$(filter-out main,$(MOD_SUBDIRS)),$(wildcard $(di
 
 asterisk.pdf: doc/asterisk.pdf
 
-doc/asterisk.pdf: $(wildcard doc/*.tex)
-ifeq ($(findstring rubber,$(RUBBER)),)
-       @echo "**********************************************"
-       @echo "** You must install the \"rubber\" tool      ***"
-       @echo "** to generate the Asterisk reference PDF. ***"
-       @echo "**********************************************"
-else
-       @echo "**********************************************"
-       @echo "** The Asterisk reference PDF will now be  ***"
-       @echo "** generated.  When complete, it will be   ***"
-       @echo "** located at doc/asterisk.pdf.            ***"  
-       @echo "**********************************************"
-       @cp doc/asterisk.tex doc/asterisk.tex.orig
-       @sed -i -e 's/ASTERISKVERSION/$(ASTERISKVERSION)/' doc/asterisk.tex
-       @cd doc && $(RUBBER) --pdf asterisk.tex
-       @mv doc/asterisk.tex.orig doc/asterisk.tex
-endif
-
 .PHONY: menuselect main sounds clean dist-clean distclean all prereqs cleantest uninstall _uninstall uninstall-all dont-optimize $(SUBDIRS_INSTALL) $(SUBDIRS_CLEAN) $(SUBDIRS_UNINSTALL) $(SUBDIRS) $(MOD_SUBDIRS_EMBED_LDSCRIPT) $(MOD_SUBDIRS_EMBED_LDFLAGS) $(MOD_SUBDIRS_EMBED_LIBS) menuselect.makeopts
index dbdbd46..d8a55be 100755 (executable)
@@ -9,4 +9,6 @@ make -C sounds all MENUSELECT_CORE_SOUNDS=CORE-SOUNDS-EN-GSM MENUSELECT_MOH=MOH-
 
 make menuselect-tree
 
-cd doc && rubber --pdf asterisk.tex
+VERSION=`cat .version`
+sed -i -e "s/ASTERISKVERSION/${VERSION}/" doc/tex/asterisk.tex
+cd doc/tex && rubber --pdf asterisk.tex
diff --git a/doc/tex/Makefile b/doc/tex/Makefile
new file mode 100644 (file)
index 0000000..2ccf892
--- /dev/null
@@ -0,0 +1,35 @@
+include ../../makeopts
+
+pdf: asterisk.pdf
+
+asterisk.pdf: $(wildcard *.tex)
+ifeq ($(findstring rubber,$(RUBBER)),)
+       @echo "**********************************************"
+       @echo "** You must install the \"rubber\" tool      ***"
+       @echo "** to generate the Asterisk reference PDF. ***"
+       @echo "**********************************************"
+else
+       @echo "**********************************************"
+       @echo "** The Asterisk reference PDF will now be  ***"
+       @echo "** generated.  When complete, it will be   ***"
+       @echo "** located at asterisk.pdf.                ***"  
+       @echo "**********************************************"
+       @cp asterisk.tex asterisk.tex.orig
+       @sed -i -e 's/ASTERISKVERSION/$(ASTERISKVERSION)/' asterisk.tex
+       @$(RUBBER) --pdf asterisk.tex
+       @mv asterisk.tex.orig asterisk.tex
+endif
+
+html:
+       @echo "**********************************************"
+       @echo "** The Asterisk reference HTML will now be ***"
+       @echo "** generated.  When complete, it will be   ***"
+       @echo "** located in the asterisk/ directory.     ***"  
+       @echo "** Note that the latex2html tool is        ***"  
+       @echo "** required for this to work.              ***"  
+       @echo "**********************************************"
+       @cp asterisk.tex asterisk.tex.orig
+       @sed -i -e 's/ASTERISKVERSION/$(ASTERISKVERSION)/' asterisk.tex
+       @latex2html asterisk.tex
+       @mv asterisk.tex.orig asterisk.tex
+
diff --git a/doc/tex/README.txt b/doc/tex/README.txt
new file mode 100644 (file)
index 0000000..460d330
--- /dev/null
@@ -0,0 +1,24 @@
+Asterisk Reference Documentation
+--------------------------------
+
+1) To generate a PDF from this documentation, you will need the rubber tool,
+   and all of its dependencies.  The web site for this tool is:
+
+      http://www.pps.jussieu.fr/~beffara/soft/rubber/
+
+   Then, once this tool is installed, running "make pdf" will generate
+   the PDF automatically using this tool.  The result will be asterisk.pdf.
+
+   NOTE:  After installing rubber, you will need to re-run the top level
+   configure script.  It checks to see if rubber is installed, so that the
+   asterisk.pdf Makefile target can produce a useful error message when it is
+   not installed.
+
+2) To generate HTML from this documentation, you will need the latex2html tool,
+   and all of its dependencies.  The web site for this tool is:
+
+      http://www.latex2html.org/
+
+   Then, once this tool is installed, running "make html" will generate the
+   HTML documentation.  The result will be an asterisk directory full of
+   HTML files.
similarity index 100%
rename from doc/ael.tex
rename to doc/tex/ael.tex
similarity index 100%
rename from doc/ajam.tex
rename to doc/tex/ajam.tex
similarity index 100%
rename from doc/app-sms.tex
rename to doc/tex/app-sms.tex
similarity index 100%
rename from doc/ast_appdocs.tex
rename to doc/tex/ast_appdocs.tex
similarity index 98%
rename from doc/asterisk.tex
rename to doc/tex/asterisk.tex
index 10ad7f0..e6bbf38 100644 (file)
@@ -22,7 +22,7 @@ This document contains various pieces of information that are useful for
 reference purposes.
 
   \section{License Information}
-  \input{../LICENSE}
+  \input{../../LICENSE}
      \subsection{Hold Music}
        Digium has licensed the music included with
        the Asterisk distribution From FreePlayMusic
@@ -81,7 +81,7 @@ reference purposes.
   \section{Introduction}
   \input{dundi.tex}
   \section{Peering Agreement}
-  \input{PEERING}
+  \input{../PEERING}
 
 \chapter{ENUM}
 \input{enum.tex}
similarity index 100%
rename from doc/billing.tex
rename to doc/tex/billing.tex
similarity index 100%
rename from doc/cdrdriver.tex
rename to doc/tex/cdrdriver.tex
similarity index 100%
rename from doc/chaniax.tex
rename to doc/tex/chaniax.tex
similarity index 100%
rename from doc/cliprompt.tex
rename to doc/tex/cliprompt.tex
similarity index 100%
rename from doc/dundi.tex
rename to doc/tex/dundi.tex
similarity index 100%
rename from doc/enum.tex
rename to doc/tex/enum.tex
similarity index 100%
rename from doc/extensions.tex
rename to doc/tex/extensions.tex
similarity index 100%
rename from doc/freetds.tex
rename to doc/tex/freetds.tex
similarity index 100%
rename from doc/hardware.tex
rename to doc/tex/hardware.tex
similarity index 100%
rename from doc/ices.tex
rename to doc/tex/ices.tex
similarity index 100%
rename from doc/imapstorage.tex
rename to doc/tex/imapstorage.tex
similarity index 100%
rename from doc/manager.tex
rename to doc/tex/manager.tex
similarity index 100%
rename from doc/misdn.tex
rename to doc/tex/misdn.tex
similarity index 100%
rename from doc/mp3.tex
rename to doc/tex/mp3.tex
similarity index 100%
rename from doc/odbcstorage.tex
rename to doc/tex/odbcstorage.tex
similarity index 100%
rename from doc/privacy.tex
rename to doc/tex/privacy.tex
similarity index 100%
rename from doc/qos.tex
rename to doc/tex/qos.tex
similarity index 100%
rename from doc/queuelog.tex
rename to doc/tex/queuelog.tex
similarity index 100%
rename from doc/realtime.tex
rename to doc/tex/realtime.tex
similarity index 100%
rename from doc/security.tex
rename to doc/tex/security.tex
similarity index 100%
rename from doc/sla.tex
rename to doc/tex/sla.tex