summaryrefslogtreecommitdiff
path: root/docutils/test/functional/input/data
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2009-10-23 19:49:19 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2009-10-23 19:49:19 +0000
commite538843f8fb8bc26bb22d56c5ecf31edacca8feb (patch)
treeef6eca6c61308b79e9e8e2a80238732b90d3375e /docutils/test/functional/input/data
parent61ce6b36b1e7f8ab6986d5e38dce4c30cc72e074 (diff)
downloaddocutils-e538843f8fb8bc26bb22d56c5ecf31edacca8feb.tar.gz
Use the ``\\\\url`` command for URLs
(breaks long URLs instead of writing into the margin). git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@6183 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/test/functional/input/data')
-rw-r--r--docutils/test/functional/input/data/urls.txt62
1 files changed, 62 insertions, 0 deletions
diff --git a/docutils/test/functional/input/data/urls.txt b/docutils/test/functional/input/data/urls.txt
new file mode 100644
index 000000000..fc3d788cb
--- /dev/null
+++ b/docutils/test/functional/input/data/urls.txt
@@ -0,0 +1,62 @@
+External references
+-------------------
+
+Long URLs should be wrapped in the PDF.
+This can be achieved with the \url command which is used by the LaTeX writer
+wheneve the content (name) of a reference node equals the link URL.
+
+Example:
+ a long URL that should wrap in the output
+ http://docutils.sourceforge.net/docs/user/latex.html#id79
+
+
+If the argument contains any "%", "#", or "^^", or ends with ``\``, it can't
+be used in the argument to another command. The argument must not contain
+unbalanced braces.
+
+The characters ^, {, }, and ``\`` are invalid in a "http:" or "ftp:" URL
+and not recognized as part of it:
+
+| http://www.example.org/strange^^name
+| http://www.example.org\\using\\DOS\\paths\\
+| http://www.example.org/XML/strange{n}ame
+
+They can, however be used in paths and/or filenames.
+
+Handling by the LaTeX writer:
+
+* ``#``, ``\`` and ``%`` are escaped:
+
+ | `URL with # <http://www.w3.org/XML/Schema#dev>`__
+ http://www.w3.org/XML/Schema#dev
+ | `URL with % <http://www.w3.org/XML/Schema%dev>`__
+ http://example.org/Schema%dev
+ | `file with DOS path`__ `A:DOS\\path\\`__
+
+ .. note:: These URLs are typeset inside a LaTeX command without error.
+
+ | http://www.w3.org/XML/Schema#dev
+ | http://example.org/Schema%dev
+ | `A:DOS\\path\\`__
+
+__
+__
+__ A:DOS\\path\\
+
+
+* ^^ LaTeX's special syntax for characters results in "strange" replacements
+ (both with \href and \url). A warning is given.
+
+ `file with ^^ <../strange^^name>`__:
+ `<../strange^^name>`__
+
+* Unbalanced braces, { or }, will fail (both with \href and \url)::
+
+ `file with { <../strange{name>`__
+ `<../strange{name>`__
+
+ while balanced braces are suported:
+
+ | `<../strange{n}ame>`__
+ | `<../st{r}ange{n}ame>`__
+ | `<../{st{r}ange{n}ame}>`__