question about "help" content
Marc Esher
Thinking about the mxunit plugin lately, and I want to get my html
help files outta there and use the wiki exclusively. The problem, as I
see that, is that the help is no longer indexed and searchable.
I'm wondering; what's a good way of writing help in a wiki, but also
including static versions of that in the plugin? or is that just not
useful?
Thanks guys.
Marc
Steve Good
tools. Allows me to update help from a single location.
Sent from my iPhone
> --
> You received this message because you are subscribed to the Google Groups "CFEclipse Developers" group.
> To post to this group, send email to cfecli...@googlegroups.com.
> To unsubscribe from this group, send email to cfeclipse-de...@googlegroups.com.
> For more options, visit this group at http://groups.google.com/group/cfeclipse-dev?hl=en.
>
Marc Esher
So the problems with that are that it's not searchable, and not
available offline. The former is a sort of problem (maybe), and the
latter... I just dont' care much about at all. Am I wrong in thinking
that way?
Marc
Steve Good
mura tools isn't very complex...
If somebody wants to search then I'll show them to the wiki's search field.
Having offline help these days doesn't seem like much of an issue.
Seems like most projects will offer a PDF user guide if they offer
anything offline.
Sent from my iPhone
denstar
lucene maybe?), which makes whatever is in there accessible via the
eclipse help search.
I personally like offline stuff, which is a plus with git.
Maybe it's because my wireless router suxorz sometimes, or maybe it
was those 11 hours spent in that airport with no internet access...
but whatever the reason, I like offline access.
What I'm doing with CFE (and someday will finish), is using
Web-Harvest (http://web-harvest.sourceforge.net/) to scrape various
contents into the Eclipse help system as part of the build.
I've also got a CF wrapper for web-harvest, since it's pretty coolie-ohs. ;)p
I'm hoping that once it's part of the build, folks will have more
incentive to contribute to the wiki (to improve the built-in help),
but I must admit it's a small hope.
Mostly it's just to have an easy way to edit the help contents without
having multiple copies of it run'n 'bout and whathaveyou.
It's not really a big priority to finish it, but I got pretty far, and
it was straightforward enough that I thought I'd suggest it as an idea
(web-harvest is pretty flexible).
Don't think you're wrong in thinking that way though. :)
:Den
--
To acquire immunity to eloquence is of the utmost importance to the
citizens of a democracy.
Bertrand Russell
On Mon, Mar 28, 2011 at 7:36 PM, Marc Esher wrote:
> That's where I was gonna go with this.
>
> So the problems with that are that it's not searchable, and not
> available offline. The former is a sort of problem (maybe), and the
> latter... I just dont' care much about at all. Am I wrong in thinking
> that way?
>
> Marc
>
Marc Esher
I remember you were doing some scraping. It sounds like a great
idea. BUT: isn't the downside that you don't get the advantage of the
content being always updated? Because it's still static, right?
I am wondering if there is, indeed, no good compromise, and that you
have to pick static or dynamic. And if you pick static, go with
something like web-harvest?
Marc
Jim Priest
And you can always have a link that said "Current Help Online" and
point them to the web.
That said, have you looked on the Confluence site for solutions?
http://ffeathers.wordpress.com/2010/05/08/confluence-wiki-to-eclipse-help-the-easy-way-scroll-ftw/
Jim
Steve Good
All I need now are some help documents that aren't in video format!
___________
Steve Good
http://stevegood.org/
http://twitter.com/stevegood
http://muratools.com/