svn commit: r481810 - in /httpd/mod_python/trunk/Doc: README modpython2.tex modpython4.tex

[jg...@apache.org]

Author: jgallacher
Date: Sun Dec  3 08:56:19 2006
New Revision: 481810

URL: http://svn.apache.org/viewvc?view=rev&rev=481810
Log:
Fixed the LaTeX tilde character problems in the Docs.
Fixed a broken html link (which contained a tilde).
Added some notes on LaTeX tilde handling to Doc/README so we don't forget
how to do this in the future.

Modified:
    httpd/mod_python/trunk/Doc/README
    httpd/mod_python/trunk/Doc/modpython2.tex
    httpd/mod_python/trunk/Doc/modpython4.tex

Modified: httpd/mod_python/trunk/Doc/README
URL: http://svn.apache.org/viewvc/httpd/mod_python/trunk/Doc/README?view=diff&rev=481810&r1=481809&r2=481810
==============================================================================
--- httpd/mod_python/trunk/Doc/README (original)
+++ httpd/mod_python/trunk/Doc/README Sun Dec  3 08:56:19 2006
@@ -23,3 +23,34 @@
 
 Good Luck!
 
+
+LaTeX Notes
+-----------
+
+Using the tilde character in LaTex is a bit of a headache as ~ is used for
+markup.
+
+The obvious solution of escaping it as \~ doesn't work, as this is also used
+for markup and actually adds a diactrical to the immediately following 
+character.
+
+If you want a ~ enclosed in double quotes you can use \character{\~}.
+So \character{\~} becomes "~" in the generated documentation.
+
+If you want a ~ without the quotes you can use \textasciitilde.
+For example ~/foo/bar should be written as \textasciitilde/foo/bar in the
+LaTeX source.
+
+Using \textasciitilde does not work if there is an alpha-numeric character 
+immediately following. For a url you can hex encode the ~ as %7e. For example:
+	http://people.apache.org/~jgallacher
+should be written as:
+	http://people.apache.org/\%7ejgallacher
+
+Note that the ~ character is handled properly within a {verbatim} section,
+so the following works without modification:
+
+  \begin{verbatim}
+	path = "~/foo/bar"
+  \end{verbatim}
+

Modified: httpd/mod_python/trunk/Doc/modpython2.tex
URL: http://svn.apache.org/viewvc/httpd/mod_python/trunk/Doc/modpython2.tex?view=diff&rev=481810&r1=481809&r2=481810
==============================================================================
--- httpd/mod_python/trunk/Doc/modpython2.tex (original)
+++ httpd/mod_python/trunk/Doc/modpython2.tex Sun Dec  3 08:56:19 2006
@@ -413,7 +413,7 @@
 \end{enumerate}
 
 \begin{seealso}
-  \seeurl{http://home.comcast.net/~d.popowich/mpservlets}{mpservlets}
+  \seeurl{http://www.astro.umass.edu/\%7edpopowich/python/mpservlets/}{mpservlets}
   \seeurl{http://www.dscpl.com.au/projects/vampire}{Vampire}
 \end{seealso}
 

Modified: httpd/mod_python/trunk/Doc/modpython4.tex
URL: http://svn.apache.org/viewvc/httpd/mod_python/trunk/Doc/modpython4.tex?view=diff&rev=481810&r1=481809&r2=481810
==============================================================================
--- httpd/mod_python/trunk/Doc/modpython4.tex (original)
+++ httpd/mod_python/trunk/Doc/modpython4.tex Sun Dec  3 08:56:19 2006
@@ -581,8 +581,8 @@
   \code{VirtualHost} directive, or at global server scope, the handler root
   will be the relevant document root for the server.
   
-  To express path relatives to the handler root, the '~/' prefix should be
-  used. A forward slash must again always be used.
+  To express path relatives to the handler root, the '\textasciitilde/' prefix
+  should be used. A forward slash must again always be used.
 
   For example:
 
@@ -643,16 +643,16 @@
   to the mod_python module importer, whether it be specified using the
   \code{PythonOption} called \code{mod_python.importer.path}, using the
   \var{path} argument to the \code{apache.import_module()} function or
-  in the \code{__mp_path__} attribute, the prefix '~/' can be used in
-  a path and that path will be taken as being relative to handler root.
-  For example:
+  in the \code{__mp_path__} attribute, the prefix '\textasciitilde/'
+  can be used in a path and that path will be taken as being relative
+  to handler root. For example:
 
   \begin{verbatim}
     PythonOption mod_python.importer.path "['~/modules']"
   \end{verbatim}
 
-  If wishing to refer to the handler root directory itself, then '~' can be
-  used and the trailing slash left off. For example:
+  If wishing to refer to the handler root directory itself, then
+  '\textasciitilde' can be used and the trailing slash left off. For example:
 
   \begin{verbatim}
     PythonOption mod_python.importer.path "['~']"
@@ -664,16 +664,17 @@
   importer only when required, some existing code which expected to be able
   to import modules in the handler root directory from a module in a
   subdirectory may no longer work. In these situations it will be necessary
-  to set the mod_python module importer path to include '~' or list '~' in
-  the \code{__mp_path__} attribute of the module performing the import.
-
-  This trick of listing '~' in the module importer path will not however
-  help in the case where Python packages were previously being placed into
-  the handler root directory. In this case, the Python package should
-  either be moved out of the document tree and the directory where it is
-  located listed against the \code{PythonPath} directive, or the package
-  converted into the pseudo packages that mod_python supports and change
-  the module imports used to access the package.
+  to set the mod_python module importer path to include '\textasciitilde'
+  or list '\textasciitilde' in the \code{__mp_path__} attribute of the module
+  performing the import.
+
+  This trick of listing '\textasciitilde' in the module importer path 
+  will not however help in the case where Python packages were previously
+  being placed into the handler root directory. In this case, the Python
+  package should either be moved out of the document tree and the directory
+  where it is located listed against the \code{PythonPath} directive, or the
+  package converted into the pseudo packages that mod_python supports and
+  change the module imports used to access the package.
 
   Only modules which could be imported by the mod_python module importer
   will be candidates for automatic reloading when changes are made to the