Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
структура топика Task
 
Задача такая: В своих ранних word-руководствах я придерживалась следующей структуры:

  1. Текст текст текст.
  2. Текст текст текст:
o  Подтекст подтекст подтекст;
      o  Подтекст подтекст подтекст:
  • подпод текст;
  • подпод текст.
А в топике Task есть только <step> и <substep>...я сделала специализацию и с <subsubstep> - но хотелось бы без специализации, так как я новичок и не хочется лишний раз отклоняться от изначальной структуры топиков. Как мне запихать ещё шаги в <substep>, не меняя текст и не прибегая к специализации?
Изменено: TechW - 29.05.2014 16:50:53
 
Недовольна специализацией только потому что XMLMind не показывает специализированный топик в "пользовательском" режиме, только xml-код. Ну и боюсь дальнейших осложнений.
Наверное нужно делать выбор или "неизведанная до конца специализация" или "без подпод текста".
 
В принципе, в Substep можно сделать внутренние шаги. Для этого нужно добавить тег itemgroup, а в него вставить ol или ul.
Другой вопрос, что я не советую так делать. Использование в шагах двух уровней вложенности придумано не просто так. Это просто поначалу непривычно. Как правило, если описание требует более 2 уровней, следует начиная со второго уровня делать для описания отдельные Task-топики. Это исключит появление проблем с созданием ссылок на описание шага из какого-либо другого места справки или документа.
 
Спасибо, Елена. ol  и ul не рассматривала,так как у них все-таки другая смысловая нагрузка (списки, а не действия). Да, пока постараюсь без специализации.
 
3 уровня списков/шагов не рекомендуется делать из-за проблем восприятия текста (как русского, так и иностранных текстов). Лучше поиграться с иерархией топиков и заголовков.
Изменено: ADVANCED - 26.06.2014 11:17:45
 
Если принципиально описывать шаги как step/substep, можно изменить иерархию в тексте и в топиках.

Предполагаемый третий уровень сделать  substep, второй step,  а первый сделать заголовком task и поместить его внутрь исходного TASK.

В один TASK можно вставить несколько других TASK. Например, TASK, имеющий внутри себя 5 task равносильно файлам в ditamap, расположенным как "раздел" и 5 "подразделов", Такой вариант удобен тем, что можно сохранять всю тему в одном физическом файле, а не в разрозненных мелких и не путаться в файловой системе с названbzvb файлов.

К тому же если будут использоваться фильтры ditaval, в таком топике проще поставить параметры фильтров (и забыть про них), чем в каждой карте ditamap.  
 
 
Цитата
ADVANCED пишет:


В один TASK можно вставить несколько других TASK.
Действительно можно! Иногда действительно удобнее в одном файле разные варианты настройки одной и той же фичи описывать, например. Спасибо! Интересно только, как тулкит это проглотит. Придется наверно стиль донастраивать.
 
Цитата
Elena пишет:
Цитата
ADVANCED пишет:


В один TASK можно вставить несколько других TASK.
Действительно можно! Иногда действительно удобнее в одном файле разные варианты настройки одной и той же фичи описывать, например. Спасибо! Интересно только, как тулкит это проглотит. Придется наверно стиль донастраивать.
Нет, не придется (при условии, что заголовки H1,H2,H3...уже настроены. Он воспринимает вложенные топики/таскии/концепты,  аналогично топикам/таскам/концептам, которые вставлены в ditamap на уровень ниже исходного (редактируемого).

Т.е. для тулкита разницы нет, двухуровневая иерархия сделана в ditamap или в топике. Для писателя есть, как писал выше, удобство сохранения описаний шагов/операций в одном файле.
 
Также можно помещать карту (ditamap) внутрь другой карты (ditamap), за исключением bookmap в bookmap. Иерархия также будет наследоваться и доп.настроек не нужно.  

Например, есть четко выстроеная последовательность шагов, которую можно добавлять в несколько книг из года в год. Создается одна карта для описания этой последовательности, а в нее добавляются файлы с описанием каждого шага (или один сложный топик/концепт/таск).
Потом эту карту (ditamap) можно вставлять в другие карты на любой уровень. Либо использовать самостоятельно, например, как use-case в отдельной книге, со своей обложкой и колонтитулами. Нумерация  и стили  от этого не страдают. Если карта вкладывается внутрь другой карты, то все данные, которые должны были пойти на титульный лист игнорируются, а на титульный лист идет информация из главной карты.

DITA создана специально для структурирования блоками (блок, блок в блоке, пять блоков в блоке, блок в пяти блоках и т.д. )  ;)
Страницы: 1
Читают тему