diff options
author | joey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071> | 2006-11-20 11:31:23 +0000 |
---|---|---|
committer | joey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071> | 2006-11-20 11:31:23 +0000 |
commit | eac31eff5c9147792c2886359b0faa4615e51e77 (patch) | |
tree | ba2f38eee49cc4163ecbcfd4d173fbaf650cbe73 /doc/todo | |
parent | bcb41d1de98fc88829b978fb750582ad4523a8a1 (diff) |
shortcut stuff
Diffstat (limited to 'doc/todo')
-rw-r--r-- | doc/todo/shortcut_link_text.mdwn | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/doc/todo/shortcut_link_text.mdwn b/doc/todo/shortcut_link_text.mdwn index 31820836b..6842a911f 100644 --- a/doc/todo/shortcut_link_text.mdwn +++ b/doc/todo/shortcut_link_text.mdwn @@ -1 +1,19 @@ -[[plugins/shortcut]] creates link shortcut [[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 <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>, 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 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 url="http://bugs.debian.org/%s" desc="Debian bug #%s"]]`.
\ No newline at end of file +[[plugins/shortcut]] creates link shortcut [[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 +<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>, +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 +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 +url="http://bugs.debian.org/%s" desc="Debian bug #%s"]]`. + +> [[todo/done]] --[[Joey]] |