Короткая верхняя часть этого сообщения - это то, что я пытаюсь сделать. Вторая часть - это то, что было сделано до сих пор. Это очень долго, но вы должны уметь видеть, что я делаю с верхней части здесь. Просто проверьте заметки, если вы заинтересованы более подробно.Использование JavaHelp для документации для конечного пользователя в приложении, инструментах или плагинах на базе NetBeans, чтобы упростить его?
Я создаю приложение, использующее платформу NetBeans, как точку перехода. В предыдущей версии JavaHelp использовался для документации для конечного пользователя. Я в порядке с продолжением практики, когда я пишу всю новую документацию, но я нахожу недостаток, если информация о ее использовании.
Я догадался, как создать новый HelpSet & отношениями XML-HTML. Я могу сдать код в новых документах & применить скриншоты, но он выглядит очень ручным, и мне интересно, есть ли какие-либо плагины или инструменты для облегчения создания?
Выполнение некоторых Google-foo Я нахожу несколько сообщений по этой теме, но большинство из них относятся к 2003 году и теперь являются тупиками. Является ли использование JavaHelp устаревшим? Ниже я излагаю, что я сделал для любого назидания людей, ищущих одно и то же, и, возможно, кто-то может указать на неэффективность в том, как я это делаю.
Это не страшный подход, но вам нужно добавить строки в два файла XML для каждого загружаемого файла, а затем иметь длинный URL-адрес кода, который должен указывать на каждый раз, громоздкий для быстрого написания этого материала.
Спасибо за чтение.
Редактировать: У меня есть проблема. Я не знаю, как изменить начальную целевую страницу для JavaHelp. Сейчас он говорит: «В этом списке содержится вся документация, загруженная с помощью среды IDE, щелкните влево, чтобы прочитать ее». Это ничего не значит для моих конечных пользователей.
Кроме того, я не знаю, как изменить порядок тем слева. Сейчас они, похоже, не в каком-то полезном порядке. Я хотел бы по алфавиту или поместить их в какой-то полезный порядок.
В Netbeans щелкните правой кнопкой мыши по модулю New-> Other, щелкните по разделу «Разработка модуля», выберите «Набор справки JavaHelp». Это создаст новый пакет под модулем. Он будет следовать соглашению об именах вашего модуля и добавит .docs в конец. E.G org.netbeans.newmodule.docs.
В соответствии с этим он будет создавать 6 файлов:
package-info.java (package info file)
<modulename>-about.html (As seen HTML help file)
<modulename>-map.xml (creates a connection to the HTML pages (E.G about) to a target, used in making links & building the hierarchy for the table of contents)
<modulename>-toc.xml (Table of contents XML)
<modulename>-hs.xml (Specifies the Table of contents view & javax control, & index)
<modulename>-idx.xml (Controls the index)
Первый HTML файл исходной информации страницы. Это файл справки, который будет читать конечный пользователь. Это обычный HTML-код в определенном формате.
<modulename>-about.html
<!--
To change this template, choose Tools | Templates
and open the template in the editor.
-->
<html>
<head>
<title>About Module</title>
<link rel="stylesheet" href="nbdocs:/org/netbeans/modules/usersguide/ide.css" type="text/css">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<h2>About Module</h2>
<p>
<!-- TODO describe your module, add more pages... -->
</p>
</body>
</html>
<!--
Tip: to create a link which will open in an external web browser, try:
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.netbeans.org/">
<param name="text" value="<html><u>http://www.netbeans.org/</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
To create a link to a help set from another module, you need to know the code name base and path, e.g.:
<a href="nbdocs://org.netbeans.modules.usersguide/org/netbeans/modules/usersguide/configure/configure_options.html">Using the Options Window</a>
(This link will behave sanely if that module is disabled or missing.)
-->
Все, что может быть добавлено в <body> частей документа. Я работал с простым встроенным CSS и использовал теги <FONT>. Он также ссылается на внешний файл CSS, поэтому я предполагаю, что это тоже сработает. Вы можете ссылаться на другие файлы справки, указав путь. Путь всегда будет начинаться с nbdocs:/<yorumodulepath>
например: Any event added here will show up on the <a href="nbdocs:/com/mymodule/mod1/start/docs/start-about.html">start page</a>
Изображения могут быть связаны относительно, если они находятся в том же самом исходном пакете, JavaHelp.
например: <img src="startPageLogo.png">
файлы XML являются важными, поскольку они установка структуры справочной документации.
<modulename>-map.xml
Этот файл связывает файлы HTML с файлами nbdocs. Это позволит вам создавать ссылки внутри HTML-файлов в других местах файлов справки и правильно ли их открыть. & закрыть дерево JavaHelp. структура кажется: <mapID target="<com.yoruproject.modname" url="<htmlfilename/.html"/>
<?xml version="1.0" encoding="UTF-8"?>
<!--
To change this template, choose Tools | Templates
and open the template in the editor.
-->
<!DOCTYPE map PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp Map Version 2.0//EN" "http://java.sun.com/products/javahelp/map_2_0.dtd">
<map version="2.0">
<mapID target="com.mymodule.mod1.start.about" url="start-about.html"/>
<mapID target="com.mymodule.mod1.start.calevents" url="start-calevents.html"/>
<mapID target="com.mymodule.mod1.start.backupreminder" url="start-backupreminder.html"/>
</map>
<modulename>-toc.xml
Этот файл управляет структурой на левой стороне JavaHelp, что пользователь может использовать, чтобы развернуть в различных областях справочной документации. Формат идет как:
<toc version="2.0">
<tocitem text="Top Category">
<tocitem text="SubItem" target="com.mymod.mod1.start.about"/>
<tocitem text="SubCategory">
<tocitem text="SubCategoryItem1" target="com.mymod.mod1.start.backupreminder"/>
<tocitem text="SubCategory2" target="com.mymod.mod1.start.about">
<tocitem text="SubCategoryItem2" target="com.mymod.mod1.start.classifyreminder"/>
</tocitem>
</tocitem>
</tocitem>
</toc>
Вот пример полного файла:
<?xml version="1.0" encoding="UTF-8"?>
<!--
To change this template, choose Tools | Templates
and open the template in the editor.
-->
<!DOCTYPE toc PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp TOC Version 2.0//EN" "http://java.sun.com/products/javahelp/toc_2_0.dtd">
<toc version="2.0">
<tocitem text="Start Page">
<tocitem text="Getting Started" target="com.mymodule.mod1.start.about"/>
<tocitem text="Calendar Events" target="com.mymodule.mod1.start.calevents"/>
<tocitem text="Notification Pane">
<tocitem text="Backup Reminders" target="com.mymodule.mod1.start.backupreminder"/>
<tocitem text="New Classification Downloads" target="com.mymodule.mod1.start.backupreminder"/>
</tocitem>
</tocitem>
</toc>
<modulename>-hs.xml
я не связывайтесь с этим файлом еще. Похоже, что указано расположение Оглавления, IDX-файл для индекса и файл SearchView (который был местом Java по умолчанию).
<?xml version="1.0" encoding="UTF-8"?>
<!--
To change this template, choose Tools | Templates
and open the template in the editor.
-->
<!DOCTYPE helpset PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp HelpSet Version 2.0//EN" "http://java.sun.com/products/javahelp/helpset_2_0.dtd">
<helpset version="2.0">
<title>HMSStart Help</title>
<maps>
<homeID>com.mymodule.mod1.start.about</homeID>
<mapref location="start-map.xml"/>
</maps>
<view mergetype="javax.help.AppendMerge">
<name>TOC</name>
<label>Table of Contents</label>
<type>javax.help.TOCView</type>
<data>start-toc.xml</data>
</view>
<view mergetype="javax.help.AppendMerge">
<name>Index</name>
<label>Index</label>
<type>javax.help.IndexView</type>
<data>start-idx.xml</data>
</view>
<view>
<name>Search</name>
<label>Search</label>
<type>javax.help.SearchView</type>
<data engine="com.sun.java.help.search.DefaultSearchEngine">JavaHelpSearch</data>
</view>
</helpset>
Это слишком трудоемко, так как я не могу правильно его запечатлеть. Мое приложение в основном представляет собой набор модулей поверх Netbeans. Я удалил все файлы помощи Netbeans, и я создал HelpSet для каждого модуля. Но конечная оглавление в основном выглядит как дерьмо, а судоходство отстой. Но, как вы говорите, это может быть по пути, поэтому я проверю эти другие решения, которые вы выдвинули. – kevingreen
Вопрос ушел слишком долго, потому что, когда я продвигался вперед, я постоянно обновлял его.Я надеялся помочь любому, кто мог бы искать то же самое, начать работу над решением проблемы. – kevingreen