Name | Modified | Size | Downloads / Week |
---|---|---|---|
Parent folder | |||
README_Help.md | 2023-07-04 | 2.4 kB | |
Totals: 1 Item | 2.4 kB | 0 |
sf.eclipse.javacc.help project description
History
Marc Mazas. Created 03/2021. 1.6.0.
The Help plug-in just stores source & generated files used to produce the JavaCC Eclipse Plug-in User Guide.
Source folders structure
It uses standard Eclipse Help plug-in structure:
- .externalToolBuilders
: the launch configuration created by Eclipse when adding an Ant builder to the project, for automatically generating the html and xml files on saving the textile source file (see inside the Ant script how to configure the project builder)
- .settings
: standard project settings files
- doc
: license file
- help
:
+ JavaCC Plug-in User Guide.textile
which is the source file in Mylyn Wikitext Textile format
+ the CSS file used by the generated html files
+ the generated html and -toc.xml files
+ an Eclipse linked file (xml, with no spaces in its name) pointing to the generated -toc.xml files
+ the contexts xml file
- img
: the image files for the Help (screenshots, navigation, drawings...)
- META-INF
: standard project META-INF files
- /
:
+ standard plug-in xml & project files
+ an Ant script for building html files
+ README file
Tips
When testing the plug-ins through Eclipse launch configurations, on Eclipse Neon (4.6.3), opening the Help produces tons of jetty DEBUG logs.
Eclipse Neon uses Jetty 9.3.9, and I get a multiple SLF4J bindings message.
I found no way to change the log level other than also change the logger.
I had to add the following properties in the VM arguments of the launch configuration:
-Dorg.eclipse.jetty.util.LEVEL=INFO
-Dorg.eclipse.jetty.util.log.class=org.eclipse.jetty.util.log.StdErrLog
Also Jetty complains about an invalid URL to the (generated) TOC file (spaces in its name). The way found to get rid of this error is to create a linked file with no spaces in its name pointing to the generated file.
The contexts file refers to page fragments (page#fragment), whose names are generated from the textile titles in the html files.
How to build
Build the html documents manually with the ant script build_help_html.xml or automatically with the corresponding Builder.
Build the project for the update site though Admin_Guide.