Notice: This plugin is unmaintained and availableforadoption.
This macro inserts a "top of page" link in your Trac wiki page. The only option is a string that is inserted into the content of the markup. This defaults to a single circumflex "^" character (more commonly known as a caret), surrounded by square brackets. The anchor element returned includes a "Top of Page" title attribute so the user knows its purpose, and a "topofpage" class so the Wiki author may apply their preferred style rules.
Inserting the macro in your wiki page would be as follows:
[[Top]][[Top(^)]][[Top(top)]][[Top(Top of page)]]
More specifically:
[[Top]] returns:[<a href="#" title="Top of page">^</a>]
You could of course achieve the same effect by doing this:
{{{#!html[<a href="#" title="Top of page">^</a>]}}}Resulting in this:
[^]Note that the brackets do not form part of the anchor itself. This is a personal preference. If you pass a string to themacro they are omitted.
If you like the caret, but prefer to omit the brackets and style the link yourself withCSS, try something like this:
a.topofpage{display:block;height:11px;width:11px;font-family:'BitStream Vera Sans',Verdana,Arial,Helvetica,sans-serif;font-weight:bold;text-decoration:none;background-color:#eaeaea;color:#e9611c;padding:1px2px2px;border:1pxsolid#c6c7db;margin-left:-6px;}a.topofpage:hover{border-color:#000;background-color:#777;color:#fc3;}
Note: If you're going to style the anchor like this, you should also pass an argument to the macro or you'll end up with the default brackets in addition to the styling.
If you want to get really fancy, you can use jQuery to create a smooth scrolling effect when the link is clicked. In yoursite.html template add:
<htmlxmlns="http://www.w3.org/1999/xhtml"xmlns:py="http://genshi.edgewall.org/"py:strip=""><headpy:match="head"py:attrs="select('@*')"> ${select('*')}<scripttype="text/javascript"> jQuery(function($) { $('a.topofpage').click(function() { $('html, body').animate({scrollTop:0}, 'slow'); return false; }); });</script></head></html>
Note: Returning false from the lambda, or anonymous, function prevents the browser from kicking in its own event model. However, it degrades nicely and still works even if the user has JavaScript disabled.
Existing bugs and feature requests forTopMacro arehere.
If you have any issues, create anew ticket.
git clone git://github.com/dwclifton/tractopmacro.git
Download the zipped source fromhere or clone the repository (seeabove) from GitHub to a location on your local drive.Unzip the archive to a temporary location, visit the0.11 directory and run:
python setup.py bdist_eggcp dist/*.egg /trac/env/Project/plugins
Enable the macro in/trac/env/Project/conf/trac.ini:
[components]top.*=enabled
You may need to restart your Web server.
Author:dwclifton
Maintainer:none (needsadoption)
Contributors:
version 0.11.1
Download all attachments as:.zip
