-
Notifications
You must be signed in to change notification settings - Fork 43
Shortcode Reference [tpcloud]
Use this shortcode if you want to show an interactive list of publications with filters and a tag cloud in a post or page.
user (optional)
(integer) The IDs of the WordPress users whose publications you want to show (separated by comma).
type (optional)
(integer) The publication types for publications you want to show (separated by comma).
author (optional)
(string) If you want to display only publications of one or more authors, so set here the IDs of the authors (separated by comma).
year (optional) new since 6.0.0
(string) One or more years for publications you want to show (separated by comma).
exclude (optional)
(string) One or more IDs of publications (separated by comma) you don’t want to show.
include_editor_as_author (optional) new since 6.1.0
(integer) Defines if the filter results includes editors as authors (=1) or not (=0), Default is: 1.
order (optional)
(string) The order clause for publications. Default is date DESC. Possible values: bibtex, title, type, year.
Examples:
[tpcloud order="title ASC"]
[tpcloud order="type ASC, title ASC"]
headline (optional)
(integer) You can set the following options for the headlines within the publication list:
- headline=“0″: Disable headlines
- headline=“1″ (default): For years like 2011, 2010, 2009.
- headline=“2″: For publication types like articles, books, inproceedings
- headline=“3″: For headlines grouped by year then by type
- headline=“4″: For headlines grouped by type then by year Please note, that if you set headline=“2″, the order parameter will be ignored.
minsize (optional)
(integer) Min. font size for the words in the tag cloud in px. Default is 11.
maxsize (optional)
(integer) Max. font size for the words in the tag cloud in px. Default is 35.
tag_limit (optional)
(integer) Number of tags in the tag cloud. Default is 50.
hide_tags (optional)
(string) The IDs of the tags you want to hide (separated by comma). This has no influence of the selection of publications.
exclude_tags (optional)
(string) This parameter is similar to hide_tags but has an influence on publications. If exclude_tags is defined hide_tags will be ignored.
exclude_types (optional) new since 6.2.0
(string) Names of the publication types you want to exclude (separated by comma).
image (optional)
(string) Sets the image position: left, right or bottom. Default is none (No images displaying).
image_size (optinal)
(integer) Maximum size of an image in px. Default is 0. Use this only together with the „image“-parameter.
image_link (optional) new since 7.1.0
(string) Sets the global link target for the images. Please note, that the local image target setting of a publication can overwrite the global option. The following options are available:
- none (default): No link will be set.
- self: The link refers to the the image source
- rel_page: The link refers to the related page if this is set for the publication
- external: The link refers to the external URL if this is set for the publication
anchor (optional)
(integer) If you want to use HTML-Anchor for the Tag-Links (anchor = „1″) or not (anchor=“0″). Default is 1.
author_name (optional)
(string) Defines the style of the author names. The possible styles are simple, old, last or initials. Default is initials.
Examples:
If you have the name: Ludwig C. van der Vaart
The output is the following:
simple --> Ludwig C. van der Vaart
old --> Vaart, Ludwig C. van der
last --> van der Vaart, Ludwig
initials --> van der Vaart, Ludwig C
short --> van der Vaart LC
editor_name (optional)
(string) Defines the style of the editor names. The possible styles are simple, old, last or initials. Default is initials. The usage is similar to author_name.
author_separator (optional) new since 6.0.4
(string) Sets the separator between different authors of a publication. The default is ";".
Example:
[tpcloud author_separator="," editor_separator=","]
editor_separator (optional) new since 6.0.4
(string) Sets the separator between different editors of a publication. The default is ";".
style (optional)
(string) Defines the style of your publication list. The possible styles are:
- none (default)
- numbered: Numbered publication list, number is ascending
- numbered_desc: Numbered publication list, number is descending
template (optional) new since 6.0.0
(string) Sets the template key for the publication list. The default is "tp_template_2016".
title_ref (optional) new since 6.0.0
(string) Sets, which info box is linked whith the publication title. The possible options are: links (default): The info box with the links abstract: The info box with the abstract
link_style (optional)
(string) The style of publication links. The possible styles are:
- inline (default): The title of the publication is a link which opens an info box.
- images: All links will be direct displayed as little icons behind the publication.
- direct: The title of the publication opens the first link. All links are visible in the info box.
date_format (optional)
(string) This parameter defines the format for dates and is used for some publication types (presentation,online). Default is d.m.Y. For possible values have a look to the documentation of PHP's date function.
pagination (optional)
(integer) Activates pagination (1) or not (0). Default is 1.
entries_per_page (optional)
(integer) Number of publications per page (pagination must be set to 1). Default is 50. Don't set entries_per_page to "0", use pagination="0" instead.
sort_list (optional)
(string) A list of publication types (separated by comma) which overwrites the default sort order for headline = 2. Please note, that sort_list is not compatible with the pagination function. If you use sort_order, set pagination=“0″.
show_tags_as (optional)
(string) Defines the style of the tags or their filter. You can choice between:
- cloud - Shows a tag cloud as filter and tags with links under each publication
- pulldown - Shows a pulldown as filter and tags with links under each publication
- plain - Shows no filter and tags without links under each publication
- none - Shows no tags.
Default is cloud.
show_bibtex (optional) new since 6.0.0
(integer) Define, if you want to show the bibtex box under each publication (1) or not (0). Default is 1.
show_comment (optional) new since 9.0.7
(integer) Define, if you want to show the private comment box under each publication (1) or not (0). Default is 0.
comment_text (optional) new since 9.0.7
(string) Sets the text used for the comment link, if shown. Default: 'Comment'.
comment_tooltip (optional) new since 9.0.7
(string) Sets the tooltip text for the comment link, if shown. Default: 'Show comment'.
show_author_filter (optional) new since 6.2.1
(integer) Define, if you want to show the author filter (1) or not (0). Default is 1.
show_in_author_filter (optional) new since 6.2.2
(string) A list of author IDs (separated by comma). Can be used to manage the list of authors in the author filter. Don't use it, if you use also the author parameter.
show_type_filter (optional) new since 6.2.3
(integer) Define, if you want to show the publication type filter (1) or not (0). Default is 1.
show_user_filter (optional) new since 6.2.1
(integer) Define, if you want to show the user filter (1) or not (0). Default is 1.
container_suffix (optional)
(string) A suffix, which can optionally set to modify container IDs in publication lists. It’s not set by default.
show_altmetric_donut (optional) new since 6.0.0
(integer) Define, if you want to show the altmetric donut (1) or not (0). Default is 0. Please note that altmetric support is not available by default.
show_altmetric_entry (optional) new since 6.0.0
(integer) Define, if you want to show the altmetric entry (1) or not (0). Default is 0. Please note that altmetric support is not available by default.
show_dimensions_badge (optional) new since 9.0.0
(integer) Define if you want to show the Dimensions Badge (1) or not (0). Default is 0. Please note that Dimensions Badge support is not available by default.
show_plumx_widget (optional) new since 9.0.0
(integer) Define if you want to show the PlumX Widget (1) or not (0). Default is 0. Please note that PlumX support is not available by default.
A publication list with images:
[tpcloud image="left" image_size="60"]
A list with an other author name style:
[tpcloud author_name="last"]
A list of a single author (WordPress user-ID: 15) with some changes on the tag cloud:
[tpcloud user="15" maxsize="40" minsize="10" tag_limit="100"]
A list of publications with a custom sort order for publication types:
[tpcloud headline="2" sort_list="book, inbook, incollection, article, inproceedings, techreport, misc, presentation, mastersthesis, unpublished" pagination="0"]
- Since: 2.0.0
- 2.0.11: Parameter author_names added
- 2.0.12: Parameter editor_names added
- 2.2.0: Parameters order and type added
- 3.0.0: Parameter headline added / Paramter id renamed to user
- 3.1.0: Parameters link_style and exclude added
- 4.0.0: Parameter date_format added / Third style option (numbered) added
- 4.2.0: Parameter hide_tags added / Fourth style option(numbereed_desc) added
- 4.2.1: Style options „std_num“ and „std_num_desc“ added
- 4.3.0: Parameter „limit“ is now „tag_limit“ / New parameters „pagination“, „entries_per_page“ and „sort_list“ added
- 4.3.2: New parameter „exclude_tags“ added
- 4.3.3: New headline option (headline=“4″) added
- 4.3.5: New link style option (link_style=“direct“) added
- 5.0.0: New parameter „show_tags_as“ added; Pagination is active by default
- 5.0.2: New parameter „container_suffix“ added
- 5.0.15: New parameter „author“ added
- 6.0.0: New parameters "year", "template", "image_link", "title_ref", "show_bibtex", "show_altmetric_donut", "show_altmetric_entry" added / Default settings for author/editor name parsing changed to initials / Usage of parameter "style" changed
- 6.0.4: New parameters "author_separator" and "editor_separator" added
- 6.1.0: New parameter "include_editor_as_author" added
- 6.2.0: New parameter "exclude_types" added
- 6.2.1: New parameters "show_author_filter" and "show_user_filter" added
- 6.2.2: New parameter "show_in_author_filter" added
- 6.2.3: New parameter "show_type_filter" added
- 7.1.0: Changed behavior for parameter "image_link"
- 8.0.0: "short" option for author/editor names added
- 9.0.0: New parameters "show_dimensions_badge" and "show_plumx_widget"