Skip to content

Commit 51fb16f

Browse files
committed
2 parents 6d2a63e + 97f6fea commit 51fb16f

File tree

1 file changed

+25
-24
lines changed

1 file changed

+25
-24
lines changed

docs/declarative-customization/site-design-json-schema.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Site template JSON schema
33
description: JSON schema reference for building site templates for SharePoint.
4-
ms.date: 01/27/2022
4+
ms.date: 01/31/2022
55
ms.localizationpriority: high
66
---
77

@@ -35,27 +35,27 @@ The overall JSON structure is specified as follows:
3535
Use the **createSPList** verb to create a new SharePoint list.
3636

3737
> [!NOTE]
38-
> Once **createSPList** is applied on a site, runnning the **createSPList** with the same list name will act as an update to the existing list.
38+
> Once **createSPList** is applied on a site, running the **createSPList** with the same list name will act as an update to the existing list.
3939
4040
### JSON values
4141

4242
- `listName`: The name of the list.
43-
- `templateType`: Which template to apply to the list. Typically you would use value 100. The full list of template type values is documented in [SPListTemplateType enumeration](/previous-versions/office/sharepoint-server/ms413878(v=office.15)) - but the ones we currently support include:
43+
- `templateType`: Which template to apply to the list. Typically, you would use value 100. The full list of template type values is documented in [SPListTemplateType enumeration](/previous-versions/office/sharepoint-server/ms413878(v=office.15)) - but the ones we currently support include:
4444

4545
| List Template Name | Enum |
4646
|--------------|---------|
47-
Generic List | 100
48-
Document Library | 101
49-
Survey | 102
50-
Links | 103
51-
Announcements | 104
52-
Contacts | 105
53-
Events | 106
54-
Tasks | 107
55-
Discussion Board | 108
56-
PictureLibrary | 109
57-
Site Pages | 119
58-
Issue Tracking | 1100
47+
|Generic List | 100|
48+
|Document Library | 101|
49+
|Survey | 102|
50+
|Links | 103|
51+
|Announcements | 104|
52+
|Contacts | 105|
53+
|Events | 106|
54+
|Tasks | 107|
55+
|Discussion Board | 108|
56+
|PictureLibrary | 109|
57+
|Site Pages | 119|
58+
|Issue Tracking | 1100|
5959

6060
If you use 101 or 119 and reference the default names ("Documents" or "Site Pages"), you can modify the library created with the template. See example below.
6161
- `subactions`: An array of actions that run in the order listed to create your list.
@@ -198,7 +198,7 @@ Subaction to add a previously defined site column directly to a list (existing o
198198
#### JSON value
199199

200200
- `internalName`: The internal name of the site column to add.
201-
- `addToDefaultView`: Optional attribute that defaults to false. If true, the newly added field will also be added to the default view.
201+
- `addToDefaultView`: Optional attribute that defaults to **False**. If **True**, the newly added field will also be added to the default view.
202202

203203
#### Example
204204

@@ -223,7 +223,7 @@ Defines and adds a view to the list. Use this action to specify the desired colu
223223
- `isPaged`: Specifies whether the view is paged.
224224
- `makeDefault`: If **True**, the view will be made the default for the list; otherwise, **False**.
225225
- `scope`: An optional setting to specify the scope of the view. For more information, see [SPViewScope enumeration](/previous-versions/office/sharepoint-server/ms458474(v=office.15)).
226-
- `formatterJSON`: An optional setting to specify the JSON formatting for the view
226+
- `formatterJSON`: An optional setting to specify the JSON formatting for the view.
227227

228228
#### Example
229229

@@ -617,13 +617,13 @@ Use the `addNavLink` verb to add a new navigation link to the site QuickLaunch o
617617

618618
#### JSON values
619619

620-
- `url`: The url of the link to add.
620+
- `url`: The URL of the link to add.
621621
- `displayName`: The display name of the link.
622622
- `navComponent`: The component where to add the link, QuickLaunch, Hub, or Footer. The default is **QuickLaunch**.
623623
- `isWebRelative`: **True** if the link is web relative; otherwise, **False**. The default is **False**.
624624
- `parentDisplayName`: An optional parameter. If provided, it makes this navigation link a child (sub link) of the navigation link with this displayName. If both this and parentUrl are provided, it searches for a link that matches both to be the parent.
625-
- `parentUrl`: An optional parameter. If provided, it makes this navigation link a child (sub link) of the navigation link with this url. If both this and parentDisplayName are provided, it searches for a link that matches both to be the parent.
626-
- `isParentUrlWebRelative`: An optional parameter. **True** if the link is web relative; otherwise, **False**. The default is **False**.
625+
- `parentUrl`: An optional parameter. If provided, it makes this navigation link a child (sub link) of the navigation link with this URL. If both this and parentDisplayName are provided, it searches for a link that matches both to be the parent.
626+
- `isParentUrlWebRelative`: An optional parameter. **True** if the link is web relative; otherwise, **False**. The default value is **False**.
627627

628628
#### Example
629629

@@ -670,15 +670,15 @@ Use the `removeNavLink` verb to remove a navigation link from the site.
670670

671671
#### JSON values
672672

673-
- `url`: The url of the link to remove.
673+
- `url`: The URL of the link to remove.
674674
- `displayName`: The display name of the link.
675675
- `navComponent`: The component where to remove the link from, QuickLaunch, Hub, or Footer. The default is **QuickLaunch**.
676676
- `isWebRelative`: **True** if the link is web relative; otherwise, **False**.
677677

678678
#### Example
679679

680680
> [!NOTE]
681-
> This action can be used to remove site links added by the collaboration and communication site templates (for example, "home", "documents", "pages", "conversations", etc.).
681+
> This action can be used to remove site links added by the collaboration and communication site templates (for example, "home", "documents", "pages", and "conversations").
682682
683683
```json
684684
{
@@ -806,7 +806,7 @@ Use the `setSiteLogo` verb to specify a logo for your site.
806806
807807
#### JSON value
808808

809-
- `url`: The url of the logo image to use.
809+
- `url`: The URL of the logo image to use.
810810

811811
#### Example
812812

@@ -831,7 +831,8 @@ Use the `joinHubSite` verb to join the site to a designated hub site.
831831

832832
#### Example
833833

834-
> [!NOTE] To get the hubSiteId, sign in to a site by using the **Connect-PnPOnline** cmdlet, and then run:
834+
> [!NOTE]
835+
> To get the `hubSiteId`, sign in to a site by using the **Connect-PnPOnline** cmdlet, and then run:
835836
836837
```PowerShell
837838
$hubSiteName = "My Hub Site"

0 commit comments

Comments
 (0)