Документация

2014-08-18 00:12:20 +04:00
parent 7375ded858
commit 1cdac76c41
1 changed files with 28 additions and 0 deletions
@@ -4,6 +4,34 @@
 //
 // Текущая реализация подразумевает только одностороннюю транслитерацию: обратное преобразование
 // будет уже не так очевидно.
 //
 // Хоть кода в этой библиотеке и не очень много, но время на нее все-таки было потрачено, т.к.
 // раньше я просто не задумывался о некоторых аспектах работы с транслитерацией.
 //
 // В общем, как и большинство других аналогичных библиотек, она перебирает все символы в строке
 // и заменяет их по предложенному ей словарю. Отличие только в том, что, с моей точки зрения, она
 // более корректно отрабатывает случаи с чередованием заглавных букв. Например:
 //
 //     "ЧАЩА" -> "CHASCHA"
 //     "ЧаЩа" -> "ChaScha"
 //     "Чаща" -> "Chascha"
 //     "чаЩА" -> "chaSCHA"
 //
 // Для транслитерации русских букв в ней уже предусмотрен встроенный словарь. Для других языков
 // вы можете задать свой. Все достаточно просто:
 //
 //  import "github.com/mdigger/translit"
 //
 //  tests := []string{
 //     "Проверочная СТРОКА для транслитерации",
 //     "ЧАЩА",
 //     "ЧаЩа",
 //     "Чаща",
 //     "чаЩА",
 //  }
 //  for _, text := range tests {
 //      fmt.Println(translit.Ru(text))
 //  }
 package translit
 import (