https://github.com/malexer/sublimetranslit

a transliteration plugin for Sublime Text 3
https://github.com/malexer/sublimetranslit

Last synced: 3 days ago
JSON representation

a transliteration plugin for Sublime Text 3

• Host: GitHub
• URL: https://github.com/malexer/sublimetranslit
• Owner: malexer
• License: mit
• Created: 2012-08-29T13:00:36.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2018-02-05T23:13:02.000Z (almost 7 years ago)
• Last Synced: 2023-03-27T22:31:14.416Z (over 1 year ago)
• Language: Python
• Homepage:
• Size: 31.3 KB
• Stars: 5
• Watchers: 2
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
SublimeTranslit

===============

[![build](https://travis-ci.org/malexer/SublimeTranslit.svg?branch=master)](https://travis-ci.org/malexer/SublimeTranslit)

SublimeTranslit is a plugin for Sublime Text 3

(http://www.sublimetext.com/3) for transliterating selected text.

Intented to be used via Command Palette.

Install

=======

Install using Package Control: `Translit`

Usage

=====

Open Command Palette and type "translit" to see several options.

Creating Transliteration Dictionaries

=====================================

SublimeTranslit supports extending it with additional dictionaries.

Every Dictionary is described by two files:

1. `dictionary_name.json` - is used to define characters mapping.

2. `dictionary_name.sublime-commands` - is used to add a command for this

dictionary to Command Palette.

dictionary_name.dict

--------------------

Contains mapping (dictionary "chars_mapping") of characters.

All other fields (name, description, link) is optional and specified in order

to explain used translit rules and point to source documents.

dictionary_name.sublime-commands

--------------------------------

It is a ordinary .sublime-commands file for Command Palette item for this

dictionary.

Should run command `transliterate_selection` with parameter

`dictionary_file` - a file name of **dictionary_name.json** (without path).

Example:

    [

        {

            "caption": "",

            "command": "transliterate_selection", "args":

            {

                "dictionary_file": "dictionary_name.json",

                "invert_mapping": false

            }

        }

    ]

`invert_mapping` field will trigger inverting of mapping from JSON file which

is useful to use one mapping file to define two transliterations (both sides).

Run unittests

=============

Using pytest:

    $ pytest