URLs

The URL component lets you reference an external link by key instead of hardcoding it. Each key maps to a URL per language, so a visitor always lands on the language-appropriate version of the destination, and a link that moves or breaks only needs fixing in one place, no matter how many docs reference it.

Managing URLs

You can edit the URLs collection in the CMS.

1. Click the Add icon ( + ) to add a new Key.
2. Under URL (per language), click the Add icon to add a Translation for each language the link should support. Give it a Language Code and the destination URL.
3. Under Default Link Text (per language), add a Translation for each language, giving the text a <Url> usage should show when it doesn't supply its own.

Using URLs

1. Select URL Link from the Embed list.
2. Enter the URL Key matching an entry in the URLs collection.
3. Optionally, add Link Text translations to override the key's default text for this specific usage — the same key can be used in different places with different wording.

リンクテキストは機械翻訳されていません

通常の文章とは異なり、<Url> の「リンクテキスト」は自動翻訳の対象にはなりません。ドキュメントが翻訳される際、このコンポーネント全体は、どの言語においても記述されたままの状態で完全に保持されます。リンクテキストを追加する場合は、そのリンクを最初に追加したドキュメント内で、サポートされているすべての言語について同時に記入してください。 その時点で省略された言語は、誰かがソースを編集して手動で追加するまで、欠落したままとなります。

特定の使用例で独自の文言が必要ない場合は、リンクテキストを空欄のままにしておくと、代わりにキーの「デフォルトのリンクテキスト」が使用されます。このテキストは、URLコレクション内で通常の方法で一度だけ翻訳されます。

Example

URL NOT FOUND

Checking link health

The URLs collection also hosts the Link Health dashboard, which reports on both the URLs stored here and any external links still hardcoded directly in your docs — including which of those aren't in the URLs collection yet, so you can find and centralize them. See Dashboards for details.