Add Page via Form

Description

Creates a simple form on a page for users to enter the name of the new page to add.

Very similar to the Add Page macro, this will then create a new page, which may be based on a template if so desired.

Notes about migration

  • Some legacy Macro parameters from Confluence Server are not supported yet. More details at our FAQ page. We have tagged these parameters with a (Legacy) prefix as seen below.
  • Server users migrating to the cloud will not lose any data.
  • Some server-version parameters are currently unsupported and are ignored by the macro, but all server data will be retained. These functions will automatically work when the function is available in the future.

What features would you like to see in Cloud?

Would you like to see more Server macro parameters in Cloud? Feel free to take our ongoing survey and we will prioritize accordingly.


Parameters

NameRequiredAvailable InMigratable to Cloud?Default ValueDescription
Link Text
 Yes
Server, Data Center
Yes
Text display for the link.
Button text (same as Link Text in Server)
 Yes
Cloud
No
Text display for the link.
Field hint
 Optional
Cloud
No
Hint for the Button Text field to guide users. e,g, “Enter a maximum of 255 characters.”
 

Source
 Optional
Server, Data Center, Cloud
Yes
The name of the template to use or page to clone.
Source Type
 Optional
Server, Data Center, Cloud
Yes
template
The type of source to use, either template or page.
Live Template
 Optional
Server, Data Center
No
false

If set to true, the template will be "live" - that it it uses Scaffolding's Live Template macro to import and execute the current value of the template every time the page is viewed.

Requires Scaffolding Forms & Templates to be installed. 

Prefix
 Optional
Server, Data Center, Cloud
Partial

Server

The injectable prefix to apply to the page name. The user will not be able to modify this section of the name while creating it. 

For example:

"%page:title% - " will add the current page title plus " - " to the start of the page name. 

Cloud

(warning) Injections are not supported on Cloud. For example, “%page:title% - Meeting Notes” would result in the literal text "%page:title% - Meeting Notes" instead of "My Page Title - Meeting Notes" when migrated to Cloud.

The prefix to apply before the page name. May contain these functions:

  • $spaceKey to use the targeted page's Confluence space key as prefix.
  • $spaceName to use the targeted page's Confluence space name as prefix.

  • $date(<date-format>) to output the current time and date e.g. $date(YYYY-MM-dd HH:mm a). Supported date-formats are as follows:

     Click here to expand table...
    FormatOutputDescription
    YY18Two-digit year
    YYYY2018Four-digit year
    M1-12The month, beginning at 1
    MM01-12The month, 2-digits
    MMMJan-DecThe abbreviated month name
    MMMMJanuary-DecemberThe full month name
    D1-31The day of the month
    DD01-31The day of the month, 2-digits
    d0-6The day of the week, with Sunday as 0
    ddSu-SaThe min name of the day of the week
    dddSun-SatThe short name of the day of the week
    ddddSunday-SaturdayThe name of the day of the week
    H0-23The hour
    HH00-23The hour, 2-digits
    h1-12The hour, 12-hour clock
    hh01-12The hour, 12-hour clock, 2-digits
    m0-59The minute
    mm00-59The minute, 2-digits
    s0-59The second
    ss00-59The second, 2-digits
    SSS000-999The millisecond, 3-digits
    Z+5:00The offset from UTC
    ZZ+0500The offset from UTC, 2-digits
    AAM PM
    aam pm
  • $id(<format>,<startAt>) to assign incremental IDs e.g. $id(000,1)
Postfix
 Optional
Server, Data Center, Cloud
Partial

Server

The injectable postfix to apply to the page name. The user will not be able to modify this section of the name while creating it. 

For example:

" - %page:title%" will add " - " plus the current page title to the end of the page name. 

Cloud

(warning) Injections are not supported on Cloud. For example, “%page:title% - Meeting Notes” would result in the literal text "%page:title% - Meeting Notes" instead of "My Page Title - Meeting Notes" when migrated to Cloud.

The postfix to apply before the page name. May contain these functions:

  • $spaceKey to use the targeted page's Confluence space key as prefix.
  • $spaceName to use use the targeted page's Confluence space name as prefix.

  • $date(<date-format>) to output the current time and date e.g. $date(YYYY-MM-dd HH:mm a). Supported date-formats are as follows:

     Click here to expand table...
    FormatOutputDescription
    YY18Two-digit year
    YYYY2018Four-digit year
    M1-12The month, beginning at 1
    MM01-12The month, 2-digits
    MMMJan-DecThe abbreviated month name
    MMMMJanuary-DecemberThe full month name
    D1-31The day of the month
    DD01-31The day of the month, 2-digits
    d0-6The day of the week, with Sunday as 0
    ddSu-SaThe min name of the day of the week
    dddSun-SatThe short name of the day of the week
    ddddSunday-SaturdayThe name of the day of the week
    H0-23The hour
    HH00-23The hour, 2-digits
    h1-12The hour, 12-hour clock
    hh01-12The hour, 12-hour clock, 2-digits
    m0-59The minute
    mm00-59The minute, 2-digits
    s0-59The second
    ss00-59The second, 2-digits
    SSS000-999The millisecond, 3-digits
    Z+5:00The offset from UTC
    ZZ+0500The offset from UTC, 2-digits
    AAM PM
    aam pm
  • $id(<format>,<startAt>) to assign incremental IDs e.g. $id(000,1)
Parent
 Optional
Server, Data Center, Cloud
Yes

@self (Server)

Current page (Cloud)

Server

The page you would like to be the parent of the new page.

If no parent page is desired, set parent to a blank value.

e.g. "parent=". There are also three special values:

  • @self - sets the parent to the new page the macro appears in.
  • @parent - sets the parent of the new page to the parent of the current page.
  • @home - sets the parent of the new page to the home page of the current space. 

Cloud

The target parent for the new page. Defaults to the current page.

NOTE

The special values @self, @parent, and @home are no longer supported in Cloud. Existing macros with these special values will continue to work, unless the Parent field is updated to another page.
Labels
 Optional
Server, Data Center, Cloud
Yes
The list of labels to attach to the new page.
Allow Rename
 Optional
Server, Data Center
No
If set to true, the user will be allowed to rename the page when it is being created. 
Name Field Width
 Optional
Server, Data Center
No

If set, this specifies the width of the name text field.

Can be any valid CSS width value, such as "300px" or "60%".

CSS Class
 Optional
Server, Data Center
No
(Deprecated) Sets a class for the displayed form items.

Solutions
Apps

Resources
Company