Елементи, які можна використовувати у файлах довідки .rkh- <document>
Має бути в усіх файлах
.xmlяк кореневий вузол (лише один раз). Не має атрибутів.- <title>
Заголовок сторінки довідки. Не береться до уваги для сторінок довідки з додатків (для таких сторінок заголовком завжди буде назва самого додатка). Використовується лише для самодостатніх сторінок. Не має атрибутів. Як заголовок сторінки довідки буде використано вміст теґу <title>. Можна використовувати лише один раз як безпосередній дочірній елемент вузла <document>.
- <summary>
Коротка анотація сторінки довідки (або опис того, для чого призначено цей додаток). Цей розділ завжди буде показано на початку сторінки довідки. Не має атрибутів. Буде показано текст, що міститься у тезі <summary>. Є рекомендованим, але не є обов’язковим. Можна визначати лише один раз як безпосередній дочірній елемент вузла <document>.
- <usage>
Дещо докладніша анотація щодо користування. Завжди буде показано безпосередньо після розділу <summary>. Не має атрибутів. Буде показано текст, що міститься у тезі <usage>. Рекомендовано для сторінок довідки з додатків, але не є обов’язковим. Можна визначати лише один раз як безпосередній дочірній елемент вузла <document>.
- <section>
Розділ загального призначення. Можна використовувати довільну кількість разів як безпосередній дочірній елемент вузла <document>. Розділи, визначені цим теґом, розташовуватимуться у порядку їхнього визначення, але усі після розділу <usage> і перед розділом <settings>. Буде показано текст, що міститься у тезі <section>.
- id
Ідентифікатор, потрібний для переходу до цього розділу з панелі навігації (або за посиланням). Має бути неповторюваним у межах одного файла. Обов’язковий, не має типового значення.
- title
Заголовок розділу. Обов’язковий, не має типового значення.
- short_title
Короткий заголовок для панелі навігації. Необов’язковий, типовим значенням є повна версія заголовка.
- <settings>
Визначає розділ, який містить довідкові дані щодо різноманітних параметрів графічного інтерфейсу. Має сенс і використовується лише для сторінок довідки, пов’язаних із додатками. Використовується як безпосередній дочірній елемент вузла <document>. Може містити як дочірні елементи лише елементи <setting> і <caption>. Не має атрибутів.
- <setting>
Стосується окремого параметра у графічному інтерфейсі. Можна використовувати лише як безпосередній дочірній елемент елемента <settings>. У інтерфейсі буде показано текст, який міститься у цьому елементі.
- id
Ідентифікатор параметра у
.xmlдодатка. Обов’язковий, не має типового значення.- title
Додатковий заголовок параметра. Якщо не вказано (у більшості випадків рекомендовано не вказувати), заголовок буде запозичено з файла
.xmlдодатка.
- <caption>
Надпис для візуального групування декількох параметрів. Можна використовувати лише як безпосередній дочірній елемент елемента <settings>.
- id
Ідентифікатор відповідного елемента (типово <frame>, <page> або <tab>) у файлі
.xmlдодатка.- title
Додатковий заголовок надпису. Якщо не вказано (у більшості випадків рекомендовано не вказувати), заголовок буде запозичено з файла
.xmlдодатка.
- <related>
Визначає розділ, що містить посилання на додаткову пов’язану з темою інформацію. Завжди буде показано після розділу <settings>. Не має атрибутів. Буде показано текст, що міститься у тезі <related>. Типово, там має міститися список у форматі HTML. Рекомендовано для сторінок довідки з додатків, але не є обов’язковим. Можна визначати лише один раз, як безпосередній дочірній елемент вузла <document>.
- <technical>
Визначає розділ, що містить технічні дані, які не потрібні кінцевому користувачеві (зокрема про внутрішню структуру додатка). Цей розділ на сторінці довідки завжди буде показано останнім. Не має атрибутів. Показано буде текст, що міститься всередині теґу <related>. Не є обов’язковим і не рекомендується для більшості сторінок довідки з додатків. Можна визначати лише один раз як безпосередній дочірній елемент вузла <document>.
- <link>
Посилання. Може бути використано у будь-якому з описаних вище розділів.
- href
Адреса посилання. Зауважте, що можна використовувати декілька специфічних для RKWard адрес. Див. розділ щодо написання сторінок довідки, щоб дізнатися більше.
- <label>
Вставляє значення мітки інтерфейсу користувача. Може бути використано у будь-якому з описаних вище розділів.
- id
Ідентифікатор елемента у додатку, з якого слід скопіювати атрибут
label.
- <різноманітні теґи HTML>
У цих розділах можна використовувати більшість теґів HTML. Втім, не слід зловживати форматуванням вручну.