Verbix API

Verb Conjugation Service

Custom verb conjugator that developers can use on their own site

Note!

This conjugator replaces the old Conjugator. Users of the old service should migrate their code to use this new service.

Usage

Add a reference to verbix.js: add this line of code in the HEAD section of your HTML.

<script src="https://verbix-api.nyc3.cdn.digitaloceanspaces.com/conjugator/v2.0.2.js"></script>

Add the following DIV in your HTML.

<div data-verbix-conjugate-language='<language>' data-verbix-conjugate-key='<apikey>'></div>

<language> //The language (scroll further down) to conjugate

```
<apikey> //Your personal api key
```

Add one or more DIVs that will contain the conjugated verb forms:
```
<div data-verbix-conjugate-tense='<tenseid>'></div>
```
- ```
<tenseid> //The id of the tense to show
```
If the DIV is not added, the conjugator will display the language-specific tenseids.

To see more features included in the library, see Advanced Features Showcased.

Examples

Basic Features Showcased

Example that shows how to conjugate a Spanish verb using Javascript function verbix.conjugate(). (See: http://verbconjugation.org/example_1.html )

<!doctype html>
<html lang="en">
<head>
  <script src="https://verbix-api.nyc3.cdn.digitaloceanspaces.com/conjugator/v2.0.2.js"></script>
  <style>
  .pronoun { color: green; }
  .irregular { color: red; }
  .orto { color: blue; }
  .arca { color: purple; }
  .obsolete { color: gray; }
  </style>  
</head>
<body>
  <div data-verbix-conjugate-language='spa' data-verbix-conjugate-key='<apikey>'>
    <input id="verb" type="text" placeholder="Enter verb" value="ser">
    <input type="button" value="Go" onclick="verbix.conjugate(document.getElementById('verb').value);"> 
  </div>
  <hr>
  <h3>Indicative Present</h3>
  <div data-verbix-conjugate-tense='0'></div>
</body>
</html>

Example that shows the Spanish verb 'tener' conjugated. (See: http://verbconjugation.org/example_2.html )

<!doctype html>
<html lang="en">
<head>
  <script src="https://verbix-api.nyc3.cdn.digitaloceanspaces.com/conjugator/v2.0.2.js"></script>
</head>
<body>
  <div data-verbix-conjugate-language='spa' data-verbix-conjugate-key='<apikey>' data-verbix-conjugate-verb='tener'></div>
  <h3>Indicative Present</h3>
  <div data-verbix-conjugate-tense='0'></div>
</body>
</html>

Another example that shows how to display the Spanish verb 'tener' conjugated. The URL should have the parameter "verbixverb=tener" (See: http://verbconjugation.org/example_2b.html?verbixverb=tener )

<!doctype html>
<html lang="en">
<head>
  <script src="https://verbix-api.nyc3.cdn.digitaloceanspaces.com/conjugator/v2.0.2.js"></script>
</head>
<body>
  <div data-verbix-conjugate-language='spa' data-verbix-conjugate-key='<apikey>'></div>
  <h3>Indicative Present</h3>
  <div data-verbix-conjugate-tense='0'></div>
</body>
</html>

Advanced Features Showcased

Advanced example that shows more features that control the content in case the verb can conjugated or can't conjugate. (See: http://verbconjugation.org/example_3.html?verbixverb=tener )

001: <!doctype html>
002: <html lang="en">
003: <head>
004:   <script src="https://verbix-api.nyc3.cdn.digitaloceanspaces.com/conjugator/v2.0.2.js"></script>
005:   <style>
006:   .pronoun { color: green; }
007:   .irregular { color: red; }
008:   .orto { color: blue; }
009:   .arca { color: purple; }
010:   .obsolete { color: gray; }
011:   </style>  
012: </head>
013: <body>
014:   <div 
015:     data-verbix-conjugate-language='fra' 
016:     data-verbix-conjugate-key='ab8e7bb5-9ac6-11e7-ab6a-00089be4dcbc'
017:     data-verbix-conjugate-noresultfortensetext='No result for this tense'  
018:   >
019:     <input id="verb" type="text" placeholder="Enter verb" value="être">
020:     <input type="button" value="Go" onclick="verbix.conjugate(document.getElementById('verb').value);"> 
021:   </div>
022: 	<span onclick="verbix.conjugate('être');">être</span> |
023: 	<span onclick="verbix.conjugate('gésir');">gésir</span> |
024: 	<span onclick="verbix.conjugate('foo');">foo</span>
025:   <hr>
026:   <div data-verbix-conjugate-noverb-display='none' data-verbix-conjugate-verb-display='block'>
027:     <h3>Indicative Present</h3>
028:     <div data-verbix-conjugate-tense='0'></div>
029:     <div data-verbix-conjugate-tense='1' data-verbix-conjugate-noresultfortensetext='Not conjugated in subjunctive present'>
030:       <h3>Subjunctive Present</h3>
031:       <div data-verbix-tense-placeholder='1'></div>
032:    </div>
033:   </div>
034:   <div style="display: none;" data-verbix-conjugate-noverb-display='block' data-verbix-conjugate-verb-display='none'>
035:     This is not a verb!
036:   </div>
037: </body>
038: </html>

Lines 006-010 define color codes for pronouns and verbs
Lines 014-018 define basic functionality as follows:
- Line 015 defines French as the language
- Line 016 is the compulsory key that is needed to consume the service
- Line 017 Defines the text that is shown for a specific tense, if there are no conjugations for the specific tense. This value can be overridden inside a data-verbix-conjugate-tense block.
Line 020 shows how to call the Verbix conjugation library to conjugate the verb and populate the tenses.
Lines 022-024 show an alternative way to conjugate verbs.
Line 026 shows how to alter the CSS display attribute depending on, whether the verb can be conjugated or not:
- data-verbix-conjugate-noverb-display='none' tells that the display CSS attribute should be 'none', if the verb can't be conjugated
- data-verbix-conjugate-verb-display='block' tells that the display CSS attribute should be 'block', if the verb is conjugated
Line 028 Tells to replace the DIV's content with the Indicative Present tense
Line 029 Tells to replace the DIV's content with the Subjunctive Present tense. The replacing happens inside data-verbix-tense-placeholder block on line 031. The data-verbix-conjugate-noresultfortensetext attribute overrides the earlier defined value on line 017.
Line 031 is the placeholder DIV for the tense defined on line 029.

Language codes

The language parameter is a lower case 3-letter ISO language code. Supported languages are shown below: