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 



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

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

#business=(val) ⇒ Object 



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

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

#company_branding=(val) ⇒ Object 



795
796
797
 
# File 'lib/phraseapp-ruby.rb', line 795

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

#formatting=(val) ⇒ Object 



799
800
801
 
# File 'lib/phraseapp-ruby.rb', line 799

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

#glossary_terms=(val) ⇒ Object 



803
804
805
 
# File 'lib/phraseapp-ruby.rb', line 803

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

#grammar_consistency=(val) ⇒ Object 



807
808
809
 
# File 'lib/phraseapp-ruby.rb', line 807

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

#grammatical_person=(val) ⇒ Object 



811
812
813
 
# File 'lib/phraseapp-ruby.rb', line 811

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

#literal_translation=(val) ⇒ Object 



815
816
817
 
# File 'lib/phraseapp-ruby.rb', line 815

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

#overall_tone=(val) ⇒ Object 



819
820
821
 
# File 'lib/phraseapp-ruby.rb', line 819

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

#samples=(val) ⇒ Object 



823
824
825
 
# File 'lib/phraseapp-ruby.rb', line 823

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

#target_audience=(val) ⇒ Object 



827
828
829
 
# File 'lib/phraseapp-ruby.rb', line 827

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

#title=(val) ⇒ Object 



831
832
833
 
# File 'lib/phraseapp-ruby.rb', line 831

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

#to_h ⇒ Object 



845
846
847
 
# File 'lib/phraseapp-ruby.rb', line 845

def to_h
  @table.dup
end

#validate ⇒ Object 



839
840
841
842
843
 
# File 'lib/phraseapp-ruby.rb', line 839

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 



835
836
837
 
# File 'lib/phraseapp-ruby.rb', line 835

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