50245275ecdf4101e14404b5c2ec244878b29db0
[ikiwiki.git] / doc / todo / CSS_classes_for_links.mdwn
1 Hi Joey,
2
3 What do you think about CSS classes for links to display link with icon?
4 You probably know that there are wikis with that feature, for example
5 Moin Moin.
6
7 Here is a piece of `common.css` file grabbed from <http://wiki.openwrt.org>
8 site which is powered by Moin Moin wiki:
9
10     a.www:before {content: url(../img/moin-www.png); margin: 0 0.2em;}
11     a.http:before {content: url(../img/moin-www.png); margin: 0 0.2em;}
12     a.https:before {content: url(../img/moin-www.png); margin: 0 0.2em;}
13     a.file:before {content: url(../img/moin-ftp.png); margin: 0 0.2em;}
14     a.ftp:before {content: url(../img/moin-ftp.png); margin: 0 0.2em;}
15     a.nntp:before {content: url(../img/moin-news.png); margin: 0 0.2em;}
16     a.news:before {content: url(../img/moin-news.png); margin: 0 0.2em;}
17     a.telnet:before {content: url(../img/moin-telnet.png); margin: 0 0.2em;}
18     a.irc:before {content: url(../img/moin-telnet.png); margin: 0 0.2em;}
19     a.mailto:before {content: url(../img/moin-email.png); margin: 0 0.2em;}
20     a.attachment:before {content: url(../img/moin-attach.png); margin: 0 0.2em;}
21     a.badinterwiki:before {content: url(../img/moin-inter.png); margin: 0 0.2em;}
22     a.interwiki:before {content: url(../img/moin-inter.png); margin: 0 0.2em;}
23
24 You can see that they use a lot of CSS classes for links, but only one CSS class
25 for external links is enough for me :) Please look at my example:
26
27     \[[Foo]]                    -> <a href="http://www.mywiki.org/foo.html">Foo</a>
28     \[[Bar|foo/bar]]            -> <a href="http://www.mywiki.org/foo/bar.html">Bar</a>
29     <http://www.gnu.org/>      -> <a class="external" href="http://www.gnu.org/">http://www.gnu.org/</a>
30     [GNU](http://www.gnu.org/) -> <a class="external" href="http://www.gnu.org/">GNU</a>
31     [RMS](mailto:rms@gnu.org)  -> <a href="mailto:rms@gnu.org">RMS</a>
32
33 My best regards,
34
35 --[[Paweł|ptecza]]
36
37 > If you did not already know, you can achieve similar results using CSS3
38 > selectors.  Eg: `a[href="http://www.foobar.com/"] { foobar: css }` or
39 > `a[title~="Mail"] {text-decoration: none; }`.  See
40 > <http://www.w3.org/TR/2001/CR-css3-selectors-20011113/> for a complete list.
41
42 >> Hi Charles,
43 >>
44 >> Thanks for the hint! I don't know CSS3 yet :) What modern and popular
45 >> WWW browsers do support it now?
46 >>
47 >>> Safari supports it. Firefoz&Co support most of it. IE6 did not, but IE7
48 >>> supports a fair part of CSS3, ans is said to support selectors.
49 >>>
50 >>> Example on how to use selectors here: http://www.kryogenix.org/days/2002/08/30/external
51 >>>
52 >>> I also think this should be in an external plugin, not in ikiwiki.
53 >>>
54
55 I find CSS3 support still spotty...  Here are some notes on how to do this in IkiWiki with jQuery: <http://iki.u32.net/setup/External_Links> --[[sabr]]
56
57 > If you need to achieve this in IkiWiki itself, I imagine you could create a
58 > plugin which runs in the `format` phase of rendering and search/replaces
59 > specific link patterns.  This should be a fairly simple exercise in regular
60 > expressions.
61 >
62 > --CharlesMauch
63
64 >> I've never written plugin for ikiwiki, but I can try if it's simple job :)
65 >>
66 >> --[[Paweł|ptecza]]
67
68 > I wouldn't mind adding a _single_ css class to ikiwiki links, but it
69 > would have to be a class added to all internal, not all external, links.
70 > Reason is that there are many ways for external links to get into an
71 > ikiwiki page, including being entered as raw html. The only time ikiwiki
72 > controls a link is when an internal link is added using a WikiLink.
73 >
74 > (Note that tags get their own special
75 > [[rel_attribute|rel_attribute_for_links]] now that CSS can use.)
76
77 > --[[Joey]]
78
79 >> I had a little look at this, last weekend. I added a class definition to
80 >> the `htmllink` call in `linkify` in `link.pm`. It works pretty well, but
81 >> I'd also need to adjust other `htmllink` calls (map, inline, etc.). I found
82 >> other methods (CSS3 selectors, etc.) to be unreliable.
83 >> 
84 >> Would you potentially accept a patch that added `class="internal"` to
85 >> various `htmllink` calls in ikiwiki?
86 >> 
87 >> How configurable do you think this behaviour should be? I'm considering a
88 >> config switch to enable or disable this behaviour, or possibly a
89 >> configurable list of class names to append for internal links (defaulting
90 >> to an empty list for backwards compatibility)>
91 >> 
92 >> As an alternative to patching the uses of `htmllink`, what do you think
93 >> about patching `htmllink` itself? Are there circumstances where it might be
94 >> used to generate a non-internal link? -- [[Jon]]
95
96 >>> I think that the minimum configurability to get something that
97 >>> can be used by CSS to style the links however the end user wants
98 >>> is the best thing to shoot for. Ideally, no configurability. And
99 >>> a tip or something documenting how to use the classes in your CSS
100 >>> to style links so that eg, external links have a warning icon.
101 >>> 
102 >>> `htmllink` can never be used to generate an external link. So,
103 >>> patching it seems the best approach. --[[Joey]] 
104
105 >>>> I had a quick look to this issue. Internal links are generated at
106 >>>> 11 places in the Perl code and would need to be patched (this
107 >>>> number could be lowered a bit if a htmllink-like function existed
108 >>>> for CGI urls; such a function would use `cgiurl`, and be used in
109 >>>> most places where `cgiurl` is currently called by plugins).
110 >>>> 
111 >>>> Also, more than 30 `<a>` links appear in templates, most of those
112 >>>> being internal links.
113 >>>> 
114 >>>> Sure, patching those few dozen places is trivial. On the other
115 >>>> hand, I'm wondering how doable it would be to make sure, on the
116 >>>> long run, any generated internal link has the right CSS class
117 >>>> applied. One would need to write tests running against the code
118 >>>> with all plugins enabled, all templates put to work, in order to
119 >>>> ensure consistency is maintained. --[[intrigeri]]
120
121 -----
122 If you're going to be patching htmmllink anyway, might I suggest something more flexible, like being able to configure the link format?
123 (Yes, PmWiki allows this, that's where I got the idea)
124 That is, rather than having "&lt;a href=". blah . blah ...
125 one could use a sprintf with a default format which could be configured in the setup file.
126
127 For example:
128
129     $format = ($config{createlink_format}
130                ? $config{createlink_format}
131                : '<span class=\"createlink\"><a href="%s" rel="nofollow">?</a>%s</span>');
132     return sprintf($format,
133         cgiurl(do => "create", page => lc($link), from => $lpage),
134         $linktext);
135
136 I admit, I've been wanting something like this for a long time, because I dislike the existing createlink format...
137
138 --[[KathrynAndersen]]