class PhraseApp::RequestParams::StyleguideParams

StyleguideParams

Parameters:

audience

Audience description

business

Description of the business

company_branding

Company branding to remain consistent.

formatting

Formatting requirements and character limitations.

glossary_terms

List of terms and/or phrases that need to be translated consistently.

grammar_consistency

Formal or informal pronouns, consistent conjugation, grammatical gender

grammatical_person

Can be one of: not_specified, first_person_singular, second_person_singular, third_person_singular_masculine, third_person_singular_feminine, third_person_singular_neuter, first_person_plural, second_person_plural, third_person_plural.

literal_translation

Can be one of: Cultural/Conversational, Literal, Neutral.

overall_tone

Tone requirement descriptions

samples

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.

target_audience

Can be one of: not_specified, children, teenager, young_adults, adults, old_adults.

title

Style guide title

vocabulary_type

Can be one of: not_specified, popular, technical, fictional.

Public Instance Methods

audience=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1446
def audience=(val)
  super(val)
end
business=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1450
def business=(val)
  super(val)
end
company_branding=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1454
def company_branding=(val)
  super(val)
end
formatting=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1458
def formatting=(val)
  super(val)
end
glossary_terms=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1462
def glossary_terms=(val)
  super(val)
end
grammar_consistency=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1466
def grammar_consistency=(val)
  super(val)
end
grammatical_person=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1470
def grammatical_person=(val)
  super(val)
end
literal_translation=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1474
def literal_translation=(val)
  super(val)
end
overall_tone=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1478
def overall_tone=(val)
  super(val)
end
samples=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1482
def samples=(val)
  super(val)
end
target_audience=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1486
def target_audience=(val)
  super(val)
end
title=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1490
def title=(val)
  super(val)
end
validate() click to toggle source
# File lib/phraseapp-ruby.rb, line 1498
def validate
  
  if title == nil || title == "" 
    raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"title\" of \"StyleguideParams\" not set")
  end
end
vocabulary_type=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1494
def vocabulary_type=(val)
  super(val)
end