Changes between Version 5 and Version 6 of AddHeadersPlugin

Timestamp:

Nov 1, 2008, 2:36:13 PM (15 years ago)

Author:

Martin Scharrer

Comment:

Added general link tag example.

AddHeadersPlugin

@@ -143 +143 @@
 }}}
 
+=== General `link` tag ===
+The `link` tags are used to define ''relations'' between the page and other pages, e.g. 'My startpage is at ..., the next page is at ...'. Trac itself adds a couple of link tags for `help`, `up`, `prev`, etc. for some pages.
+
+The following example would add a linked copyright notice (written  plain text) and a shortcut icon to every Trac page. Please note that the information is not displayed by default to the user in any way and most browsers are ignoring link tags which aren't used for style sheets an shortcut icons.
+
+{{{
+# in trac.ini
+[addheaders]
+add_links    = cpyrght,icon
+
+cpyrght.rel   = copyright
+cpyrght.type  = text/plain
+cpyrght.title = Copyright notice
+cpyrght.href  = /chrome/site/copyright.txt
+
+icon.rel  = shortcut icon
+icon.type = image/x-icon
+icon.href = /chrome/site/favicon.ico
+}}}
+
+This will result in the following added header:
+{{{
+<link title="Copyright notice" type="text/plain" href="/chrome/site/copyright.txt" rel="copyright">
+<link type="image/x-icon" href="/chrome/site/icon.ico" rel="shortcut icon">
+}}}
 
 == Recent Changes ==