Skip to content
This repository

Client and parser of documents pulled from the wiktionary api

branch: master
README.pod

Name

Wiktionary::Parser - Client and Parser of content from the Wiktionary API

Synopsis

This package may be used to query the Wiktionary API (en.wiktionary.org/w/api.php) for documents by title. It parses the resulting MediaWiki document and provides access to data structures containing word senses, translations, synonyms, parts of speech, etc. It also provides access to the raw content of each MediaWiki section should you wish to extract other data on your own, or build on top of this package.

The repository for this package is available on github at https://github.com/clbecker/perl-wiktionary-parser And on CPAN at: http://search.cpan.org/~clbecker/Wiktionary-Parser/

Usage

        my $parser = Wiktionary::Parser->new();
        
        my $document = $parser->get_document(title => 'bunny');
        
        my $translation_hashref     = $document->get_translations();
        my $word_sense_hashref      = $document->get_word_senses();
        my $parts_of_speech_hashref = $document->get_parts_of_speech();
        my $pronunciations_hashref  = $document->get_pronunciations();
        my $synonyms_hashref        = $document->get_synonyms();
        my $hyponyms_hashref        = $document->get_hyponyms();
        my $hypernyms_hashref       = $document->get_hypernyms();
        my $antonyms_hashref        = $document->get_antonyms();
        my $derived_terms_hashref   = $document->get_derived_terms();

        my $section_hashref = $document->get_sections();
        my $sub_document = $document->get_sub_document(title => 'string or regex');
        my $table_of_contents_arrayref = $document->get_table_of_contents();

Methods for Wiktionary::Parser

new

Create an instance of the Wiktionary::Parser. This object is used to contact the Wiktionary API, and parse the results.

     my $parser = Wiktionary::Parser->new();
get_document (title => TITLE)

Contacts the wiktionary API, and downloads the page with the given title. It then parses the content and returns a Wiktionary::Parser::Document object that you can call further methods on.

     my $document = $parser->get_document(title => 'orange');

Methods for Wiktionary::Parser::Document

See https://github.com/clbecker/perl-wiktionary-parser/wiki for details and examples on methods for the Wiktionary::Parser::Document object.

get_derived_terms

Returns a reference to a hash mapping language to a list of derived terms and phrases

     my $derived_words = $document->get_derived_words();

     print Dumper $derived_words;
     
     $VAR1 = {
          'en' => [
                'bergamot orange',
                'bitter orange',
                'blood orange',
                'burnt orange',
                ...
          ],
          ...
     }
get_parts_of_speech

Returns a reference to a hash mapping language to a list of parts of speech. See https://github.com/clbecker/perl-wiktionary-parser/wiki/Parts-of-speech for details.

     my $parts_of_speech = $document->get_parts_of_speech();
        
     print Dumper $parts_of_speech;
     
     $VAR1 = {
          'en' => {
               'language' => 'English',
               'part_of_speech' => [
                    'noun',
                    'adj',
                    'verb'
                ]
          },
          'sv' => {
               'language' => 'Swedish',
               'part_of_speech' => [
                    'adjective',
                    'noun'
               ]
          },
          ...
     }
get_pronunciations

Returns a reference to a hash mapping language to a pronunciation metadata. See https://github.com/clbecker/perl-wiktionary-parser/wiki/pronunciations for details.

     my $pronunciations = $document->get_pronunciations();
get_translations

Returns a reference to a hash mapping word sense to language to translated words

     my $translations = $document_get_translations();

     print Dumper $translations
     
     $VAR1 = {
          'fruit' => {
               'tr' => {
                    'language' => 'Turkish',
                    'translations' => [
                         'portakal'
                    ],
                    'part_of_speech' => 'noun'
               },
               'fr' => {
                    'language' => 'French',
                    'translations' => [
                         'orange'
                    ],
                    'part_of_speech' => 'noun'
               },
               'da' => {
                    'language' => 'Danish',
                    'translations' => [
                         'appelsin'
                    ],
                    'part_of_speech' => 'noun'
               },
               ...
          },
          ...    
     }
get_word_senses

Returns an arrayref containing a list of word senses

     my $word_senses = $document->get_word_senses();
        
     print Dumper $word_senses;
     
     $VAR1 = [
          'tree',
          'colour',
          'fruit',
          ...
     ]
get_synonyms

Returns a reference to a hash mapping language and word sense to a list of synonyms

     my $synonyms = $document->get_synonyms();

     # Synonyms of 'cat'
     print Dumper $synonyms;
     
     $VAR1 = {
          'en' => {
               'language' => 'English',
               'sense' => {
                    'domestic species' => [
                         'housecat',
                         'kitten',
                         'kitty',
                         ...
                    ],
                    ...
               },
          }
     }
get_hyponyms

Returns a reference to a hash mapping language and word sense to a list of hyponyms

     my $hyponyms = $document->get_hyponyms();
get_hypernyms

Returns a reference to a hash mapping language and word sense to a list of hypernyms

     my $hypernyms = $document->get_hypernyms();
get_antonyms

Returns a reference to a hash mapping language and word sense to a list of antonyms

     my $antonyms = $document->get_antonyms();
get_section (number => SECTION_NUMBER)

Given the section number, returns the corresponding Wiktionary::Parser::Section object. Numbers correspond to the those in the table of contents shown on a mediawiki page.

     my $section = $document->get_section(number => '1.2');
get_sections

Returns a reference to a hash of Wiktionary::Parser::Section objects. These provide access to the data for each section of the document. The format of the hash is { $section_number => object } e.g. {'1.2.1' => $obj}

get_sections (title => STRING_OR_REGEX)

Given a string or regular expression, this will return an array of Section objects containing any sections that match the given title pattern.

This returns a list containing section(s) with 'english' in the title (case insensitive) In most cases this will just return the 'English' section, in some cases you'll also get the 'Old English' section too.

     my $sections = $document->get_sections(title => 'english');

If you want to get only the "English" section, use this pattern:

     my $sections = $document->get_sections(title => '^english$');

This returns an array of all etymology, pronunciation, and synonym sections my $sections = $document->get_sections(title => 'etymology|pronunciation|synonyms');

get_sub_document (title => STRING_OR_REGEX)

Given a string or regular expression, this will return a Wiktionary::Parser::Document object consisting of just the matching sections, and their child sections. This can be used if you're just interested in certain parts of a document.

This returns a document object containing just the sections with 'english' in the title (case insensitive). In most cases this will just return the 'English' section, in some cases you'll also get the 'Old English' section too.

     my $sub_document = $document->get_sub_document(title => 'english');

If you want to get only the "English" section, use this pattern:

     my $sub_document = $document->get_sub_document(title => '^english$');

     # To verify what sections you have, you can print out the table of contents for this sub document.  
     print Dumper $sub_document->get_table_of_contents();
get_part_of_speech_sections

Returns an array of Wiktionary::Parser::Section objects representating all the sections on the page that cover a part of speech. This current includes all sections that match the following header:

     Parts of Speech used in Wiktionary include:
     
        noun
        verb
        adjective
        adverb
        pronoun
        preposition
        article
        conjunction
        determiner
        interjection
        symbol


     my $sections = $document->get_part_of_speech_section();
get_translation_sections

Returns an array of Wiktionary::Parser::Section objects consisting of all Translation sections in the document.

     my $sections = $document->get_translation_sections();
get_synonym_sections

Returns an array of Wiktionary::Parser::Section objects consisting of all Synonym sections in the document.

     my $sections = $document->get_synonym_sections();
get_hyponym_sections

Returns an array of Wiktionary::Parser::Section objects consisting of all Hyponym sections in the document.

     my $sections = $document->get_hyponym_sections();
get_hypernym_sections

Returns an array of Wiktionary::Parser::Section objects consisting of all Hypernym sections in the document.

     my $sections = $document->get_hypernym_sections();
get_antonym_sections

Returns an array of Wiktionary::Parser::Section objects consisting of all Antonym sections in the document.

     my $sections = $document->get_antonym_sections();
get_pronunciation_sections

Returns an array of Wiktionary::Parser::Section objects consisting of all Pronunciation sections in the document.

     my $sections = $document->get_pronunciation_sections();
get_table_of_contents

Returns an arrayref containing section numbers and names. Mostly helpful for informational / debugging purposes when you need a summary of what's in your document object.

     my $table_of_contents = $document->get_table_of_contents();


     print Dumper $table_of_contents;

     $VAR1 = [
          '1,english',
          '1.1,etymology',
          '1.2,pronunciation',
          '1.2.1,usage notes',
          '1.3,noun',
          '1.3.1,derived terms',
          '1.3.2,translations',
          '1.4,adjective',
          '1.4.1,translations',
          ...
      ]
get_title

Return the document title. ( i.e. the argument you used in $parser->get_document(title => $title) )

get_categories

Return an array of all categories this page falls under. (These are usually the links that appear at the bottom of a wiki page)

Methods for Wiktionary::Parser::Section

get_content

Returns an arrayref containing lines of text from the section of the document

get_header

Returns the section heading name

get_section_number

Returns the number of this section (e.g. 1.2.1)

get_parent_section

Return the Wiktionary::Parser::Section instance of the parent section. e.g. if you call this on section 1.2.1, it'll return the object for section 1.2

get_language

Returns the language that this section falls under.

get_part_of_speech

Returns the part of speech that this section falls under.

get_ancestor_sections

Return an arrayref containing all sections above this one in the hierarchy.

get_child_document

This returns a Wiktionary::Parser::Document object containing the current section and all its child sections.

get_child_sections

Returns an array of all sections below this one in the hierarchy

Something went wrong with that request. Please try again.