Как сделать ссылку из документа Sphinx в файл CHM?

Как я могу связать документ Sphinx с файлом CHM?

Кажется, я мог бы связать один файл chm с другим, используя синтаксис вроде

<a href="ms-its:path+filename.chm::/pagename.htm">

Можно ли передать это в команды Sphinx?


person tfv    schedule 27.09.2016    source источник
comment
Вы хотите использовать команду сборки, например make html и ссылку из темы HTML на специальную тему pagename.htm из filename.chm? ИЛИ вы хотите использовать make htmlhelp и связать полученный откомпилированный модуль справки (файл CHM) на специальную тему pagename.htm в другом filename.chm?   -  person help-info.de    schedule 28.09.2016
comment
В конце концов, я хочу сделать и то, и другое: я хочу иметь концепцию, которая позволила бы в полной мере использовать файлы chm в Sphinx, то есть использовать их во всех возможных выводах. На данный момент я был бы рад, если бы один из них заработал.   -  person tfv    schedule 29.09.2016


Ответы (1)


Вы знаете, что открыть тему, скомпилированную в CHM, можно только в Microsoft Internet Explorer (!), Добавив следующий код в HTML-файл:

<p>Sample of CHM link to a topic in a compiled help file that is stored on a local computer</p>
<!-- To link to a topic in a compiled help file that is stored on a local computer, create a link using the following syntax:  -->
<A HREF="ms-its:D:\UserData-Sphinx\CHM-example.chm::/garden/garden.htm">Link to Garden topic here</a>

Думаю, парсер reStructuredText не может передавать эти особые ссылки из источника (reST).

Но вы можете использовать Replacement Text, как показано ниже. Обратите внимание, что обратная косая черта используется дважды:

================
Replacement Text
================

I recommend you try |HTMLHelp|_ and continue compiling help in CHM file format.

.. |HTMLHelp| replace:: CHM, *the* best help format around
.. _HTMLHelp: ms-its:D:\\UserData-Sphinx\\CHM-example.chm::/garden/garden.htm

Директива replace используется для указания текста замены для ссылки на замену. Его можно использовать только в определениях замены.

Полученное представление файла HTML:

введите описание изображения здесь

Скомпилированная справка CHM:

введите описание изображения здесь

Тема garden.htm отображается на панели тем средства просмотра справки после нажатия ссылки:

введите описание изображения здесь

Вы можете загрузить использованный выше CHM-example.chm файл с моего информационного сайта HTMLHelp (HH) см. Раздел загрузки или загрузите CHM.

Обратите внимание: чтобы открыть этот файл CHM, щелкните сохраненный файл правой кнопкой мыши, выберите «Свойства», а затем нажмите «Разблокировать».

person help-info.de    schedule 14.10.2016
comment
Выглядит неплохо, хотя было бы неплохо иметь и решение для firefox. - person tfv; 18.10.2016