I have an application, and now it's the time to write the user help document. I need at least 3 features:
An offline UserHelp.chm;
An online version index.html;
Clicking "help" on any winform can guide the user to a specified help page.
So what kind of tools (HTML workshop?) are perfect for my project, and how to do? I appreciate if you can give me some general guidelines.
For requirement #1 and #2, I recommend you to use SandCastle. It can generate chm file as well as ASP.NET pages. Most importantly, this project is still active and maintained by Microsoft.
For requirement #3, you can google "context sensitive help winform". You should be able to find a lot of references. Here is one of them from code project
If it must not be free of charge, I heard good things about Help & Manual: http://www.ec-software.com/
Helpware is another wellknown vendor: http://www.helpware.net/
Check out Helpinator, it's good too, but less expensive and has free edition.
Related
I work for a large company with agents all over the U.S. We want to upgrade our agents to Open Source office suite (Apache Open Office) from the chaotic mismatch of different versions used now. Problem is many of our people are barely computer literate.
I need to build a menu in Html to install the proper version on their systems from a DVD I have downloaded the files onto.
I can code some Html and some java but not a lot. It would help if it were cross browser since some use Macs but most use PCs.
I have researched for days and find many references to no access from the Web bit surely there is a way to do it offline?
Thanks in Advance.
I'm not sure that HTML is really what you want here. HTML is used to create web pages, but it's not a programming language and is not well suited to executing commands or performing tasks. JavaScript is the most common programming language used in web browsers, but you will have problems accessing a user's local file system for security reasons.
The best option I can think of is to give the installers appropriate names based on OS, and include documentation that clearly explains to users what they need to do. HTML may or may not be suitable for the documentation depending on your needs.
I want to thank everyone for their help.
Do to time restraints I believe the fastest solution is to do a simple text document in several forms describing the file choices and links to the files.
This way may not be eloquent but it is efficient.
Thanks for your time.
Hi i did my search but was not able to find a proper answer to my question. I am looking for a simle req. mgmt tool where I can assign unique ID s to each requirement and trace each ID to a test case. It is amazing that there are no solutions I can find out there. Excell and word does not cut it since I can not assign unique IDs and do traceability. I am hoping someone out there will have an answer.
Thank you all for your help.
I don't know if this convenient for you but I would suggest Trac. It is a nice open source tool whch you could setup in your own server. Please be aware that this is a general purpose issue management tool, and it is not adjusted to test cases management. It can also integrate with SVN and GIT source versioning tools. Trac is based on a ticket creation logic and on a wiki functionality. It also provides milestones, deadlines and other functionality related with the project management of a software project.
Hope I helped!
There is one that I'm using regularly to track requirement to code and requirement to test-case.
It's called reqflow and it's in Github:
http://goeb.github.io/reqflow/
Hope this help.
Just got started and running with jqMobi, which is now called 'intel's application framework' (cheesy name eh)
Along with intel's porting to their new site, they forgot to put the full docs online (at least I can't find it). Now there's only minimal documentation, like the getting started. I'd like to get on with it.
Anyone knows where the (full) docs are hosted? I really hate to go look for another framework again.
The documentation is all there. The only thing they did not add was the "testdrive", which is just the kitchen sink sample found in github
In my opinion the docs are somewhat scattered, but there's some helpful stuff if you can find it. I keep bookmarks for these links. There are some links from those that get you to more stuff.
http://html5dev-software.intel.com/documentation/jqmobiapis/index.html
http://app-framework-software.intel.com/documentation.php?r=9057
http://developer.html5dev-software.intel.com/
http://www.html5dev-software.intel.com/documentation/
Actually they split off where appMobi is a cloud services company to support apps, and Intel took the part to build the apps. So you may still need/want appMobi. Their docs are on their site of course. There is still some duplication on the appMobi site.
Technically I don't think jqMobi is the same thing as the Intel App Framework, but at the same time I have a hard time understanding what's called what anymore. I'm sure they'll clear this up over time. I hope they find names that can be useful tags on stackoverflow.com!
I am currently working on a database that contains two tables: tblAuthor and tblBooks. I am looking for a way to generate a timline look with a strong visual emphasis. I do not know all the possible oulets for creating reports in Access and any advice (including give up this isn't possible) would be welcome. I am hoping to format it similarly to a Gantt chart.
If there is anyway of doing this, or if you have any other suggestions please let me know!!
I work for a company that develops Gantt chart controls. We still develop, maintain and support an ActiveX Edition, which seamlessly integrates into Access. Here is an overview of some key features of the general control:
http://www.youtube.com/watch?v=gxc4-R1Kn_4&feature=plcp
If these features do what you want your Gantt to do, then you can download a free trial version from our website. You then should also download the samples collection as this also will provide you with an example of how to directly embed the control into Access. However, make sure that you download the ActiveX version (you have to register first before downloading): http://www.netronic.com/gantt/gantt-software/free-gantt-chart.html
Hope this helps. If you have questions, please send an email to support#netronic.de, and mention the stackoverflow post from Martin. Good luck with your project :-)
I need to write on-line help (Eclipse help format) for an Eclipse plugin. I tried out the evaluation of Help Composer that comes as part of RCP Developer from Instantiations and it pretty much does what I am looking for. However at $500 per license it's way overkill and over budget for my needs.
Surely there must be some other tool for managing the help project, assembling the various files, table of contents, and editing the html documents using WYSIWYG.
Does anybody have any suggestions for what plugin(s) I should add to a basic Eclipse 3.5 install to give me full authoring capability?
Thanks in advance!
I know that my solution is not entirely what you need, but you should have a look at Mylyn Wikitext .
It uses a simple markup with good editor support and is also capable of exporting to Eclipse Help format.
I gave up looking for free since all the available tools have a lot of shortcomings.
I decided to use Adobe RoboHelp 8 since it has one of the nicest editors that I found. However, the main benefit for me has been that it automatically updates links in all pages if I rename or move a topic (which I do a lot).
When I want to generate the Eclipse Help file, I use the script that they provide.
For a large documentation project, we used Latex in combination with plastex. This allowed us to generate PDF, Eclipse Help and HTML from the same sources. Cross Referencing, which seems like an issue for some readers, is handled, as well as indexing and other cool stuff. Getting it to work was a bit tedious, but it was a good solution, as the documentation contained a lot of formulas.
This was an open source project, so everything is available - feel free to use and adapt as you see fit:
Result (HTML, PDF, Eclipse Help: http://handbook.event-b.org/
Code: https://sourceforge.net/p/rodin-b-sharp/svn/HEAD/tree/trunk/Handbook/
I don't think it exists in eclipse, but try the MS one (free):
Here is the info: http://msdn.microsoft.com/en-us/library/ms670169(VS.85).aspx
Here is the download: http://www.microsoft.com/downloads/details.aspx?displaylang=en&FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc
Then you can convert to eclipse format: http://home.amnet.net.au/~ghannington/hh2e/hh2e-readme.html