Merge branch 'master' into cvs

[git.ikiwiki.info.git] / doc / todo / CSS_classes_for_links.mdwn

diff --git a/doc/todo/CSS_classes_for_links.mdwn b/doc/todo/CSS_classes_for_links.mdwn
index ad4813eb25f3d8c33abd99ce1e66bc9fa6a5fedd..29ed3770e99855322b8df1020ff497ea06fe50f4 100644 (file)
--- a/doc/todo/CSS_classes_for_links.mdwn
+++ b/doc/todo/CSS_classes_for_links.mdwn
@@ -52,6 +52,8 @@ My best regards,
 >>> I also think this should be in an external plugin, not in ikiwiki.
 >>>
 
 >>> I also think this should be in an external plugin, not in ikiwiki.
 >>>
 

+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]]
+

 > If you need to achieve this in IkiWiki itself, I imagine you could create a
 > plugin which runs in the `format` phase of rendering and search/replaces
 > specific link patterns.  This should be a fairly simple exercise in regular
 > If you need to achieve this in IkiWiki itself, I imagine you could create a
 > plugin which runs in the `format` phase of rendering and search/replaces
 > specific link patterns.  This should be a fairly simple exercise in regular


@@ -70,6 +72,67 @@ My best regards,
 > controls a link is when an internal link is added using a WikiLink.
 >
 > (Note that tags get their own special
 > controls a link is when an internal link is added using a WikiLink.
 >
 > (Note that tags get their own special

-> [[rel_attribute|rel_attribute_for_link]] now that CSS can use.)
+> [[rel_attribute|rel_attribute_for_links]] now that CSS can use.)

 > 
 > --[[Joey]]
 > 
 > --[[Joey]]

+
+>> I had a little look at this, last weekend. I added a class definition to
+>> the `htmllink` call in `linkify` in `link.pm`. It works pretty well, but
+>> I'd also need to adjust other `htmllink` calls (map, inline, etc.). I found
+>> other methods (CSS3 selectors, etc.) to be unreliable.
+>> 
+>> Would you potentially accept a patch that added `class="internal"` to
+>> various `htmllink` calls in ikiwiki?
+>> 
+>> How configurable do you think this behaviour should be? I'm considering a
+>> config switch to enable or disable this behaviour, or possibly a
+>> configurable list of class names to append for internal links (defaulting
+>> to an empty list for backwards compatibility)>
+>> 
+>> As an alternative to patching the uses of `htmllink`, what do you think
+>> about patching `htmllink` itself? Are there circumstances where it might be
+>> used to generate a non-internal link? -- [[Jon]]
+
+>>> I think that the minimum configurability to get something that
+>>> can be used by CSS to style the links however the end user wants
+>>> is the best thing to shoot for. Ideally, no configurability. And
+>>> a tip or something documenting how to use the classes in your CSS
+>>> to style links so that eg, external links have a warning icon.
+>>> 
+>>> `htmllink` can never be used to generate an external link. So,
+>>> patching it seems the best approach. --[[Joey]] 
+
+>>>> I had a quick look to this issue. Internal links are generated at
+>>>> 11 places in the Perl code and would need to be patched (this
+>>>> number could be lowered a bit if a htmllink-like function existed
+>>>> for CGI urls; such a function would use `cgiurl`, and be used in
+>>>> most places where `cgiurl` is currently called by plugins).
+>>>> 
+>>>> Also, more than 30 `<a>` links appear in templates, most of those
+>>>> being internal links.
+>>>> 
+>>>> Sure, patching those few dozen places is trivial. On the other
+>>>> hand, I'm wondering how doable it would be to make sure, on the
+>>>> long run, any generated internal link has the right CSS class
+>>>> applied. One would need to write tests running against the code
+>>>> with all plugins enabled, all templates put to work, in order to
+>>>> ensure consistency is maintained. --[[intrigeri]]
+
+-----
+If you're going to be patching htmllink anyway, might I suggest something more flexible, like being able to configure the link format?
+(Yes, PmWiki allows this, that's where I got the idea)
+That is, rather than having "&lt;a href=". blah . blah ...
+one could use a sprintf with a default format which could be configured in the setup file.
+
+For example:
+
+    $format = ($config{createlink_format}
+               ? $config{createlink_format}
+               : '<span class=\"createlink\"><a href="%s" rel="nofollow">?</a>%s</span>');
+    return sprintf($format,
+        cgiurl(do => "create", page => lc($link), from => $lpage),
+        $linktext);
+
+I admit, I've been wanting something like this for a long time, because I dislike the existing createlink format...
+
+--[[KathrynAndersen]]