Patches item #1244559, was opened at 2005-07-25 15:31
Message generated for change (Comment added) made by jmaferreira
You can respond by visiting:
https://sourceforge.net/tracker/?func=detail&atid=319984&aid=1244559&group_id=19984
Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: None
Group: None
Status: Open
Resolution: None
Priority: 5
Submitted By: Miguel Ferreira (jmaferreira)
Assigned to: Richard Jones (richard-jones)
Summary: Controlled Vocabulary Add-on
Initial Comment:
DSpace does not define any metadata vocabularies to
confine the set of keywords that users can use while
describing items. The need for a limited set of
keywords is important since it eliminates the ambiguity
of a free description system, consequently simplifying
the task of finding specific items of information.
The controlled vocabulary add-on allows the user to
choose from a defined set of keywords organised in an
tree and then use these keywords to describe items
while they are being submitted.
We have also developed a small search engine that
displays the classification tree (or taxonomy) allowing
the user to select the branches that best describe the
information that he/she seeks.
The add-on supports several taxonomies at the same as
long as they are provided with the appropriate syntax.
The taxonomies are described in XML with the following
(simple) structure:
<node id="acmccs98" label="ACMCCS98">
<isComposedBy>
<node id="A." label="General Literature"/>
</isComposedBy>
<isRelatedTo>
<node id="D.3.2"/>
</isRelatedTo>
</node>
The elements isComposedBy and isRelatedTo are optional
within a node.
With this patch we include the ACM Computing
Classification System. If this patch is to be
distributed with DSpace an email must be sent to ACM
asking for permition to use it.
----------------------------------------------------------------------
>Comment By: Miguel Ferreira (jmaferreira)
Date: 2006-01-31 16:55
Message:
Logged In: YES
user_id=1202907
Hi Richard,
The patch looks really good. I like the help messages you've
added to the patch.
My only remark is the help link in the submission page. I
don't like the place where it stands. I would suggest
placing it at the beginning of the page close to the link to
the regular help or in the same place, but centred.
Now, your questions...
1. The add-on never had a close button. We can add one if
you think it will make it more user-friendly.
2. In the first version of the addon, the background colour
of the popup window was grey. Since the default dspace
background colour was white I decided to set it to white as
well.
----------------------------------------------------------------------
Comment By: Richard Jones (richard-jones)
Date: 2006-01-31 13:14
Message:
Logged In: YES
user_id=1021756
Hi Miguel,
I have gone over this patch, and I think we are set to
commit. I have generated a new patch (attached) with my
changes to it, detailed here:
- There was no default line to switch the feature on and off
in the dspace.cfg as in previous versions of the patch, so I
have put this back in.
- Added a help link to the search page
- Changed the default vocabulary back to acmccs in the
input-forms.xml, as this seems more likely to be of use to
people than the norwegian science index
- Added on-page help for the search page. I had to fiddle
the layout a little, so probably worth checking that it
looks ok at your end.
- added submitter and end user help to help/index.html and
linked it appropriately from the search page
- added a "help on controlled vocabularies" link to any
field that utilises one, pointing to the submitter
documentation
There are a couple of things that I noticed that might need
looking at:
- I can't remember if old versions of the patch had a "close
window" link on the popup. If not, perhaps it's worth
adding one?
- The styles look different (page background is now white in
the popup); is this deliberate? If so, don't worry, but if
not perhaps the patch wasn't complete.
If you want to look over this, and confirm that you are
happy with it, we can go on and commit soon.
----------------------------------------------------------------------
Comment By: Miguel Ferreira (jmaferreira)
Date: 2006-01-27 16:48
Message:
Logged In: YES
user_id=1202907
Dear all,
Iâve made the following changes to the patch (see patch
version 1.3):
- "webui.controlledvocabulary.metadata" is not being used
anymore, so it was removed from dspace.cfg. Assignment of
vocabularies to fields is now done in input-forms.xml
- Added javadocs to the source code
- Added admininistration and configuration documentation
(please review my english)
- Added a âClear filter buttonâ to the filter functionality
- Added the NSI vocabulary to the list of vocabularies
Cheers,
Miguel
----------------------------------------------------------------------
Comment By: Richard Jones (richard-jones)
Date: 2006-01-19 10:58
Message:
Logged In: YES
user_id=1021756
Hi Miguel,
This patch is looking good. I am having some problems,
though, with assigning controlled vocabulary terms to
different input boxes. I notice that even though dc.subject
in input-forms.xml has:
<vocabulary>acmccs98-1.2.4</vocabulary>
in the field definition, if you place an additional
vocabulary in the configuration it will display both of
them.
I think that perhaps we should remove the webui.
controlledvocabulary.metadata field configuration altogether
and rely only on the input-forms.xml field definition to
tell the system which vocabulary to use. This would require
modifying DCInput in a similar way to how we previously
discussed (but with some extra modifications). At the
moment it doesn't look like DCInput is being used at all, so
the value in input-forms.xml is irrelevant to the process.
Could you have a look at this?
In addition, we will need some additional documentation:
- Full javadocs in all of the classes
- Administration and configuration documentation: how to
configure the input-forms.xml especially, and how to add new
controlled vocabularies (including how to author your own)
- End user documentation: a "help" link would be useful on
the filter and select pages, which would link to
instructions in the end user help guide on how to use the
search/filter tools
Also (one last thing), my test users here were slightly
confused by the filtering process, and the main suggestion
to make life easier would be to include a "Clear Filter"
button. I mocked one up to see how it works, and it should
be necessary only to include the following form in the right
place:
<form name="clearFilter" method="post" action="<%= request.
getContextPath() %>/subject-search">
<input type="hidden" name="filter" value=""/>
<input type="submit" name="submit" value="Clear Filter"/>
<input type="hidden" name="action" value="filter"/>
</form>
I have attached my nsi.xml (Norwegian Science Index)
document for you to play with, and if you want we can put
this in with the patch when we commit.
----------------------------------------------------------------------
Comment By: Miguel Ferreira (jmaferreira)
Date: 2006-01-02 15:59
Message:
Logged In: YES
user_id=1202907
I'm submitting a new version of the add-on with the some
fixes (controlledvocabulary-addon-patch-1.2.txt):
- results.jsp is now internationalised
- filter is internationalised
- the addon may be switched on/off in the dspace.cfg
- the field to which the controlled vocabulary will be
associated with is now configurable in dspace.cfg
- the addon now works with the doOneBox
----------------------------------------------------------------------
Comment By: Miguel Ferreira (jmaferreira)
Date: 2005-11-30 15:39
Message:
Logged In: YES
user_id=1202907
Sorry, forgot to check the box!
(I hate this interface)! :-\
----------------------------------------------------------------------
Comment By: Miguel Ferreira (jmaferreira)
Date: 2005-11-30 15:37
Message:
Logged In: YES
user_id=1202907
Added a tar with the images in case there's a problem with
the binaries in the patch.
The images should be unpacked into "jsp/image/"
The final structure should be
"jsp/image/controlledvocabulary/*.gif"
Cheers.
----------------------------------------------------------------------
Comment By: Miguel Ferreira (jmaferreira)
Date: 2005-11-30 15:31
Message:
Logged In: YES
user_id=1202907
Here's an updated version of the Controlled Vocabulary add-on.
Changes reflect the suggestions made by Richard. Hope its ok
now.
The addon still requires Javascript to work... I'll try to
develop a new version that doesn't rely on javascript.
I also added a few comments to the JSPs. Its not very
detailed by it provides some queues about what each file is
supposed to represent.
Any questions or comments, please shoot!
----------------------------------------------------------------------
Comment By: Miguel Ferreira (jmaferreira)
Date: 2005-11-23 17:04
Message:
Logged In: YES
user_id=1202907
Dear flflee,
I'm working on it... please give a few more days...
I'll submit a new patch soon.
In mean time if you want to take a look at the add-on
documentation... it may help you in your objectives:
http://dspace-dev.dsi.uminho.pt:8080/en/addon_ontology.jsp
----------------------------------------------------------------------
Comment By: fleet (flflee)
Date: 2005-11-22 12:22
Message:
Logged In: YES
user_id=1367436
is there any detailed documentation so that i can follow to
add this patch on my dspace?
----------------------------------------------------------------------
Comment By: Miguel Ferreira (jmaferreira)
Date: 2005-11-10 15:32
Message:
Logged In: YES
user_id=1202907
Hi Richard,
I'll be pleased to help you fix the problems in the add-on
to make more fit to be included in the dspace core.
In what regards the ACM Computing Classification System, I
don't think there will be a problem delivering it with
DSpace... But some official permission will have to be
issued by ACM. You should contact Deborah Cotton for more
information:
Deborah Cotton,
Copyright & Permissions
ACM Publications
1515 Broadway, 17th floor
New York, NY 10036
212.869.7440 ext. 652
Fax: 212.869.0481
permissions@...
In order to add more classification systems we just have to
copy the new XML taxonomy in the right directory and restart
the application. It will be automatically loaded on startup.
PS: Give me some days to fix the problems you outlined.
Cheers.
----------------------------------------------------------------------
Comment By: Richard Jones (richard-jones)
Date: 2005-11-10 15:13
Message:
Logged In: YES
user_id=1021756
Hi Miguel,
I have installed this code on the CVS HEAD today, and it looks great. I have a couple of
queries and suggestions as to where to go next if you are willing to put in a little work:
1) The patch is slightly out of date. I have manually fixed Messages.properties, navbar-
default and edit-metadata and am going to attach them to this patch for you to look at.
2) There are a couple of compile warnings. "enum" is due to become a reserved word in
Java 1.5, so if we could change this for something else that will make it future-proof
3) Is there any chance you could provide some user documentation and perhaps use clearer
terminology in the UI. It took me a while to figure out exactly what to do.
4) There are some layout problems on the keywords page. Perhaps a line break to place the
"Controlled Vocabulary" link under the subject keyword box would neaten it up a little
5) If we are to include in the core dspace release it would probably be best to restructure the
organisation of the code to be more standardised. For example, the images could be in the
standard dspace/jsp/images folder, and the xml sources would probably be best in config.
6) Do you think that ACM would be happy to give us permission to circulate the
classification? If not, we could provide the system with one of our own devising, and provide
options to download their classification from some other location. How easy is it to plug
different classification systems into the code, and/or to support multiple classification
schemes?
I am happy to help out with the changes if you are interested.
Cheers,
Richard
----------------------------------------------------------------------
Comment By: Miguel Ferreira (jmaferreira)
Date: 2005-07-25 15:34
Message:
Logged In: YES
user_id=1202907
If you encounter any problem in patching the images...
here's an external tar.gz file that should be uncompressed
to "jsp/controlledvocabulary/image".
----------------------------------------------------------------------
You can respond by visiting:
https://sourceforge.net/tracker/?func=detail&atid=319984&aid=1244559&group_id=19984