User Tools

Site Tools


en:styleguide
no way to compare when less than two revisions

Differences

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


Previous revision
Next revision
en:styleguide [2016/12/29 11:28] – fixed broken stuff hantilles
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 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:
 +
 +  
 +=== 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!
 +
 +== example: ==
 +<file plain>
 +Constanze Kurz: welcome!
 +*applause*
 +Kurz: nice to have you here!
 +Frank Rieger: also a warm welcome from me, too!
 +Rieger: …
 +</file>
 +
 +== example: (only first/nick names are known) ==
 +<file plain>
 +Laura: Hi Alice! Hi Bob!
 +B: Hi Laura, how're you?
 +A: Hi!
 +L: I'm fine, thanks!
 +</file>
 +
 +=== No parenthesis around names! ===
 +
 +=== dialog between only two people can be further simplified ===
 +
 +== example: ==
 +<file plain>
 +- Hey, everything's fine?
 +- yes, how about you?
 +- all done and dusted
 +- then we'll see each other tomorrow!
 +</file>
 +
 +=== cuttings are allowed, but should be avoided ===
 +
 +"Ehm"s, stumbling or words that were said twice can be omitted, but not if they're important (e.g. for a joke)
 +
 +=== Subtitles are in direct speech, but no quotation marks, except there's really a quote ===
 +
 +=== numbers should be written in digits, because that's shorter. If readability is affected, you can write numbers in words (mostly only with numbers from one to twelve) ===
 +
 +=== Sounds are marked with "*". ===
 +
 +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: ==
 +<file plain>
 +*applause*
 +*laughing*
 +*loud laughing*
 +*boo*
 +*disquietness*
 +*phone ringing*
 +</file>
 +
 +=== explicit linebreaks in amara can be created with [Shift]+[Return] ===
 +
 +== example: ==
 +<file plain>
 +Well, yes, thank you very much for your talk (linebreak)
 +*standing ovation*
 +</file>
 +
 +=== Q&A ===
 +
 +in the Q&A part you can do it like that. Name at first appearence the Angel with "Angel:" or "XY Angel" if you want to specify the type of angel, questions with "Question:", answers as "Answer:". Later abbreviate to eather only the type of angel, e.g. "Audio:", "Signal:", "Herald:" or "Angel:" and abbreviate question and answer to "Q:" and "A:" for shortness.
 +
 +== example: ==
 +<file plain>
 +Herald Angel: We welcome to this talk 
 +Linus Torvalds, Richard Stallman,
 +
 +*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.
en/styleguide.txt · Last modified: 2021/01/05 21:17 by percidae

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki