DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
Reference¶
plugin.tx_bib_pi1¶
There are many TypoScript variables that adjust the behaviour of the list view plugin. At this place only the most important will be listed. For a more complete list check the static include file EXT:bib/pi1/static/default/setup.txt.
a
Property:
b
Data type:
c
Description:
d
Default:
a
authors
b
array
c
-> authors.
Author string configuration
d
a
authorNav
b
Array
c
Configures the author navigation bar
-> authorNav
d
a
charset
b
String
c
The character set that will be used in some operations
d
UTF-8
a
debug
b
boolean
c
Enables the debug mode.
This prints a lot debug information in the frontend.
d
a
display_mode
b
integer
c
The list display mode.
0: Simple1: Year split2: Year navigation
This is only used if “ TypoScript ”is selected in the FlexForm.
d
0
a
classes
b
Array
c
-> classes.
Some CSS classes
d
a
date_sorting
b
integer
c
The date sorting rule.
0: descending1: ascending
This is only used if “ TypoScript ”is selected in the FlexForm.
d
0
a
editor
b
Array
c
-> editor.
The FE editor configuration.
d
a
enum
b
Array
c
-> enum.
Enumeration wraps
d
a
enum_style
b
integer
c
The enumeration style.
1: Count all on page2: Count all3: Bullet4: None5: File Icon
This is only used if “ TypoScript ”is selected in the FlexForm.
d
2
a
export
b
Array
c
-> export.
The export link configuration.
d
a
FE_edit_groups
b
String
c
A comma separated list of frontend user group ids that are allowed to access the frontend editor. Also can be 'all' to allow all fe groups.
d
a
field
b
Array
c
-> field.
Contains stdWraps for all printable database fields.
d
a
import
b
Array
c
-> import.
The import link configuration.
d
a
items_per_page
b
integer
c
The maximal number of items (references) that should be displayed on a page at once.
0 means all.
It is used only if the FlexForm option is set to -1.
d
12
a
max_authors
b
integer
c
The maximal number of authors to display.
0 means all
It is used only if the FlexForm option is set to -1.
d
0
a
pageNav
b
Array
c
-> pageNav
Configures the page navigation bar
d
a
prefNav
b
Array
c
-> prefNav
Configures the preferences navigation bar
d
a
reference
b
stdWrap
c
A wrap around the reference data parts. Replaces the ###REFERENCE_WRAP### markers.
d
a
restrictions
b
Array
c
-> restrictions
Restricts some content to user groups and content type
d
a
searchNav
b
Array
c
Configures the search navigation bar
-> searchNav
d
a
single_view
b
Array
c
Configures the single view
-> single_view
d
a
stat_mode
b
integer
c
The statistics mode
0: None1: Total2: Year / Total
This is only used if “ TypoScript ”is selected in the FlexForm.
d
0
a
template
b
resource
c
The HTML template file for the list view
d
a
yearNav
b
Array
c
The (visual) year navigation configuration. See the static include file for more details.
d
Examples:
Set the html-template
plugin.tx_bib_pi1 {
template = /fileadmin/templates/my_bib.tmpl
}
Change the all number wrap
plugin.tx_bib_pi1 {
enum.all.wrap = <span>|</span>
}
plugin.tx_bib_pi1.authors¶
This array contains some values that influence the author string generation.
a
Property:
b
Data type:
c
Description:
d
Default:
a
forename
b
stdWrap
c
Forename wrap
d
a
highlight
b
stdWrap
c
Author highlightning wrap
d
a
separator
b
string/stdWrap
c
Author separator and its wrap
d
a
surname
b
stdWrap
c
Surname wrap
d
a
template
b
string
c
Full author name template string. Should contain ###FORENAME### and ###SURNAME###. The default string expects a spacing wrap of around the surname.
d
###FORENAME######SURNAME###
a
url_icon_fields
b
string
c
A comma separated list of fields that must be set before a link can be created.
d
url
a
url_icon_file
b
Resource
c
The image file to use as a link icon
d
a
url_icon
b
stdWrap
c
The wrap around the icon image.
d
In this example the author field fe_user_id is used to create a link
plugin.tx_bib_pi1.authors {
url_icon_fields = fe_user_id
url_icon.typolink {
# Unset default value
parameter.field >
# A Page id
parameter = 42
# Append the fe_user_id parameter
additionalParams.field = fe_user_id
additionalParams.wrap = &tx_feuserlisting_pi1[showUid]=|
}
}
plugin.tx_bib_pi1.field¶
Most fields can be wrapped with stdWrap. Additionally this default wrap can be overridden for specific bibtypes with a plugin.tx_bib_pi1.field.BIBTYPE.FIELDstatement.
The following example wraps the organization field with a <span> but (and only) in case of a book with a <div>.
plugin.tx_bib_pi1.field {
organization.wrap = <span>|</span>
book.organization.wrap = <div>|</div>
}
Basically every field can be wrapped. Here is a list of fields that are created from the database or have a different name there.
a
Property:
b
Data type:
c
Description:
d
Default:
a
author
b
stdWrap
c
Each author
d
a
authors
b
stdWrap
c
All authors
d
a
auto_url
b
stdWrap
c
The automatically generated url
d
a
auto_url_short
b
stdWrap
c
The automatically generated shortened url
d
a
editor_each
b
stdWrap
c
Each editor
d
a
file_url_short
b
stdWrap
c
The short file url
d
a
web_url_short
b
stdWrap
c
The short web url
d
a
web_url2_short
b
stdWrap
c
The short web url 2
d
To wrap the forename or surname check the plugin.tx_bib_pi1.authorsarray.
To avoid (or create?) confusion it may happen that in the output something looks like a field wrap but actually is defined in the html templated used by bib.
More examples:
- Wrap title and the whole authors string and each author
plugin.tx_bib_pi1 {
field.title.wrap = TITLE --- | --- TITLE
field.authors.wrap = AUTHORS --- | --- AUTHORS
field.author.wrap = <b>|</b>
}
plugin.tx_bib_pi1.restrictions.TABLE.FIELD_NAME¶
Each field from each bib tables can be restricted to specific FE user groups. The table names are not literally but abbreviated with
- 'ref' for 'tx_bib_references' and
- 'authors' for 'tx_bib_authors'
The interpreted restriction values are listed below.
a
Property:
b
Data type:
c
Description:
d
Default:
a
hide_all
b
Bool
c
Allways hide this field. The fields is revealed when FE_user_groups is set and matches.
d
a
hide_file_ext
b
String
c
Hide on string ending. Comma separated values of string endings. E.g. '.pdf,.ppt'
d
a
FE_user_groups
b
String
c
'all' or a comma separated list of fe_user group ids. E.g. '12,45,76'
d
Examples:
- file_url only gets displayed if it does not end with '.pdf' or '.ppt'
plugin.tx_bib_pi1 {
restrictions.ref {
file_url.hide_file_ext = .pdf,.ppt
}
}
- The same but now all logged in frontend users are allowed to see the file links
plugin.tx_bib_pi1 {
restrictions.ref {
file_url.hide_file_ext = .pdf,.ppt
FE_user_groups = all
}
}
- This is a more elaborated example where many fields are hidden for users that are not logged in.
temp.bib_fe_grp = 2
temp.bib_restrict {
hide_all = 1
FE_user_groups < temp.bib_fe_grp
}
plugin.tx_bib_pi1 {
restrictions {
ref {
file_url < temp.bib_restrict
DOI < temp.bib_restrict
web_url < temp.bib_restrict
web_url2 < temp.bib_restrict
}
authors {
url < temp.bib_restrict
fe_user_id < temp.bib_restrict
}
}
}
plugin.tx_bib_pi1.classes¶
Here some CSS classes are defined.
a
Property:
b
Data type:
c
Description:
d
Default:
a
author_highlight
b
CSS class
c
CSS class for (filtered) author highlightning.
d
tx_bib-author_hl
a
even
b
CSS class
c
CSS class for even rows.
d
tx_bib-item_even
a
odd
b
CSS class
c
CSS class for odd rows.
d
tx_bib-item_odd
plugin.tx_bib_pi1.single_view¶
This array configures the single view.
a
Property:
b
Data type:
c
Description:
d
Default:
a
all_labels
b
stdWrap
c
Wraps the field labels
d
wrap = |:
a
dont_show
b
String
c
A list of comma separated field names that should not be displayed
d
uid,pid,in_library,...
Check the static include file
a
field_wrap
b
Array
c
This is the same as the tx_bib_pi1.field array but overrides the values from there for the dingle view.
d
a
template
b
Resource
c
Defines the HTML template file
d
EXT:bib/res/templates/single_view.html
a
title
b
stdWrap
c
Wrap for the title string in the HTML template ###SINGLE_VIEW_TITLE###
d
a
post_text
b
String / stdWrap
c
Some text & wrap can be set here. It will be inserted in the HTML template for the marker ###POST_TEXT###
d
empty
a
pre_text
b
String / stdWrap
c
The same as post_text but for the marker ###PRE_TEXT###
d
empty
The following example wraps the title in the list view with a link to the single view.
Inside the single view the wrap gets overridden with a wrap that does nothing since a link there would not make too much sense.
plugin.tx_bib_pi1 {
# Wraps the title with a link to the single view
field {
title.single_view_link = 1
}
single_view {
# Overrides any wrap from field.title
field_wrap.title.wrap = |
}
}
plugin.tx_bib_pi1.editor¶
These options configure the frontend editor and the list view in edit mode.
a
Property:
b
Data type:
c
Description:
d
Default:
a
default_pid
b
integer
c
The uid of the default publication storage folder. This is useful if there are multiple storages to read from but only one into which new publications should go.
d
a
delete_no_ref_authors
b
Bool
c
Delete authors without publications after a publication save
d
1
a
field_default.XXX
b
Array
c
This array defines the default values for new entries.
E.g.
field_default.in_library = 1
sets all new entries to be in the library. This works for most fields but not for the authors field.
d
a
full_text
b
Array
c
Configures the full text extraction
->full_text
d
a
list
b
Array
c
Configures the list view in edit mode
d
a
no_edit
b
Array
c
Configures which fields should not be allowed to be edited -> no_edit
d
a
no_show
b
Array
c
Configures which fields should not be shown
-> no_show
d
a
warnings
b
Array
c
Which data checks should be performed before save -> warnings
d
Here is an example
plugin.tx_bib_pi1.editor {
# This is convenient when multiple storages are selected
default_pid = 12345
field_default {
note = This book is in the library
in_library = 1
}
}
plugin.tx_bib_pi1.editor.full_text¶
These options configure the full text extraction from PDF files to the full_text field which can be searched.
a
Property:
b
Data type:
c
Description:
d
Default:
a
pdftotext_bin
b
Resource
c
Absolute path to the pdftotext binary
d
/usr/bin/pdftotext
a
tmp_dir
b
Directory
c
Directory where temporary text files will be created
d
/tmp
a
max_num
b
Integer
c
The maximal number of caches to update in one turn.
d
100
a
max_sec
b
Integer
c
The maximal number of seconds to spend for updating full text caches.
d
5
a
update
b
Bool
c
Enables automatic text extraction from PDFs during save or import of publication references by the FE editor.
d
0
Here is an example
plugin.tx_bib_pi1.editor.full_text {
# Activate text extraction for full_text field
update = 1
# Set a custom pdftotext binary
pdftotext_bin = /usr/local/bin/pdftotext
}
plugin.tx_bib_pi1.editor.list¶
Here the behaviour of the list view in the edit mode is configured
a
Property:
b
Data type:
c
Description:
d
Default:
a
warnings.file_nexist
b
Bool
c
Enable a 'file does not exist' warning if a local file does not exist
d
1
plugin.tx_bib_pi1.editor.no_edit¶
With no_edit fields can be set not editable in the FE editor. The fields and values still get displayed. Have a look at the no_show variable if fields should be hidden completely.
a
Property:
b
Data type:
c
Description:
d
Default:
a
FIELD_NAME
b
Bool
c
If set to 1 then the field FIELD_NAME can't be edited in the FE editor
d
0
Here is an example
plugin.tx_bib_pi1.editor.no_edit {
# The citeid should not be touched by editors
citeid = 1
}
plugin.tx_bib_pi1.editor.no_show¶
no_show allows to hide fields in the FE editor completely.
a
Property:
b
Data type:
c
Description:
d
Default:
a
FIELD_NAME
b
Bool
c
If set to 1 then the field FIELD_NAME doesn't show up in the FE editor
d
0
An example
plugin.tx_bib_pi1.editor.no_show {
# We don't use the library fields, so please hide them
extern = 1
reviewed = 1
in_library = 1
borrowed_by = 1
}
plugin.tx_bib_pi1.editor.warnings¶
Before saving the FE editor performs some data checks. These can be enabled/disabled here.
a
Property:
b
Data type:
c
Description:
d
Default:
a
empty_fields
b
Bool
c
Check if all required fields have a value
d
1
a
file_nexist
b
Bool
c
Check if a local file in 'file_url' exists
d
1
a
double_citeid
b
Bool
c
Check if an other reference with the same citeid exists
d
1
Here is an example
plugin.tx_bib_pi1.editor.warnings {
# Disable the 'empty fields' check
empty_fields = 0
}
plugin.tx_bib_pi1.enum¶
a
Property:
b
Data type:
c
Description:
d
Default:
a
all
b
String/stdWrap
c
Wrap for 'Count all' enumeration
d
String: ###I_ALL###
Wrap: |.
a
bullet
b
String/stdWrap
c
Wrap for 'Bullet' enumeration
d
String: •
Wrap: |
a
empty
b
String/stdWrap
c
Wrap for 'Empty' enumeration. (Not used)
d
a
file_icon
b
String/stdWrap
c
Wrap for 'File Icon' enumeration
d
String: ###FILE_URL_ICON###
Wrap: <div class="tx_bib-file_url_icon">|</div>
a
file_icon_image
b
stdWrap
c
Wrap for the link image
d
A typolink for 'file_url'
a
page
b
String/stdWrap
c
Wrap for 'Count page' enumeration
d
String: ###I_PAGE###
Wrap: |.
plugin.tx_bib_pi1.export¶
a
Property:
b
Data type:
c
Description:
d
Default:
a
enable_export
b
Comma separated values
c
Which export links should be available in the list view:
'bibtex' - BibTeX
'xml' - Bib XML
d
bibtex,xml
a
FE_groups_only
b
String
c
This can be a comma separated list of FE user group uids which are allowed to export only.
Can also be 'all' to allow any logged in user.
d
a
bibtex
b
stdWrap
c
The wrap for the BibTeX export link
d
a
label
b
String & stdWrap
c
The export label and its wrap
d
a
path
b
resource
c
The path where the export files will be stored
d
a
separator
b
String & stdWrap
c
The export link separator string and its wrap
d
a
xml
b
stdWrap
c
The wrap for the XML export link
d
plugin.tx_bib_pi1.import¶
a
Property:
b
Data type:
c
Description:
d
Default:
a
bibtex
b
stdWrap
c
The wrap for the BibTeX import link
d
a
label
b
String & stdWrap
c
The import label and its wrap
d
a
separator
b
String & stdWrap
c
The import link separator string and its wrap
d
a
xml
b
stdWrap
c
The wrap for the XML import link
d