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.
Related
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 4 years ago.
Improve this question
I'm currently trying to find a documentation (user guide) system that would have following features:
documentation files in text mode (so svn could diff/merge it)
possibility to use images, table, cross-references and table of
contents
export to pdf (or .doc/.odt) that would support cross-references
I tried markdown for documentation source files and pandoc for pdf export but markdown does not support tables.
I really appreciate any help you can provide.
We use Sphinx for this scenario.
It can generate html, pdf and some other formats from reStructuredText Files.
And have a look at list-table when you want to add complex tables.
I use the TeX for electonic and printable documentation
https://tex.stackexchange.com/
https://en.wikipedia.org/wiki/TeX
Probably the most commonly used solution set for documentation is XML in Docbook or DITA. You can certainly manage those in SVN as well as perform diffs. They both provide processing toolchains with many output types include PDF through XSL FO.
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 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've use javadoc, as well as a variety of different XML based doc-generation systems. Javadoc is fine, XML based doc-generators are hideous, with the XML getting all over the comments and turning the comments into soup.
I've looked at markdown, and the fact that it is easily parseable into structured data but also super human-readable would make it perfect for in-code comments, where the readability of both the docs and the plaintext is of utmost importance.
Are there any markdown based doc-generators out there already? Is there any reason why it wouldn't work which I don't know of?
There exits some Markdown-Doclets (f.ex. http://www.richardnichols.net/open-source/markdown-doclet/ ) which can be used with JavaDoc.
Maybe you are also interested in the famous doxygen tool. It doesn't use Markdown but the format is very similar to it (f. ex. unordered lists with - etc.).
You may try mdoc to generate Markdown based documentation. It reads all the .md files and produces HTML based documentation. It also creates a TOC. Check it out.
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 7 years ago.
Improve this question
Is there a free way to read PDF files through VBA to extract basic text content? I need to automate a weekly data acquisition process at my company where data is contained in PDF files (which are updated weekly by the data provider). Also, is there a reference I can look into to understand the file structure (DOM?) of a PDF?
Adobe's PDF reference is online here: http://www.adobe.com/devnet/pdf/pdf_reference.html
I'm not sure about the best way to read PDFs from VBA directly, but if you can call an external Java or C# program, then I would recommend using iText for basic text extraction.
EDIT: I should maybe mention that Adobe's PDF reference is an 800 page beast. I found that it's good for looking up answers to particular questions (eg, storing widths of embedded truetype fonts), but it may not be a good place to start. For that, reading through the iText book helped me to get started on the format.
The IText book contains lots of worked examples for general PDF tasks and lots of background info to help you understand PDF files. It more than pays for itself very quickly!
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.