Windows Help files - каковы опции?
Другим вариантом является перенос JSON-демпинга в свой класс:
import json
class FileItem:
def __init__(self, fname):
self.fname = fname
def __repr__(self):
return json.dumps(self.__dict__)
Или, что еще лучше, подклассификация класса FileItem из класса JsonSerializable:
import json
class JsonSerializable(object):
def toJson(self):
return json.dumps(self.__dict__)
def __repr__(self):
return self.toJson()
class FileItem(JsonSerializable):
def __init__(self, fname):
self.fname = fname
Тестирование:
>>> f = FileItem('/foo/bar')
>>> f.toJson()
'{"fname": "/foo/bar"}'
>>> f
'{"fname": "/foo/bar"}'
>>> str(f) # string coercion
'{"fname": "/foo/bar"}'
10 ответов
HTML был бы следующим лучшим выбором, ТОЛЬКО ЕСЛИ Вы будете служить им с сервера государственной сети. Если Вы пытались связать его своим приложением, все файлы (и изображения (и таблицы стилей (и...))) заставят CHM быть похожим на подарок от богов.
Однако когда на самом деле связано в пакете установки, (вместо того, чтобы быть обслуженным по сети), я нашел, что файлы CHM работали приятно.
OTOH, другая ловушка о файлах CHM: Даже при попытке открыть файл CHM на локальный диск, можно врезаться в блок безопасности при начальной загрузке его с где-нибудь потому что файл мог быть отмечен, как это "прибыло из внешнего источника", когда это было получено.
Наше программное обеспечение и распределено локально клиентам и вручено от сетевого ресурса. Мы выбрали генерацию и файл CHM и ряд файлов HTML для обслуживания от сети. Пользователи, запускающие программу локально, используют файл CHM, и пользователи, получающие их программу, врученную от сетевого ресурса, должны использовать файлы HTML.
Мы используем Справка и Руководство и можем таким образом легко произвести оба типа вывода из того же исходного проекта. Файлы HTML также содержат ищущие возможности, и не требует веб-сервера, поэтому хотя это не оптимальное решение, хорошо работает.
До сих пор все однофайловые типы для Windows кажется поврежденным так или иначе:
- WinHelp - (CHM) obsoleted
- HtmlHelp - obsoleted на Vista, не работает от сетевого ресурса, кроме этого работы, действительно хорошие
- Microsoft Help 2 (HXS) - это, кажется, работает правильно вплоть до точки, когда это не делает, поврежденные индексы или подобный, это используется Visual Studio 2005 и выше как пример
Если Вы не хотите использовать установщик, и Вы не хотите, чтобы пользователь выполнил какие-либо дополнительные шаги, чтобы позволить файлы CHM по сети, почему бы не отступить к WinHelp? Vista не включает WinHlp32.exe из поля, но это в свободном доступе как загрузка и для Vista и для Сервера 2008.
Это зависит от того, как импорт, который онлайн-документация к Вашему продукту, хорошая инфраструктура документации, может быть сложным для установления, но когда-то сделанный это окупается. Вот то, как мы делаем это -
- источник Справки DITA compilant XML, сохраненный в SCC (ClearCase).
- Справка, редактируя компиляция Справки XMetal
- , настроенная , Открывают DITA Toolkit, с пользовательским Perl/Java, предварительно обрабатывающим
- исходные ресурсы приложений перекрестных ссылок Справки во время компиляции.RC файлы и т.д.
- результаты Справки из единственного источника, PDF, CHM, Справка Eclipse , HTML.
- Единственный исходный репозиторий производит справку для нескольких продуктов 10 + с тысячами общих тем.
Из того, что Вы описываете, я посмотрел бы на Справку Eclipse, не простой интегрироваться в.NET или приложения MFC, в основном необходимо сделать справку, отображающуюся, чтобы разрешить, что запрос к URL тогда запускает URL в обертку Справки Eclipse или браузер.
Состоит в том вопрос, как генерировать Ваши собственные справочные файлы, или каков лучший формат справочного файла?
Лично, я нахожу, что CHM превосходен. Одна из первых вещей, которые я делаю при установке машины, состоит в том, чтобы загрузить Руководство PHP в формате CHM ( http://www.php.net/download-docs.php ) и добавить горячую клавишу к ней в Темно-красный Редактор . Таким образом, когда я нажимаю F1, он загружает CHM и выполняет поиск слова, мой курсор идет (большой для быстрой ссылки на функцию).
При выполнении "просто извлечения и выполненные", Вы собираетесь работать в проблемах безопасности. Это особенно верно, если Вы - пользователи, выполняют Vista (или позже). существует ли причина, почему Вы не хотели упаковывать свои приложения в установщике? Используя установщик облегчил бы "внешний источник" проблема. Вы были бы в состоянии использовать .chm файлы без любых проблем.
Мы используем InstallAware для создания наших пакетов установки. Это не дешево, но очень хорошо. Если стоивший Ваше беспокойство, , WIX является открытым исходным кодом и довольно устойчивый. WIX действительно имеет кривую обучения, но легко работать с.
PDF имеет недостаток требования Adobe Reader
, я использую Читатель Foxit в Windows дома и на работе. Намного меньший и очень быстрый для открытия. Очень удобный, когда Вы задаетесь вопросом, что точно a80000326.pdf и почему это забивает Вашу папку документов.
Я думаю решение, с которым мы собираемся закончить тем, что шли для нашего приложения, размещает справочные файлы сами. Это предоставляет нам немедленный доступ к файлам и способности усовершенствовать их.
то, Что я планирую, должно иметь содержание, загруженное в огромную серию XML-файлов, каждый содержащий справку для определенного объекта. Этот XML содержал бы ссылки на другие XML-файлы. Мы использовали бы XSLT для отображения содержания по мере необходимости.
В зависимости от лицензирования, мы можем создать определенный для клиента файл XSLT для адаптации стиля в соответствии с тем, в чем они нуждаются. Мы, возможно, должны быть в состоянии только показать справку для конкретных версий нашего продукта также и который может быть сделан путем отфильтровывания материала в XSLT.
Я использую коммерческий пакет под названием AuthorIT, который может генерировать много различных форматов, таких как председатель, HTML, PDF, слово, справка окон, xml, xhtml, и некоторые другие, о которых я никогда не слышал (делает dita, звонят в звонок?). Это - система управления контентом, ориентированная к потребностям писателей технической документации. Преимущество состоит в том, что можно использовать и снова использовать то же содержание, чтобы создать ряд руководств, и затем генерировать их в различных форматах.
Так нижняя строка относительно вопроса выбирающего председателя или HTML или независимо от того, что то, что при использовании этого Вы не заблокированы в данный формат, но можно обеспечить несколько, среди которых может выбрать пользователь, и можно даже добавить больше форматов, как Вы продвигаетесь без дополнительной платы.
, Если у Вас просто есть одно руководство для создания его, не будет стоить Вашего, в то время как, но если Вам установили документацию для управления тогда им, является лучшим к моему знанию. Их поддержка очень полезна также.
Мне не нравится вариант html, и я фактически перешел с простого HTML на CHM, сжав и проиндексировав их. Даже использовать их на горстке клиентов, не использующих Windows. Он просто решил постоянную небольшую поломку людей, подключающих его к сети (ограниченная глубина вложенности, странные эффекты блокировки), антивирус, который умер в каталогах с 30000 html-файлами, и 20-минутное время декомпрессии при установке на более старую систему, зоны безопасности браузера и функции, просчеты необходимого места в установщике и т. д.
Я даже не включаю людей, которые начинают их «исправлять», сторонний продукт с ошибочными попытками «интеграции» и т. д., жалобы на медлительность (запуск браузера )
Мы все годами ждали, когда проблемы исчезнут по мере улучшения операционных систем и оборудования, но проблемы продолжали повторяться в огромном количестве разновидностей, и этого было достаточно. Мы нашли chmlib и решили, что можем вечно использовать что-то, основанное на этом, как побег с помощью простого внешнего считывателя, если предоставленные ОС перестали работать и переключались.
Между тем у нас также есть собственный компилятор, так что мы свободны от MS в будущем. Это не значит, что мы никогда не изменимся (решения с локальными веб-серверами кажутся сейчас фаворитами), но, по крайней мере, у нас есть выбор.