Issue Details (XML | Word | Printable)

Key: FOR-756
Type: New Feature New Feature
Status: Closed Closed
Resolution: Fixed
Priority: Minor Minor
Assignee: David Crossley
Reporter: Ross Gardler
Votes: 0
Watchers: 0
Operations

If you were logged in you would be able to see more operations.
Forrest

Citations Plugin

Created: 06/Dec/05 07:21 PM   Updated: 23/Apr/06 02:53 PM
Return to search
Component/s: Plugin: input.citations
Affects Version/s: None
Fix Version/s: 0.8

Time Tracking:
Not Specified

File Attachments:
  Size
Zip Archive Licensed for inclusion in ASF works org.apache.forrest.plugin.input.citations.zip 2006-04-19 08:02 PM Gavin 33 kB
XML File Licensed for inclusion in ASF works reference2document.xsl 2005-12-06 07:26 PM Ross Gardler 1 kB
File Licensed for inclusion in ASF works references-v10.dtd 2006-02-09 09:05 AM Ross Gardler 2 kB
File Licensed for inclusion in ASF works references-v10.mod 2006-02-09 09:05 AM Ross Gardler 2 kB
File Licensed for inclusion in ASF works references.xmap 2005-12-06 07:26 PM Ross Gardler 5 kB
XML File Licensed for inclusion in ASF works references.xml 2005-12-06 07:29 PM Ross Gardler 7 kB
Issue Links:
Reference
 

Urgency: Low


 Description  « Hide
A plugin to provide a central location for citations across the whole content object would be useful. We could then use a special class of link to create to correct link to the citation page, and report an error if no such citation exists.

I did someting like this a long time ago before plugins existed. This issue is a place to put the files I created. We should create a plugin from these files.

 All   Comments   Work Log   Change History   Subversion Commits      Sort Order: Ascending order - Click to sort in descending order
Ross Gardler added a comment - 06/Dec/05 07:25 PM
Attachment: The DTD

Note there are now third party XML schemas for citations, we should probably use one of those, but I don't know if any have become a defacto standard yet. This DTD will serve to give us a quick start though.

Ross Gardler made changes - 06/Dec/05 07:25 PM
Field Original Value New Value
Attachment references-v10.dtd [ 12321164 ]
Attachment references-v10.mod [ 12321165 ]
Ross Gardler added a comment - 06/Dec/05 07:26 PM
Attachement: internal files

Ross Gardler made changes - 06/Dec/05 07:26 PM
Attachment references.xmap [ 12321167 ]
Attachment reference2document.xsl [ 12321166 ]
Ross Gardler added a comment - 06/Dec/05 07:29 PM
An example references document.

You can see the output at http://www.gardler.org/teaching/references.html

You can see an example of linking to citations in http://www.gardler.org/teaching/glossary.html (generated from special citation links, take a look at the XML of the page for examples these are processed by a custom stlesheet in the skin on the above site )

Ross Gardler made changes - 06/Dec/05 07:29 PM
Attachment references.xml [ 12321168 ]
Johannes Schaefer added a comment - 07/Dec/05 10:43 PM
Glossary and Index are pretty much the same; although I did not look at Ross' work; not sure about citations but might be related as well.

Johannes Schaefer made changes - 07/Dec/05 10:43 PM
Link This issue relates to FOR-280 [ FOR-280 ]
David Crossley made changes - 24/Dec/05 11:39 AM
Other Info [Patch available]
Ross Gardler added a comment - 08/Feb/06 09:07 PM
No, glossary, index and citations are all quite different:

Glossary - a list of terms with definitions, occurences of glossary terms i the text can be linked to the coresponding entry in the glossary

Index - a list of terms with cross-references to where they are used in the text

Citation - a list of sources for more information with links in the text to specific citations for further reading

Ross Gardler made changes - 09/Feb/06 09:04 AM
Attachment references-v10.dtd [ 12321164 ]
Ross Gardler made changes - 09/Feb/06 09:04 AM
Attachment references-v10.mod [ 12321165 ]
Ross Gardler added a comment - 09/Feb/06 09:05 AM
New version of the DTD with corect ASF license header.

Ross Gardler made changes - 09/Feb/06 09:05 AM
Attachment references-v10.mod [ 12322773 ]
Attachment references-v10.dtd [ 12322774 ]
Ross Gardler added a comment - 14/Feb/06 08:51 PM
Removing "patch available" flag as this is not really a patch, rather an attachment to illustrate things. It cannot be applied as a patch. The issue will still appear in the "FOR-unresolved-with-attachment" filter

Ross Gardler made changes - 14/Feb/06 08:51 PM
Other Info [Patch available]
Urgency Low
Component/s XML grammars & validation [ 12310001 ]
David Crossley made changes - 31/Mar/06 04:50 PM
Component/s Plugins (general issues) [ 12310030 ]
Component/s Plugins: Potential new [ 12310864 ]
Gavin added a comment - 12/Apr/06 09:55 PM
I have made a start and created the (input) plugin for this, now to configure it.

Gavin added a comment - 19/Apr/06 08:02 PM
Working version of Citations Plugin. Tested with 'Ant Test' and used a test site using 'forrest run' and 'forrest site' . All work fine.

Gavin made changes - 19/Apr/06 08:02 PM
Repository Revision Date User Message
ASF #396240 Sun Apr 23 07:51:11 UTC 2006 crossley Add initial citations plugin.
Thanks to Ross Gardler who contributed the code against an early version
of Forrest, and to Gavin McDonald who prepared it as a new input plugin.
Issue: FOR-756
Files Changed
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/resources/stylesheets/copyover.xsl
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/resources/schema/citations-v10.mod
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/lib
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/input.xmap
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/src/documentation/content/xdocs/favicon.ico
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/src/documentation/content/xdocs/index.xml
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/src/documentation/skinconf.xml
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/resources/schema
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/src/documentation
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/src/documentation/content/xdocs/images/group.svg
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/src/documentation/content/xdocs/images/usemap.gif
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/src/java/readme.txt
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/src/documentation/content/xdocs/images/group-logo.gif
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/resources/schema/citations-v10.dtd
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/resources/schema/catalog.xcat
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/build.xml
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/src/documentation/content/xdocs/tabs.xml
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/status.xml
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/src/documentation/content/xdocs
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/src/documentation/content/xdocs/site.xml
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/src/documentation/content/xdocs/references.xml
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/forrest.properties
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/src
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/resources
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/src/documentation/content/xdocs/images
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/src/documentation/content/xdocs/images/project.svg
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/src/java
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/locationmap.xml
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/src/documentation/content/xdocs/images/icon.png
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/src/documentation/content
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/lib/readme.txt
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/resources/stylesheets/reference-to-document.xsl
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/src/documentation/content/xdocs/images/project-logo.gif
ADD /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.citations/resources/stylesheets
MODIFY /forrest/trunk/whiteboard/plugins/whiteboard-plugins.xml

David Crossley made changes - 23/Apr/06 02:39 PM
Assignee David Crossley [ crossley ]
David Crossley made changes - 23/Apr/06 02:40 PM
Component/s Plugin: input.citations [ 12310920 ]
Component/s Plugins: Potential new [ 12310864 ]
David Crossley added a comment - 23/Apr/06 02:51 PM
Thanks Gavin, applied your patch.

David Crossley made changes - 23/Apr/06 02:53 PM
Status Open [ 1 ] Closed [ 6 ]
Resolution Fixed [ 1 ]
Fix Version/s 0.8-dev [ 12310040 ]