Skip to content

Commit

Permalink
Документация. Все ссылки относительные.
Browse files Browse the repository at this point in the history
  • Loading branch information
@PLoginoff
PLoginoff committed Feb 28, 2014
1 parent 6a250f5 commit 594269e
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 31 deletions.
22 changes: 11 additions & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Currently supported platforms:
- Philips 2012+
- <a href="http://wiki.infomir.eu/">STB Infomir MAG200/250</a> ([MAG200/250 How-to](docs/ru_mag.md)).

To add your own platform please see the platform <a href="https://github.com/immosmart/smartbox/blob/master/docs/en_platform.md">documentation</a>
To add your own platform please see the platform [documentation](docs/en_platform.md).

# Initialization

Expand All @@ -28,18 +28,18 @@ The compiled version of the library is located in the folder <a href="https://gi

# Library plugins

* <a href="https://github.com/immosmart/smartbox/blob/master/docs/en_platform.md">Platforms' methods</a>
* <a href="https://github.com/immosmart/smartbox/blob/master/docs/en_log.md">Log console</a>
* <a href="https://github.com/immosmart/smartbox/blob/master/docs/ru_legend.md">Legend</a>
* [Platforms' methods](docs/en_platform.md)
* [Log console](docs/en_log.md)
* [Legend](docs/ru_legend.md)
* Navigation
* <a href="https://github.com/immosmart/smartbox/blob/master/docs/en_nav.md">Initialization and methods</a>
* <a href="https://github.com/immosmart/smartbox/blob/master/docs/en_nav_alg.md">Algorithm</a>
* <a href="https://github.com/immosmart/smartbox/blob/master/docs/en_nav_extended.md">Extended usage</a>
* <a href="https://github.com/immosmart/smartbox/blob/master/docs/en_input.md">Input fields</a>
* <a href="https://github.com/immosmart/smartbox/blob/master/docs/en_keyboard.md">Keyboard(virtual)</a>
* <a href="https://github.com/immosmart/smartbox/blob/master/docs/en_voice.md">Voice management</a>
* [Initialization and methods](docs/en_nav.md)
* [Algorithm](docs/en_nav_alg.md)
* [Extended usage](docs/en_nav_extended.md)
* [Input fields](docs/en_input.md)
* [Keyboard(virtual)](docs/en_keyboard.md)
* [Voice management](docs/en_voice.md)
* Legend @todo_doc
* <a href="https://github.com/immosmart/smartbox/blob/master/docs/en_player.md">Player</a>
* [Player](docs/en_player.md)

# How to use the library

Expand Down
14 changes: 7 additions & 7 deletions docs/en_nav_alg.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,27 @@ The alghorithm is reasonable for any direction. "Upper edge" means an edge coinc

Example: There are navigation elements, focused element is marked in red.

<img src="http://immosmart.github.io/smartbox/docs/nav_slides/slide1.png" />
![slide1](nav_slides/slide1.png)

User presses the button "Up". The first occuring thing is eliminating of elements that have upper edge lower then upper edge of the focused element.

<img src="http://immosmart.github.io/smartbox/docs/nav_slides/slide2.png" />
![slide2](nav_slides/slide2.png)

The elements that have edges that intersect along the axis perpendicular to the direction are found. If there is any of such element exists then their priority become higher and other elements are eliminated.

<img src="http://immosmart.github.io/smartbox/docs/nav_slides/slide3.png" />
![slide3](nav_slides/slide3.png)

The element that has upper edge closer to the upper edge of the focused element is searched for from the last elements.
<img src="http://immosmart.github.io/smartbox/docs/nav_slides/slide4.png" />

If on the second step intersected elements haven't been found the closest element is found.
![slide4](nav_slides/slide4.png)

If on the second step intersected elements haven't been found the closest element is found.

<img src="http://immosmart.github.io/smartbox/docs/nav_slides/slide5.png" />
![slide5](nav_slides/slide5.png)

# It's not a bug, it's a feature!

<img src="http://immosmart.github.io/smartbox/docs/nav_slides/slide6.png" />
![slide6](nav_slides/slide6.png)

In this example moving vertically from the element **B** to the element **A** it's possible to transit the focus but not vise versaю
It happens because of the bottom edge pf the element **A** is lower then the bottom edge of the element **B**.
Expand Down
2 changes: 1 addition & 1 deletion docs/en_nav_extended.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,4 @@ A phantom is a `nav-item` which transits the focus on the another element as soo

In this example when the focus comes to the element it's transited to the element #card_owner.

<img src="http://immosmart.github.io/smartbox/docs/nav_slides/slide7.png" />
![slide7](nav_slides/slide7.png)
2 changes: 1 addition & 1 deletion docs/ru_legend.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
При нажатии на такой элемент возникает событие nav_key:(Имя элемента) в body
По умолчанию в легенде присутствуют элементы:

<img src="http://immosmart.github.io/smartbox/docs/img/legend.jpg" />
![legend](img/legend.jpg)

# Скрытие/отображение элемента

Expand Down
2 changes: 0 additions & 2 deletions docs/ru_mag.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@
/usr/share/qt-4.6.0/stbapp -qws -display directfb http://immosmart.github.io/smartbox/ &
```

* http://wiki.infomir.eu/doku.php/stalker:faq

* Можно сделать скриншот (инструкция http://wiki.infomir.eu/doku.php/stalker:faq). На MAG250 работает только рецепт с fbdump. Правда видео не захватывается.

```
Expand Down
12 changes: 6 additions & 6 deletions docs/ru_nav_alg.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,29 @@

Пример: есть элементы навигации, элемент в фокусе обозначен красным цветом.

<img src="http://immosmart.github.io/smartbox/docs/nav_slides/slide1.png" />
![slide1](nav_slides/slide1.png)

Юзер нижмает кнопку вверх. Первое что происходит - отсеиваютя элементы верхняя грань которых ниже чем верхняя грань элемента в фокусе.

<img src="http://immosmart.github.io/smartbox/docs/nav_slides/slide2.png" />
![slide2](nav_slides/slide2.png)

Находятся элементы, грани которых пересекаются по оси перпендикулярной направлению. Если такие элементы находятся, их приоритет становится выше и остальные отсеиваются.

<img src="http://immosmart.github.io/smartbox/docs/nav_slides/slide3.png" />
![slide3](nav_slides/slide3.png)

Из оставшихся элементов находится тот чья верхняя грань ближе всего к верхней грани элемента в фокусе. Это и есть искомый элемент.

<img src="http://immosmart.github.io/smartbox/docs/nav_slides/slide4.png" />
![slide4](nav_slides/slide4.png)


Если на втором шаге пересекающихся элементов не было найдено с оставшимися элементами происходит тоже самое. Находится самый ближайший.

<img src="http://immosmart.github.io/smartbox/docs/nav_slides/slide5.png" />
![slide5](nav_slides/slide5.png)

# Это не баг, это фича.


<img src="http://immosmart.github.io/smartbox/docs/nav_slides/slide6.png" />
![slide6](nav_slides/slide6.png)

В этом примере двигаясь по вертикали из элемента **B** в элемент **A** перейти можно, но не наоборот.
Это происходит потому что нижняя грань элемента **A**, ниже нижней грани элемента **B**.
Expand Down
4 changes: 1 addition & 3 deletions docs/ru_nav_extended.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,5 @@

http://immosmart.github.io/smartbox/examples/navigation/phantom/index.html

<img src="http://immosmart.github.io/smartbox/docs/nav_slides/slide7.png" />


![slide7](nav_slides/slide7.png)

0 comments on commit 594269e

Please sign in to comment.