HOWTO

Installation:
    Install with script
        Open terminal and execute 'sudo ./plugin_install.sh'

    Manual Install
        Find your gedit version by checking help > about
        Copy all contents of matching version's folder to path '~/.local/share/gedit/plugins/'
        Copy dictonator.svg to path '/usr/share/icons/hicolor/scalable/apps/'
        Install python3 and pip3 by 'sudo apt-get install python3-all-dev python3-pip'
        Install portaudio and swig by 'sudo apt-get install swig portaudio19-dev'
        Install SpeechRecognition and pocketsphinx by 'pip3 install SpeechRecognition pocketsphinx'

How to run:
    Open Gedit, goto edit > preferences > plugins, and tick Dict'O'nator

How to use:
    * All commands work from the cursor, including put, deletes.
    * Multiple commands can be used together
    * Only repeatable actions can be repeated
    * To input specific characters/digits use "put" command

    Format of instruction:
        * "some non command text" : input directly
        * "repeatable command (number) times" : execute command number times
        * "non repeatable command" : execute command
        * "put (special character)" : input special character
        * "put (special character) (number) times" : input special character number times
        * "put (number) digit : input number
        * "put (number1) digit (number2) times" : input number1 number2 times

    Examples:
        * "Hello what's up" : non commands will be input directly
        * "put underscore" : input _
        * "delete sentence" : delete last sentence from pointer
        * "put question mark 4 times" : input question mark 4 times
        * "delete 5 lines" : delete 5 lines
        * "go to line 5" : moves the cursor to line 5
        * "save document" : saves document

    Command (How to call)
        start_dictation= start dictation, start dictator, start speaking
        stop_dictation= stop dictation, stop dictator, stop dictation
        hold_dictation= hold dictation, hold dictator, wait dictation
        scroll_to_cursor= scroll to cursor, back to cursor
        goto_line= go to line, goto line
        undo= undo, do undo
        redo= redo, do redo
        cut_clipboard= cut clipboard, cut clip board, cut selection, cut to clipboard
        copy_clipboard= copy clipboard, copy to clipboard, copy selection, copy clip board
        paste_clipboard= paste clipboard, paste clipboard, paste from clipboard
        delete_selection= delete selection, delete selected text
        select_all= select all, select all text
        sentence_end= sentence end, close sentence, end sentence, full stop, put period
        line_end= end line, close line, input enter, put enter, next line
        delete_line= delete line, delete last line
        delete_word= delete word, delete last word
        delete_sentence= delete sentence, delete this sentence, delete current sentence
        clear_document= clear document, empty document, clear file, empty file
        new_document= new document, new file
        save_as_document= save as document, save document as, save as file, save file as
        save_document= save document, save file
        close_document= close document, close file
        force_close_document= force close document, force close file
        exit= exit editor, exit gedit, editor exit, gedit exit, close editor, close gedit,quit editor
        put= put, insert, type, input


    repeatable_actions = delete_sentence, delete_line, delete_word, undo, redo, line_end, sentence_end

    Special Characters
        question_mark= ?, question mark
        exclamation_mark= !, exclamation mark
        full_stop= ., full_stop
        comma= ,, comma
        new_line= \n
        new line, enter, newline
        tab=\t, tab, tab space
        quote= ", quotes
        apostrophe= ', apostrophe
        forward_slash= /, slash, forward slash
        backward_slash= \, backward slash
        colon= :, colon
        semi_colon= ;, semi colon, semicolon
        ampersand= &, ampersand
        at_rate= @, atrate, at rate
        hash= #, hash
        dollar= $, dollar
        per_cent= %, percentage, per cent, percent
        star= *, star, multiply
        hyphen= -, minus, hyphen, subtract, subtraction
        under_score= _, underscore, under score
        equal= =, equals, equal to
        plus= +, plus, add, addition
        left_bracket= (, left bracket, open bracket
        right_bracket= ), right bracket, close bracket

    Digits
        zero_digit= 0 digit, zero digit
        one_digit= 1 digit, one digit
        two_digit= 2 digit, two digit
        three_digit= 3 digit, three digit
        four_digit= 4 digit, four digit
        five_digit= 5 digit, five digit
        six_digit= 6 digit, six digit
        seven_digit= 7 digit, seven digit
        eight_digit= 8 digit, eight digit
        nine_digit= 9 digit, nine digit

Difficulties:
    Default Sphinx requires American English accent and will give bad results otherwise.
    The keys provided are temporary and aren't guaranteed to work.
    Depending on the user load on given APIs the results might be slower.

How to use more services:
    Open Gedit, goto edit > preferences > plugins > Dict'O'nator > preferences and tick whichever service you wan't and fill in the API key.
    Save settings by clicking on "save button".
    Microsoft Bing, Wit.ai, Api.ai, provide free trials/services and you can get an api key from their respective sites.