Dashboard > Atlassian Plugins > ... > Suppliers > Content Supplier
  Atlassian Plugins Log In | Sign Up   View a printable version of the current page.  
  Content Supplier

Added by david , last edited by David Peterson on Apr 03, 2008  (view change) show comment
Labels: 

Summary

Supplies information about Confluence content, such as pages, news items, attachments and comments.

Key names are case-sensitive. That is, you must supply a key of "id" rather than "ID".

Details

Name: Content Supplier
Prefix: content (optional)
Supported Content: Confluence pages, news items, attachments, comments and space descriptions.
Provided By: Reporting Plugin

Keys Supported

The following are the list of keys which this supplier will return a value for.

Key Content Types Return Type Description
id All Number The unique identifier for the content.
title All Text The title of the content.
type All Text The name of the content type. Eg 'Page' or 'News'.
url All Text The server-relative URL to view the content.
creator All User The user who created the content.
creation date All Date The date the content was created.
modifier All User The user who most recently modified the content.
modification date All Date The date the content was most recently modified.
icon All Text The server-relative URL of the icon for this content type.
space All Space The space the content exists in. If the content is itself a space, the space is returned.
excerpt Pages, news items, space descriptions Text The excerpt for the content.
body Pages, news items, space descriptions, comments Text The main body text of the content.
labels Pages, news items, space descriptions List of Labels A list of the labels attached to this content.
attachments Pages, news items List of Attachments A list of the attachments on the supplied content.
incoming links Pages, news items List of Links A list of links to content which links to the supplied content.
outgoing links Pages, news items List of Links A list of links to content which the supplied content links to.
comments Pages, news items List of Comments A list of top-level comments attached to the supplied page or news item. These are comments which are not replies to other comments.
all comments Pages, news items List of Comments A list of all comments attached to the supplied page or news item. This includes all replies in comment threads.
parent Pages Page The parent of the current page.
ancestors Pages List of Pages The list of ancestors of the current page.
children Pages List of Pages The list of children belonging to the current page.
descendents Pages List of Pages The list of all descendents belonging to the current page.
replies Comments List of Comments The list of all comments replying directly to the current comment.
repliers Comments List of Users The list of all users who replied to the current comment, directly or indirectly.
reply count Comments Number The total number of all replies to this comment, directly or indirectly.
replying to Comments Comment The comment that the current comment is replying to. Will be empty for top-level comments.
download path Attachments Text The path to the download location for the attachment.
file name Attachments Text The file name of the attachment.
file size Attachments Number The length of the file in bytes.
nice file size Attachments Text The length of the file, described in bytes, kilobytes or megabytes, depending what makes the most sense.
content type Attachments Text The content (MIME) type.
comment Attachments Text The attachment comment text.
attached to Attachments Page/News Item The content the attachment is attached to.
attachment version Attachments Number The attachment version number.
summary Content Text Either the excerpt (as above), if it exists, or a short summary of the page content if it does not.
(Since 1.3)
equals [X] Content Boolean Tests if the current context is equal to that specified by X, where X is a standard link to Confluence content.
(Since 2.0.0)

Examples:

  • equals My Page - compares to 'My Page' in the current space.
  • equals @self - compares to the current context.
  • equals @parent - compares to the parent page of the current context.
  • equals ^attachment.ext - compares to the file attached to the current page.
  • content:equals KEY:Page - compares to a page in another space. Note: the 'content:' prefix is required for tests on pages in other spaces, due to the ':' character in the value.
version Content Number The version number for the content.
version comment Content Text The comment about the version, as set by the editor.
(Since 2.1.0)
version history Content List of Content The list of historical versions for the current content object. The most recent version will be listed first.
(Since 2.1.0)
is latest version Content Boolean Checks if the content is the latest version.
latest version Content Content Returns the latest version of the content. May be the same content if this is the latest version.

Related Suppliers

Label Supplier, Link Supplier, Reference Supplier, Report Supplier, Space Supplier, User Supplier

Related Recipes

Aggregate news report recipe, Attachment List Recipe, Custom children list recipe, External Link List Recipe, Include all child pages recipe, Outgoing link list recipe, Space Labels Recipe

Hi,

I'm trying to generate html code to display the images properly (report-image does not allow me to resize the images nor use all of the CSS options of the <img ...> html tag).

In order to display a thumbnail, Confluence uses the "/download/thumbnails/..." path ;
could you please add this url to the content supplier?

Also is it possible, while reporting on pages, to get for example content:images > collection:first ? Would it be possible to include in a future release the possibility to extract the image attachments instead of just any attachments (because we cannot filter while in the body on the attachment types)?

Thanks a lot for your help,
Vincent

My suggestion would be to create feature requests for each of these, so that we'll process them for a future version of the plugin. Create one each for allowing 'class' and 'style' to be specified for report-image, thumbnails and 'content:images'. The latter is the least likely, but present a good enough argument and we'll see what happens.

Copyright(c) CustomWare Asia Pacific Pty Ltd
Powered by Atlassian Confluence 2.7.3, the Enterprise Wiki. Bug/feature request - Atlassian news - Contact administrators