PDF Citation Cover Page

Adding a cover page to retrieved documents from DSpace that include additional citation information has been sought, as documents uploaded to the repository might have had their context stripped from them, when they are just a PDF. Context that might have surrounded the document would be the journal, publisher, edition, and more. Without that information, the document might just be a few pages of text, with no way to piece it together. Since repository policy might be to include this information as metadata to the Item, this metadata can be added to the citation cover page, so that the derivative PDF includes all of this information.

The citation cover page works by only storing the original PDF in DSpace, and then generating the citation-cover-page PDF on-the-fly. An alternative set up would be to run the PDF Citation Coverpage Curation Task on the DSpace repository contents, and then disseminate the pre-generated citation-version instead of generating it on the fly.

Configuration settings for Citation Cover Page

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

Layout and metadata settings for Citation Cover Page

As of DSpace 9.0, the cover page is generated with an HTML templating engine. This allows for more flexible header, content, and footer layout.

The template uses the Thymeleaf templating language.

The default cover page template is in dspace-src/main/src/resources/dspace_coverpage.html  and can be overridden using configuration properties as above.

The header, body, and footer content from the default template can be seen below. The metadata availability comes from the CoverPageContributor  implementations (e.g. DefaultCoverPageContributor )

Variables can be referenced with ${variable_name} 

<div class="page">
    <div class="header">
        <img th:src="@{classpath:dspace_logo.png}" src="dspace_logo.png"/>

        <div>
            <a th:href="@{https://dspace.org/}" href="https://dspace.org">
                https://dspace.org/
            </a>
        </div>
    </div>

    <div class="body">
        <div class="metadata">
            <!-- The metadata fields from the current item can be referenced here in the format schema_field_qualifier -->
            <div class="title" th:text="${metadata_title}">Test title</div>

            <div class="author" th:text="${metadata_author}">Author 1; Author 2; Author 3</div>

            <div class="editor" th:text="${metadata_editor}">Editor 1; Editor 2; Editor 3</div>

            <div class="issued" th:text="${dc_date_issued}">2017</div>

            <div class="publisher" th:text="${dc_publisher}">Publisher Name</div>

            <div class="identifier">
                <a th:href="${dc_identifier_uri}" href="${dc_identifier_uri}" th:text="${dc_identifier_uri}">https://hdl.handle.net/123456789/12345</a>
            </div>

            <div class="citation" th:text="${dc_identifier_citation}">Author 1 (2017), Test title. Publisher Name. Retrieved from https://hdl.handle.net/123456789/12345</div>
        </div>
    </div>

    <div class="footer">
        Downloaded from a DSpace repository.

        <a th:href="@{https://dspace.org}" href="https://dspace.org">
            https://dspace.org/
        </a>
    </div>