Merge pull request #3 from stasganiev/dev

Новая версия 8.3.4

README.md

@@ -1,2 +1,57 @@
-# OnesTemplates
-Шаблоны фрагментов кода для удобной работы в конфигураторе 1С:Предприятия 8.3
+# OnesTemplates - шаблоны кода 1С
+
+[![Join telegram chat](https://img.shields.io/badge/chat-telegram-blue?style=flat&logo=telegram)](https://t.me/st1c8)
+[![GitHub issues](https://img.shields.io/github/issues-raw/stasganiev/OnesTemplates?style=badge)](https://github.com/stasganiev/OnesTemplates/issues)
+[![Last release](https://img.shields.io/github/v/release/stasganiev/OnesTemplates?include_prereleases&label=last%20release&style=badge)](https://github.com/stasganiev/OnesTemplates/releases/latest)
+
+<div id="header" align="center">
+  <img src="./img/titlepaper.png" width="320" height="180"/>
+</div>
+
+## О проекте
+
+Механизм шаблонов автозамены - это возможность быстро подставлять в модуль часто используемые фрагменты кода, операторные конструкции и целые алгоритмы.
+Штатный набор шаблонов не раскрывает всех возможностей и удобства использования этого чудесного инструмента, но, к счастью, конфигуратор позволяет расширять его, разрабатывая свои собственные.
+
+Преимущества использования шаблонов:
+- В разы повышает скорость написания кода, особенно особенно его рутинных частей;
+- Весь код пишется в одном стиле, что помогает поддерживать еднообразие как в собственных разработках, как и среди коллег в команде;
+- Код сразу соответствует требованиям Стандартов, что понравится Sonar-у и EDT.
+
+Проект OnesTemplates - это продолжение труда Павла Чистова - основоположника по-настоящему удобного и наиболее полного набора шаблонов для конфигуратора 1С.
+С 01.08.2023 этот репозиторий является новым постоянным местом хранения и развития проекта, который поддерживается его [авторами](#title_outhers) и сообществом.
+
+## Установка
+
+>Данные дейсвия выполняются один раз и действуют в конфигураторах всех информационных баз на вашем компьютере
+
+1. Скачай себе в локальную папку файл *GanievPRO.st*
+2. Открой в конфигураторе менеджер шаблонов через меню **Сервис - Шаблоны текста** (Ctrl+Shift+T)
+3. В подменю **Действия** или из контекстного меню перейди в **Настройку шаблонов**
+4. Отключи использование стандартных шаблонов
+5. Добавь новый используемый файл и выбери сохраненный файл *GanievPRO.st*. Нажми **ОК**
+6. Для включения режима автоподстановки, перейди в конфигураторе в меню **Сервис - Параметры**
+7. На вкладке **Модули** в поле **Автозамена** выбери режим *Включить* или *Включить с подсказкой*. Нажми **ОК**
+
+[Подробная инструкция](./doc/installtutorial.md)
+
+## Инструкции
+
+*О механизме шаблонов автозамены в 1С* (в разработке)
+
+[Как скачать и установить шаблоны на свой конфигуратор](./doc/installtutorial.md)
+
+*Как предложить идею для улучшения* (в разработке)
+
+[Как принять участие в разработке и предложить свои изменения](./doc/gitflow.md)
+
+## Каталог шаблонов
+
+(в разрботке)
+
+## <a name="title_outhers"></a> Авторы
+
+|*Имя*|*Страница*|*Telegram-канал*|
+|---|---|---|
+|Стас Ганиев|[Taplink](https://stasganiev.taplink.ws/)|[OneSCast](https://t.me/OneSCast)|
+|Артур|[Портал программиста 1С](https://koder.by/shablony_avtozameny_1s.php)|[1Cnik](https://t.me/by_1cnik)|

doc/gitflow.md

@@ -0,0 +1,15 @@
+[Главная](./../README.md)
+
+# Как скачать репозиторий с Github и принять участие в проекте
+
+>Пока кратко, подробнее будет позже
+
+- Создать fork репозитория на Github
+- Установить Git на локальной машине([статья](https://infostart.ru/1c/articles/864097/))
+- Создать локальный репозиторий и синхронизировать его с Github. Либо склонировать с Github на локальный диск
+- Создать ветку фичи для доработки на основании ветки dev
+- Выполнить доработки и закоммитить изменения в свой fork
+- Создание на Github Pull request на принятие изменений в родительский проект
+- Дождаться результата. Если после кодревью потребуются корректировки, то выполнить коммит дополнений
+
+[Назад](./../README.md)

doc/installtutorial.md

@@ -0,0 +1,79 @@
+[Главная](./../README.md)
+
+# Установка и подключение шаблонов
+
+>Данные дейсвия выполняются один раз и действуют в конфигураторах всех информационных баз на вашем компьютере
+
+## 1 Сохранение файла шаблонов в локальную папку на диске
+
+>Процесс скачивания, подключения репозитория и работы с проектом по git-flow описан в [отдельной инструкции](./gitflow.md).
+
+Если у вас нет желания подключаться к разработке проекта на Github и скачивать к себе весь репозиторий, тогда для вас есть два способа скачать файл шаблона с [основной страницы](https://github.com/stasganiev/OnesTemplates) проекта:
+
+### Способ 1
+
+1. Открыть файл **GanievPRO.st** щелчком по его имени
+2. Нажать кнопу *Download raw file* и указать папку для сохранения файла
+
+<div align="center">
+  <img src="./../img/dowmload_ref.png" alt="Файл шаблона" width="428" height="200"/>&nbsp;
+  <img src="./../img/download_button.png" alt="Сохранение файла на диск" width="546" height="200"/>
+</div>
+
+### Способ 2
+
+1. Перейти к описанию последней версии релиза проекта по ссылке справа, в разделе описания релизов, либо по ссылке в заголовке справки на главной странице
+2. На странице описания версии щелкаем по ссылке *Source code (zip)* и скачиваем архив
+3. Распаковываем содержимое архива в локальную папку, где лежат все ваши шаблоны
+
+<div align="center">
+  <img src="./../img/releases.png" alt="Последний релиз проекта" width="371" height="200"/>&nbsp;
+  <img src="./../img/releases_sourse.png" alt="Выбор архива релиза" width="455" height="200"/>
+</div>
+
+## 2 Подключиение шаблонов в конфигураторе
+
+1. Открыть в конфигураторе менеджер шаблонов через меню *Сервис - Шаблоны текста* (Ctrl+Shift+T)
+2. В подменю *Действия* или из контекстного меню выбрать пункт *Настройка шаблонов*
+3. Отключить использование стандартных шаблонов (снять флажок)
+4. В список используемых файлов добавить новый файл и выбрать сохраненный файл *GanievPRO.st*
+5. Нажать *ОК* для сохранения изменений
+
+<div align="center">
+  <img src="./../img/templates.png" alt="Менеджер шаблонов" width="230" height="200"/>&nbsp;
+  <img src="./../img/settings.png" alt="Настройки" width="419" height="200"/>
+</div>
+
+## 3 Включение режима автозамены в настройках конфигуратора
+
+1. В конфигураторе перейти в меню *Сервис - Параметры*, вкладка *Модули*
+2. В поле *Автозамена* выбрать режим *Включить* или *Включить с подсказкой*
+3. Нажать *ОК* для сохранения изменений
+
+<div align="center">
+  <img src="./../img/config_settings.png" alt="Настройки" width="170" height="200"/>
+</div>
+
+Как работают разные режимы автозамены:
+
+### Включить
+
+При наборе шаблона или его существенной части (если известно, что это шаблон), для продолжения подстановки кода дополнения достаточно нажать пробел или клавишу *Enter*.
+
+<div align="center">
+  <img src="./../img/auto1.png" alt="Режим Включить" width="358" height="200"/>
+</div>
+
+### Включить с подсказкой
+
+При наборе шаблона, как только набрана его существенная часть, конфигуратор начинает подсвечивать подсказку с перечнем возможных вариантов для текущей последовательности символов. Для продолжения подстановки кода дополнения достаточно нажать пробел или клавишу *Enter*.
+
+<div align="center">
+  <img src="./../img/auto2.png" alt="Режим Включить" width="295" height="200"/>
+</div>
+
+### Только подсказка
+
+При наборе шаблона, также будет появлятся подсказка с возможными подстановками, но по факту автозамена работать не будет. Вариант применим, например, если вы редко пользуетесь шаблонами для больших фрагментов алгоритмов. Данная подсказко может напомнить о существовании шаблона, после чего можно будет мышкой перетащить код шаблона из списка шаблонов непосредственно в модуль.
+
+[Назад](./../README.md)