Differences

This shows you the differences between two versions of the page.

--- en:styleguide [2016/01/06 03:56] – hantilles
+++ en:styleguide [2021/01/05 21:17] (current) – [Keep lines short] percidae
@@ Line 1: / Line 1: @@
+====== Style guide ======
 **In short:** \\
 **Control chars** – ()[]\*\* –: fewer are better \\
 **Content:** if applicable word for word \\
-These guidelines are the result of a lot of discussion including sing language interpreter also doing subtitles and a deaf person using subtitles. Also I used this (german): https://www.ndr.de/fernsehen/service/untertitel/Untertitel-Standards,untertitelstandards102.html
+These guidelines are the result of long discussions that included a sign language interpreter who also does subtitles and also a deaf person using subtitles. Also, I used this (german): https://www.ndr.de/fernsehen/service/untertitel/Untertitel-Standards,untertitelstandards102.html
 The following was our common result:
@@ Line 10: / Line 13: @@
 === In dialogs the person speaking has to be indicated ===
-Full names are only useful when first using them. After that please use a form of abbreviation. If you use first names or family names is up to you (different might be appropriate from talk to talk), but the prinpipal is always: the shorter the better!
+Full names are only useful when first using them. After that please use a form of abbreviation. If you use first names or family names is up to you (different might be appropriate from talk to talk), but the principle is always: the shorter the better!
 == example: ==
-> Constanze Kurz: welcome! \\
+<file plain>
-> *applause* \\
+Constanze Kurz: Welcome!
-> Kurz: nice to have you here! \\
+*applause*
-> Frank Rieger: also a warm welcome from me, too! \\
+Kurz: Nice to have you here!
-> Rieger: … \\
+Frank Rieger: Also a warm welcome from me!
+Rieger: …
+</file>
 == example: (only first/nick names are known) ==
-> Laura: Hi Alice! Hi Bob! \\
+<file plain>
-> B: Hi Laura, how're you? \\
+Laura: Hi Alice! Hi Bob!
-> A: Hi! \\
+B: Hi Laura, how're you?
-> L: I'm fine, thanks! \\
+A: Hi!
+L: I'm fine, thanks!
+</file>
 === No parenthesis around names! ===
@@ Line 30: / Line 37: @@
 == example: ==
-> - Hey, everything's fine? \\
+<file plain>
-> - yes, how about you? \\
+- Hey, everything's fine?
-> - all done and dusted \\
+- yes, how about you?
-> - then we'll see each other tomorrow!
+- all done and dusted
+- then we'll see each other tomorrow!
+</file>
 === cuttings are allowed, but should be avoided ===
@@ Line 44: / Line 53: @@
 === Sounds are marked with "*". ===
+This **excludes** things that are visible in the video (e.g. *Points to slides*)
 Unfortunately there is a bug in amara which uses the * for italic. Just ignore it we will fix that with a script in the textfiles.
 == Examples: ==
-> *applause* \\
+<file plain>
-> &#42;laughing&#42; \\
+*applause*
-> *loud laughing* \\
+*laughing*
-> *boo* \\
+*loud laughing*
-> *disquietness* \\
+*boo*
-> *phone ringing* \\
+*disquietness*
+*phone ringing*
+</file>
 === explicit linebreaks in amara can be created with [Shift]+[Return] ===
 == example: ==
-> Well, yes, thank you very much for your talk (linebreak)
+<file plain>
-> *standing ovation*
+Well, yes, thank you very much for your talk (linebreak)
+*standing ovation*
+</file>
+=== Keep lines short ===
+<WRAP center round important 60%>
+New! Additional Infos Jan 2019
+</WRAP>
+In general subtitles can be easily read, if a line is not more than around 42 chars.
+Since we use and format the transcripts from the etherpads you don't have to take care of linebreaks. Please insert as few linebreaks as possible. Please only insert linebreaks for speaker changes or sounds and when the etherpad forces you to.
+In short: Fewer linebreaks is better.
+If you are working on a subtitle in amara during the quality control phase, please do not change the double lines with a maximum line length of 42 characters. The subtitles are formatted as a continous text intentionally. This creates text blocks which are visible for a as long as possible period of time. This improves the readability of the subtitles, especially for fast tech talks.
+=== Intro and outro ===
+The video intro for the talks as well as the credits can also be experienced acustically. As we'd like to have all subtitles have a minimum of corporate identity, we suggest you use for these:
+<file plain>
+*33C3 preroll music*
+*postroll music*
+</file>
+for German respectively:
+<file plain>
+*33C3 Vorspannmusik*
+*Abspannmusik*
+</file>
 === Q&A ===
@@ Line 66: / Line 111: @@
 == example: ==
-> Herald Angel: We welcome to this talk Linus Torvalds, Richard Stallman,  \\
+<file plain>
-> *raging applause* \\
+Herald Angel: We welcome to this talk
-> Herald: … Bill Gates and Steve Jobs. \\
+Linus Torvalds, Richard Stallman,
-> *cautios applause* \\
-> Herald: And now have fun with the talk: "How does good software look like?" \\
-> Torvalds: Good evening \\
-> *applause* \\
-> Stallmann: Evening \\
-> *applause* \\
-> Gates: Good evening \\
-> *applause* \\
-> Jobs: Evening \\
-> *applause* \\
-> Stallman: Software must be free. That's the highest principle! \\
-> Gates: And how does the programmer make a living of it? Air and love? \\
-> Torvalds: My software is used on a huge bunch of devices and programmers are paid to develop that software, when it should be used on new devices. \\
-> Jobs: And what about the UI design? Only if it looks good software is also used! \\
-> Stallman: I want to use the CLI! \\
-> Gates: To send users back to the hell of text, after they got to know graphical user interfaces … \\
-> Jobs: … which YOU stole from US! There's still a court decision pending! \\
-> Stallman: Good concepts are always copied and further developed, just like with the code. \\
-> Torvalds: That reminds me of a specific line of code that was actually copied from Linux to Windows: "if OPEN BRACKET …
-=== If you have a talk which is totally mixed in two or more languages, then use the language "Klingon" in amara (seriously) ===
+*raging applause*
+Herald: … Bill Gates and Steve Jobs.
+*cautios applause*
+Herald: And now have fun with the talk:
+"How does good software look like?"
+Torvalds: Good evening
+*applause*
+Stallmann: Evening
+*applause*
+Gates: Good evening
+*applause*
+Jobs: Evening
+*applause*
+Stallman: Software must be free.
+That's the highest principle!
+Gates: And how does the programmer
+make a living of it? Air and love?
+Torvalds: My software is used on a
+huge bunch of devices and programmers
+are paid to develop that software,
+when it should be used on new devices.
+Jobs: And what about the UI design?
+Only if it looks good software is also used!
+Stallman: I want to use the CLI!
+Gates: To send users back to the
+hell of text, after they got to know
+graphical user interfaces …
+Jobs: … which YOU stole from US!
+There's still a court decision pending!
+Stallman: Good concepts are
+always copied and further developed,
+just like with the code.
+Torvalds: That reminds me of a specific
+line of code that was actually copied
+from Linux to Windows: "if OPEN BRACKET …
+</file>
+=== If you have a talk which is totally mixed in two or more languages, then use the language "Klingon" in amara (seriously). ===
 Afterwards there can be a whole translation to english and german and whatever.