Class: PhraseApp::RequestParams::StyleguideParams
- Inherits:
-
OpenStruct
- Object
- OpenStruct
- PhraseApp::RequestParams::StyleguideParams
- 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
- #audience=(val) ⇒ Object
- #business=(val) ⇒ Object
- #company_branding=(val) ⇒ Object
- #formatting=(val) ⇒ Object
- #glossary_terms=(val) ⇒ Object
- #grammar_consistency=(val) ⇒ Object
- #grammatical_person=(val) ⇒ Object
- #literal_translation=(val) ⇒ Object
- #overall_tone=(val) ⇒ Object
- #samples=(val) ⇒ Object
- #target_audience=(val) ⇒ Object
- #title=(val) ⇒ Object
- #validate ⇒ Object
- #vocabulary_type=(val) ⇒ Object
Instance Method Details
#audience=(val) ⇒ Object
1446 1447 1448 |
# File 'lib/phraseapp-ruby.rb', line 1446 def audience=(val) super(val) end |
#business=(val) ⇒ Object
1450 1451 1452 |
# File 'lib/phraseapp-ruby.rb', line 1450 def business=(val) super(val) end |
#company_branding=(val) ⇒ Object
1454 1455 1456 |
# File 'lib/phraseapp-ruby.rb', line 1454 def company_branding=(val) super(val) end |
#formatting=(val) ⇒ Object
1458 1459 1460 |
# File 'lib/phraseapp-ruby.rb', line 1458 def formatting=(val) super(val) end |
#glossary_terms=(val) ⇒ Object
1462 1463 1464 |
# File 'lib/phraseapp-ruby.rb', line 1462 def glossary_terms=(val) super(val) end |
#grammar_consistency=(val) ⇒ Object
1466 1467 1468 |
# File 'lib/phraseapp-ruby.rb', line 1466 def grammar_consistency=(val) super(val) end |
#grammatical_person=(val) ⇒ Object
1470 1471 1472 |
# File 'lib/phraseapp-ruby.rb', line 1470 def grammatical_person=(val) super(val) end |
#literal_translation=(val) ⇒ Object
1474 1475 1476 |
# File 'lib/phraseapp-ruby.rb', line 1474 def literal_translation=(val) super(val) end |
#overall_tone=(val) ⇒ Object
1478 1479 1480 |
# File 'lib/phraseapp-ruby.rb', line 1478 def overall_tone=(val) super(val) end |
#samples=(val) ⇒ Object
1482 1483 1484 |
# File 'lib/phraseapp-ruby.rb', line 1482 def samples=(val) super(val) end |
#target_audience=(val) ⇒ Object
1486 1487 1488 |
# File 'lib/phraseapp-ruby.rb', line 1486 def target_audience=(val) super(val) end |
#title=(val) ⇒ Object
1490 1491 1492 |
# File 'lib/phraseapp-ruby.rb', line 1490 def title=(val) super(val) end |
#validate ⇒ Object
1498 1499 1500 1501 1502 1503 |
# 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) ⇒ Object
1494 1495 1496 |
# File 'lib/phraseapp-ruby.rb', line 1494 def vocabulary_type=(val) super(val) end |