Skip to content

StyleguideCreateParameters.md

Latest commit

 

History

History
41 lines (34 loc) · 2.47 KB

StyleguideCreateParameters.md

File metadata and controls

41 lines (34 loc) · 2.47 KB
Raw

Phrase::StyleguideCreateParameters

Properties

Name Type Description Notes
title String Style guide title
audience String Audience description [optional]
target_audience String Target audience for the translations. [optional]
grammatical_person String Preferred grammatical person. [optional]
vocabulary_type String Vocabulary register the translations should use. [optional]
business String Description of the business [optional]
company_branding String Company branding to remain consistent. [optional]
formatting String Formatting requirements and character limitations. [optional]
glossary_terms String List of terms and/or phrases that need to be translated consistently. [optional]
grammar_consistency String Formal or informal pronouns, consistent conjugation, grammatical gender [optional]
literal_translation String Can be one of: Cultural/Conversational, Literal, Neutral. [optional]
overall_tone String Tone requirement descriptions [optional]
samples String Provide links to sample product pages, FAQ pages, etc. to give the translator a point of reference. You can also provide past translations. Even snippets or short paragraphs are helpful for maintaining consistency. [optional]

Code Sample

require 'phrase'

instance = Phrase::StyleguideCreateParameters.new(title: 'Web application style guide',
                                 audience: 'customer-facing',
                                 target_audience: 'teenager',
                                 grammatical_person: 'first_person_singular',
                                 vocabulary_type: 'technical',
                                 business: 'We are a travel site that helps customers find the best hotels and flights.',
                                 company_branding: 'ACME Inc. should never be translated.',
                                 formatting: 'Never use capital letters',
                                 glossary_terms: 'Apartment, cabin, loft',
                                 grammar_consistency: '',
                                 literal_translation: 'Neutral',
                                 overall_tone: 'Tone should be fun and light',
                                 samples: 'http://www.myexample.com/my/document/path/to/samples.pdf')