Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Documentation Related to Translations #69

Merged
merged 11 commits into from
Dec 23, 2023
40 changes: 40 additions & 0 deletions _components/video-player-data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: "Video Player"
lang: en
inline_css: |
---

## Code

Embedding the video player:

```liquid
{%raw%}{% include video-player-data.html
video-id="video-introduction"
yt-id="20SHvU2PKsM"
%}{% endraw%}
```

### Parameters

`yt-id="20SHvU2PKsM"`
`yt-id-ad="1rBwxGMT9ZM"`
: YouTube ID of the video, `-ad` for the audio described version

`video-id="video-introduction"`
: Unique identifier of the video, as used in video-metadata.yml & VTT files basenames.

## Behaviour

- Based on video id, the video player component automatically uses all related VTT files.
- Captions/subtitles and descriptions in the language of the page are selected by default.
- The user can still select any other available language in the video player interface, to see the captions/subtitles/descriptions in another language.
- If the language of the page is supported by AblePlayer, the video player interface is displayed in that language.

## Example

{% include video-player-data.html
video-id="video-introduction"
yt-id="20SHvU2PKsM"
%}

14 changes: 4 additions & 10 deletions _components/video-player.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@
---
title: "Video Player"
title: "Video Player (deprecated version)"
lang: en
# translators: # Uncomment (remove #) for translations, one - name line per translator.
# - name: Translator 1
# - name: Translator 2
# contributors:
# - name: Contributor 1
# - name: Contributor 2
footer: > # Text in footer in HTML
<p> This is the text in the footer </p>
doc-note-type: deprecated
doc-note-message-md: The template is deprecated.
inline_css: |
---

Expand Down Expand Up @@ -60,4 +54,4 @@ It is possible to concatenate multiple sets of those subtitles using commas. See

{% include video-player.html
yt-id="20SHvU2PKsM"
%}
%}
6 changes: 6 additions & 0 deletions _data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
url: "/technical/integrating-resource/"
- name: Navigation
url: "/technical/navigation/"
- name: Translations
url: "/technical/translations/"
- name:
en: 'Create and Edit Documents'
pages:
Expand All @@ -32,6 +34,8 @@
url: "/writing/html/"
- name: Images
url: "/writing/images/"
- name: Videos
url: "/writing/videos/"
- name: Stand-alone Resources
url: "/writing/standalone-resources/"
- name:
Expand Down Expand Up @@ -131,6 +135,8 @@
- name: "Video Links"
url: "/components/video-links/"
- name: "Video Player"
url: "/components/video-player-data/"
- name: "Video Player (deprecated)"
url: "/components/video-player/"
- name: "Your Report"
url: "/components/your-report/"
1 change: 1 addition & 0 deletions _data/video-metadata.yml
Loading
Loading