1 Отредактировано kondor (22-04-2009 11:33:11)

Тема: [анонс] Создание справочных файлов для Maemo приложений

Приветствую,

  Хочу рассказать о еще одном проекте, который сегодня взял старт.

  С точки зрения пользователя, если приложение обладает не только хорошим и понятным интерфейсом, но
  и возможностью вызова справки по работе с ней из самой программы, то это, очевидно, удобно спроектированная
  программа. К сожалению, до сего момента создание справочных файлов (т.н. OSSO Help file format, XML) для приложений
  Maemo было неприятным:
[ul]- Отсутствие нормальной документации по формату файлов. То, что написано в официальном Maemo*Reference*Guide.pdf -- простите, откровенная отписка, по которой не очень-то и приятно писать справку.
- Отсустствие удобного средства для написания таких файлов. Не все знают XML. Не все хотят разбираться в чем-то непонятным, но зато они готовы помочь в написании документации для приложений.
[/ul]

  Я сам столкнулся с этим, когда писал справочную помощь для Conler. После чего было решено, все-таки, попробовать исправить данную ситуацию.

Чтобы не плодить лишние сущности в виде отдельной программы для редактирования, за основу был взят уже существующий кроссплатформенный визуальный XML редактор Syntext Serna, который с недавнего времени стал бесплатным. Были досконально изучены исходники библиотеки Maemo для работы со справочными файлами. Была прочитана документация по редактору.
В результате появился плагин, позволяющий в визуальном режиме, даже не имея особого представления о формате OSSO Help, создавать файлы помощи для приложений Maemo.

Вот так выглядит редактирование в Serna:

http://forum.internet-tablet.com/uploads/thumbs/376_osso-help-in-serna.png
(кликабельно)

А вот финальный результат на таблетке:

http://forum.internet-tablet.com/uploads/thumbs/376_osso-help-in-maemo.png
(кликабельно)


Надеюсь, данный проект позволит увеличить число "задокументированных" Maemo-программ и позволит "не-гикам" вносить свой вклад в развитие Maemo. Домашняя страница проекта: http://thekondor.net/osso-help-plugin там же: инструкции по установке, документация и скриншоты.

Лицензия: GNU Lesser GPL v3

И, как обычно, feedback is welcome.

http://thekondor.net

2

Re: [анонс] Создание справочных файлов для Maemo приложений

Приветствую!
Просьба растолковать как потом хэлп стыкуется с конкретным приложением..
(и линк поправьте плиз)

N800(4.2008.43-7) + Kingston microSDHC 4Gb Class 4

3

Re: [анонс] Создание справочных файлов для Maemo приложений

DJArty пишет:

Приветствую!
Просьба растолковать как потом хэлп стыкуется с конкретным приложением..
(и линк поправьте плиз)

Линк поправил, спасибо.

А вот про стыковку в Developer's Guide написано как раз хорошо. В общем случае, если просто написать хэлп и положить его в /usr/share/osso-help/en_GB или, например, /usr/share/osso-help/ru_RU, то хэлп будет сразу же доступен для навигации через Main Menu -> Help (у меня системная локаль на таблетке английская, поэтому не знаю, как это будет на русском). Но в таком случае будет невозможно вызвать эту справку из самого приложения.

Для создания возможности вызова справки из самого приложения необходима модификация как самой программы, так и справки. Для этого вводится понятие "контекста" -- некого уникального идентификатора, строго характеризующее определенное место в справке, по которому можно вызвать этот самый хэлп. В самой программе, в зависимости от места, где произошел вызов справки, делается запрос такого контекста, в результате которого показывается определенное место справки. Примерно так.

Если очень уж сумбурно описал, не стесняйтесь, задавайте вопросы. Наглядный пример, как это делается в коде есть, например, тут http://maemo.org/development/documentat … framework/

http://thekondor.net

4

Re: [анонс] Создание справочных файлов для Maemo приложений

Не могу ничего скачивать в приложение(например,агент,браузер),выходит "неверное приложение".Что надо сделать?