quetz-mod_python-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jim Gallacher <...@jgassociates.ca>
Subject Re: Updated documentation on apache.import_module()
Date Sun, 03 Dec 2006 17:28:59 GMT
Jim Gallacher wrote:
> Jim Gallacher wrote:
>> Jim Gallacher wrote:
>>> Graham Dumpleton wrote:
>>>> Jim, I have updated LaTeX documentation for the apache.import_module()
>>>> function. Can you run it through LaTeX and fixup all my wrongly 
>>>> closed LaTeX
>>>> formatting. :-)
>>>
>>> It would seem LaTeX doesn't like naked tilde characters, as ~ is used 
>>> for markup. Something like:
>>>
>>> """The '~/' prefix should be  used."""
>>>
>>> becomes
>>>
>>> """The '&nbsp;/' prefix should be  used."""
>>>
>>> in the generated html.
>>>
>>
>> The solution is to use \textasciitilde, so
>>
>> """The '\textasciitilde/' prefix should be  used."""
>>
>> becomes
>>
>> """The '~/' prefix should be  used."""
>>
>> Note that the "~" character can be used without substitution within 
>> \begin{verbatim} and \end{verbatim}.
>>
>> I'll fix and commit the changes to the docs.
> 
> Using a tilde in a url is also messed up, and the \textasciitilde
> macro does not help. The solution is to use the hex
> encoding (%7e) for the tilde, so:
> 
> \seeurl{http://people.apache.org/~jgallacher}
> 
> should be written as:
> 
> \seeurl{http://people.apache.org/%7ejgallacher}

I've uploaded the generated docs with the tilde correction: 
http://people.apache.org/~jgallacher/mod_python/dist/mod_python-3.3.0-dev-20061203/doc-html/

Jim



Mime
View raw message