[МЕМО] Как встроить справку в расширение.

Автор Рыбка Рио, 18 июля 2010, 10:12

0 Пользователи и 1 гость просматривают эту тему.

Рыбка Рио

Нам понадобится только текстовый редактор.
Для того чтобы написать справку, нужно создать по крайней мере 2 файла: 1 с расширением .tree, а другой с расширением .xhp. Хороший пример расширения со справкой есть в SDK (см. прицеп к этому сообщению). Распакуйте и посмотрите на то, как устроены файлы .xhp. Ещё примеры:
MRI - UNO Object Inspection Tool | OpenOffice.org repository for Extensions
Default Browser | OpenOffice.org repository for Extensions
Barcode | OpenOffice.org repository for Extensions
Watching Window | OpenOffice.org repository for Extensions
Table → Text | OpenOffice.org repository for Extensions
Sun Wiki Publisher | OpenOffice.org repository for Extensions

Ссылки по теме:
Help Content — OpenOffice.org Wiki
Download Netbeans Project "OptionsPageDemo"

Re: [documentation-dev] Authoring Help With OpenOffice.org
ЦитироватьFor an occasional writer of an extension help it would be too much of an effort to setup that environment. Copy an existing xhp file to get the structure, then change the contents and save with another name.

[вложение удалено Администратором]
ubuntu 12.04 + LibO3.6.0

dr.Faust

Очень интересно! Спасибо  Крио.
А где увидеть саму справку?
Свобода информации - свобода личности!

Рыбка Рио

Извините, в первом сообщении в прицепленном файле было много лишних файлов (исправлено) (но файла tree там нет). Просто оно скопировано из папки с установленными расширениями, а при установке расширения со справкой генерируются ещё несколько файлов. Из-за отсутствия файла tree это расширение не добавляет себя в содержание, зато его можно было найти во вкладке Индекс или поиском по справке. Файл tree есть в других расширениях.

Справка находится в папке расширения, которую обычно называют help (имя этой папки прописано в файле META-INF/manifest.xml).
Описание формата xhp тут:
http://documentation.openoffice.org/online_help/helpers/helpauthoring/guide/OOo2HelpAuthoring.pdf
ubuntu 12.04 + LibO3.6.0

Рыбка Рио

Вот (Help Content — OpenOffice.org Wiki):
DialogWithHelp.oxt

├─ DialogWithHelp
│   │
│   └─ ... Dialog Library

├─ META-INF
│   │
│   └─ manifest.xml (assigning "help" folder to media type
│                    "application/vnd.sun.star.help")
├─ help
│   │
│   ├─ en
│   │   │
│   │   └─ com.foocorp.foo-ext
│   │       │
│   │       ├─ page1.xhp 
│   │       │
│   │       ├─ page2.xhp 
│   │       │
│   │       └─ subfolder 
│   │           │
│   │           └─ anotherpage.xhp 
│   │
│   └─ de
│       │
│       └─ com.foocorp.foo-ext
│           │
│           ├─ page1.xhp 
│           │
│           ├─ page2.xhp 
│           │
│           └─ subfolder 
│               │
│               └─ anotherpage.xhp 
│   
├─ Addons.xcu (Menu/Toolbar specification)

└─ description.xml (contains identifier)
Все остальные файлы были сгенерированы при установке.
ubuntu 12.04 + LibO3.6.0

Рыбка Рио

Расширение для создания справки: documentation: CVS

В файле http://documentation.openoffice.org/online_help/helpers/helpauthoring/guide/OOo2HelpAuthoring.pdf на странице 75 объяснено, что нужно сделать, чтобы установить среду. Но сыслки на файлы устарели, теперь все эти файлы можно найти тут: documentation: CVS

Возможно, придётся установить OOo 1.x, ля тех кто хочет редактировать справку прямо в Writer (Re: [documentation-dev] Authoring Help With OpenOffice.org)

ubuntu 12.04 + LibO3.6.0

Рыбка Рио

Extensions Packagers — OpenOffice.org Wiki содержит библиотеку для создания полноценной справки.
ubuntu 12.04 + LibO3.6.0