summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--includes/common.inc8
1 files changed, 8 insertions, 0 deletions
diff --git a/includes/common.inc b/includes/common.inc
index cd694fd..ea353d1 100644
--- a/includes/common.inc
+++ b/includes/common.inc
@@ -1596,6 +1596,14 @@ function drupal_attributes($attributes = array()) {
* internal links output by modules should be generated by this function if
* possible.
*
+ * However, for links enclosed in translatable text you should use t() and
+ * embed the HTML anchor tag directly in the translated string. For example:
+ * @code
+ * t('Visit the <a href="@url">settings</a> page', array('@url' => url('admin')));
+ * @endcode
+ * This keeps the context of the link title ('settings' in the example) for
+ * translators.
+ *
* @param $text
* The link text for the anchor tag.
* @param $path