Buildroot Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Thomas De Schampheleire <patrickdepinguin@gmail.com>
To: buildroot@busybox.net
Subject: [Buildroot] [PATCH 4 of 5 v4 for 2014.08] manual-text: make sure URLs are displayed if a link text was provided
Date: Fri, 15 Aug 2014 15:40:37 +0200	[thread overview]
Message-ID: <93b82c1cf8a4a7cf3212.1408110037@localhost> (raw)
In-Reply-To: <patchbomb.1408110033@localhost>

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>

---
v4: no changes
v3: no changes
v2:
- link to relevant documentation (which was hard to find)
- refine so that the display is identical to before when no link text is
  provided.

 docs/manual/asciidoc-text.conf |  17 +++++++++++++++++
 1 files changed, 17 insertions(+), 0 deletions(-)

diff -r 81d40b841073 -r 93b82c1cf8a4 docs/manual/asciidoc-text.conf
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/manual/asciidoc-text.conf	Sat Aug 09 19:42:30 2014 +0200
@@ -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;}

  parent reply	other threads:[~2014-08-15 13:40 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-08-15 13:40 [Buildroot] [PATCH 0 of 5 v4 for 2014.08] manual-text generation improvements Thomas De Schampheleire
2014-08-15 13:40 ` [Buildroot] [PATCH 1 of 5 v4 for 2014.08] Makefile: unconditionally include pkg-utils.mk Thomas De Schampheleire
2014-08-15 22:04   ` Yann E. MORIN
2014-08-15 13:40 ` [Buildroot] [PATCH 2 of 5 v4 for 2014.08] gendoc infra: use $(pkgname) instead of explicitly passing 'manual' Thomas De Schampheleire
2014-08-15 14:50   ` Samuel Martin
2014-08-15 22:13   ` Yann E. MORIN
2014-08-15 13:40 ` [Buildroot] [PATCH 3 of 5 v4 for 2014.08] gendoc infra: add support for asciidoc configuration files Thomas De Schampheleire
2014-08-15 22:23   ` Yann E. MORIN
2014-08-15 13:40 ` Thomas De Schampheleire [this message]
2014-08-15 22:32   ` [Buildroot] [PATCH 4 of 5 v4 for 2014.08] manual-text: make sure URLs are displayed if a link text was provided Yann E. MORIN
2014-08-15 13:40 ` [Buildroot] [PATCH 5 of 5 v4 for 2014.08] manual-text: hide image representations Thomas De Schampheleire
2014-08-15 22:45   ` Yann E. MORIN
2014-08-15 14:53 ` [Buildroot] [PATCH 0 of 5 v4 for 2014.08] manual-text generation improvements Samuel Martin
2014-08-16  7:35 ` Thomas Petazzoni
2014-08-16 10:15   ` Thomas De Schampheleire
2014-08-16 11:00     ` Samuel Martin
2014-08-16 17:24       ` Samuel Martin
2014-08-16 18:08         ` Thomas Petazzoni
2014-08-16 18:35         ` Thomas De Schampheleire
2014-08-16 19:39           ` Samuel Martin
2014-08-17 10:17             ` Thomas De Schampheleire

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=93b82c1cf8a4a7cf3212.1408110037@localhost \
    --to=patrickdepinguin@gmail.com \
    --cc=buildroot@busybox.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox