Skip to content

Commit fc5665e

Browse files
committed
Format files according to .editorconfig
1 parent 06546e3 commit fc5665e

File tree

460 files changed

+5378
-5432
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

460 files changed

+5378
-5432
lines changed

.github/ISSUE_TEMPLATE/issue-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Missing documentation
1010
Wrong documentation
1111
Other (write it here)
1212

13-
## What article/section is this about?
13+
## What article/section is this about?
1414
(link here)
1515

1616
## Describe the issue

Add-ons/The-Licensing-model/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ versionFrom: 7.0.0
44

55
# The Licensing Model
66

7-
Umbraco Forms and Umbraco Courier are commercial products.
7+
Umbraco Forms and Umbraco Courier are commercial products.
88

99
For Umbraco Forms you will have a 14-day free trial to try out the product. After your trial expires, you'll need to have a **valid license** in order to keep using the product on your site.
1010

@@ -60,7 +60,7 @@ That this is an add-on domain for existing licenses. Refunds will not be given f
6060
- The development domains works with or without the `www` subdomain
6161
- The license also includes `localhost` as a valid domain
6262

63-
For the Umbraco Courier license you do not need to purchase additional domains if you are running multiple sites within the same Umbraco installation.
63+
For the Umbraco Courier license you do not need to purchase additional domains if you are running multiple sites within the same Umbraco installation.
6464

6565
## Configuring and installing your license
6666

Add-ons/UmbracoCourier/Configuration/RepositoryProviders.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ versionRemoved: 8.0.0
55

66
# Repository Providers
77

8-
A repository provider is a location to store the files Courier produces when data is serialized from objects to files.
8+
A repository provider is a location to store the files Courier produces when data is serialized from objects to files.
99

1010
A repository is a file storage, which can return items in sets based on a revision alias. It is possible to store sets of changes in a revision with a certain name, and let the repository store and handle where the files exists.
1111

@@ -14,7 +14,7 @@ A repository is a file storage, which can return items in sets based on a revisi
1414
* **Guid**: e0472598-e73b-11df-9492-0800200c9a67
1515
* **Full name**: `Umbraco.Courier.Providers.RepositoryProviders.Local`
1616

17-
The underlying IO provider. This provider is used whenever Courier access revisions or files on the local machine.
17+
The underlying IO provider. This provider is used whenever Courier access revisions or files on the local machine.
1818

1919
This cannot be configured as Courier always automatically lists all revisions from the local provider.
2020

@@ -23,17 +23,17 @@ This cannot be configured as Courier always automatically lists all revisions fr
2323
* **Guid**: e0472596-e73b-11df-9492-0800200c9a66
2424
* **Full name**: `Umbraco.Courier.Providers.RepositoryProviders.CourierWebserviceRepositoryProvider`
2525

26-
The Courier webservice provider can connect any other website running Umbraco, with Courier installed as a repository. It is possible to transfer items back and forth using the HTTP protocol.
26+
The Courier webservice provider can connect any other website running Umbraco, with Courier installed as a repository. It is possible to transfer items back and forth using the HTTP protocol.
2727

2828
To install, add the following to your `courier.config` under `<repositories>`:
2929

3030
```xml
3131
<repository name="Live" alias="1" type="CourierWebserviceRepositoryProvider" visible="true">
32-
<url>http://cws.local</url>
33-
<user>0</user>
34-
<login>login</login>
35-
<password>pass</password>
36-
<passwordEncoding>Clear|Hashed</passwordEncoding>
32+
<url>http://cws.local</url>
33+
<user>0</user>
34+
<login>login</login>
35+
<password>pass</password>
36+
<passwordEncoding>Clear|Hashed</passwordEncoding>
3737
</repository>
3838
```
3939

Add-ons/UmbracoCourier/Configuration/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Courier keeps an ongoing cache of items to speed up transfers, this can be turne
1818

1919
```xml
2020
<cache>
21-
<enable>False</enable>
21+
<enable>False</enable>
2222
</cache>
2323
```
2424

@@ -51,7 +51,7 @@ The root folder containing all Courier's data. This folder needs changed, if Cou
5151

5252
```xml
5353
<paths>
54-
<root>~/path/to/courier</root>
54+
<root>~/path/to/courier</root>
5555
</paths>
5656
```
5757

@@ -60,7 +60,7 @@ Specifies the folder within the root folder, which holds each individual revisio
6060

6161
```xml
6262
<paths>
63-
<revisions>/folder</revisions>
63+
<revisions>/folder</revisions>
6464
</paths>
6565
```
6666

@@ -69,15 +69,15 @@ The SQL connection to the SQL database Courier should use. Notice this is not ne
6969

7070
```xml
7171
<paths>
72-
<masterPages>/folder</masterPages>
72+
<masterPages>/folder</masterPages>
7373
</paths>
7474
```
7575

7676
### Database connection
7777

7878
```xml
7979
<databaseConnectionString>
80-
DATABASE=yahahdasd;USER ID=etc
80+
DATABASE=yahahdasd;USER ID=etc
8181
</databaseConnectionString>
8282
```
8383

Add-ons/UmbracoCourier/DataIntegrity.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ versionRemoved: 8.0.0
44
---
55

66
# Courier data integrity fix
7-
We recently discovered a bug introduced in Courier `2.51.0`, which has now been fixed in `2.51.4` and all versions above `2.51.4`.
7+
We recently discovered a bug introduced in Courier `2.51.0`, which has now been fixed in `2.51.4` and all versions above `2.51.4`.
88
This bug affects people who use inherited document types or compositions on their document types.
99

1010
## Symptoms
11-
It is pretty easy to notice if you've been affected by this bug. The first time you transferred content using Courier it all went well and your content updated on the target environment.
11+
It is pretty easy to notice if you've been affected by this bug. The first time you transferred content using Courier it all went well and your content updated on the target environment.
1212
However, any updates you make on the source environment and then try to transfer seem to never arrive on the target environment.
1313

1414
## Problem explanation
@@ -21,17 +21,17 @@ As you can see the `propertyTypeId` is duplicated here. The next time you do a C
2121
![database updated](images/courierpropertydataupdated.png)
2222

2323
The problem here is that when the Umbraco backoffice reads the values for each property from the database it will take the last row and show it to you in the Umbraco interface. So in the backoffice, you'd still see "This is some text".
24-
24+
2525
## Solution
2626
The solution is to delete all of the duplicated rows that shouldn't be there, so for each property only the first row should be left behind.
2727

28-
First of all, you need to update [Courier to at least version 2.51.4](https://our.umbraco.com/projects/umbraco-pro/umbraco-courier-2/) on all of your environments. This will prevent the problem from re-occurring. We fixed how Courier transfers content the first time and this problem will not occur again after v2.51.4.
28+
First of all, you need to update [Courier to at least version 2.51.4](https://our.umbraco.com/projects/umbraco-pro/umbraco-courier-2/) on all of your environments. This will prevent the problem from re-occurring. We fixed how Courier transfers content the first time and this problem will not occur again after v2.51.4.
2929

3030
**Note:** At this point, you should **back up** your database in both environments (so the source and the target database).
3131

3232
In order to figure out if you are affected by this problem you can run the following (safe) select query on the source and on the target database:
3333

34-
`SELECT contentNodeId FROM cmsPropertyData GROUP BY contentNodeId, versionId, propertyTypeId HAVING COUNT(*) > 1`
34+
`SELECT contentNodeId FROM cmsPropertyData GROUP BY contentNodeId, versionId, propertyTypeId HAVING COUNT(*) > 1`
3535

3636
If this query gives you any result then you are affected by this problem and you need to run the query to fix this.
3737

@@ -45,11 +45,11 @@ WHERE id NOT IN (
4545
SELECT MIN(id)
4646
FROM cmsPropertyData
4747
GROUP BY contentNodeId, versionId, propertytypeid
48-
HAVING MIN(id) IS NOT NULL
48+
HAVING MIN(id) IS NOT NULL
4949
)
5050
```
5151

52-
This query will **delete** all of the extraneous rows in the `cmsPropertyData` table that shouldn't have been there in the first place but will leave that first row intact.
52+
This query will **delete** all of the extraneous rows in the `cmsPropertyData` table that shouldn't have been there in the first place but will leave that first row intact.
5353

5454
You can now transfer your content again and it should update on the destination like it should've done in the first place.
5555

@@ -60,4 +60,4 @@ Courier version 2.51.4 and higher will detect if your source or target environme
6060

6161
We opted not to automatically fix this for you because we want to make absolutely sure that we don't delete any data in an unrecoverable way. This is why we keep urging you to make sure to make backups before doing anything.
6262

63-
We'll await your feedback and based on that, we'll be able to include an automatic fix for this issue in a future version of Courier.
63+
We'll await your feedback and based on that, we'll be able to include an automatic fix for this issue in a future version of Courier.

Add-ons/UmbracoCourier/Developer/DataResolvers.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ versionRemoved: 8.0.0
88
Data resolvers are used by Courier to understand and transfer your data.
99

1010
## Intended audience
11-
Developers who understands .NET, C# and have a clear idea of how Umbraco works and what components in Umbraco do what.
11+
Developers who understands .NET, C# and have a clear idea of how Umbraco works and what components in Umbraco do what.
1212

1313
These concepts are targeted at developers who wish to add support for 3rd party components such as data types, or change or extend the way Courier handles current built-in components.
1414

1515
## What is a Data Resolver
1616

1717
In short, a data resolver is a .NET class, which inherits from a specific base class, which allows the developer to hook into different events during the data packaging and extraction.
1818

19-
Out of the box Courier can understand all standard data types in Umbraco. This means that Courier knows that a content picker contains an ID for a document, which then becomes a dependency, and the ID gets translated into a GUID which can safely be deployed to another location. It also knows that a template might contain references to JavaScript files or internal links, using the [locallink:] syntax. Or a lot of other cases where data have a special meaning.
19+
Out of the box Courier can understand all standard data types in Umbraco. This means that Courier knows that a content picker contains an ID for a document, which then becomes a dependency, and the ID gets translated into a GUID which can safely be deployed to another location. It also knows that a template might contain references to JavaScript files or internal links, using the [locallink:] syntax. Or a lot of other cases where data have a special meaning.
2020

2121
A data resolver adds special meaning to specific data that matches certain criteria. For instance properties using a specific data type, templates containing a certain keyword and so on.
2222

@@ -57,23 +57,23 @@ If you need to build your own data resolvers for Courier there are some great ex
5757
### DampResolver
5858
* **Full name:** `Umbraco.Courier.DataResolvers.DampResolver`
5959
* **Triggers on:** Propertydata, which have a DAMP pick as data type
60-
* If value is set, and is an `int`, Courier will convert the value to the media GUID and add the media item as a dependency
60+
* If value is set, and is an `int`, Courier will convert the value to the media GUID and add the media item as a dependency
6161
* On extraction the GUID will be converted back to the right ID.
6262

6363
### EmbeddedContent
6464
* **Full name:** `Umbraco.Courier.DataResolvers.EmbeddedContent`
65-
* **Triggers on:** Propertydata, which have a EmbeddedContent type as data type
65+
* **Triggers on:** Propertydata, which have a EmbeddedContent type as data type
6666
* Replaces node IDs in the embedded content with corresponding GUIDs and converts them back again on extraction
6767

6868
### Images
6969
* **Full name:** `Umbraco.Courier.DataResolvers.Images`
70-
* **Triggers on:** Propertydata, which contains an RTE
70+
* **Triggers on:** Propertydata, which contains an RTE
7171
* Finds linked images in the RTE HTML and sorts out IDs, paths and resources
7272

7373

7474
### KeyValuePrevalueEditor
7575
* **Full name:** `Umbraco.Courier.DataResolvers.KeyValuePrevalueEditor`
76-
* **Triggers on:** Propertydata, which contains a keyvalue editor like dropdownlist, radiobutton list or checkboxlist
76+
* **Triggers on:** Propertydata, which contains a keyvalue editor like dropdownlist, radiobutton list or checkboxlist
7777
* Resolves prevalues from IDs to actual value, and back again on extraction
7878

7979
**Configuration**
@@ -87,7 +87,7 @@ If you need to build your own data resolvers for Courier there are some great ex
8787

8888
### LocalLinks
8989
* **Full name:** `Umbraco.Courier.DataResolvers.LocalLinks`
90-
* **Triggers on:** Propertydata, which contains the string {locallink:
90+
* **Triggers on:** Propertydata, which contains the string {locallink:
9191
* Resolves the ID to a GUID, and adds the linked document as a dependency
9292

9393
**Configuration**

Add-ons/UmbracoCourier/Developer/PackagingAndExtraction.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ To understand how Courier works, and to use its API, you must know and understan
1111
- Extraction
1212
- Transferring
1313

14-
These 3 concepts are what enables Courier to perform deployments in a way that can decouple the Courier client from the sites/destinations it's deploying to/from.
14+
These 3 concepts are what enables Courier to perform deployments in a way that can decouple the Courier client from the sites/destinations it's deploying to/from.
1515

16-
The descriptions below are from an API point of view and provide examples on how to use each concept.
16+
The descriptions below are from an API point of view and provide examples on how to use each concept.
1717

1818
## Packaging
1919
Packaging collects data and files from a given target repository that supports packaging. Out of the box, any Courier enabled website supports this, however, you cannot perform a packaging on a network share or subversion repository.
2020

21-
When an item has been packaged its data is serialized to an xml file and stored at a given destination. For storage you can use the local storage on any repository the client is connected to.
21+
When an item has been packaged its data is serialized to an xml file and stored at a given destination. For storage you can use the local storage on any repository the client is connected to.
2222

2323
So to take packaging step by step:
2424

@@ -27,16 +27,16 @@ So to take packaging step by step:
2727
- During packaging, the client will find dependencies and resources and add these to its queue
2828
- When each item is packaged, it's saved as a xml file at a given destination.
2929

30-
To translate this into code, we need a couple of things defined:
30+
To translate this into code, we need a couple of things defined:
3131

3232
- The client runs on "Machine A"
33-
- The source repository is "devsite"
33+
- The source repository is "devsite"
3434
- The destination repository is "qasite"
3535

36-
So the code we are executing is not on either the devsite or qasite, but it could be. If no source or destination is set, Courier will try to use the local machine for storage.
36+
So the code we are executing is not on either the devsite or qasite, but it could be. If no source or destination is set, Courier will try to use the local machine for storage.
3737

3838

39-
### Configuration
39+
### Configuration
4040
For this configuration the following two repositories have been set up in the `courier.config` file:
4141

4242
```xml
@@ -72,7 +72,7 @@ using Umbraco.Courier.Core.Collections.Manifests;
7272
```
7373

7474
#### Connecting to destination and source
75-
Use `RepositoryStorage` to retrieve repositories from the `courier.config`
75+
Use `RepositoryStorage` to retrieve repositories from the `courier.config`
7676

7777
```csharp
7878
var rs = new RepositoryStorage();
@@ -86,12 +86,12 @@ To create a new Packaging operation you need to specify a name of the data you a
8686
```csharp
8787
var engine = new RevisionPackaging(Revision);
8888
engine.Source = source;
89-
engine.Destination = destination;
89+
engine.Destination = destination;
9090
```
9191

9292
#### Instant Comparison
9393
If you want to allow Courier to perform comparison checking against a destination, you can enable this. This means that Courier will do a hashed comparison of all items to determine if they are needed in the revision. This can save time, but it should only be used if you know the destination won't change before the extraction happens.
9494

9595
```csharp
9696
engine.EnableInstantCompare(destination);
97-
```
97+
```

Add-ons/UmbracoCourier/Developer/PersistenceProviders.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ versionRemoved: 8.0.0
66
# PersistenceProviders
77
Persistence providers are the underlying database connection Courier uses to retrieve and persist items. A persistence provider contains a collection of persisters which handles each unique type of object from Courier differently. It is a very large undertaking to write a complete PersistenceProvider, but it is possible to add individual item persisters to add database support for new item providers.
88

9-
A persistence provider handles the entire transaction from opening the connection, adding items to the transaction to committing. In case of errors it can also perform a rollback of the changes.
9+
A persistence provider handles the entire transaction from opening the connection, adding items to the transaction to committing. In case of errors it can also perform a rollback of the changes.
1010

1111
### NHibernate
1212
Provider build on NHibernate 3.x, using FluentNhibernate for mappings. This replicates the Umbraco datalayer, and bypasses all events handles in Umbraco as well. It also ensures that all transfers are handled as transactions in a safe manner to ensure data is not broken in case a single item fails.

Add-ons/UmbracoCourier/Developer/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ Courier includes a number of resource resolvers to modify deployed files as they
1818
A Persistence provider is the datalayer used by courier to store data in the database.
1919

2020
## [Included Repository Providers](../Configuration/RepositoryProviders.md)
21-
A Repository is an API Courier can use to transfer data between locations.
21+
A Repository is an API Courier can use to transfer data between locations.

Add-ons/UmbracoCourier/Installing/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The following guide will use two example sites; *development.site* and *live.sit
1414
* The **Umbraco Courier** package is usually one of the top packages - otherwise you can search for it
1515
* Follow the installation directions
1616
* Once Courier has been installed, make sure to **refresh the page**
17-
* Next step is to **add a location**
17+
* Next step is to **add a location**
1818
* In the gif below Courier is installed on development.site, and live.site is added as the location
1919
* The location you add, will be set in the `config/courier.config` file as a *repository*. Learn more about this in the [Repository Providers](../Configuration/RepositoryProviders.md) article.
2020

@@ -64,7 +64,7 @@ When you are testing Courier on two Umbraco sites locally, it’s recommended th
6464
* Add the **path to the project directory**
6565
* Finally, set the hostname - *example: development.site*
6666
* When you click ‘*OK*’ the website will start
67-
* In the navigation to the left, click **Browse _yourdomain_**
67+
* In the navigation to the left, click **Browse _yourdomain_**
6868

6969
![Setup Local hostnames](images/setupLocalIIShostnames.gif)
7070

0 commit comments

Comments
 (0)