| Name | Footnotes |
|---|---|
| Vendor | Adaptavist.com Ltd (Website) |
| Authors | Alain Moran, Guy Fraser |
| Homepage | http://confluence.atlassian.com/display/CONFEXT/Footnotes+Plugin |
| Issue Management | http://jira.adaptavist.com/browse/FOOT |
| Continuous Integration | n/a |
| Categories | Formatting Macros |
| Most Recent Version | 1.1.4 |
| Availability | Confluence v2.3-dr1 to v2.10-m5 |
| State | Stable |
| Support |
|
| License | Freeware / Open Source (BSD) |
| Price | Donate |
| Release Docs | http://confluence.atlassian.com/display/CONFEXT/Footnotes+Plugin |
| Java API Docs | n/a |
| Download Source | n/a |
| Download JAR | adaptavist-plugin-footnotes-1.1.4.jar |
 | This plugin now accessable through the Confluence Repository Client. |
 | If you like this plugin, consider voting for CONF-5418 as once that issue is resolved we'll be able to deliver some more visual macros  |
Description/Features
A pair of Macros that allow you to create footnotes
- footnote
- display-footnotes
Requirements
None.
Installation
- Install the plugin jar using the admin interface
- You're done!
Tested Environments (confluence vs plugin version)
| v macro \ confluence > | v1.4.x | v2.0.x | v2.1.x |
|---|---|---|---|
| v1.0 |  |
 |
|
| v1.1 | |
|
|
| v1.1.1 | |
|
|
Documentation
The macros in this pack are documented (with examples and related links) in our Online User Guide:
- footnote — defines a footnote
- display-footnotes — displays footnotes
Both of the macros also have accompanying documentation in the Wiki Notation Guide.
Version History
| Version | Comments | Author |
|---|---|---|
| 1.0 |
|
Adaptavist.com |
| 1.1 |
|
Adaptavist.com |
| 1.1.1 |
|
Adaptavist.com |
Future Development
If you have any comments or suggestions, report them in our issue tracker.
Comments (27)
Feb 04, 2006
Bob Swift says:
Nice! This will be very useful.Nice! This will be very useful.
Feb 04, 2006
Jason Dillon says:
Very nice One comment though; why not use a Velocity template to render the HT...Very nice
One comment though; why not use a Velocity template to render the HTML? IMO this makes it much cleaner to maintain the Java code and the HTML code. Okay 2 comments... any reason why you don't render/cache the image w/a number instead of rely on CSS to do that? Or provide pre-rendered images for notes 1-9?
Feb 04, 2006
Alain Moran says:
Why not use pre-rendered images? Only one image for the user to download, after ...Why not use pre-rendered images?
Only one image for the user to download, after that it's cached and doesnt add to the load on the server (Yes theyre only tiny, but IMO every byte counts)
Why not use Velocity?
No good reason other than I wanted to keep things as simple as possible.
I've only been coding in java for a couple of weeks and this is my first plugin ... my 'hello world' so to speak! Its not that I'm 'afraid' of velocity, I've made mods/extensions to the Content Formatting Macros which introduced me to it. I just wanted to create something that wasnt based on anybody else's code.
Feb 04, 2006
Jason Dillon says:
FYI, using Velocity is really simple. Take a peek at the bottom of MindmapMacro...FYI, using Velocity is really simple. Take a peek at the bottom of MindmapMacro#execute(). I think you will find that putting the HTML details into a Velocity template will clean things up a bit
Feb 04, 2006
Guy Fraser says:
The images don't cache properly coming from a resource url. Having the tiny imag...The images don't cache properly coming from a resource url. Having the tiny image in the jar is convinient, but as myself and David Peterson found recently, it guarantees that the files don't get cached and have to be loaded over and over again. In Firefox this isn't a problem because it's intelligent enough not to reload the image when it sees it already has it (eg. on mouse over, etc). Internet Exploder, on the other hand, well, that's for masochists
If there's an easy way to cache the image, we'd love to hear it as we're having nightmares with loading resources from the plugin jars at the moment due to them not caching.
Regarding the icons themselves, we're doing the images in this seemingly odd way because you can then have any number of footnotes and the "icon" grows to fit. In addition, if you scale the text in the browser the icon also accomodates that.
Feb 04, 2006
Jason Dillon says:
Someone should write an ActiveX control that runs FireFox inside of IE, so we do...Someone should write an ActiveX control that runs FireFox inside of IE, so we don't have to worry about IE and the mess that comes with it anymore
Feb 04, 2006
Mike Cannon-Brookes says:
Indeed! This is awesome guys! Very nifty. How does {footnotes} relate t...Indeed! This is awesome guys! Very nifty.
How does {footnotes} relate to {display-footnotes} ? (Or do the docs need to be fixed.)
I'd definitely say that Velocity is great to learn next, but if this is you first Java project - well done!
Feb 04, 2006
Guy Fraser says:
Ah, we renamed {footnotes} to {display-footnotes} at the 11th hour: While we wer...Ah, we renamed {footnotes} to {display-footnotes} at the 11th hour: While we were adding the docs to our user guide, we found it very hard to cleanly explain the difference between the two macros, hence the name change to make it more obvious what each did. (We almost renamed {footnote} to {define-footnote} but decided it would be too much to type in over and over)
The docs have been updated - I'd forgot to change the content in the tabs at the top (oops!)
Feb 05, 2006
Alain Moran says:
Now with added .vm goodness (by popular request)Now with added .vm goodness (by popular request)
Jul 03, 2006
Firat Vakiliev says:
The {footnote} and {display-footnotes} incorrectly looks with {include} pages. B...The {footnote} and {display-footnotes} incorrectly looks with {include} pages. Bug or feature?
Nov 10, 2006
Charles Hill says:
Seems there is an issue with generating PDF files when footnotes are added: com...Seems there is an issue with generating PDF files when footnotes are added:
com.atlassian.confluence.importexport.ImportExportException: Error while generating PDF!
at com.atlassian.confluence.importexport.impl.PdfExporter.generatePDF(PdfExporter.java:165)
at com.atlassian.confluence.importexport.impl.PdfExporter.doExportEntity(PdfExporter.java:117)
... at java.lang.Thread.run(Thread.java:534)
Caused by: org.apache.fop.apps.FOPException: file:/C:/confluence/conf-data/temp/export_11102006_130332/about-3-20061110-13_03_32.fo:45:61 The id "footnote-th1" already exists in this document
at org.apache.fop.datatypes.IDReferences.createID(IDReferences.java:119)
Nov 13, 2006
Alain Moran says:
Do you have more than one ocurrence of the {display-footnotes} macro in your doc...Do you have more than one ocurrence of the {display-footnotes} macro in your document?
Mar 13, 2007
RefuX Zanzeenbarr says:
When I try to install via the Confluence Repository Client and I get this error:...When I try to install via the Confluence Repository Client and I get this error:
Expected plugin key [com.adaptavist.confluence.footnoteMacros] and got [com.adaptavist.confluence.Macros] from: ... svn location ... /adapavist-plugin-footnotes-1.1.3.jar
Mar 13, 2007
Alain Moran says:
Another victim of the conversion to maven2 ... thanks for spotting that, I have ...Another victim of the conversion to maven2 ... thanks for spotting that, I have added an aka tag to the metadata which should resolve this problem.
Apr 16, 2007
Johannes says:
Hey, I get the same problem... Expected plugin key [com.adaptavist.confluence....Hey,
I get the same problem...
Expected plugin key [com.adaptavist.confluence.footnoteMacros] and got [com.adaptavist.confluence.footnotes] from: http://svn.atlassian.com/svn/public/contrib/confluence/footnotes-plugin/trunk/dist/adaptavist-plugin-footnotes-1.1.3.jar
Thanks! Johannes
Apr 16, 2007
Alain Moran says:
Until the issues with the metadata are fully resolved, please use the URL in the...Until the issues with the metadata are fully resolved, please use the URL in the error message to download a copy of the jarfile manually and install using the default confluence plugin interface.
Sep 12, 2007
David Dembo says:
FYI, there seems to be 2 instances of this plugin in the Repository - I have one...FYI, there seems to be 2 instances of this plugin in the Repository - I have one entitled "Adaptavist Footnotes" (installed), and another entitled "Footnotes" (not installed). They are both the same version. Nothing critical, just thought it was worth a quick mention.
Sep 12, 2007
Guy Fraser says:
Thanks for letting us know - it's probably just a minor typo in the repository d...Thanks for letting us know - it's probably just a minor typo in the repository data. I've added an issue to our tracker for the plugin:
http://jira.adaptavist.com/browse/FOOT-17
Nov 13, 2007
Bert Roos says:
When exporting a page with footnotes as PDF, I get the following exception: ...When exporting a page with footnotes as PDF, I get the following exception:
I've been playing around with the page and I get the impression that it's overrunning a buffer in some way. I've shortened the page till the point where the removal of a single text line (with nothing special, no footnotes, no links and even no formatting) makes the problem disappear.
Any help is appreciated!
Regards,
Bert
Nov 13, 2007
Guy Fraser says:
It looks like a bug in the footnotes plugin... <th class="accessibi...It looks like a bug in the footnotes plugin...
<th class="accessibility" id="footnote-th1">Reference</th> <th class="accessibility" id="footnote-th2">Notes</th>The error you're getting will likely only occur if display-footnotes macro is used more than once on a page. Note that if you're using the include macro to embed other pages and those other pages contain the display-footnotes macro then similar problems will occur.
There is a user-contributed patched version of the plugin here that may help: http://jira.adaptavist.com/browse/FOOT-14
Nov 13, 2007
Alain Moran says:
footnotes 1.1.4 resolves thisfootnotes 1.1.4 resolves this
Nov 14, 2007
Bert Roos says:
Hi Guy & Alain, The patch unfortunately doesn't resolve this, although the ...Hi Guy & Alain,
The patch unfortunately doesn't resolve this, although the exception is slightly different:
The page has only a single occurrence of display-footnotes and doesn't use include.
In my reproduction page, I can now make the problem vanish by removing a line with just two backslashes (empty line).
Any other ideas? Or any information I can provide to help research this problem?
Regards,
Bert
Nov 14, 2007
Alain Moran says:
create an issue at http://jira.adaptavist.com/browse/FOOT including the full exc...create an issue at http://jira.adaptavist.com/browse/FOOT including the full exception, a copy of your markup, and detailing the version of confluence that you are using.
Nov 15, 2007
Bert Roos says:
Hi Alain, I've created the issue: http://jira.adaptavist.com/browse/FOOT-18 Re...Hi Alain,
I've created the issue: http://jira.adaptavist.com/browse/FOOT-18
Regards,
Bert
Nov 16, 2007
Alain Moran says:
It would seem that this problem only occurs on confluence 2.5.x, it may be an id...It would seem that this problem only occurs on confluence 2.5.x, it may be an idea to upgrade to confluence 2.6 since that seems to generate the pdf without any problems.
May 22
Matus says:
I am using Footnote macro 1.1.1. I think ,that in html titlte attribute for foot...I am using Footnote macro 1.1.1. I think ,that in html titlte attribute for footnote icon, the actual text of footnote should be better choice like now is:
'Footnote: Click here to display the footnote'. What do you think?
Oct 06
Christoph Seyfert says:
Hi, i have upgrade my confluence system to version 2.9.1. When i try to install ...Hi,
i have upgrade my confluence system to version 2.9.1. When i try to install the footnotes plugin i get the following message:
<<Snipp>>
The plugin key I expected is not what I found:
Expected: com.adaptavist.confluence.footnoteMacros
Found: com.adaptavist.confluence.footnotes
Are you sure you would you like to continue installing?
<<SNAPP>>
What does this message mean ??
Is the footnote-plugin compatibe with confluence 2.9.1 ?
Kind regards
Christoph