summaryrefslogtreecommitdiffstats
path: root/docs/manual
diff options
context:
space:
mode:
authorThomas De Schampheleire <patrickdepinguin@gmail.com>2014-08-15 15:40:37 +0200
committerThomas Petazzoni <thomas.petazzoni@free-electrons.com>2014-08-16 09:29:59 +0200
commit67274a9b6ffbb6266e253746bb257847e48e5566 (patch)
treee2f7bd21a49c6cdbb5e8024c258158f0f03a7ccf /docs/manual
parent05fa99d03c8f5207efb4ae30846a07f01519965a (diff)
downloadbuildroot-67274a9b6ffbb6266e253746bb257847e48e5566.tar.gz
buildroot-67274a9b6ffbb6266e253746bb257847e48e5566.zip
manual-text: make sure URLs are displayed if a link text was provided
When the asciidoc source contain URLs of the form: http://example.com[An example website] the text representation of the manual would only contain: An example website without displaying the actual URL. This patch adds an asciidoc configuration file that sets the inline macros for several URL types so that the display becomes: An example website [http://example.com] For URLs where no link text was provided, the display becomes: http://example.com which is the same as before. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Tested-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Diffstat (limited to 'docs/manual')
-rw-r--r--docs/manual/asciidoc-text.conf17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/manual/asciidoc-text.conf b/docs/manual/asciidoc-text.conf
new file mode 100644
index 0000000000..671cf3abc5
--- /dev/null
+++ b/docs/manual/asciidoc-text.conf
@@ -0,0 +1,17 @@
+# Refer to following asciidoc documentation:
+# http://www.methods.co.nz/asciidoc/userguide.html
+# In particular sections "Macros" and "Attribute References"
+#
+# For hyperlinks, show 'link text [URL]' (if link text provided) or 'URL'
+[http-inlinemacro]
+{0=}{0? &#91;}{name}:{target}{0?&#93;}
+[https-inlinemacro]
+{0=}{0? &#91;}{name}:{target}{0?&#93;}
+[ftp-inlinemacro]
+{0=}{0? &#91;}{name}:{target}{0?&#93;}
+[file-inlinemacro]
+{0=}{0? &#91;}{name}:{target}{0?&#93;}
+[irc-inlinemacro]
+{0=}{0? &#91;}{name}:{target}{0?&#93;}
+[mailto-inlinemacro]
+{0=}{0? &#91;}{name}:{target}{0?&#93;}
OpenPOWER on IntegriCloud