Class: PhraseApp::RequestParams::StyleguideParams

Inherits:
OpenStruct
  • Object
show all
Defined in:
lib/phraseapp-ruby.rb

Overview

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.

Instance Method Summary collapse

Instance Method Details

#audience=(val) ⇒ Object 



744
745
746
 
# File 'lib/phraseapp-ruby.rb', line 744

def audience=(val)
  self.audience = val
end

#business=(val) ⇒ Object 



748
749
750
 
# File 'lib/phraseapp-ruby.rb', line 748

def business=(val)
  self.business = val
end

#company_branding=(val) ⇒ Object 



752
753
754
 
# File 'lib/phraseapp-ruby.rb', line 752

def company_branding=(val)
  self.company_branding = val
end

#formatting=(val) ⇒ Object 



756
757
758
 
# File 'lib/phraseapp-ruby.rb', line 756

def formatting=(val)
  self.formatting = val
end

#glossary_terms=(val) ⇒ Object 



760
761
762
 
# File 'lib/phraseapp-ruby.rb', line 760

def glossary_terms=(val)
  self.glossary_terms = val
end

#grammar_consistency=(val) ⇒ Object 



764
765
766
 
# File 'lib/phraseapp-ruby.rb', line 764

def grammar_consistency=(val)
  self.grammar_consistency = val
end

#grammatical_person=(val) ⇒ Object 



768
769
770
 
# File 'lib/phraseapp-ruby.rb', line 768

def grammatical_person=(val)
  self.grammatical_person = val
end

#literal_translation=(val) ⇒ Object 



772
773
774
 
# File 'lib/phraseapp-ruby.rb', line 772

def literal_translation=(val)
  self.literal_translation = val
end

#overall_tone=(val) ⇒ Object 



776
777
778
 
# File 'lib/phraseapp-ruby.rb', line 776

def overall_tone=(val)
  self.overall_tone = val
end

#samples=(val) ⇒ Object 



780
781
782
 
# File 'lib/phraseapp-ruby.rb', line 780

def samples=(val)
  self.samples = val
end

#target_audience=(val) ⇒ Object 



784
785
786
 
# File 'lib/phraseapp-ruby.rb', line 784

def target_audience=(val)
  self.target_audience = val
end

#title=(val) ⇒ Object 



788
789
790
 
# File 'lib/phraseapp-ruby.rb', line 788

def title=(val)
  self.title = val
end

#validate ⇒ Object 



796
797
798
799
800
 
# File 'lib/phraseapp-ruby.rb', line 796

def validate
  if self.title == nil || self.title == "" 
    raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"title\" of \"StyleguideParams\" not set")
  end
end

#vocabulary_type=(val) ⇒ Object 



792
793
794
 
# File 'lib/phraseapp-ruby.rb', line 792

def vocabulary_type=(val)
  self.vocabulary_type = val
end