Skip to content

Conversation

Lili-Rossiter
Copy link
Contributor

πŸ“‹ Description

  • Wording updated
  • Links addded
  • 'Registering Document Type localization Files' section added
  • Small errors fixed

πŸ“Ž Related Issues (if applicable)

#7342

βœ… Contributor Checklist

I've followed the Umbraco Documentation Style Guide and can confirm that:

  • Code blocks are correctly formatted.
  • Sentences are short and clear (preferably under 25 words).
  • Passive voice and first-person language (β€œwe”, β€œI”) are avoided.
  • Relevant pages are linked.
  • All links work and point to the correct resources.
  • Screenshots or diagrams are included if useful.
  • Any code examples or instructions have been tested.
  • Typos, broken links, and broken images are fixed.

Product & Version (if relevant)

V16

Deadline (if relevant)

NA

πŸ“š Helpful Resources

Copy link
Contributor

@mikecp mikecp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @Lili-Rossiter !

I have read through the document and left a few suggestions/questions to maybe make a few points a little clearer. but it's basically great already😁


* Create the localizations in [user defined backoffice localization file](../../../customizing/foundation/localization.md).
Setting up localization for Document Types is a three-step process:
* Register the Document Type localization Files via [a new manifest 'umbraco-package.json' file](../../../customizing/extending-overview/extension-types/localization.md#registering-localization).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would write the word Files without capital letters.

{% endhint %}

The Umbraco backoffice is localized to match the [user's configured language](../users/README.md).
The Umbraco backoffice is localized to match the [user's configured UI Culture](../../../tutorials/multilanguage-setup#changing-the-default-backoffice-language-of-a-user).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Strangely enough, the link is displayed as an external link and gives a 404 when you click on it, while the one below on line 17 is OK. The only difference I could spot is the missing .md extension at the end of the main file name, could that be it?

Cf. screenshot: the url links to githuib instead of umbraco docs

image

The Umbraco backoffice is localized to match the [user's configured language](../users/README.md).
The Umbraco backoffice is localized to match the [user's configured UI Culture](../../../tutorials/multilanguage-setup#changing-the-default-backoffice-language-of-a-user).

When defining a Document Type, you can apply localization to:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a global suggestion for the last 3 bullet points below: we have a strange mix of singular and plural IMHO. I would either leave the element singular and then what follows also singular, either all plural.

So for example, for the second bullet:
Property name and description or Properties names and descriptions

I hope this makes sense ? πŸ˜…

{% endhint %}

{% code title="umbraco-package.json" %}
```json
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is not very clear to me if there are parts in the manifest where I have to use the actual alias of the associated document type, or if I need to use specifically the generic term DocumentType.

For example, if I am localizing my custom document type named MikeDocumentType, what do I have to specifiy as alias: DocumentType.Localize.En as written currently, or MikeDocumentType.Localize.En ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I just opened the linked docs mentioned above πŸ˜… and it seems to be indeed the actual document type name that needs to be used. I would suggest to then maybe reflect it in the sample for more direct clarity?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mikecp Localization works with keys like in the 'old' backoffice. There is no connection to your content type and the registration of the language file. The alias needs to be unique, that's it.

* Add a new **group** called `#groups_titles`.
* Add a **property** called `#properties_title` with **alias** `title`.
* Set description to `{#properties_title-desc}`.
* Set the description to `{#properties_title-desc}`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just making sure that it is normal that it's the only place where we use {} around the #area_key part.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mikecp it is. The descriptions support Umbraco Flavoured markdown, so that's why the { } are needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants