Bug 23 - Add online help
Status:
RESOLVED LATER
Component:
GUI
Version:
unspecified
Hardware:
PC All
Importance:
P5 enhancement
Target Milestone:
future
Assignee:
Rob Caelers
URL:
Depends on:
Blocks:
Reported:
Sep 2 2002 20:04:46 UTC
by:
Kees-Jan Dijkzeul
Modified:
Aug 25 2003 03:09:07 UTC
WhoWhenWhatRemovedAdded
Raymond PennersSep 24 2002 13:10:25 UTCop_sysWindows NTAll
priorityP3P5
summaryDocumentation somewhat incompleteAdd online help
Raymond PennersSep 25 2002 23:14:28 UTCtarget_milestone---future
Rob CaelersOct 20 2002 12:26:11 UTCseveritynormalenhancement
Kees-Jan DijkzeulOct 22 2002 01:23:15 UTCcomponentCoreGui-Gtkmm
Raymond PennersOct 22 2002 01:57:40 UTCcomponentGUI :: gtkmmGUI
Raymond PennersAug 25 2003 03:09:07 UTCstatusNEWRESOLVED
resolutionLATER
Description
Kees-Jan Dijkzeul  Sep 2 2002 20:04:46 UTC
An overview of configuration options would be nice :-)
Comment 1
Raymond Penners  Sep 24 2002 13:10:25 UTC
Requirement: use native help mechanisms (Windows .HLP versus Gnome
Scrollkeeper?) on each platform.
Comment 2
Kees-Jan Dijkzeul  Oct 22 2002 01:23:15 UTC
If you know nothing about break-software, wr is very hard to understand. When
you start it, a window pops up with some icons whos meaning is not immediately
clear, and some progess-bar like widgets in all kinds of rainbow colors and some
digits counting down.

An overview of what these widgets mean would be helpful, as well as an
explanation of the ideas behind them.

Currently, wr is only usable if you are familiar with wp or some such program.
If we're going to attract new users, this situation should be improved.

I would recommend not diving into the details of native help mechanisms right
now, but instead generate some content first (for example web-based), and then
convert it to some more desirable format later.
Comment 3
Raymond Penners  Oct 22 2002 01:53:19 UTC
The native help mechanisms are not the problem here. The bulk of the work is
writing the documentation itself. And, if the documentation is written in
docbook it can be easily converted to HTML and other (online help) formats. 

So, regardless of what type of documentation your are going to write, be it for
the web or whatever, if you do so in docbook, adding online help using native
mechanisms is relatively easy to do.

Oh, I noticed your set the component from Core to Gui-Gtkmm. Both are wrong
actually, we need a "Gui" component.
Comment 4
Raymond Penners  Aug 25 2003 03:09:07 UTC
Let's be honest, this is not going to happen any time soon...