Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Warning

A known issue with the current implementation of the PDF Citation Cover Page is that primarily only English/Roman characters are supported. This is due to a limitation in the tool used to generate PDFs.  See DS-2224 https://github.com/DSpace/DSpace/issues/5590 for more details on this issue

...

In the {dspace.dir}/config/modules/citation-page.cfg file review the following fields to make sure they are uncommented:

Property:

citation-page.enable_globally

Example Values:

citation-page.enable_globally = true

Informational Note:

Boolean to determine is citation-functionality is enabled globally for entire site. This will enable the citation cover page generator for all PDFs.

Default: disabled


Property:

citation-page.enabled_collections

Example Values:

citation-page.enabled_collections = 1811/123, 1811/234

Informational Note:

List of collection handles to enable the cover page generator for bitstreams within.

Default: blank

Property:

citation-page.enabled_communities

Example Values:

citation-page.enabled_communities = 1811/222, 1811/333

Informational Note:

List of community handles to enable the cover page generator for bitstreams within.

Default: blank

Property:

citation-page.citation_as_first_page

Example Values:

citation-page.citation_as_first_page = true

Informational Note:

Should the citation page be the first page cover (true), or the last page (false).

Default: true, (first page)

Property:

citation-page.header1

Example Values:

citation-page.header1 = University of Higher Education

Informational Note:

First row of header, perhaps for institution / university name. Commas separate multiple sections of the header (see screenshot above)

Default Value: DSpace Institution

Property:

citation-page.header2

Example Values:

citation-page.header2 = Scholar Archive\, http://archive.example.com

Informational Note:

Second row of header, perhaps put your DSpace instance branded name, and url to your DSpace. A comma is used to separate instance name, and the URL

Default Value: DSpace Repository, http://dspace.org

Property:

citation-page.fields

Example Values:

citation-page.fields = dc.date.issued, dc.title, dc.creator, dc.contributor.author, dc.publisher, _line_, dc.identifier.citation, dc.identifier.uri

Informational Note:

Metadata fields to display on the citation PDF. Specify in schema.element.qualifier form, and separate fields by a comma. If you want to have a horizontal line break, use _line_

Default Value: dc.date.issued,dc.title,dc.creator,dc.contributor.author,dc.publisher,_line_,dc.identifier.citation,dc.identifier.uri

Property:

citation-page.footer

Example Values:

citation-page.footer = Downloaded from Scholar Archive at University of Higher Education\, an open access institutional repository. All Rights Reserved.

Informational Note:

Footer text at the bottom of the citation page. It might be some type of license or copyright information, or just letting the recipient know where they downloaded the file from.

Default Value: Downloaded from DSpace Repository\, DSpace Institution's institutional repository

NOTE: any commas appearing in this text should be escaped as "\,". See example above.

 

...