Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 5 years ago.
Improve this question
We are trying to find a set of tools to generate context-sensitive help files (CHM) and manuals (CHM and PDF) from the same sources.
Features wanted are:
able to deal with linked hypertext
must be able to generate CHM and PDF from
should be able to integrate documentation generated from code (currently XML comments)
cross-file links would be great
source format being plain text (SCM diff-able) would be truly glorious
I suppose that just about every software shop must have run into this problem.
How do you do this?
What tools do you use?
What's your experience with those?
Edit: I thought every shop providing Windows software would have to solve this and many of you would have input for this. It seems I was wrong. although I still wonder how you all do this.
Anyway, thanks for the input of those who answered. We haven't decided yet, but this bounty runs out in a few hours. Unless someone comes in with a glorious suggestion, since the answer suggesting docbook got the most up-votes, I'll pick that one.
Have you considered DocBook? You can render that as just about anything. See this Code Project article for examples for CHM generation.
Check out Help And Manual http://helpandmanual.com/products_hm_features.html
I love this product
http://www.helpndoc.com/
You could achieve what you want if you implement the following:
1) Generate Html from XML
2) Generate CHM from Html
You can use Microsoft Html Help workshop to generate CHM files using Html, see: http://www.microsoft.com/downloads/details.aspx?familyid=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en
3) Generate PDF from Html using an Html-to-PDF tool.
Related
Closed. This question needs to be more focused. It is not currently accepting answers.
Want to improve this question? Update the question so it focuses on one problem only by editing this post.
Closed 5 years ago.
Improve this question
is there a possibility to convert a markdown written documentation (https://github.com/propelorm/propelorm.github.com) to a pdf file?
Thank you.
Can you print it? If so, use a PDF printer driver, perhaps CutePDF or similar.
Consider converting from Markdown to HTML, and then from HTML to PDF; I use Pandoc and DOMPDF respectively for each task. This approach allows you to apply styling using CSS. I tried converting directly, but didn't seem to have much luck.
I have some Markdown documentation which I convert as above using this script - I need to do a little more work on it, but I'm 99% happy with it. Give that a go?
If you get this working, ping me - it would be great to set up a simple site to mirror the official Propel docs with a PDF!
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I am looking into ways of documenting my code in a JavaDocs kinda way.
Any ideas?
I use UFT 11.52
So far I have seen NaturalDocs + Perl.
Any other ideas?
Thanks in advance.
At least one solution looks
practical,
mature,
is delivered in source code form (consists of one huge (but very professionally written) VBS script that generates the documentation fragments),
and is absolutely free:
VBSdoc, "A VBScript API Documentation Generator"
See http://www.planetcobalt.net/sdb/vbsdoc.shtml.
The author appears to be very competent, given his high SO rep (see https://stackoverflow.com/users/1630171/ansgar-wiechers), and the general quality of his website's content.
Of course, this one is built for standalone VBS scripts, not QTP/UFT scripts. But this should be no obstacle, given the source code is available.
I'd love to hear from you about experiences with this one. Feel free to edit them into this answer, be it accepted or not.
I had success using Natural Docs several years ago. It's one of the few things I blogged about: automated code documentation for QTP
There is a product called Test Design Studio, an IDE alternative for QuickTest and UFT. One of the key features it provides is the ability to generate detailed documentation. It uses XML-style comments to mark up your code, and those comments drive documentation. The same comments also drive detailed IntelliSense for editing your code.
It does exactly what you're talking about.
Test Design Studio
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 6 years ago.
Improve this question
I want to develop a plagiarism checker for checking several source codes but I couldn't find any proper source code or even a resource to get an idea about it.
I have checked the Boss2 which is useless. they claim that they use Sherlock module for detecting plagiarism but it seems there is no such tools included in boss2.
if any open source detection tool is available for checking source code please let me know.
regards
I'm aware of open-source plagiarism detectors for text (e.g., WCopyFind), but not code.
I couldn't find... even a resource to get an idea about it.
The authors of the excellent closed-source tool MOSS have published a helpful paper about the technology.
I know the question is old, but I did land here from a google.
Sherlock is an open source plagiarism detector. Sherlock's home page is here
I wrote SimiCheck, and you are welcome to use it. If you are interested in an API, I could probably write one very quickly.
I wrote the original algorithm as part of the CrowdGrader peer-grading tool, but then I decided to make the comparison tools available independently.
SimiCheck can handle code, Word (.docx), html, pdf, text, ..., as well as .zip, .tar, .gz, .tgz, and some more formats, and can deal with variable renaming, code moves, code across multiple files, etc.
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 5 years ago.
Improve this question
Currently I'm wrapping up an application at the moment, and I'm at the stage where I need to document the application for anyone who wants to use it.
At this point, I just need something that will tell users how to use my program. Even though I tried to design it as user friendly as possible, I have a group of users who aren't tech savvy and need something they can refer to.
So my question is basically: What can I do to easily create help files?
This answer will pretty much assume you're using some version of Microsoft Visual Studio, although the first approach is generic enough to work on any OS with a HTML rendering engine.
You could create a series of HTML files, store them locally on the user's computer, and when the user calls up help, load those in the default browser (this being the same kind of approach Microsoft took with Visual Studio 2010). However, I think that's kind of a hacky solution.
There used to be a product called HelpStudio Lite; unfortunately it's been discontinued.
If you're willing to use Microsoft Help 2.0 (which was used through Visual Studio 2008 and some other products), you might want to take a look at http://www.mshelpwiki.com/wiki/tiki-index.php?page=Help2. Evidently it's some kind of wiki detailing how to put together your own Help 2.0 documents. I'm not sure if it will work with Visual Studio 2010 (this is because VS 2010 uses a new help system).
I really wish Microsoft would get their act together on the help documentation front.
EDIT: You may want to look at Sandcastle Help File Builder. I found it recommended at https://stackoverflow.com/questions/6023/what-are-good-tools-for-creating-compiled-html-help-files-chm... actually you may want to go read that thread as well.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
At work we use Sandcastle for creation of help files. I have been using SandCastleGUI for some time and I'm looking for a way to create additional pages in the help file.
These pages are written in XML format called MAML.
The only problem is that I couldn't find any decent editor for these file format.
I'm looking for a WYSIWYG editor to create & edit additional documentation pages.
You could use a generic XML editor with WYSIWYG support like Oxygen or Serna. You would need a Xml Schema or DTD for MAML, I assume there is one somewhere in an SDK or such. Probably the harder part is that you would need a stylesheet that renders the XML to an display format that can be used by the editor to provide a WYSIWYG view of the document.
It works rather well for standard XML formats such as Docbook, but I don't know how easy it is to find/create the needed stylesheets for MAML. But generally there is no reason why it couldn't be done.
Finally I found a solution the good people of SandCastle Help File Builder have included an HTML to MAML converter.
There are many good HTML editorsout there - and now I can use one of them and then convert the result to MAML
Don't know if you are still looking for a solution to this, but I've been looking at help editors and ran across a codeproject article that might be useful. The article can be found at http://www.codeproject.com/KB/dotnet/DocMounter_2_Sandcastle.aspx. It features an editor that might be just what you need.