User Journals - Shortcodes

From e107 Wiki
Jump to: navigation, search

e107 Wiki: English | Русский | Deutsch | Français | Magyar | Português | Български | Česky | Nederlands | Ελληνικά | Italiano | Norske | Polska | Slovenščina | Español | Svenska | Translate: Wiki | Page

logo_wiki.png

Current Release 1.0.4 | e107.org | Download | Changelog | Forum | Plugins | Themes | RSS Feed of Latest Changes | Atom Feed of Latest Changes


e107 Shortcode Guide
Main page > I : First Aid > II : Development > III : Administration > IV : How To's > V : Plugin Writing > VI : Theming & Shortcodes




Contents

Overview

This page details the shortcodes used by the User Journals plugin.

Shortcode Parameters

Shortcode parameters are passed to the shortcode using name/value pairs.

Each pair is seperated by & and name/values are seperated by =. If a parameter does not require a value, e.g. it switches something on or off, then just omit the value part.

Code: Shortcode parameter syntax
// Single parameter, no value
{UJ_BLOG_DATE=param1}

// Single parameter with value
{UJ_BLOG_DATE=param1=value1}

// Multiple parameters, param1 has no value
{UJ_BLOG_DATE=param1&param2=value2}


Blog Related Shortcodes

UJ_BLOG_BLOGGER_LINK

A link to the list of blogs for the writer of the current blog


UJ_BLOG_CATEGORIES

A list of categories (each one is a link to a categories page) for the current blog

Parameters:

label - show a label when the date is displayed

UJ_BLOG_COMMENTS

Comments for the current blog - uses e107 comments system (also depends on User Journals preferences)


UJ_BLOG_DATE

The current blog date

Parameters:

label - show a label when the date is displayed

UJ_BLOG_DELETE_LINK

A link to delete the current blog (wil lonly be shown if the blog belongs to the current user or the current user is a site admin)


UJ_BLOG_EDIT_LINK

A link to allow editing of the current blog (will only be shown if the blog belongs to the current user)


UJ_BLOG_ENTRY

The blog text


UJ_BLOG_ENTRY_SHORT

The blog text, truncated to the length specified in User journals preferences


UJ_BLOG_LINK

A link to a blog


UJ_BLOG_MOOD

The image for the mood of the current blog


UJ_BLOG_NOW_PLAYING

The current blog Now Playing text

Parameters:

label - show a label when the date is displayed

UJ_BLOG_RATINGS

Ratings for the current blog - uses e107 ratings so if not rated by current user will also display an option to allow the blog to be rated (also depends on User Journals preferences)


UJ_BLOG_SUBJECT

The current blog subject


Blogger Related Shortcodes

UJ_BLOGGER_LINK

A link to the the blogs list for a blogger


UJ_BLOGGER_NAME

The name of the blogger for the current blog


UJ_BLOGGER_PICTURE

The bloggers picture (actually USER_PICTURE shortcode) if allowed by site preferences and available.


UJ_BLOGGER_SYNOPSIS

The text of the current bloggers synopsis


UJ_BLOGGER_TIMESTAMP

The date/time of the current bloggers last blog


Blog Category Related Shortcodes

UJ_CATEGORY_ICON

The defined icon for a category


UJ_CATEGORY_LINK

A link to a specific category list page


UJ_CATEGORY_LIST

A list of categories


UJ_CATEGORY_LIST_HEADING

Text for heading the categories list


UJ_CATEGORY_START/UJ_CATEGORY_END

Wrappers for a category


Menu Specific Shortcodes

UJ_BLOGGER_MENU_LINK

A link to the the blogs list for a blogger when displayed in a menu


UJ_CATEGORY_MENU_LINK

A link to a specific category list page when displayed on a menu


UJ_MENU_READER_BLOGGERS

Wrapper for a list of bloggers on the menu displayed for users that are allowed to read blogs


UJ_MENU_READER_CATEGORIES

Wrapper for a list of categories on the menu displayed for users that are allowed to read blogs


UJ_MENU_WRITER_OPTIONS

Wrapper for Options section of the menu displayed for blog writers


UJ_MENU_WRITER_RECENT

Wrapper for the Recent Entries section of the menu displayed for blog writers


UJ_MENU_WRITER_UNPUBLISHED

Wrapper for Unpublished section of the menu displayed for blog writers


Miscellaneous Shortcodes

UJ_MESSAGE

Messages displayed to user, for example, after database insert, update or failure.


UJ_MESSAGE_EXTRA

Additional text, usually only displayed on database failure


UJ_RSS

Wrapper for RSS links


UJ_RSS_1

RSS 1 link


UJ_RSS_2

RSS 2 link


UJ_RSS_3

RSS RDF link