aboutsummaryrefslogtreecommitdiff
path: root/doc/todo/shortcut_with_different_link_text.mdwn
blob: d1e5e2b2645a9da44781aeaf254e797878eae3ed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
I'd like the ability to use a shortcut, but declare an explicit link text
rather than using the link text defined on [[/shortcuts]].  For example, if I
create a shortcut `protogit` pointing to files in the xcb/proto.git gitweb
repository, I don't always want to use the path to the file as the link text;
I would like to src/xcb.xsd, but use the link text "XML Schema for the X
Window System protocol".  --[[JoshTriplett]]

> If I understand you correctly, you can use Markdown \[your link text\]\(the path or URL\) . Using your example:
> [XML Schema for the X Window System protocol](src/xcb.xsd)
>
> If I don't understand this, can you give an HTML example? --[[JeremyReed]]

>> The problem is like that in [[bugs/shortcuts_don't_escape_from_Markdown]]. We would like to use 
>> the shortcuts plugin but add a descriptive text -- in this case \[[xcbgit src/xcb.xsd|XML Schema...]]
>> The file src/xcb.xsd could be any url, and the point of shortcuts is that you get to shorten it.
>> --Ethan

>>> Some clarifications:
>>> You can always write something like
>>> `[XML Schema for the X Window System Protocol](http://gitweb.freedesktop.org/?p=xcb/proto.git;a=blob;hb=HEAD;f=src/xcb.xsd)`
>>> to get [XML Schema for the X Window System Protocol](http://gitweb.freedesktop.org/?p=xcb/proto.git;a=blob;hb=HEAD;f=src/xcb.xsd).
>>> However, I want to define a [[plugins/shortcut]] to save the typing.  If I
>>> define something like `protogit` pointing to
>>> `http://gitweb.freedesktop.org/?p=xcb/proto.git;a=blob;hb=HEAD;f=%s`, then
>>> I can write `\[[protogit src/xcb.xsd]]`; however, I then can't change the
>>> link text to anything other than what the shortcut defines as the link
>>> text. I want to write something like
>>> `\[[XML Schema for the X Window System Protocol|protogit src/xcb.xsd]]`,
>>> just as I would write a wikilink like
>>> `\[[the_shortcuts_on_this_wiki|shortcuts]]` to get
>>> [[the_shortcuts_on_this_wiki|shortcuts]]. (The order you suggest, with the
>>> preprocessor directive first, seems quite confusing since wikilinks work
>>> the other way around.) --[[JoshTriplett]]

> How about \\[[xcbgit XML_Schema|src/xcb.xsd]]. That's the same way round
> as a wikilink, if you look at it the right way. The syntax Josh suggests
> is not currently possible in ikiwiki.
> 
> However.. [[Short_wikilinks]] has some similar objectives in a way, and
> over there a similar syntax to what Josh proposes was suggested. So maybe
> I should modify how ikiwiki preprocessors work to make it doable.
> Although, I seem to have come up with a clear alternative syntax over
> there. --[[Joey]]