Skip to content

Shortcode Reference: [tpsearch]

Michael edited this page Aug 17, 2017 · 12 revisions

Description

Use this shortcode if you want to show a search function for publications in a post or a page.

Parameters

user (optional)

(integer) The IDs of the user you want to include into the search area (separated by comma).

tag (optional)

(integer) The IDs of the tags you want to include into the search area (separated by comma).

entries_per_page (optional)

(integer) The number of entries per page. Default is 20.

image (optional)

(string) Sets the image position to: 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 6.0.0

(string) Sets the link target for the images. The following options are available:

  • none (default): No link will be set.
  • self: The link refers to the the image source
  • post: The link refers to the related page if this is set for the publication

author_name (optional)

(string) Defines the style of the author names. The possible styles are simple, old, last or initials. Default is last.

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

editor_name (optional)

(string) Defines the style of the editor names. The possible styles are simple, old, last or initials. Default is last. 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:
[tpsearch 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_orig_s".

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.

as_filter (optional)

(string) Set this parameter to true, if you want to show all publications by default. Default is false.

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 funciton.

order (optional)

(string) Defines the sort order of the publication list. Default is date DESC. Other possible values: title DESC, title ASC, date ASC,…

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.

container_suffix (optional)

(string) A suffix which can optionally set to modify container IDs in publication lists. It’s not set by default.

Examples

[tpsearch]

Changelog

  • Since: 4.0.0
  • 4.2.0: Parameters user and tag added.
  • 4.2.1: Style option „std_num“ added
  • 4.3.5: New link style option (link_style=“direct“) added
  • 4.3.11: New parameter „order“ added
  • 5.0.2: New parameter „container_suffix“ added
  • 6.0.4: New parameters "author_separator", "editor_separator" added
Clone this wiki locally