EXT: Publication database¶

What does it do?¶

• This extension (pubdb) gives support for managing mainly scientific publications on a typo3 website.
• The views can be customized via templates and CSS styles similar to the well known tt_news extension

Screenshots¶

Figure 1: Example of a generated list of publications according to the AMS citation guidelines

Figure 2: Generated single view of a journal article including meta information of the journal it is in

Create a publication category¶

When the extension is installed and a storage folder for the publication data is created at least one publication category has to be created. This is done by adding a new item in the storage folder using the LIST module of typo3:

Figure 3: TYPO3 backend list module for record editing

A category has only a few options:

Hide: hide the recored

Name: an arbitrary speaking name for the category

Groups allowed to download: an optional list of website user (front end) groups which are allowed the files set in the publication record in the field “files with restricted access”.It provides access control for files related to a publication, e.g. a user needs to be logged in to access the full text pdf or the full text PDF should be available to a specific group only.

Figure 4: Data mask for a publication category

Create a publication item¶

Similar to the creation of categories choose “Pubdb Publication” in the list of possible new items in the list view:

Figure 5: Part of the edit mask for a publication

The fist step in the creation of a new publication is the definition of the publication type.

NOTE: Not all fields are visible for all publication types for a better understanding.

NOTE: Some publication types show the DEPRECATED field Author/editor, it should NOT be used anymore for new records, use the “available contributors” section instead which holds the contributors in a separate table with more details and provides a reuse of contributors (authors) and therefore a database relation between publications and contributors.

Contributors:

The current version of the extension uses the IRRE (Inline Relational Record Editing) concept to edit records of two tables in one list.

Contributors are stored now separately and linked to publications over the available contributors section in the publication edit mask:

Figure 6: Inline contributor editing

Already stored contributors can be selected via the “SELECT” box (1), if the currently shown record shall be chosen click on “Create new relation” (2).

A new contributor can be created by clicking on “Create new” (3).

A newly created entry can be opened by clicking on the gray title bar (4).

In the ROLE selection box (5) the role of the contributor for this specific publication can be defined. The role can be author, editor, chair or translator. The same contributor entry can have different roles at different publications.

The data records (7) are self-explanatory and are different for another contributor type (6) which can be PERSON or ORGANISATION.

The “Show in recored contributors list” (8) defines if the contributor shall be shown in the selector box (1) for re-use in other publications. This can be useful if there are many contributors which are unlikely for being reused.

Figure 7: Contributor editing

The order of contributors can be re-arranged with the up and down arrows in the title bar (4).

The most common publication types are explained in more details:

Publication type [JOURNAL]:

A JOURNAL defines a specific issue of a regularly published publication. The record hols only meta information of the issue and NOT any content.

Publication type [JOURNAL ARTICLE ]:

A JOURNAL ARTICLE holds information about an article within a journal. Most of the records are self-explanatory, for some exist a context- sensitive help, which is not obvious in current typo3 versions ( you need to move the cursor on the title of the record field )

If there shall be stored many articles from many different authors, the journal article offers an alternative to the separate contributors table:

List of authors field

The list of authors field can be used INSTEAD of the contributors list but requires a correct input format (please refer also to the context sensitive help):

Authors have to be separated by semicolon (;), surname and given name have to be separated by space if the order is given name(s) surname or by comma (,), if the order is surname(s), given name(s). The latter is especially usefull if the surname consists of more than one word.

For example, correctly formatted entries would be:

Albert Einstein; Jakob Laub van der Marel, Roeland P.; Gerssen, Joris or a mixed variant:

van der Marel, Roeland P.; Joris Gerssen

If you enter

Roeland P. van der Marel, surname and given name will not be separated correctly in the frontend view or in the XML export.

Create frontend pages¶

Create a new content element on a page and choose “General plugin” as content type:

Figure 8: Choose "General Plugin" as content type

Choose “pubdb” on the Plugin tab:

Figure 9: Select the Pubdb plugin

In the “what to view” selection box you can define how the page should be rendered.

Figure 10: Selector for the pubdb frontend view

The different options are described in more details below.

FAQ¶

Possible subsection: FAQ

Database administration¶

The extension provides an update script to ensure data consistency. The script can be accessed via the extension page in the Extension Manager.

For administrators mainly the third point “ Search duplicate contributors in the tx_pubdb_contributors table” is relevant which searches for duplicate contributors and merges them.

It does not only a string comparison, it fixes some formatting issues and compares given names also with initials, e.g.

Mustermann, Max and Mustermann, M. would be detected to be the same and merged.

Missing spaces e.g. between initials such as D.P. F. are corrected to D. P. F.

Configuring DOI settings for XML export¶

In the configuration section of the extension in the Extension manager a few DOI related settings can be made.

This parameters are only relevant for the CrossRef style XML export of publication data in the backend.Currently it is assumed that you have the extension realurl extension installed which maps parameters to URL parts of a static url.

The other parameters refer to your account at www.crossref.org

Figure 13: Extension configuration page

FAQ¶

Possible subsection: FAQ

Upgrade from an older version¶

If you upgrade an older version to the current release you will have to run the database update script, which should be performed automatically.

To be sure check the “Database Update” tab in the Extension manager:

Figure 14: Database update tab in Extension manager (TYPO3 4.x)

In TYPO3 6.x make a database check with the installer.

If the database update is performed you should run the Update script, accessible also via the Extension Manager (Figure 15 and Figure 16).

NOTE: Please make a backup of the tables tx_pubdb_data, tx_pubdb_contributors and tx_pubdb_pub_contributors before you run the script!

Currently, the update script fixes three issues:

Updates publication type content_item to book_chapter which are redundant and therefor not necessary

Removes author / editor entries (which is marked as DEPRECATED) in the publications and creates contributor entries for it in a separate table. Every contributor will be created only once.If the field contains the keywords “Editor”, Eds”, Editors” or “Hrsg”, the contributors in that field will get the role “Editor”, in the default case “Author”.

The script tries to parse surname and given name out of the string, authors may be separated by “,” or “;”.

Finally, a plausibility check is done and the script outputs what couldn't get parsed (see Figure 17). You should edit this entries manually and try again.

Script 2 creates every contributor only once, but due to typing errors especially in the surnames you might notice afterwards that there are still duplicate entries not identified. You should correct the entries in the back end list module and run the script again to merge duplicates. NOTE: Do not manually delete duplicates, dead references in the relation table may lead to an unexpected behavior.You can run the update script again at any time.

Figure 15: In TYPO3 4.x click on "Check update script"

Figure 16: In TYPO3 6.x click on the green arrow to run the update script

Figure 17: Result page of the update script

FAQ¶

Possible subsection: FAQ

Reference¶

plugin.tx_pubdb_pi1.templateFile = fileadmin/myPubdbTempl.tmpl

page.includeCSS{
 cssfile1 = fileadmin/mypubdbstyles.css
 }

1.1.2¶

1.1.1¶

1.1.0¶

1.0.2¶

1.0.1¶

1.0.0¶

0.0.3¶