diff options
| author | Simon McVittie <smcv@ http://smcv.pseudorandom.co.uk/> | 2008-07-21 12:45:54 +0100 |
|---|---|---|
| committer | Simon McVittie <smcv@ http://smcv.pseudorandom.co.uk/> | 2008-07-21 12:45:54 +0100 |
| commit | 1ca63edde0a1f09e58c9c1da1cf9ac7a6805750b (patch) | |
| tree | 79d0f45eedb598cbaa1452137731f8800ff65e4c /doc/todo/shortcut_link_text.mdwn | |
| parent | 47d179802d5f78365fa7077ae64de35f2892a1e4 (diff) | |
Migrate escaped directives (\[[) in doc/todo to have \[[! prefix
Diffstat (limited to 'doc/todo/shortcut_link_text.mdwn')
| -rw-r--r-- | doc/todo/shortcut_link_text.mdwn | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/todo/shortcut_link_text.mdwn b/doc/todo/shortcut_link_text.mdwn index d03d37411..765c445ab 100644 --- a/doc/todo/shortcut_link_text.mdwn +++ b/doc/todo/shortcut_link_text.mdwn @@ -1,19 +1,19 @@ [[plugins/shortcut]] creates link shortcut [[ikiwiki/PreprocessorDirective]]s, which substitute their argument into the specified shortcut URL to generate the link target, and use the argument as the link text. For example, given -the example [[shortcuts]], `\[[wikipedia ikiwiki]]` generates a link to +the example [[shortcuts]], `\[[!wikipedia ikiwiki]]` generates a link to <http://en.wikipedia.org/wiki/ikiwiki>, with the link text "ikiwiki". This works well in many cases; however, for things like the `debbug` example, it simply uses the number as the link text, which does not always provide enough context to understand the link at first glance. For example, -`\[[debbug 397501]]` generates a link to <http://bugs.debian.org/397501>, +`\[[!debbug 397501]]` generates a link to <http://bugs.debian.org/397501>, with just "397501" as the link text. While [[plugins/template]] provides a general solution for arbitrary cases, it would help to have a simple option via the shortcut plugin to set the link text, with a `%s` substitution. -Thus, something like `\[[shortcut name=debbug +Thus, something like `\[[!shortcut name=debbug url="http://bugs.debian.org/%s" desc="bug #%s"]]` might suffice on a Debian-specific wiki to indicate a bug number, while a more general wiki -might use something like `\[[shortcut name=debbug +might use something like `\[[!shortcut name=debbug url="http://bugs.debian.org/%s" desc="Debian bug #%s"]]`. > [[todo/done]] --[[Joey]] |