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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Контроль битых внешних ссылок
 
Не могу понять как проконтролировать корректность внешних ссылок на CHM (или hmxp) файл. Когда только ввожу ссылку - если ссылка не обнаруживается, то H&M сообщает об этом, но все равно позволяет сохранить. А как можно проконтролировать после? Есть какой то отчет для этого?
 
Во-первых, в настройках программы есть опция, позволяющая выбрать возможность использования "мертвых" ссылок (выделяются в редакторе красным).

Silently include linked topic - Добавлять ссылку на тему без подтверждения;
Remove link - Удалить ссылку;
Allow links to be dead - Разрешить использование мертвых ссылок.

Во-вторых, при компиляции проекта, в окне сообщений компилятора будут перечислены ссылки на темы, не включенные в проект (включая мертвые):


В-третьих, в полном отчете по проекту (Report Tool->Full Report including Image Reference), все мертвые ссылки отмечаются полужирным шрифтом красного цвета и не имеют ссылок:
 
Изменено: H&M User - 12.05.2015 12:10:13
 
Я так понимаю это касается только внутренних ссылок - то есть ссылок внутри этого проекта (на вашем скриншоте именно такая).
Если идет ссылка на другой hmxp проект, то битая ссылка красным не выделяется, и в отчет не попадает.
 
В отчет она все равно попадает, но да, Вы правы: не имеет ссылки, но выделяется синим цветом вместо голубого:

Как Вы вставляете ссылку на тему другого проекта?
Либо из дочернего проекта путем переноса темы (Merged Projects):

либо вставкой ссылки на тему другого проекта (выбор темы из списка):


Ошибки в обоих случаях - исключены (в виде мертвых ссылок). Да, Вы можете добавлять ссылки на несуществующие темы, но тогда в настройках программы по использованию ссылок выберите опцию удалять ссылки (Remove link).В таких случаях H&M предупреждает об отсутствии темы:
 
Изменено: H&M User - 12.05.2015 17:12:41
 
Это все понятно.
Но вот я сейчас в процессе импортирования из CHM файла, компилированного в Robohelp и всплывают некоторые нюансы. Я могу править ссылки не только средствами H&M, но и например через стороннее ПО (AkelPad) - чтобы массово исправить некорректно импортированные ссылки.
Во вторых, я могу в файле на который ссылаюсь что-то поменять - например название топика. И поэтому логично что хотелось бы это контролировать в виде отчета. Сейчас же H&M генерирует огромный отчет с указанием всех внешних ссылок, но не контролирует их корректность, хотя в случае с подключением к файлу hmxp он бы это легко cделать.
 
Я так понимаю такой возможности пока нет?
Есть смысл ожидать функционал?
 
Большого смысла в контроле корректности, ожидаемой Вами, нет. Сообщения компилятора + тест ссылок + отчет = достаточно. Никогда таких проблем не возникало, если использовать правильную интуитивную структуру и именование. Если же ссылки ведут на внешние ресурсы, контролируемые не Вами, то за корректность Вы просто не отвечаете.
 
Цитата
Ingvar написал:
Это все понятно.
Но вот я сейчас в процессе импортирования из CHM файла, компилированного в Robohelp и всплывают некоторые нюансы. Я могу править ссылки не только средствами H&M, но и например через стороннее ПО (AkelPad) - чтобы массово исправить некорректно импортированные ссылки.
Во вторых, я могу в файле на который ссылаюсь что-то поменять - например название топика. И поэтому логично что хотелось бы это контролировать в виде отчета. Сейчас же H&M генерирует огромный отчет с указанием всех внешних ссылок, но не контролирует их корректность, хотя в случае с подключением к файлу hmxp он бы это легко cделать.

Неужели импорт из CHM предпочтительнее импорта из проекта Robohelp?
 
 
Цитата
H&M User написал:
Если же ссылки ведут на внешние ресурсы, контролируемые не Вами, то за корректность Вы просто не отвечаете.
Не обязательно. Да, другой раздел может написать другой человек, но я должен проконтролировать что в скомпилированной справки все корректно и для этого мне нужен такой инструмент.


Цитата
H&M User написал:
Сообщения компилятора + тест ссылок + отчет = достаточно.
Я бы не стал утверждать что куча бесполезных сообщений о том что какая-то ссылка ведет к внешнему файлу является достаточным решением. Скорее наоборот - найти ошибочные сообщения в этом мусоре гораздо сложнее. Если же был бы контроль внешних ссылок, и ссылка была корректной, то и сообщение можно было бы не выводить что упростило бы навигацию в окне сообщений компилятора.


Цитата
H&M User написал:Неужели импорт из CHM предпочтительнее импорта из проекта Robohelp?
К сожалению да. При импорте из Robohelp не импортируются Map ID (в терминологии H&M - Context ID).
И в любом случае это не имеет отношения к моему вопросу.
Изменено: Ingvar - 19.05.2015 20:15:17
 
Цитата
Ingvar написал:
Есть смысл ожидать функционал?
Ожидать не стоит. Такой функционал реализован в виде автоматической обработки ссылок при компиляции (подключать без подтверждения, удалять или оставлять нерабочие ссылки). Разработчики считают это достаточным.
 
Страницы: 1
Читают тему