Оглавление для подкарты DITA

Я недавно наткнулся на DITA и дурачился с ним, чтобы оценить, будет ли он применим для наших внутренних потребностей в документации. Я пытаюсь понять (и узнать), как правильно структурировать документ. Моя первоначальная настройка выглядит примерно так:

MainMap.ditamap:

<map>
  <mapref href="submap-1.ditamap"/>
</map>

SubMap-1.ditamap:

<map>
  <topichead navtitle="Topic Title 1">
    <topicref href="topic1.dita"/>
    <topicref href="topic2.dita"/>
  </topichead>
</map>

Когда я конвертирую это в HTML, я получаю список следующих HTML:

  • toc.html
  • mainmap.html
  • topic1.html
  • topic2.html

toc.html выглядит так:

Содержание

  • Topic Title 1
    • topic1
    • topic2

Итак, я не понимаю одного: «Заголовок темы 1» также является ссылкой, и он связан с mainmap.html, который просто содержит заголовок, что делает его совершенно бесполезным. Я ожидал (или хотел бы :)), что «Заголовок темы 1» не будет ссылкой, или, если это так, он будет ссылаться на страницу с оглавлением для подкарты.

  • Возможно ли оглавление для субкарт?
  • Should I structure the submaps differently so that the topic title would be more useful? Instead of using topichead, use topicref to a topictitle.dita with summary content and TOC-like list?
    • It would be a bit cumbersome to maintain that list. Is there a way to do this automatically?
  • Преобразовать основную карту как страницу с несколькими HTML, а подкарту как страницу с одним HTML? Это возможно?

Кстати, я пробую ознакомительную версию XMLMind XML Editor - Professional Edition. Также приветствуются предложения в редакторе с точки зрения улучшения функциональности / удобства использования / доступности. :)

Спасибо за помощь!


documentation xmldocument documentation-generation dita
person blissfool    schedule 17.06.2011    source источник

Ответы (2)


arrow_upward
1
arrow_downward

Оглавления для подкарт могут быть сгенерированы, это зависит от процессора; XMLMind XML Editor использует XMLmind DITA Converter для обработки DITA.

Семантически элемент должен просто генерировать новый иерархический уровень с заголовком. XMLMind DITA Converter, похоже, обрабатывает это, как если бы тема была только для заголовка. Например, DITA Open Toolkit (DITA-OT) будет генерировать только заголовок в оглавлении, а не автоматически сгенерированный «обзорный» раздел.

Опять же, для DITA-OT, если вы используете вместо этого с обзорной темой, дочерние ссылки на вложенные темы будут сгенерированы автоматически, поэтому вам не нужно поддерживать их вручную. Посмотрите, верно ли это и для XMLMind DITA Converter.

WRT. редакторы для DITA, я лично предпочитаю oXygen XML Editor. Его могут использовать как разработчики, так и технические писатели, он находится в стадии активной разработки и вполне доступен.

person jelovirt    schedule 24.06.2011
comment
Спасибо! На самом деле я находился в процессе оценки редактора XML oXygen. Как вы упомянули, я тоже предпочитаю oXygen XML Editor, но мне кажется, что мне нужно немного поработать, чтобы стилизовать документ. Выводит ли он стиль DITA-OT по умолчанию? Как мне настроить обзорную тему? И есть ли какие-нибудь стили шаблона, которые я мог бы применить? (Я новичок в этой сфере, поэтому прошу прощения, если говорю не в правильной терминологии или контексте.) Спасибо! - person blissfool; 27.06.2011

arrow_upward
0
arrow_downward

Чтобы просмотреть содержимое подкарты-1 в виде HTML-файла, преобразуйте ее из цифровой карты в тему.

person Avi Aharon    schedule 26.08.2012