You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: 13/umbraco-cms/extending/backoffice-tours.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,23 +62,23 @@ Below is an explanation of each of the properties on the tour configuration obje
62
62
63
63
This is the name that is displayed in the help drawer for the tour.
64
64
65
-
65
+
66
66
***alias**
67
67
68
68
The unique alias of your tour. This is used to track the progress a user has made while taking a tour. The progress information is stored in the `TourData` column of the `UmbracoUsers` table in the database.
69
69
***group**
70
70
71
71
The group property is used to group related tours in the help drawer under a common subject (for example Getting started).
72
72
73
-
73
+
74
74
***groupOrder**
75
75
76
76
This is used to control the order of the groups in the help drawer. This must be an integer value.
77
77
***allowDisable**
78
78
79
79
A boolean value that indicates if the "Don't show this tour again" should be shown on the tour steps. If the user clicks this link the tour will no longer be shown in the help drawer.
80
80
81
-
81
+
82
82
***culture**
83
83
84
84
You have the option to set a culture, such as nl-NL. This tour will exclusively be displayed to users who have set this culture in their profile.
@@ -88,7 +88,7 @@ Below is an explanation of each of the properties on the tour configuration obje
88
88
89
89
The `contentType` property can also be used to limit the tours to content types that are using a specific composition. This will show the tour on all nodes that are using a specific composition.
90
90
91
-
 (1) (1) (1) (1).png>)
91
+
92
92
93
93
In the image above, two tours are available on the _Welcome_ node:
94
94
@@ -133,12 +133,12 @@ Below is an explanation of each of the properties on the tour step object.
Copy file name to clipboardExpand all lines: 13/umbraco-cms/extending/content-apps.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Content Apps are **companions** to the editing experience when working with cont
10
10
11
11
With Content Apps, editors can switch from editing 'Content' to accessing contextual information related to the item they are editing.
12
12
13
-
13
+
14
14
15
15
### Default Content Apps
16
16
@@ -144,7 +144,7 @@ And in the `.html` file:
144
144
145
145
Aftertheaboveeditsaredone, restartyourapplication. GotoanycontentnodeandyoushouldnowseeanappcalledWordCounter. Clickingontheiconshouldsay"Amount of words for each property"andconfirmthedetailsofthecurrentitemanduser. YoucannowadaptyourContentApptoretrieveexternaldatausingthestandardUmbracoandAngularJSapproach.
Copy file name to clipboardExpand all lines: 13/umbraco-cms/extending/packages/creating-a-package.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ To create a package, you first need to create a package schema through the Umbra
14
14
2. Select `Created` in the top-right corner of the screen.
15
15
3. Select the `Create package` button.
16
16
17
-
17
+
18
18
4. On the `Create package` page, there are fields that you can use to construct the contents of your package that are based on items from the backoffice.
19
19
5. Enter the package name at the top - we will call our dashboard the same as in the mentioned [Tutorial](../../tutorials/creating-a-custom-dashboard/): `Custom Welcome Dashboard`.
20
20
@@ -45,7 +45,7 @@ After filling out all the information, we can select **Create** to create the pa
45
45
46
46
If your package doesn't include backoffice specific items, the result from downloading it will be just a `package.xml` file. Otherwise, if you select media files you will download a ZIP package that looks like this:
47
47
48
-
48
+
49
49
50
50
Additionally to the `package.xml`, there is a folder containing the media items for your package. The rest of the information is recorded in the XML schema document.
51
51
@@ -96,31 +96,31 @@ For a guide on how to install the project templates, follow the 2 steps listed i
96
96
97
97
The outcome is the files generated below:
98
98
99
-
.png>)
99
+
100
100
101
-
Apart from the project file, you can find an empty `package.manifest` inside the **App\_Plugins** folder, which we will replace with the one created from the [Creating a Custom Dashboard Tutorial](../../tutorials/creating-a-custom-dashboard/). But more importantly, it also contains a `build/CustomWelcomeDashboard.targets` file.
101
+
Apart from the project file, you can find an empty `package.manifest` inside the **App_Plugins** folder, which we will replace with the one created from the [Creating a Custom Dashboard Tutorial](../../tutorials/creating-a-custom-dashboard/). But more importantly, it also contains a `build/CustomWelcomeDashboard.targets` file.
102
102
103
103
This file contains an `msbuild` target that is executed when a project has a dependency on this package. It copies the `App_Plugins` folder into the project on build. This is required for having Umbraco packages in a NuGet package format.
104
104
105
105
{% hint style="info" %}
106
-
If you are planning to overwrite the contents of the **App\_Plugins** folder, make sure that the subfolder containing your package contents has the same name as the one you specified after the `--name` flag and that the `package.manifest` has the correct path references to your files.
106
+
If you are planning to overwrite the contents of the **App_Plugins** folder, make sure that the subfolder containing your package contents has the same name as the one you specified after the `--name` flag and that the `package.manifest` has the correct path references to your files.
107
107
{% endhint %}
108
108
109
109
You can also add your custom C# files in the root of the package folder which will be part of the DLL of the package, but for our example, this won't be necessary.
110
110
111
111
### Transfer files
112
112
113
-
As mentioned previously, let's navigate to the **App\_Plugins** folder and replace its contents with the custom files we created for our new dashboard.
113
+
As mentioned previously, let's navigate to the **App_Plugins** folder and replace its contents with the custom files we created for our new dashboard.
114
114
115
-
115
+
116
116
117
117
### Specify package properties
118
118
119
119
In this section, we will demonstrate how you can add metadata about the package and its creator(s).
120
120
121
121
Now that Umbraco 9 is built on ASP.NET Core, you can add values directly to the package `csproj` file and it will pick them up. If you don't want to manually edit the `csproj` file, you can right-click your project, go to _Properties_ and then to _Package_. There you can insert your specific information:
Whenever the embedded package.xml file changes, the automatic package migration plan is executed again. This is due to the fact that the migration state is based on the file hash. Existing schema or content will not be overwritten in this process.
@@ -291,13 +291,13 @@ public class CustomPackageMigration : PackageMigrationBase
291
291
292
292
Here we also added the ZIP file as an embedded resource to the package project.
293
293
294
-
.png>)
294
+
When using a custom package migration plan, the current state is ignored by default. This causes it to execute all migrations again whenever this isn't the same as the final state of the plan (e.g. if you added a new migration). This is due to the `IgnoreCurrentState` being set to `true` in the `PackageMigrationPlan` base class. You can override this property and set it to `false` again to make it behave like regular migration plans and only run the migrations that have not yet been executed on the current environment.
303
303
@@ -318,6 +318,6 @@ By default, all these package migrations are executed unattended during startup
The configuration of package migrations can be different for each environment and makes it possible to have the migration executed unattended on the development environment, but leave them out or manually execute them on other environments. This is useful when you use a tool like Umbraco Deploy or USync as these will migrate the content.
We release the package manually in Azure DevOps, with a two stage process. Firstly we release to a "pre-releases" feed, and then after manual approval, to NuGet.
@@ -74,7 +74,7 @@ With packages like the StarterKit, the process does not end there. While the pac
74
74
75
75
There is no universal way to tell what content comes from a package, and what content is custom-made. In the Content section, delete individual nodes accordingly. If the goal is to fully remove the package and clean the site, all the content can be removed (and the recycle bin emptied).
@@ -104,7 +104,7 @@ Document Types can be removed from the **Settings** section. If fully removing t
104
104
105
105
As opposed to Document Types, there are some Data Types that are available out of the box when Umbraco is installed. It is not recommended to remove them. The safe approach is to delete any item that starts with a Document Type prefix and includes multiple dashes. That is the default naming convention for new configurations of Data Types (Example: "Blog - How many posts should be shown - Slider")
106
106
107
-
<imgsrc="../../../../10/umbraco-cms/extending/packages/images/removing-datatypes.png"alt="Backoffice - removing data types"data-size="original">
107
+
<imgsrc="images/removing-datatypes.png"alt="Backoffice - removing data types"data-size="original">
108
108
109
109
</details>
110
110
@@ -114,7 +114,7 @@ As opposed to Document Types, there are some Data Types that are available out o
114
114
115
115
No Templates are available out of the box in a new installation. If cleaning up after a package, it would be okay to delete all that are present
@@ -154,7 +154,7 @@ In this example, we will be using the SEOChecker package. This package allows de
154
154
155
155
An example use case of the SEOChecker property on a Document Type, as presented in the Content section:
156
156
157
-
157
+
158
158
159
159
To uninstall the SEOChecker from a website, the first step is to remove the package via a `dotnet` command or use the NuGet Package Manager.
160
160
@@ -172,7 +172,7 @@ After that, cleaning the solution is recommended.
172
172
173
173
While uninstalling the package would remove most of the custom code, the `App_Plugins` folder has to be cleaned manually.
174
174
175
-
<imgsrc="../../../../10/umbraco-cms/extending/packages/images/seochecker-app-plugins.png"alt="SEOChecker files in App Plugins"data-size="original">
175
+
<imgsrc="images/seochecker-app-plugins.png"alt="SEOChecker files in App Plugins"data-size="original">
176
176
177
177
Removing _seochecker_ folder from `App_Plugins` will clean up the leftover backoffice section and dashboards.
178
178
@@ -184,6 +184,6 @@ If content on the website relies on having a custom Property Editor or a data so
184
184
185
185
In the case of the SEOChecker, the custom property added from the package would look like this after all the package files have been removed:
186
186
187
-
187
+
188
188
189
189
Depending on the packages and the implementation, rendering of content from custom editors, or any frontend functionality dependent on external code, might not work correctly. It is always recommended to inspect the frontend of the site after removing any packages.
0 commit comments