[ CSS blogs-test ] Doc test

Inhaltsverzeichnis

Description
Shortcode usage
Shortcode parameters
1. Query parameters
  1. user
  2. tag
  3. equipment
  4. orgunit
  5. n
2. Additional parameters
  1. style
  2. type
  3. year
  4. groupBy
  5. locale

]

Description

The JGU FIS plugin provides a WordPress shortcode for rendering a list of publications from Gutenberg Research Elements, JGU's Research Information System.

Publications can be queried by user, organization unit, tag or equipment. Additionally, publications can be filtered by year(s) or publication type, and/or grouped by year or publication type.

Shortcode usage

[[fis user="brinkman"]]
[[fis user="brinkman"]]
[[fis user="brinkman"]]

[[fis user="brinkman"]]

    /**
     * Create page title from plugin name or H1
     *
     * @param string $name The plugin name.
     *
     * @return string
     */
    private function get_page_title( string $name ): string {
        $title = array_map(
            static function( $word ) {
                return ucfirst( $word );
            },
            explode( '-', $name )
        );
        return implode( ' ', $title );
    }

/**

* Create page title from plugin name or H1

* @param string $name The plugin name.

* @return string

private function get_page_title( string $name ): string {

$title = array_map(

static function( $word ) {

return ucfirst( $word );

explode( '-', $name )

);

return implode( ' ', $title );

}

Shortcode parameters

The shortcode comes with a set of parameters that allows you to set what you want to query, and how the results should be rendered.

Query parameters

Note: The query parameters user, tag, equipment and orgunit cannot be used together, i.e. you can query by only one of these parameters. The number of results for each of these parameters can be limited using the n parameter.

`user`

Query publications by user, for example user brinkman:

[[fis user="brinkman"]]

1	[[fis user="brinkman"]]

`tag`

Query publications by tag(s), e.g.

[[fis tag="AGBrinkman"]]

1	[[fis tag="AGBrinkman"]]

This parameter accepts one or multiple tags. Multiple tags have to be separated by commas. If multiple tags are used, the query returns publications that are tagged with all given tags (AND logic).

`equipment`

Query publications by equipments, e.g.

[[fis equipment="69007"]]

1	[[fis equipment="69007"]]

The equiment parameter expects an equiment ID, for example 69007 for "Mogon".

`orgunit`

Query publications by organization unit, e.g.

[[fis orgunit="c6b4744c-55d4-e711-a960-001dd8b72533"]]

1	[[fis orgunit="c6b4744c-55d4-e711-a960-001dd8b72533"]]

To search by organization unit, you need the UUID of an organizsation.

`n`

[[fis orgunit="c6b4744c-55d4-e711-a960-001dd8b72533" n="5"]]

1	[[fis orgunit="c6b4744c-55d4-e711-a960-001dd8b72533" n="5"]]

The n parameter limits the number of results returned from the query to the given number. The query will then return the last n results in reverse chronological order (in other words: newest first).

Note: The n parameter will be ignored if you filter by years or publication type, see below.

Additional parameters

`style`

The style parameter sets the CSL stylesheet for rendering the list of publications.

Default: apa-jgu ( based on APA style but author list abbreviated to 3 + et.al., reverse chronologigal order)

Available styles:

apa-jgu
apa
apa-cv
…

`type`

Filter by one or more publication types:

[[fis orgunit="c6b4744c-55d4-e711-a960-001dd8b72533" type="article-journal"]]

1	[[fis orgunit="c6b4744c-55d4-e711-a960-001dd8b72533" type="article-journal"]]

Multiple types have to be separated by commas.

The following types can be used:

article
article-journal
book
chapter
document
paper-conference
patent
report
thesis
webpage

`year`

Filter by one or more years

[[fis user="brinkman" year="2020, 2019"]]

1	[[fis user="brinkman" year="2020, 2019"]]

Multiple years have to be separated by commas.

`groupBy`

Group results by year or type

[[fis user="brinkman" groupBy="year"]]
[[fis user="brinkman" groupBy="type"]]

1 2	[[fis user="brinkman" groupBy="year"]] [[fis user="brinkman" groupBy="type"]]

The parameter accepts the values year and type.

`locale`

The locale to be used for rendering the result, in the format en_US.

Default: locale of the blog