I've built plug-ins with both context-sensitive and "Table Of Content" help so I might be able to help out.
My strategy was to use DITA (http://dita-ot.sourceforge.net/, http://dita.xml.org) for constructing the help files, and it gives: o Good separation of content and layout (layout is dictated by CSS for Eclipse Help) o Enforces structure in the help pages by DTDs o Validats links between help pages (no links pointing to void in the pages) o Validates the table of content structure (no links to non-existing pages) o Generates different help formats, such as PDF, DocBook, RTF, Eclipse Help, Windows Help Using an XML editor, such as XML Buddy, which follows the rules specified in the DTD you can write help pages rather quickly. DITA basics: ========= The basic types in DITA are Topic, Concept, Task and Reference where the last three inherits from Topic. All 4 are specified by DTDs. Concept is used to describe something and I used it primarly for pages in the help menu. Task describes how to do something, such as the steps in a Wizard, and I used it for context-sensitive helps. Reference is pointing to other sources. So a topic is a help section The DITA map files, also XML, dictates the structure between Topic files and creates the Table of Content. The transformations to help files is done by ant tasks that runs the Topic through XSL files, which in the end produces the different help formats. It can be a bit tricky in the beginning to get the hang of the compilation steps, especially when DITA finds a problem with the files. Also, if you are not happy with the help structure you have to hack XSL files. The layout easy to change since it is defined in plain CSS files. Also, DITA does not help with context-sensitive help (at least not in version 1.4) so you still have to map your help context to html files by hand. /Tobias On Tue, Jun 10, 2008 at 11:36 PM, Anders Nawroth <[EMAIL PROTECTED]> wrote: > Hi! > > Peter Neubauer skrev: > >> this looks great, I think this would be good enough to put up an >> update site >> > > Yes, with information on the early stage of the project. This could be a > good way to get more input and ideas regarding Neoclipse. > > What I see as a top priority is to get started with setting up user help > that will be integrated into the plugin. I think setting it up is the > worst part ... (someone here have experience in doing this?) > > It's also important to test Neoclipse with a much greater number of > nodes/relations then I did so far. > > And we should get the Maven build stable, I can't get hte icons to >> load, otherwise things work there. >> > > The Neo icons or the "dynamic" ones? I didn't add the dynamic ones to > the repos yet ... > > I'm thinking about adding an "examples" package (src/examples) as I want > to add multiple examples, and don't think it's appropriate to have them > in the test package. What do you think? They won't actually perform any > tests, but enter different data into a node space. I could add the icons > there as well. > > Neo question: what's the easiest way to empty a node space completely? > (other than removing the files) > > > > /anders > > _______________________________________________ > Neo mailing list > [email protected] > https://lists.neo4j.org/mailman/listinfo/user > _______________________________________________ Neo mailing list [email protected] https://lists.neo4j.org/mailman/listinfo/user
