Skip to content

Commit 11b6b11

Browse files
updating contributing file to describe caption process with positioning, and style guide
1 parent cda5067 commit 11b6b11

1 file changed

Lines changed: 70 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 70 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,77 @@ Here is [an example](https://github.com/InnerSourceCommons/InnerSourceLearningPa
2828
* Here is the [status of translation efforts](https://github.com/InnerSourceCommons/InnerSourceLearningPath/wiki/Translations).
2929
* Other mechanics of working on translations follow the guidelines below that apply to any file in the `InnerSourceLearningPath`.
3030

31-
# Subtitles
31+
# Video Subtitles
32+
33+
All videos may have subtitles in any language. See [this video](https://drive.google.com/file/d/1IaAH8Zmp2ggBtelexhaZUqia5yS8mUjE/view?usp=sharing) for a short intro on how to access them.
34+
35+
## Adding Subtitles For the First Time
36+
37+
YouTube will automatically generate subtitles to most videos in English.
38+
It is easiest to use that as a starting point to then manually clean up timings and correct misspellings.
39+
1. In Creator Studio, select DUPLICATE AND EDIT on the automatic subtitles.
40+
2. When you are satisfied with your changes in the subtitle editor, choose PUBLISH.
41+
42+
## Changing Existing Subtitles
43+
44+
Be aware that, at this time, Creator Studio does not support subtitle positioning natively.
45+
The subtitle editor only addresses content and timings.
46+
If your video needs positioning changes, the tags must be added or adjusted manually.
47+
48+
Subtitle positioning will NOT be reflected in the video in the editor.
49+
All subtitles will appear at the bottom of the viewport while using the editor.
50+
It is also NOT currently possible to download a VTT file of a DRAFT subtitle set.
51+
Finally, making changes in the editor and publishing them will erase all pre-existing positioning tags.
52+
53+
Therefore, the overall process for editing subtitles with positioning goes like this:
54+
1. In Creator Studio, download a copy of the current VTT file (or look in source control for it).
55+
This gives you a back up of the existing set in case you want to completely revert your changes.
56+
2. Make your content and timing changes using the subtitle editor and PUBLISH them.
57+
_This erases pre-existing positioning tags._
58+
3. Download a copy of the new VTT file.
59+
4. Using your favorite text editor, add positioning tags and save the file.
60+
5. Go back to the subtitle editor, upload the new VTT file with positioning tags, and PUBLISH it to close the editor.
61+
6. Add the updated VTT file with positioning tags to source control.
62+
63+
If your video does not require positioning adjustments, you only need to do step #2.
64+
65+
## Subtitle Style Guide
66+
67+
* Keep subtitle height to a single line. **Never display more than two lines in height**, to prevent content blocking.
68+
* Keep subtitle width to the central 60% of the viewport. **Do not to let them extend to the full width of the viewport.**
69+
Drawing eyeballs to the extreme edges of the screen distracts from the content.
70+
* **Subtitles should be centered horizontally and shown at the bottom of the viewport**, unless this would obscure important visual information.
71+
In these cases, use positioning tags to put the subtitle at the top of the viewport.
72+
Revert to the bottom position when the scene allows.
73+
No matter where the subtitle ends up being placed, try to avoid obscuring the mouths of speakers in shot.
74+
* Try to display subtitles for at least 1.5 seconds before changing or disappearing them, to aid reading comprehension.
75+
This isn't always possible, however,
76+
**never display a subtitle for less than one second**.
77+
* **Subtitles should be timed to the speaker's voice.**
78+
They should appear when the speaker starts, and disappear when the speaker is finished and before a camera change, unless that causes the subtitle to be on screen for less than one second.
79+
* **Display words as spoken**, not as you think the speaker intended to say them.
80+
Do not censor or simplify the dialogue.
81+
Strive for accuracy.
82+
There are two exceptions:
83+
- Omit stuttering
84+
- Omit filler words like ("um")
85+
- _This runs counter to most captioning guidelines.
86+
However, we have had complaints in the past for subtitling these.
87+
Given these exceptions, don't automatically omit words like "but" or "so".
88+
These are filler words, but they are often essential for expressing meaning.
89+
Similarly, conversational phrases like "you know", and "right" often add flavour and should be included when time allows._
90+
* It is only necessary to identify a speaker when it is not obvious to the viewer.
91+
This is rare, even in cases where there are two speakers in a scene, since they speak one-at-a-time.
92+
But, it can happen, for example, when a diagram is being displayed and there are multiple speakers off screen.
93+
**If we do need identification, use a label in all caps.**
94+
Here are some examples:
95+
- _(single speaker)_ DANESE: This diagram will help us understand how InnerSource works.
96+
- _(two speakers)_ BOTH: Hope to see you there!
97+
- _(three or more)_ ALL: Fa la la la la!
98+
99+
100+
32101

33-
* All videos may have subtitles in any language.
34-
* See [this video](https://drive.google.com/file/d/1IaAH8Zmp2ggBtelexhaZUqia5yS8mUjE/view?usp=sharing) for how to add them.
35102

36103
# Files
37104

0 commit comments

Comments
 (0)