Skip to content

Commit daf484a

Browse files
Sofie Toft Kristensengitbook-bot
authored andcommitted
GITBOOK-19: Organize Extension Types articles
1 parent dd9b7d4 commit daf484a

File tree

12 files changed

+68
-73
lines changed

12 files changed

+68
-73
lines changed

15/umbraco-cms/SUMMARY.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,13 @@
173173
* [Extension Manifest](customizing/extending-overview/extension-registry/extension-manifest.md)
174174
* [Extension Types](customizing/extending-overview/extension-types/README.md)
175175
* [Sections](customizing/extending-overview/extension-types/sections/README.md)
176+
* [Sections](customizing/extending-overview/extension-types/sections/section.md)
177+
* [Section Sidebar](customizing/extending-overview/extension-types/sections/section-sidebar.md)
178+
* [Section View](customizing/extending-overview/extension-types/sections/section-view.md)
176179
* [Workspaces](customizing/extending-overview/extension-types/workspaces/README.md)
180+
* [Workspace Actions](customizing/extending-overview/extension-types/workspaces/workspace-editor-actions.md)
181+
* [Workspace Context](customizing/extending-overview/extension-types/workspaces/workspace-context.md)
182+
* [Workspace Views](customizing/extending-overview/extension-types/workspaces/workspace-views.md)
177183
* [Modals](customizing/extending-overview/extension-types/modals/README.md)
178184
* [Confirm Dialog](customizing/extending-overview/extension-types/modals/confirm-dialog.md)
179185
* [Custom Modals](customizing/extending-overview/extension-types/modals/custom-modals.md)
@@ -190,12 +196,6 @@
190196
* [Entity Bulk Actions](customizing/extending-overview/extension-types/entity-bulk-actions.md)
191197
* [Trees](customizing/extending-overview/extension-types/tree.md)
192198
* [Global Context](customizing/extending-overview/extension-types/global-context.md)
193-
* [Section Sidebar](customizing/extending-overview/extension-types/section-sidebar.md)
194-
* [Section View](customizing/extending-overview/extension-types/section-view.md)
195-
* [Sections](customizing/extending-overview/extension-types/section.md)
196-
* [Workspace Context](customizing/extending-overview/extension-types/workspace-context.md)
197-
* [Workspace Views](customizing/extending-overview/extension-types/workspace-views.md)
198-
* [Workspace Actions](customizing/extending-overview/extension-types/workspace-editor-actions.md)
199199
* [Localization](customizing/extending-overview/extension-types/localization.md)
200200
* [Extension Kind](customizing/extending-overview/extension-kind.md)
201201
* [Extension Conditions](customizing/extending-overview/extension-conditions.md)

15/umbraco-cms/customizing/extending-overview/extension-types/dashboard.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Each section of the Umbraco backoffice has its own set of default dashboards. Yo
1010

1111
The dashboard area of Umbraco is used to display an "editor" for the selected item in the tree. If no item is selected, then the default set of section dashboards is shown in the dashboard area.
1212

13-
Notice that [Section Views](section-view.md) is another similar approach to append information to the root of a Section. Section views are thought mainly to be used as Secondary pages. These two approaches should ideally not be combined.
13+
Notice that [Section Views](sections/section-view.md) is another similar approach to append information to the root of a Section. Section views are thought mainly to be used as Secondary pages. These two approaches should ideally not be combined.
1414

1515
## Default Dashboards in Umbraco
1616

@@ -37,7 +37,7 @@ Here is a table of the default dashboards in Umbraco and the sections they are u
3737

3838
Even though these dashboards are useful, you might want to create your own custom dashboard to display specific information or functionality.
3939

40-
You can try and [create a custom dashboard](../../../tutorials/creating-a-custom-dashboard/README.md) as a way on getting started on this topic.
40+
You can try and [create a custom dashboard](../../../tutorials/creating-a-custom-dashboard/) as a way on getting started on this topic.
4141

4242
## Registering your Dashboard
4343

@@ -110,6 +110,9 @@ The dashboard manifest can contain the following properties:
110110
| Property | Type | Description |
111111
| Label | string | The label shown to the user |
112112
| pathname | string | The routable URL pathname |
113+
| Property | Type | Description |
114+
| Label | string | The label shown to the user |
115+
| pathname | string | The routable URL pathname |
113116
| conditions | array | (Optional) [Conditions](condition.md) for when the dashboard should be displayed |
114117

115118
### Full Example

15/umbraco-cms/customizing/extending-overview/extension-types/section-sidebar.md renamed to 15/umbraco-cms/customizing/extending-overview/extension-types/sections/section-sidebar.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44
This page is a work in progress and may undergo further revisions, updates, or amendments. The information contained herein is subject to change without notice.
55
{% endhint %}
66

7-
<figure><img src="../../../.gitbook/assets/section-sidebar.svg" alt=""><figcaption><p>Section Sidebar</p></figcaption></figure>
7+
<figure><img src="../../../../.gitbook/assets/section-sidebar.svg" alt=""><figcaption><p>Section Sidebar</p></figcaption></figure>
88

99
## Section Sidebar Apps <a href="#section-sidebar-apps" id="section-sidebar-apps"></a>
1010

11-
<figure><img src="../../../.gitbook/assets/section-sidebar-apps.svg" alt=""><figcaption><p>Section Sidebar Apps</p></figcaption></figure>
11+
<figure><img src="../../../../.gitbook/assets/section-sidebar-apps.svg" alt=""><figcaption><p>Section Sidebar Apps</p></figcaption></figure>
1212

1313
**Manifest**
1414

@@ -37,7 +37,7 @@ interface UmbSectionSidebarAppElement {}
3737
* To register a new menu sidebar app, add the following to your manifest
3838
* The menu sidebar app will reference a menu that you have registered in the menu with a menu manifest
3939

40-
<figure><img src="../../../.gitbook/assets/section-menu-sidebar-app.svg" alt=""><figcaption><p>Menu Sidebar App</p></figcaption></figure>
40+
<figure><img src="../../../../.gitbook/assets/section-menu-sidebar-app.svg" alt=""><figcaption><p>Menu Sidebar App</p></figcaption></figure>
4141

4242
**Manifest**
4343

@@ -70,6 +70,6 @@ interface UmbMenuSectionSidebarAppElement {}
7070

7171
This will make it possible to compose a sidebar menu from multiple Apps:
7272

73-
<figure><img src="../../../.gitbook/assets/section-sidebar-composed-apps.svg" alt=""><figcaption><p>Composed sidebar menu</p></figcaption></figure>
73+
<figure><img src="../../../../.gitbook/assets/section-sidebar-composed-apps.svg" alt=""><figcaption><p>Composed sidebar menu</p></figcaption></figure>
7474

75-
You can read more about this in the [Menu](../../../extending/section-trees/menu/) article.
75+
You can read more about this in the [Menu](../../../../extending/section-trees/menu/) article.

15/umbraco-cms/customizing/extending-overview/extension-types/section-view.md renamed to 15/umbraco-cms/customizing/extending-overview/extension-types/sections/section-view.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: >-
1010
This page is a work in progress and may undergo further revisions, updates, or amendments. The information contained herein is subject to change without notice.
1111
{% endhint %}
1212

13-
<figure><img src="../../../.gitbook/assets/section-views.svg" alt=""><figcaption><p>Section View</p></figcaption></figure>
13+
<figure><img src="../../../../.gitbook/assets/section-views.svg" alt=""><figcaption><p>Section View</p></figcaption></figure>
1414

1515
## Creating a custom Section View
1616

@@ -21,9 +21,7 @@ In this section, you can learn how to register and create a custom Section View
2121
The manifest file can be created using either JSON or Typescript. Both methods are shown below.
2222

2323
{% tabs %}
24-
25-
{% tab title="Json" %}
26-
24+
{% tab title="Json" %}
2725
We can create the manifest using json in the `umbraco-package.json`.
2826

2927
```json
@@ -45,15 +43,12 @@ We can create the manifest using json in the `umbraco-package.json`.
4543
]
4644
}
4745
```
48-
4946
{% endtab %}
5047

51-
{% tab title="Typescript" %}
52-
53-
48+
{% tab title="Typescript" %}
5449
The manifest can also be written in TypeScript.
5550

56-
For this typescript example we used a [Backoffice Entry Point](../../extending-overview/extension-types/backoffice-entry-point) extension to register the manifests.
51+
For this typescript example we used a [Backoffice Entry Point](../backoffice-entry-point/) extension to register the manifests.
5752

5853
```typescript
5954
import { ManifestSectionView } from "@umbraco-cms/backoffice/extension-registry";
@@ -78,18 +73,15 @@ const sectionViews: Array<ManifestSectionView> = [
7873
}
7974
]
8075
```
81-
82-
{% endtab %}
83-
76+
{% endtab %}
8477
{% endtabs %}
8578

86-
8779
### Lit Element
8880

8981
Creating the Section View Element using a Lit Element.
9082

91-
9283
**my-section.element.ts:**
84+
9385
```typescript
9486
import { UmbLitElement } from "@umbraco-cms/backoffice/lit-element";
9587
import { css, html, customElement, property } from '@umbraco-cms/backoffice/external/lit';

15/umbraco-cms/customizing/extending-overview/extension-types/section.md renamed to 15/umbraco-cms/customizing/extending-overview/extension-types/sections/section.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ For example, when you load the backoffice, you'll see the 'Content' section, 'Se
1414

1515
You can create your own sections to extend Umbraco with room for more features.
1616

17-
<figure><img src="../../../.gitbook/assets/section.svg" alt=""><figcaption><p>Section</p></figcaption></figure>
17+
<figure><img src="../../../../.gitbook/assets/section.svg" alt=""><figcaption><p>Section</p></figcaption></figure>
1818

1919
## **Creating a section**
2020

2121
### **Manifests**
2222

23-
When creating a new section it's recommended to use a [Entry Point](../../../customizing/extending-overview/extension-types/backoffice-entry-point.md)-extension in your [Umbraco Package Manifest](../../umbraco-package.md). This is to get better control over all the additional extensions required for the new section.
23+
When creating a new section it's recommended to use a [Entry Point](../backoffice-entry-point.md)-extension in your [Umbraco Package Manifest](../../../umbraco-package.md). This is to get better control over all the additional extensions required for the new section.
2424

2525
Create a section by defining a manifest for it:
2626

@@ -38,15 +38,15 @@ Create a section by defining a manifest for it:
3838

3939
Once registered, you will be able to select this action for your User Group Permissions. Once that is permitted, you can view your section.
4040

41-
<figure><img src="../../../.gitbook/assets/section-empty.png" alt=""><figcaption><p>Section</p></figcaption></figure>
41+
<figure><img src="../../../../.gitbook/assets/section-empty.png" alt=""><figcaption><p>Section</p></figcaption></figure>
4242

4343
#### **Extend with Sidebar, Dashboards and more**
4444

4545
Once a section is registered, it can be extended like any other section.
4646

4747
Here is a list of appropriate extensions to append to your section:
4848

49-
* [Creating a Custom Dashboard](../../../tutorials/creating-a-custom-dashboard/)
49+
* [Creating a Custom Dashboard](../../../../tutorials/creating-a-custom-dashboard/)
5050
* [Section Sidebar](section-sidebar.md)
5151
* [Section View](section-view.md)
5252

15/umbraco-cms/customizing/extending-overview/extension-types/workspace-context.md renamed to 15/umbraco-cms/customizing/extending-overview/extension-types/workspaces/workspace-context.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ A Workspace context is a container for the data of a workspace. It is a wrapper
1313
* A workspace context knows about its entity type (for example content, media, member, etc.) and holds its unique string (for example: key).
1414
* Most workspace contexts hold a draft state of its entity data. It is a copy of the entity data that can be modified at runtime and sent to the server to be saved.
1515

16-
If a workspace wants to utilize Property Editor UIs, then it must provide a variant context for the property editors. The variant-context is the generic interface between workspace and property editors.&#x20;
16+
If a workspace wants to utilize Property Editor UIs, then it must provide a variant context for the property editors. The variant-context is the generic interface between workspace and property editors.
1717

1818
```ts
1919
interface UmbWorkspaceContext {}
@@ -80,4 +80,4 @@ export const UMB_APP_CONTEXT = new UmbContextToken<MyContextCounterApi>(
8080
);
8181
```
8282

83-
We recommend using `UmbWorkspaceContext` as the Context Alias for your Context Token. This will ensure that the requester only retrieves this Context if it's present at their nearest Workspace Context. Use the Extension Manifest Alias as the API Alias for your Context Token. For more information, see the [Context API](../../../customizing/foundation/working-with-data/context-api.md) article.
83+
We recommend using `UmbWorkspaceContext` as the Context Alias for your Context Token. This will ensure that the requester only retrieves this Context if it's present at their nearest Workspace Context. Use the Extension Manifest Alias as the API Alias for your Context Token. For more information, see the [Context API](../../../foundation/working-with-data/context-api.md) article.

15/umbraco-cms/customizing/extending-overview/extension-types/workspace-editor-actions.md renamed to 15/umbraco-cms/customizing/extending-overview/extension-types/workspaces/workspace-editor-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Workspace actions are a set of functionalities or operations that can be perform
88

99
Workspace action relates to a workspace alias (Umb.Workspace.Document) and has Access to the workspace context.
1010

11-
<figure><img src="../../../.gitbook/assets/workspace-actions.svg" alt=""><figcaption><p>Workspace Actions</p></figcaption></figure>
11+
<figure><img src="../../../../.gitbook/assets/workspace-actions.svg" alt=""><figcaption><p>Workspace Actions</p></figcaption></figure>
1212

1313
**JavaScript Manifest example**
1414

15/umbraco-cms/customizing/extending-overview/extension-types/workspace-views.md renamed to 15/umbraco-cms/customizing/extending-overview/extension-types/workspaces/workspace-views.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Workspace Views was previously called Content Apps.
1414

1515
Workspace Views are customizable companion **tabs** with the ability to take place in any workspace.
1616

17-
<figure><img src="../../../.gitbook/assets/workspace-views.svg" alt=""><figcaption><p>Workspace Views</p></figcaption></figure>
17+
<figure><img src="../../../../.gitbook/assets/workspace-views.svg" alt=""><figcaption><p>Workspace Views</p></figcaption></figure>
1818

1919
**In Content Section**
2020

@@ -24,7 +24,7 @@ The default workspace view is **'Info'** - displaying Links, History and Status
2424

2525
## Example of a Workspace View
2626

27-
1. Follow the [Vite Package Setup](../../../customizing/development-flow/vite-package-setup.md) by creating a new project folder called "`workspaceview`" in `App_Plugins`.
27+
1. Follow the [Vite Package Setup](../../../development-flow/vite-package-setup.md) by creating a new project folder called "`workspaceview`" in `App_Plugins`.
2828
2. Create a manifest file named `umbraco-package.json` at the root of the `welcome-dashboard` folder. Here we define and configure our dashboard.
2929
3. Add the following code to `umbraco-package.json`:
3030

@@ -93,7 +93,7 @@ declare global {
9393

9494
In the `workspaceview` folder run `npm run build` and then run the project. Then in the content section of the Backoffice you will see our new Workspace View:
9595

96-
<figure><img src="../../../.gitbook/assets/workspace-view-example.png" alt=""><figcaption><p>Workspace View Example</p></figcaption></figure>
96+
<figure><img src="../../../../.gitbook/assets/workspace-view-example.png" alt=""><figcaption><p>Workspace View Example</p></figcaption></figure>
9797

9898
{% hint style="info" %}
9999
To see the Workspace View that we have created in the content section, first you will need to have some content created.

15/umbraco-cms/customizing/section-trees.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ For example, when you load the backoffice, you'll see that the 'Content' section
1616

1717
You can create your own sections and trees to extend Umbraco.
1818

19-
## [Sections](extending-overview/extension-types/section.md)
19+
## [Sections](extending-overview/extension-types/sections/section.md)
2020

2121
Describes Umbraco Sections, configuration, and APIs.
2222

0 commit comments

Comments
 (0)