Merge pull request xDrivenDevelopment#151 from zeratulayuris/fix-docs

Обновление документации

Author: zeratulayuris

README.md

@@ -1,18 +1,20 @@
-## Набор утилит для автоматической разборки/сборки внешних обработок и отчетов, при помещении (commit) в git
+# Набор утилит для автоматической разборки/сборки внешних обработок и отчетов, при помещении (commit) в git
 
 [![Join the chat at https://gitter.im/xDrivenDevelopment/precommit1c](https://badges.gitter.im/xDrivenDevelopment/precommit1c.svg)](https://gitter.im/xDrivenDevelopment/precommit1c?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) Здесь вы можете задавать любые вопросы разработчикам и активным участникам
 
 [![GitHub release](https://img.shields.io/github/release/xDrivenDevelopment/precommit1c.svg)](https://github.com/xDrivenDevelopment/precommit1c/releases)
 
-### Что к чему
+## Что к чему
 
 ----
 
+**precommit1c** - инструмент для хранения в Git исходников внешних отчетов/обработок, технически состоит из:
+
 * v8files-extractor.os - скрипт для OneScript, получающий список помещаемых файлов при коммите, фильтрующий по расширению только внешние отчёты/обработки, расширения и запускающий команды для распаковки этих файлов. Так же позволяет собирать обработки из полученных исходников.
 * [V8Reader.epf](http://infostart.ru/public/106310/) - внешняя обработка 1С, которая с помощью  [v8unpack](http://svn2.assembla.com/svn/V8Unpack/track/) разбирает внешние обработки, определяет нормальные  наименования для каталогов форм, файлов модулей объектов и т. д. и раскладывает их в нормальную структуру папок.
 * pre-commit - собственно командный файл, вызываемый git перед каждым помещением. Выполняет роль простой запускалки скрипта v8files-extractor.os
 
-### Установка
+## Установка
 
 1. Зависимости:
     * OneScript [http://oscript.io/](http://oscript.io/)
@@ -25,15 +27,15 @@
 
 3. Путь хранения исходных текстов разобранных обработок по умолчанию используется как **src** (для обеспечения совместимости со старыми версиями обработки), однако его можно переназначить в файле `pre-commit`
 
-#### Установка через OneScript Package Manager
+### Установка через OneScript Package Manager (предпочтительно)
 
-1. Выполните установку precommit1c из командной строки `opm install precommit1c` (предполагается, что OneScript уже установлен и командная строка запущена с правами администратора).
+1. Выполните установку precommit1c из командной строки `opm install precommit1c` (предполагается, что OneScript уже установлен и командная строка запущена с правами администратора). При этом необходимые библиотеки oscript будут установлены автоматически.
 
 2. Перейдите в рабочий каталог репозитория, для которого следует использовать автоматическую сборку/разборку.
 
 3. Выполните из командной строки `precommit1c --install` (здесь можно без прав администратора).
 
-#### Установка через zip-архив
+### Установка через zip-архив
 
 1. Скачайте zip-архив precommit1c.zip со страницы [последнего релиза](https://github.com/xDrivenDevelopment/precommit1c/releases/latest).
 
@@ -50,12 +52,15 @@
         v8files-extractor.os
 ```
 
-#### Установка через git clone
+3. Установите необходимые библиотеки oscript - их список можно посмотреть в списке зависимостей в файле `packagedef`.
+
+### Установка через git clone
 
 1. Склонируйте репозиторий `precommit1c` в удобное место.
 
 2. После клонирования репозитория необходимо инициализировать используемые подмодули.  
 Откройте командую строку и выполните команды:
+
 ```cmd
 cd путь/к/репозиторию/precommit1c
 git submodule update --init --recursive
@@ -64,6 +69,7 @@ git submodule update --init --recursive
 3. Cодержимое каталога необходимо скопировать в каталог .git/hooks/ вашего проекта.  
 *Примечание:* каталог .git по умолчанию скрыт.  
 В итоге у вас должна получиться следующая структура каталога:
+
 ```
 .git\
     hooks\
@@ -73,6 +79,8 @@ git submodule update --init --recursive
         v8files-extractor.os
 ```
 
+4. Установите необходимые библиотеки oscript - их список можно посмотреть в списке зависимостей в файле `packagedef`.
+
 ## Запуск
 
 После установки достаточно для проверки сделать commit для любого файла epf/erf/cfe, и в вашем репозитории автоматически должна создаться папка *src*, полностью повторяющая структуру проекта, изменённые или добавленные файлы распакуются в папки с аналогичными наименованиями.
@@ -132,11 +140,21 @@ git config --local core.longpaths true
 Т.о. в файл C:\Program Files (x86)\1cv8\conf\conf.cfg необходимо добавить строку `DisableUnsafeActionProtection=.*`
 Подробнее [на ИТС](http://its.1c.ru/db/v838doc#bookmark:dev:TI000001873)
 
+## Особенности распаковки макетов
+
+При использовании v8Reader макеты выгружаются в файлы, соответствующие их типам, дополнительно обрабатываются специальные случаи:
+
+* У макетов табличных документов дополнительно создаются .txt версии, чтобы их было легче сравнивать в текстовом редакторе.
+* У макетов типа html дополнительно выгружаются файлы вложений.
+* Макеты в двоичных данных выгружаются либо в .bin, либо (для печатных форм) в тот тип файла, который указан в имени макета (например, `ПФ_MXL_КакаяТоПечатнаяФорма` будет выгружен в `ПФ_MXL_КакаяТоПечатнаяФорма.mxl`).
+
 ## Известные проблемы
 
 1. При использовании некоторых версий SourceTree (удобный клиент git) может возникать следующая ошибка:
+
 >`.git/hooks/pre-commit: line 4: oscript: command not found`
 Несколько вариантов решения:
+
 + убедиться, что команда `oscript` доступна
   + для проверки вызвать из командной строки или Win+R `cmd /k oscript`
 + откатиться на предыдущую версию SourceTree
@@ -151,12 +169,10 @@ git config --local core.longpaths true
   * добавить нужную обработку в индекс git - например, `git add XXX.epf`
   * установить переменную среды `LOGOS_CONFIG` или заполнить спец.файл настройки логов
   * выполнить `git commit` или `precommit1c --git-precommit`
+  * Например, рядом с файлом `v8files-extractor.os` положить файл `logos.cfg` со следующим текстом `logger.rootLogger=DEBUG`
+  * или переименовать файл-пример `logos.debug-example.cfg` в `logos.cfg`
+  * Или создать и выполнить командный файл
 
-+ Например, рядом с файлом `v8files-extractor.os` положить файл `logos.cfg` со следующим текстом `logger.rootLogger=DEBUG`
-
-+ или переименовать файл-пример `logos.debug-example.cfg` в `logos.cfg`
-
-* Или создать и выполнить командный файл
 ```bat
 git add XXX.epf
 @set LOGOS_CONFIG=logger.rootLogger=DEBUG
@@ -166,6 +182,7 @@ git add XXX.epf
   * где каталог `src` - выходной каталог, где хранятся исходники
 
 2. Для отключения отладочных логов выполнить обратные действия
+
 ## Что внутри
 
 Как это работает: `v8files-extractor.os` полностью повторяет иерархию папок относительно корня репозитория только в папке SRC (от слова source), для каждой изменённой внешней обработки создаётся своя папка и туда с помощью v8unpack распаковывается помещаемая обработка, с помощью v8reader определяются наименования макетов, форм, модуля обработки и переименовываются, переименования сохраняются в служебном файле renames.txt, те файлы, которые невозможно определить или же носят чисто служебный характер, переносятся в каталог *und*.