modules/biblio/README.txt


                           biblio.module

Author:  Ron Jerome (ron dot jerome at nrc dot ca)
Released under the GPL


Description:
============
This module extends the node data type with additional fields to manage lists 
of scholarly publications.

It closely follows the EndNote model, thus both importing from and exporting 
to Endote are supported. Other formats such as bibtex and RIS are also supported.

Bibliographic information is displayed in lists with links to detailed 
information on each publication.

The lists can be sorted, filtered and ordered in many different ways.


Requirements:
=============
Drupal 6.x


Installation:
=============
Create a directory called biblio in the sites/all/modules directory, then place all of the
files packaged with this module in that directory.

This module will auto-install the required database tables the first time you 
enable it on the admin/modules page.   This will also setup a number of pre-defined 
publication types.  These types can be changed or deleted on the 
admin/settings/biblio/types page.


Settings:
=========
A number of settings are available at admin/settings/biblio.  They control how 
the author names are displayed, whether export links are added to pages and the
number of entries per page to display.

The admin/settings/biblio/types page allows the the site administrator to set
the default field titles and set which fields are common to all publication 
types.  When a new publication type is added, it will contain all the common 
fields and any that are specifically activated (custom is checked).  This also
allows the admin to over ride any of the default settings for any given type.

Access Control:
===============
Three permissions are controlable on the admin/access page.  I think they are fairly
self evident, they control who can create biblio entries, edit entries and who can
import from file.

Adding/importing records:
=========================
Bibliographic entries can be added to the database in one of two ways, individualy
from the node/add/biblio link, or by importing records from Endnote in "Tagged" or
XML file format, also BibTex files can be imported on this page.  Administrators 
can go to admin/settings/biblio/import and fill in the form to upload and import 
of an Endnote and BibTex files.


Features:
=========
By default, the /biblio page will list all of the entries in the database sorted
by Year in descending order. If you wish to sort by "Title" or "Type", you may 
do so by clicking on the appropriate links at the top of the page. To reverse 
the sort order, simply click the link a second time.


Filtering Search Results:
=========================
If you wish to filter the results, click on the "Filter" tab at the top of the 
page. To add a filter, click the radio button to the left of the filter type 
you wish to apply, then select the filter criteria from the drop down list 
on the right, then click the filter button.

It is possible to create complex filters by returning to the "Filter" tab and 
adding additional filters. Simply follow the steps outlined above and press 
the "Refine" button.

All filters can be removed by clicking the Clear All Filters link at the top 
of the result page, or on the "Filter" tab they can be removed one at a time 
using the "Undo" button, or you can remove them all using the "Clear All" button

You may also construct URLs which filter. For example, /biblio/year/2005 will 
show all of the entries for 2005. /biblio/year/2005/author/smith will show all 
of entries from 2005 for smith.


Exporting Search Results:
=========================
Assuming this option has been enabled by the administrator, you can export 
search results directly into EndNote. The link at the top of the result page 
will export all of the search results, and the links on individual entries will 
export the information related to that single entry.

Clicking on one of the export links should cause your browser to ask you 
whether you want to Open, or Save To Disk, the file endnote.enw. If you choose 
to open it, Endnote should start and ask you which library you would like 
store the results in. Alternatively, you can save the file to disk and manually 
import it into EndNote.


The information is exported in either EndNote "Tagged" format similar to this...

              %0  Book
              %A  John Smith 
              %D  1959
              %T  The Works of John Smith
              ...
              
Or Endnote 7 XML format which is similar to this...

              <XML>
              	<RECORDS>
              	  <RECORD>
                    <REFERENCE_TYPE>10</REFERENCE_TYPE>
                    <YEAR>1959</YEAR>
              	    <TITLE>The Works of John Smith</TITLE>
              	    <AUTHORS>
                      <AUTHOR>John Smith </AUTHOR>
                    </AUTHORS>
                  </RECORD>
                </RECORDS>
              </XML>
              
              
1
2	biblio.module
3
4	Author: Ron Jerome (ron dot jerome at nrc dot ca)
5	Released under the GPL
6
7
8	Description:
9	============
10	This module extends the node data type with additional fields to manage lists
11	of scholarly publications.
12
13	It closely follows the EndNote model, thus both importing from and exporting
14	to Endote are supported. Other formats such as bibtex and RIS are also supported.
15
16	Bibliographic information is displayed in lists with links to detailed
17	information on each publication.
18
19	The lists can be sorted, filtered and ordered in many different ways.
20
21
22
23
24	Requirements:
25	=============
26	Drupal 6.x
27
28
29
30	Installation:
31	=============
32	Create a directory called biblio in the sites/all/modules directory, then place all of the
33	files packaged with this module in that directory.
34
35	This module will auto-install the required database tables the first time you
36	enable it on the admin/modules page. This will also setup a number of pre-defined
37	publication types. These types can be changed or deleted on the
38	admin/settings/biblio/types page.
39
40
41	Settings:
42	=========
43	A number of settings are available at admin/settings/biblio. They control how
44	the author names are displayed, whether export links are added to pages and the
45	number of entries per page to display.
46
47	The admin/settings/biblio/types page allows the the site administrator to set
48	the default field titles and set which fields are common to all publication
49	types. When a new publication type is added, it will contain all the common
50	fields and any that are specifically activated (custom is checked). This also
51	allows the admin to over ride any of the default settings for any given type.
52
53	Access Control:
54	===============
55	Three permissions are controlable on the admin/access page. I think they are fairly
56	self evident, they control who can create biblio entries, edit entries and who can
57	import from file.
58
59	Adding/importing records:
60	=========================
61	Bibliographic entries can be added to the database in one of two ways, individualy
62	from the node/add/biblio link, or by importing records from Endnote in "Tagged" or
63	XML file format, also BibTex files can be imported on this page. Administrators
64	can go to admin/settings/biblio/import and fill in the form to upload and import
65	of an Endnote and BibTex files.
66
67
68	Features:
69	=========
70	By default, the /biblio page will list all of the entries in the database sorted
71	by Year in descending order. If you wish to sort by "Title" or "Type", you may
72	do so by clicking on the appropriate links at the top of the page. To reverse
73	the sort order, simply click the link a second time.
74
75
76	Filtering Search Results:
77	=========================
78	If you wish to filter the results, click on the "Filter" tab at the top of the
79	page. To add a filter, click the radio button to the left of the filter type
80	you wish to apply, then select the filter criteria from the drop down list
81	on the right, then click the filter button.
82
83	It is possible to create complex filters by returning to the "Filter" tab and
84	adding additional filters. Simply follow the steps outlined above and press
85	the "Refine" button.
86
87	All filters can be removed by clicking the Clear All Filters link at the top
88	of the result page, or on the "Filter" tab they can be removed one at a time
89	using the "Undo" button, or you can remove them all using the "Clear All" button
90
91	You may also construct URLs which filter. For example, /biblio/year/2005 will
92	show all of the entries for 2005. /biblio/year/2005/author/smith will show all
93	of entries from 2005 for smith.
94
95
96	Exporting Search Results:
97	=========================
98	Assuming this option has been enabled by the administrator, you can export
99	search results directly into EndNote. The link at the top of the result page
100	will export all of the search results, and the links on individual entries will
101	export the information related to that single entry.
102
103	Clicking on one of the export links should cause your browser to ask you
104	whether you want to Open, or Save To Disk, the file endnote.enw. If you choose
105	to open it, Endnote should start and ask you which library you would like
106	store the results in. Alternatively, you can save the file to disk and manually
107	import it into EndNote.
108
109
110	The information is exported in either EndNote "Tagged" format similar to this...
111
112	%0 Book
113	%A John Smith
114	%D 1959
115	%T The Works of John Smith
116	...
117
118	Or Endnote 7 XML format which is similar to this...
119
120	<XML>
121	<RECORDS>
122	<RECORD>
123	<REFERENCE_TYPE>10</REFERENCE_TYPE>
124	<YEAR>1959</YEAR>
125	<TITLE>The Works of John Smith</TITLE>
126	<AUTHORS>
127	<AUTHOR>John Smith </AUTHOR>
128	</AUTHORS>
129	</RECORD>
130	</RECORDS>
131	</XML>
132
133