Оставить заявку

H&M User (Все сообщения пользователя)

Внимание! У нас сбои с почтовым сервером! Если не пришло письмо о регистрации или смене пароля напишите нам на info@techwriters.ru! 
@twriters
 obmen_soobsheniyami.pngчат для технических писателей в Telegram

 Зарегистрируйтесь
Выбрать дату в календареВыбрать дату в календаре

Страницы: Пред. 1 ... 3 4 5 6 7 8 9 10 11 12 13 След.
Создание пользовательского маркированного (нумерованного) списка со своим стилем в Help&Manual, как создать маркированный (нумерованный) список в Help&Manual.
 
[QUOTE]writer пишет:
Появляется новый стиль, но текст он маркированным не делает
[/QUOTE]Вы просто создаете новый стиль текста.
Маркированные, нумерованные и многоуровневые списки необходимо форматировать отдельно:

Как ссылаться на .chm справку из приложения по ключевому слову?, Обсуждаем процесс интеграция help-справки и программного обеспечения (F1)
 
[QUOTE]writer пишет:

так все работает, осталась еще вот какая проблема, при открытии файла справки, в левом фрейме отображается Указатель ключевых слов, а хотелось бы чтобы отображалось Содержание, как это можно настроить?
[/QUOTE]
Замените в исходнике шаблона фрейма адрес ссылки с  [B]<%HREF_INDEX_PAGE%> [/B]на [B]<%HREF_CONTENT_PAGE%>
[/B]
Поздравляем H&M User!!!
 
Спасибо большое-пребольшое!
В свою очередь, тоже сделаю ответный подарок - скоро выложу полную русскую версию H&M 6.5.1.2974. Ура!!!
Как изменить название топика в H&M, Как изменить название топика в H&M
 
Да, H&M автоматически меняет заголовок раздела (в редакторе) на введенное пользователем название раздела в TOC (для изменения достаточно нажать F2) - просто для удобства, но на самом деле название раздела и заголовок раздела - разные переменные.
Название раздела в TOC: [B]<%HEADING1%>...<%HEADING6%>[/B]
Заголовок раздела: [B]<%HEADINGLONG1%>...<%HEADINGLONG6%>[/B]

Изменено: H&M User - 30.06.2014 16:56:31
В какой папке хранить скриншоты в Help&Manual, В какой папке хранить скриншоты в Help&Manual
 
Для добавления к проекту папки, в котором осуществляется поиск изображений и сниппетов необходимо:
1. Открыть вкладку проекта [B]Configuration -> Common Properties -> Project Search Paths[/B];
2. Нажать на кнопку [B]Add Entry[/B];
3. В окне [B]Select Directory[/B] выбрать требуемую папку и нажать [B]ОК[/B];

Если есть несколько различных папок с изображениями, имеющими одни и те же названия, устанавливаем приоритет папки (кнопками [B]Move Up/Move Down[/B]).
Изменено: H&M User - 30.06.2014 16:22:24
Формат и названия изображений в Help&Manual, В каком формате вы сохраняете рисунки и изображения при разработке документации в Help&Manual
 
[QUOTE]writer пишет:

Есть у Help&Manual свой формат сохранения изображений, кто-нибудь им пользуется?[/QUOTE]

В комплекте с H&M идет графический редактор Impict, имеющий свой формат .IPP .
Данный формат позволяет сохранять текстовые объекты, активные области и свойства  в xml-файл, находящийся в той же папке, что и связанный ipp-файл.
Очень удобно для внесения изменений и автоматического перевода (не приходится править скриншоты), а также бывает полезно тогда, когда разработчик еще не определился с названиями объектов интерфейса, например - кнопок:


Изменено: H&M User - 30.06.2014 16:14:14
Глоссарий в Help&Manual, Как создать глоссарий Help&Manual
 
Оба варианта имеют право на существование.
[U]Для PDF:[/U]

Title: [B][SIZE=5]ГЛОССАРИЙ[/SIZE][/B]
Section Heading: [B][SIZE=5]- <%INDEXSECTION%> -[/SIZE]
[/B]Keyword Text: <%INDEXKEYWORD%> <%KEYWORDPAGENUMBERS%>
Second Level Keyword:   - <%INDEXKEYWORD2%>     <%KEYWORDPAGENUMBERS%>

При публикации превращается, к примеру, в:

[B][SIZE=5]ГЛОССАРИЙ[/SIZE][/B]

[B][SIZE=5] - О -[/SIZE][/B]
Описание 5,7,9
 -  программы    5
 -  интерфейса    7
 -  работы 9

[B][SIZE=5] - П -[/SIZE][/B]
Программа  5
 - описание  5

Данный вариант идеален для печатных руководств, а для HTML-справок автоматически формируется указатель, поэтому глоссарий, как мне кажется, не актуален.
Изменено: H&M User - 24.06.2014 15:49:04
Где прячутся переменные в Help&Manual, Где находятся переменные в Help&Manual
 
P.S.: Взято из русского файла справки.
Где прячутся переменные в Help&Manual, Где находятся переменные в Help&Manual
 
[TABLE]

[TR][TD]
<%AUTHOR%>

[/TD][TD]
Имя автора, определенное на странице Конфигурация > Общие свойства > Заголовок и авторские права.
[/TD][/TR]

[TR][TD]
<%COPYRIGHT%>
[/TD][TD]
Авторские права, определенные на странице Конфигурация > Общие свойства > Заголовок и авторские права.
[/TD][/TR]

[TR][TD]
<%DATE%>
[/TD][TD]
Текущая дата в коротком формате.
[/TD][/TR]

[TR][TD]
<%DATELONG%>
[/TD][TD]
Текущая дата в длинном формате.
[/TD][/TR]

[TR][TD]
<%HMFIGURECOUNTER%>
<%HMTABLECOUNTER%>
[/TD][TD]
[url=mk:@MSITStore:D:\Install\Help&Manual%206.1.0.2504\Help%20&%20Manual%206_RUS\Справка\HelpMan.chm::/hm_working_variables_countersref.htm]Переменные-счетчики[/url] для чисел и переменных. В отличии от определенных пользователем переменных-счетчиков, на эти переменные можно ссылаться, например "См. рисунок Х".
[/TD][/TR]

[TR][TD]
<%MONTHNAME%>
[/TD][TD]
Текущий месяц в длинном формате (то есть. Февраль, не фев. или 02).
[/TD][/TR]

[TR][TD]
<%NOW%>
[/TD][TD]
Текущая дата и время.
[/TD][/TR]

[TR][TD]
<%OUTPUTFILEDIR%>
[/TD][TD]
Абсолютный путь к текущей сборке (к файлу справки на компьютере пользователя) в стиле Windows, без наклонной черты влево.
[/TD][/TR]

[TR][TD]
<%OUTPUTFILENAME%>
[/TD][TD]
Имя файла справки, без пути к нему. Например, если Вы опубликовали в формате CHM, то это будет имя файла с расширением .CHM, если в формате HTML, то это будет имя основного файла HTML (обычно index.html, если Вы его не переименовали), и так далее.
[/TD][/TR]

[TR][TD]
<%OUTPUTFILEPATH%>
[/TD][TD]
Абсолютный путь к текущей сборке (к файлу справки на компьютере пользователя) в стиле Windows, включая наклонную черту влево.
[/TD][/TR]

[TR][TD]
<%SELF%>
[/TD][TD]
Имя текущего проекта, без пути и расширения.
[/TD][/TR]

[TR][TD]
<%SELFFULLNAME%>
[/TD][TD]
Имя текущего проекта, включая полный путь и расширение, как отображается в полосе заголовка Help & Manual. Может использоваться в документации о версиях.
[/TD][/TR]

[TR][TD]
<%SUMMARY%>
[/TD][TD]
Текст в поле "Сводка", определенный на странице Конфигурация > Общие свойства > Заголовок и авторские права.
[/TD][/TR]

[TR][TD]
<%TARGETTITLE%>
[/TD][TD]
Специальная переменная, используется в заголовках гиперссылок на темы. При использовании, вместо переменной будет вставлен заголовок целевой темы. Для получения дополнительной информации, см. [url=mk:@MSITStore:D:\Install\Help&Manual%206.1.0.2504\Help%20&%20Manual%206_RUS\Справка\HelpMan.chm::/hm_working_links_inserting.htm]Вставка ссылок на тему[/url].
[/TD][/TR]

[TR][TD]
<%TIME%>
[/TD][TD]
Текущее время в коротком формате.
[/TD][/TR]

[TR][TD]
<%TIMELONG%>
[/TD][TD]
Текущее время в длинном формате.
[/TD][/TR]

[TR][TD]
<%TITLE%>
[/TD][TD]
Текст в поле "Заголовок справки", определенный на странице Конфигурация > Общие свойства > Заголовок и авторские права.
[/TD][/TR]

[TR][TD]
<%TOPICHELPCONTEXT%>
[/TD][TD]
Номер контекста справки, связанный с текущей темой.
[/TD][/TR]

[TR][TD]
<%TOPICLASTEDITED%>
[/TD][TD]
Дата последнего редактирования темы, содержащей переменную, в коротком формате.
[/TD][/TR]

[TR][TD]
<%TOPICLASTEDITEDTIME%>
[/TD][TD]
Время последнего редактирования темы, содержащей переменную.
[/TD][/TR]

[TR][TD]
<%TOPICLASTEDITEDUSER%>
[/TD][TD]
Имя пользователя, отредактировавшего текущую тему (наверно, тоже, содержащую эту переменную (от меня)).
[/TD][/TR]

[TR][TD]
<%TOPICMETA:NAME%>
[/TD][TD]
Специальная переменная, использующаяся только в темах. Вставляет значения мета тэгов, добавленных в исходный код XML файла темы. В настоящее время важно только для импорта проектов Sandcastle, где Help & Manual вставляет мета тэг с хеш значением, для проверки, были ли изменены существующие темы. (Просмотрите исходный код XML, импортированной темы из проекта Sandcastle). Будет работать с вставленными Вами в код XML мета тэгами.
Использование: Замените "NAME" именем мета тэга XML.
[/TD][/TR]

[TR][TD]
<%TOPICSTATUS%>
[/TD][TD]
[url=mk:@MSITStore:D:\Install\Help&Manual%206.1.0.2504\Help%20&%20Manual%206_RUS\Справка\HelpMan.chm::/hm_working_toc_icon.htm]Статус[/url] текущей темы.
[/TD][/TR]

[TR][TD]
<%VERSION%>
[/TD][TD]
Автоматически генерирует объединенный код версий Основная версия, Сокращенная версия и Версия сборки, с точкой между версиями. Например, если Основная версия=3, Сокращенная версия=25 и Версия сборки=329, то переменная <%VERSION%> будет равна 3.25.329.
[/TD][/TR]

[TR][TD]
<%VERSION_BUILD%>
[/TD][TD]
Текст в поле "Версия сборки", определенный на странице Конфигурация > Общие свойства > Заголовок и авторские права.
[/TD][/TR]

[TR][TD]
<%VERSION_MAJOR%>
[/TD][TD]
Текст в поле "Основная версия", определенный на странице Конфигурация > Общие свойства > Заголовок и авторские права.
[/TD][/TR]

[TR][TD]
<%VERSION_MINOR%>
[/TD][TD]
Текст в поле "Сокращенная версия", определенный на странице Конфигурация > Общие свойства > Заголовок и авторские права.
[/TD][/TR]

[TR][TD]
<%YEAR%>
[/TD][TD]
Текущий год (в четырех-цифровом формате (2013))
[/TD][/TR]

[/TABLE]
Текстовые переменные можно использовать в любом месте. Переменные HTML то же можно использовать в любом месте, но нужно посмотреть, будут ли они там работать. В выходных форматах, не основанных на HTML (PDF, RTF, печатные руководства), текстовая часть переменных будет извлечена автоматически.

[LEFT]
[TABLE]

[TR][TD] Расположение: [/TD][TD] Поддержка переменных: [/TD][/TR]

[TR][TD]
Текст и заголовок темы
[/TD][TD] Переменные простого текста:
Глобальные предопределенные переменные и определяемые пользователем переменные, вставленные при помощи инструмента Вставить текстовую переменную [IMG WIDTH=14 HEIGHT=14]http://techwriters.ru/forum/forum636/topic19758/btn_insert_variable.png[/IMG] на вкладке Запись > Вставить объект:
<%VARIABLE_NAME%>
Примечание: переменные, введенные вручную, не подсвечиваются в редакторе и двойной щелчок по ним, не будет открывать список выбора переменных.
Переменные HTML:
Переменные HTML, вставленные в этих местах, вставят только текстовую часть кода HTML. Например, если переменная содержит:
<a href="http://www.helpandmanual.com>EC Software Website</a>
будет вставлено только "EC Software Website". Весь код HTML (синий) будет удален.  Если не будет текстовой части, то ничто не будет вставлено.
[/TD][/TR]

[TR][TD]
TOC, ключевые слова, заголовок изображения, заголовок ссылки, макрос в ссылке на макрос
[/TD][TD] Переменные простого текста:
Глобальные предопределенные переменные и определяемые пользователем переменные, вставленные вручную, путем ввода имени переменной.
Переменные HTML:
Переменные HTML, вставленные в этих местах, вставят только текстовую часть кода HTML (см. пример выше).  Если не будет текстовой части, то ничто не будет вставлено.
[/TD][/TR]

[TR][TD]
Объекты кода HTML и скрипты в ссылках на скрипт
[/TD][TD] Переменные простого текста:
Глобальные предопределенные переменные и определяемые пользователем переменные, вставленные вручную, путем ввода имени переменной.
Важно: Нельзя использовать [url=mk:@MSITStore:D:\Install\Help&Manual%206.1.0.2504\Help%20&%20Manual%206_RUS\Справка\HelpMan.chm::/hm_ref_variables_html.htm]Переменные шаблона HTML[/url] в объектах кода HTML или ссылках на скрипт, потому что объекты кода анализируются вместе с контентом темы, прежде, чем они будут вставлены в шаблон.
Переменные HTML:
Можно использовать переменные HTML в объектах кода HTML и скрипты в ссылках на скрипт. Однако, не используйте переменные шаблона HTML в качестве части значения переменной, потому что они не будут анализироваться (см. выше).
[/TD][/TR]

[TR][TD]
Шаблоны HTML
[/TD][TD] Переменные простого текста:
Глобальные предопределенные переменные, определяемые пользователем переменные и специальные переменные шаблона HTML, вставленные вручную, путем ввода имени переменной.
Переменные HTML:
Можно использовать переменные HTML в шаблонах HTML без ограничений. Код HTML, сохраненный в переменной, будет вставлен в шаблон. Здесь можно использовать [url=mk:@MSITStore:D:\Install\Help&Manual%206.1.0.2504\Help%20&%20Manual%206_RUS\Справка\HelpMan.chm::/hm_ref_variables_html.htm]переменные шаблона HTML[/url] как часть значения переменной HTML.
[/TD][/TR]

[TR][TD]
Шаблоны PDF отредактированные в Print Manual Designer
[/TD][TD] Переменные простого текста:
Глобальные предопределенные переменные, определяемые пользователем переменные и специальные переменные шаблона PDF, вставленные вручную, путем ввода имени переменной.
Переменные HTML:
Переменные HTML вставят только текстовую часть значения переменной в шаблон PDF. Если не будет текстовой части, то ничто не будет вставлено.
[/TD][/TR]

[/TABLE]
[/LEFT]
Всплывающие посказки в Help and Manual
 
Для компиляции необходимо использовать HM6-OnlineHelp-Webhelp+CHM.hmskin (для версии 6+).
P.S.: Стало самому интересно - импортировал, скомпилировал - все отлично! (было 2 предупреждения, что имеются ссылки во внешний файл Helpman_XML_Ref.chm, но так и должно быть).
Изменено: H&M User - 28.04.2014 14:35:19
Вопрос по формулировке ("При этом")
 
При использовании возвратных форм глагола конструкции "при этом", "в результате" и т.п. применяются только при явном указания объекта, выполняющего действие. Например: "При этом, Системой автоматически выполняется сохранение данных...". В данном примере "при этом" - смысловое обозначение предыдущей выполненной операции, а текст после него - результат.
Экспорт H&M > Confluence
 
[QUOTE]ADVANCED пишет:
Dita может. Недавно пользовался.
В крайнем случае можно написать свой парсер и XSL-преобразования в формат confluence, если H&M может хранить файлы в текстовом виде.
[/QUOTE]

H&M это всего лишь графическая оболочка для dita-like технологии.

Проект H&M (необходимо сохранить проект в формат uncompressed или распаковать hmxz - обычный zip-файл) это три файла:
- [B]Project.hmxp [/B]- xml-файл проекта (содержит настройки, описания, содержимое проекта и т.д.) - для передачи в confluence не нужен;
- [B]helpproject.xsd[/B] - XML Schema проекта;
- [B]helpproject.xsl[/B] - содержит css-стили, скрипты и тимплейты проекта;
и папки проекта:
- [B]Baggage[/B] - содержит подключаемые файлы проекта;
- [B]Maps[/B] - содержит [B]table_of_contents.xml[/B] (toc-файл проекта);

- [B]Topics[/B] - содержит все файлы проекта в формате xml, а также дополнительные папки для xml-файлов, не входящих в toc:
Изменено: H&M User - 15.04.2014 15:53:54
Облако тэгов или что-то подобное в WebHelp с помощью H&M (Help&Manual), Облако тегов в Help Manual
 
Для H&M IndexList - это список ключевых слов Keyword Index.
Для WEB и HTML-Help это переменная [B]<%KEYWORD_INDEX%>.[/B]
Для PDF:
Master Keyword [B]<%INDEXKEYWORD%>[/B]
Subkeyword [B]<%INDEXKEYWORD2%>[/B]
ссылка на ключевое слово [B]<%KEYWORDPAGENUMBERS%>[/B]

Для создания Keyword Index используется IndexTool:

либо прописывается вручную (табуляция для обозначения subkeywords) на вкладке Topic Options в поле Keywords:
Изменено: H&M User - 03.04.2014 13:38:54
Отличия H&M от других подобных инструментов, Обсуждаем отличие программы Help Manual
 
[QUOTE]nerved пишет:
Подскажите, пожалуйста, насколько я понял в H+M можно составлять различные варианты документации для разных клиентов из единого источника. А можно ли эти варианты кастомизировать или профилировать каждый конкретный раз? Например, менять стиль отображения или логотипы-названия в одном месте, чтобы это затрагивало потом весь документ?
[/QUOTE]
Изменять стили изображений или логотипы в источнике можно, но не нужно.
При выпуске документации для разных клиентов из единого источника в H&M используется Task Manager.
Для каждого варианта документации создаем задачу, в которой указываем выходной формат, путь и имя файла, используемый шаблон (лучше для каждого клиента создать свой, если используется PDF), а также используемые переменные для задачи (например, имя файла логотипа для HTML, текстовые переменные фамилий на титульных листах для PDF и т.д.).
Стили текста в Print Manual Designer
 
[QUOTE]tech_writer_1 пишет:
Использую Print Manual Designer для настройки макета PDF. Обнаруживаю, что текст, который я здесь ввожу, не связан со стилями, используемыми в проекте. Допустим, у меня в проекте настроен стиль заголовка Heading1, а тут в заголовке я прописываю переменную <%HEADING1%> и указываю для этого блока текста форматирование вручную. А хочется, чтобы заголовок соответствовал стилю Heading1 из проекта. Можно такое сделать?
[/QUOTE]

Нет. Стили форматирования в H&M никак не связаны с форматированием шаблонов PDF в Print Manual Designer.
Ищу работу техническим писателем
 
40-80, м. Беговая
Создание интерактивных схем с всплывающими пояснениями, поддержкой ссылок и печатью
 
Создание интерактивных схем с всплывающими пояснениями, поддержкой ссылок и печатью
 
[QUOTE]ADVANCED пишет:
Попытался сохранить в HTML - не выходит:java.lang.OutOfMemoryError: Not enough memory for temporary image of size 14840x13495 (191MPixels).

[/QUOTE]
А каков размер файла и сколько оперативы? Помню, когда обрабатывал снимок города из космоса - скушало 6Гб :)
Создание интерактивных схем с всплывающими пояснениями, поддержкой ссылок и печатью
 


Если схема большая - необходимо разрезать.
Хотя, можно вставить и SWF, но только как видео  :(
Изменено: H&M User - 14.03.2014 15:18:40
Создание интерактивных схем с всплывающими пояснениями, поддержкой ссылок и печатью
 
Идеальным инструментом для такого рода задач считаю H&M. Сначала рисую схему в yEd или Aris Express (бесплатный и BPMN там красивее)



затем создаю проект в H&M, вставляю схемы и редактирую хотспоты - указываю ссылки на топики, делаю скрипты или вывожу всплывающие подсказки с любой информацией


и экспортирую в html или chm (в примере во всплывающем окне показан путь обработки условия и дополнительная информация).


Быстро, просто и удобно... Тем более, что html и откроется везде и любой топик можно распечатать...
Ссылки на якоря
 
Скрытый текст
Да, как-то так (+ анимация), а со знанием javascript ситуация такая же  :)
Изменено: H&M User - 13.03.2014 11:59:09
Ссылки на якоря
 
В принципе, правильней будет использовать встроенные функции H&M.
Например, чтобы открыть/закрыть все toggle's достаточно в скрипт-линке указать [B]jav * ascript:HMToggleExpandAll(!HMAnyToggleOpen())[/B]
Лаконично и удобно... Осталось разобраться с передаваемыми параметрами [B]HMToggleExpand[/B], чтобы при ссылке открывать интересующий нас toggle по ID (тот, в котором находится наш якорь).
Изменено: H&M User - 11.03.2014 16:41:29
Ссылки на якоря
 
При вставке ссылки на якорь вызываем свою функцию:[CODE] $(function (){ $("h2.subsubtitle a").click(function (){ var jDiv = $(this).parent().siblings("div:last"); if( jDiv.is(":visible") ){ jDiv.hide("slow");} else{ jDiv.show("slow");} return true;}); });[/CODE]
Почитать можно здесь:
[url]http://stackoverflow.com/questions/11974163/jquery-toggle-jump-to-toggle-at-named-anchor-and-open-it[/url]
[url]http://stackoverflow.com/questions/7320727/jquery-toggle-anchor-links?rq=1[/url]
[url]http://stackoverflow.com/questions/652049/mixing-jquerys-toggle-with-anchors?rq=1[/url]
Изменено: H&M User - 11.03.2014 15:13:06
Ссылки на якоря
 
На форуме H&M для версии 5.1.1 пользователь ankuram выкладывал скрипт для проверки нахождения якоря внутри скрываемого текста. Тем не менее, данный код также не работает без использования Premium Pack'а.  :(   [CODE]<sc ript>function checkAnchorInsideToggle() { var anchor = ""; var anchorName = ""; if (location.href.lastIndexOf("#") != -1) { anchorName = location.href.substring(location.href.lastIndexOf("#")+1, location.href.length); } if (anchorName) { var anchorElements = document.getElementsByTagName("a"); var theAnchorElement = null; for (var i = 0; i < anchorElements.length; i++) { if (anchorName == anchorElements[i].name) { theAnchorElement = anchorElements[i]; } } var theParent = theAnchorElement.parentNode; while(theParent) { if ( (theParent.tagName == "TABLE") && (theParent.id.lastIndexOf("TOGGLE") === 0) ) { HMToggle('toggle',theParent.id,'$' + theParent.id + '_ICON'); } theParent = theParent.parentNode; } window.setTimeout("location.hash = '" + anchorName + "'", 250); }}function addEvent( obj, type, fn ){ if (obj.addEventListener) obj.addEventListener( type, fn, false ); else if (obj.attachEvent) { obj["e"+type+fn] = fn; obj[type+fn] = function() { obj["e"+type+fn]( window.event ); } obj.attachEvent( "on"+type, obj[type+fn] ); }}addEvent(window, "load", checkAnchorInsideToggle);</sc ript>[/CODE]
Изменено: H&M User - 11.03.2014 11:52:09
Ссылки на якоря
 
Проблема якорей в свернутом тексте - проблема самого формата, так как якоря для текущей страницы генерируются только при ее открытии. Сами разработчики H&M рекомендуют иcпользовать Premium Pack, в нем эта проблема была решена. С решением Вы правы - использование скриптов.
Пробую ковырять, но выдранный скрипт пока не работает.
P.S.: Если повесить на ссылку автоматическое открытия блока со скрытым текстом - то работает только 1 раз.
Изменено: H&M User - 11.03.2014 11:54:53
Страницы: Пред. 1 ... 3 4 5 6 7 8 9 10 11 12 13 След.

Рейтинг@Mail.ru