Using the SharePoint List Macro

You can use the SharePoint List macro {sp-list} to display a SharePoint list on a Confluence wiki page. The macro can display most SharePoint list types and document libraries.

Screenshot: The SharePoint List macro in Confluence

On this page:

Usage with the Macro Browser

The Macro Browser is a graphical menu that allows you to view the list of available Confluence macros and add them to the current page or blog post.

To insert the SharePoint List macro into a page using the Macro Browser,

Open the Confluence page or blog post that you want to edit, then click the 'Edit' button.
Click the Macro Browser icon on the toolbar. The macro browser window will open.
Scroll through the list of macros to find the one you want. Alternatively, start typing the macro name into the search box at the top right of the macro browser. Macros with a matching name will appear in the main pane.
Click the desired macro.
Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
Click 'Insert' to add the macro onto the page.

You can also insert macros via autocomplete. For more information, see Using Autocomplete in the Rich Text Editor.

Parameters

Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example).

Parameter	Default	Description
Site	No default	The Site parameter is the nickname of the SharePoint site as specified in the SharePoint Administration settings. See the Confluence SharePoint plugin configuration guide. Note that this value is case-sensitive – use the same capital and lower-case letters as in the plugin configuration screen. In the Confluence 'Macro Browser' you will see a dropdown showing all the SharePoint sites configured in your Confluence wiki for you to choose from.
List	No default	Use this parameter to specify the name of the list that you want to display in Confluence. Displaying a list in a sub-site: If the list you want to display is stored in a "sub-site" of the configured site alias, then you must type the name of the subsite in the list parameter, followed by the list name. For example, to display a list called "Documents" that is stored in a sub-site called "Marketing", then the list parameter would be entered as: Marketing/Documents
View	No default	Use this parameter to reference a view in SharePoint for controlling the appearance of the list in Confluence. By creating or customising a view in SharePoint, you can control the following aspects of the list's display: The columns that are displayed, and the order in which they appear The maximum number of rows displayed The sorted order, in which the rows appear The rows that are displayed (by specifying a filter to restrict some rows from being displayed) You can leave the View parameter blank, in which case the macro will use the default view configured for the desired list.
Folder	No default	Use this parameter to view the contents of a folder or sub-folder within the list. To display the contents of a root (top-level) folder, just type the name of the folder. To display the contents of a sub-folder, enter the path to the sub-folder. For example, to show the sub-folder "Team A" in a folder called "Team Documents", the Folder parameter would be entered as: Team Documents/Team A

Examples

Example 1: Document Library with Custom View

What you need to type	What you will get
{sp-list:Site=<mysharepointalias>\|List=Confluence Requirements\|View=Support Team}

Example 2: Sub-folder in a Contacts List

What you need to type	What you will get
{sp-list:Site=<mysharepointalias>\|List=Confluence Team\|Folder=Developers/SharePoint Developers}

Example 2: Links List in a sub-site

What you need to type	What you will get
{sp-list:Site=<mysharepointalias>\|List=Developers/Important Links}

Child pages

Usage with the Macro Browser

Parameters

Examples

RELATED TOPICS