From a19d3e9412fec2f0ab965116dd9763f9dfdd2448 Mon Sep 17 00:00:00 2001 From: Vladimir Alaev Date: Wed, 21 Jan 2015 15:55:12 +0300 Subject: [PATCH] Add doc --- doc/config.md | 5 +++++ doc/config.ru.md | 9 +++++++++ 2 files changed, 14 insertions(+) diff --git a/doc/config.md b/doc/config.md index 92a82b271..5569e00b2 100644 --- a/doc/config.md +++ b/doc/config.md @@ -78,6 +78,11 @@ on Selenium Grid. `browsers` option instead) and `takesScreenshot` (always set to `true` automatically). + gemini supports custom capability option `--noCalibrate`. By default it's false and this enables browser calibration. + It is required for such cases when web driver captures screenshots with some area outside of the browser view. + Calibration makes browser to render a special page which allows to determine html body bounds and crop the screenshot + accordingly. If needed you can disable calibration for particular browser by setting `--noCalibrate` to `true`. + * `debug` (CLI: `--debug`, env: `GEMINI_DEBUG`) – turn on debug logging to the terminal. * `parallelLimit` – by default, `gemini` will run all browsers in parallel. Sometimes (i.e. when using cloud services, such as SauceLabs) you have a diff --git a/doc/config.ru.md b/doc/config.ru.md index 4d2eb8b37..2511f544a 100644 --- a/doc/config.ru.md +++ b/doc/config.ru.md @@ -61,6 +61,15 @@ browsers: Можно настроить любой параметр за исключением `browserName`/`version` (вместо этого используйте `browsers`) и `takesScreenshot` (автоматически заявлено как `true`). + + В gemini есть спциальный параметр `--noCalibrate`. Его значение равно `false` по умолчанию. Это включает калибровку + браузера. Калибровка нужна для случаев когда веб драйвер делает скриншоты браузера, захватывающие бОльшую область, + чем занимает отрисованный документ (html body). То есть на картинке помимо страницы, могут быть, например, контролы + навигации браузера. Калибровка открывает в браузере специальную страницу, которая позволяет определить границы документа + на скриншоте и отрезать лишнее. + + Если необходимо, калибровку можно отключить для конкретного браузера установкой `--noCalibrate` в значение `true`. + * `debug` (CLI: `--debug`, env: `GEMINI_DEBUG`) – включить отладочный вывод в терминал. * `parallelLimit` – число браузеров запускаемых `Gemini` параллельно. По умолчанию запускаются все, но иногда (например, при использовании облачных сервисов вроде Sauce Labs) это число необходимо контролировать.