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 would like to create a documentation website from C# XML documentation comments.
An example from the Python community. This Scipy documentation is created from this python code using a tool named Sphinx.
Is anything like that possible for a C# project?
Example of XML documentation comments in a .NET project (not mine) https://github.com/haf/NodaTime/blob/master/src/NodaTime/Period.cs#L26
/// <summary>
/// Represents a period of time expressed in human chronological terms: hours, days,
/// weeks, months and so on. All implementations in Noda Time are immutable, and return fields
/// in descending size order: hours before minutes, for example.
/// </summary>
public sealed class Period : IEnumerable<DurationFieldValue>, IEquatable<Period>
Edit: The full extent of advice I could find in other questions was 'use Sandcastle'. As far as I can tell from its (ironically limited) documentation, it can only create Windows help files (.chm). Is that correct?
Edit: The full extent of advice I could find in other questions was 'use Sandcastle'. As far as I can tell from its (ironically limited) documentation, it can only create Windows help files (.chm). Is that correct?
No, that's not correct. Sandcastle can build a wide range of output.
However, these days you really want Sandcastle Help-File Builder (SHFB) which makes things a whole lot better. Still not entirely painless, but pretty good. The documentation for SHFB is generally pretty reasonable, too.
Funny you should give an example of Noda Time - SHFB is precisely what we use to generate our online API reference.
You could also try sharpDox. Another free and open source documentation generator.
You are able to create html and chm output and soon word documents.
Here is an example for a html output.
P.S.: I am the creator of this tool.
For a one-click solution, you can also try our VSdocman.
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 2 years ago.
Improve this question
I have a task to convert the word document to PDF file. I need some process which could be done for free.Could any help me the process of converting the Word to PDF file for free with out Microsoft Interop ?
The sad truth is that you proberbly can't.
If it is a simple document with little styling and simple tables, or even less, then yes, you can proberbly find a free solution.
The paid solutions don't really work well either unless it's a somewhat simple document.
I was involved in a project where I made a document-generating system that had to prepare around 24.000 word documents in .docx and .pdf every day, and believe me we tried everything.
The free solution that almost kinda worked when the document did not contain any advances plots or tables was a java solution, docx4j.
We tried using Apose, Gembox and a bunch of others, but none of them could transform the advanced documents to a proper pdf without messing up the formatting.
Try converting something like this: example without using word. It won't work. Or at least it wouldn't approximately a year ago.
We ended up with setting up a dedicated document-server that hosts a very much abused Microsoft Word process that does nothing all day except generate and convert documents.
I would be very happy to discover the presence a decent free (or paid) alternativ. But my experience is that as soon as your document gets very complicated (see the example) no one knows .docx like Microsoft. And it sucks that they can't/won't just make a proper .dll you can include in your project for conversion, but that is the way it is.
If you have only small doc and docx files, you could use the free version of: GemBox.Document
If you want to convert your documents with all styles and so on, i think you have to buy a component. I've spent a lot of time searching for an open source solution, but could not find anything. GemBox.Document has a really good price/performance ratio.
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 8 years ago.
Improve this question
Last day in job I got pretty hard task. My task is to make new theme for our project (website). New theme should be rewritten to be fully responsive (actually it isn't). I have decided to use Bootstrap framework, because it is seems to be pretty nice, easy to learn and have good documentation with examples.
Today after reading most of documentation I tried to implement this. The only problem is that I tried to use it's main Less based version (which seems to have better support, cuz is main) to get better customizable themes (each theme can have it's own variables.less file) and I did not found good Less parser that work with .net MVC3.
Using JS to parse Bootstrap in not an option, because some of our customers have pretty old computers (Windows XP + IE8). I have tried to use dotless as a parser, but it had problems to handle Bootstrap, had problems with relative paths (problem with #include instruction) and was unable to load files from different directories (variables.less is in theme directory when rest of Bootstrap is shared).
If anyone can help me I will be very grateful, cuz today I spent ~8h and did totaly nothing.
You could try http://vswebessentials.com/
This nice Visual Studio plugin support LESS out of the box.
(http://vswebessentials.com/features/less)
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
Our C# source code is comprehensively documented using the usual Sandcastle/XML notation. We use SHFB to compile this into a MSDN-style documentation website.
We now need to*1 compile the documentation into a printable form. Ideally, we would like a PDF document but the specific format is less important than its printability. It is important, but not critical, that the documentation looks relatively professional and can be branded with the corporate logos, etc.
Is there a mostly pain-free way to do this? I don't think individually printing every page of the documentation website is a practical choice. The intermediate XML documentation files can, in principle, be transformed into a useable format but maybe there is already a viable and maintained solution for this task?
*1 - for reasons that I don't fully comprehend.
Is there a mostly pain-free way to do this?
No, DO not do it. It makes zero sense for a class level documentation - noone will ever read it. TAll hyperlinks do not work, would have to be changed to page references.
Our C# source code is comprehensively documented using the usual Sandcastle/XML notation.
No, it is not. It is documented the normal XML documentation notation. Sandcastle did not invent it.
NOw, if you really have to do it:
http://www.innovasys.com/products/dx2011/csdocumentation.aspx?cpid=gawdxcs&gclid=COiJq5To8qwCFQGHDgod900o0g
is pretty much the best you can get to. The are specialized in exactly that (multi target stuff). They also handle the additional pages etc. which is needed - the pure clas reference, without index, jsut printed, with hyperlinks instead of page references is basically tree destruction without any sense.
Apparently Help and Manual can import Sandcastle projects directly and then output them in various formats (including printable ones).
I haven't tried this myself, though. I'd be interested to hear experiences from anyone who has.
Ndoc has a Latex documentor plug-in. NDoc supports all documentation tags supported by Sandcastle, so that should be able to compile the documentation into a Latex file. This can then be used to create, for example, a Postscript document for printing.
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
Does anyone know of source code, ideally in C# or similar, for reading .DXF files (as used by AutoCAD etc)? If not code, then tables showing the various codes (elements / blocks / etc) and their meanings?
I am writing a reader myself, and have dead tree documentation detailing the format, but am trying to avoid writing e.g. a converter from each of the 255 ACI colours to RGB... Thanks!
I have work a couple of years at developing my own DXf-Viewer in java (you could drop your own DXF file or an URL on the viewer) for 2D drawings. The published information from AutoCAD is a good base but doesn't explain how it works. Becoming member of the Open Design Alliance, will give you the possibility to convert several CAD formats to DXF. It may be a good idea if you are developing a commercial product.
There is a german book (http://www.crlf.de/Verlag/DXF-intern/DXF-intern.html) about DXF which really explain this format. It's expensive, but could save days of search.
The colors in the DXF Format are indexed, you must have a converter from ACI to RGB. Be careful with values 0 and 1 which having a special meaning.
Regards.
Cadlib from WoutWare have I been using for a couple of projects with good results.
Update in case someone is still looking...
It's the same library, just including both links.
https://github.com/haplokuon/netDxf
https://www.nuget.org/packages/netDXF/
Fortunately AutoCAD publish the DXF format information here: DXF Formats
You may want to try the Open Design Alliance. It's a while since I looked at it myself, but they had a load of C libraries for dealing with various AutoCAD files.
Here is a link to a CodeProject dxf reader; it seems very limited (and not particularly well done) though.
Here is another open source dxf reader, in Java. Buggy however!
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 8 years ago.
Improve this question
Firstly, I realise that this is a very similar question to this one: Which are the good open source libraries for Collective Intelligence in .net/java?
... but all the answers to that one were Java centric so I am asking again, this time looking more for .Net (idealy C#) ideas.
A little background; I recently read Toby Segran's excellent book on CI, and I just got hold of Satnam Alag's book (which I am sure is also excellent, but I have only just opened it). These are Python and Java centric, I don't have any trouble reading the code samples, but as I am a C# developer it would be fun to play with some of these ideas in my native language. I've had a search of the web and SO and not come up with too much. In a way this is great news, maybe I could port something to .Net (suggestions welcome), but I'd also really like to take a look at any existing projects before I do this.
So, are there an CI fans out there working in .Net with OS projects, have I missed some glaringly obvious and interesting books/sites/blogs?
I realise CI is a pretty broad field, so to narrow it down a little I am primarily interested in the clustering / prediction /recommendations areas, but am open to other ideas.
Edit: Just spotted this book about to be published by Manning which may interest CI fans: Algorithms of the Intelligent Web.
Edit Clarification in response to comment by Moose; what I am looking for really is libraries, frameworks or larger-scale projects (idealy OS) that use CI techniques with .Net. Code samples are great, but as Moose said in his comment it is easy enough to take Java examples and port them. For example, there is an interesting looking project written in Java called WEKA, there is no reason I can't use this and experiment with it, I was just curious to know if there were similar things going on in .Net. I have just been browsing info on Lucene and I see that there is a C# port of that, so that's a start... are there any more out there?
Edit This is not C#, but it is .Net; Robert Pickering has started collection F# CI resources here. Looks interesting, but I'm still looking for C# info too.
Here's a link for a slope one predictor for rating-based collaborative filtering:
C# Implementation of Slope One
Microsoft Research ( full disclosure: I work at Microsoft, though not in the group that released this tool ) has just released a machine learning library in .NET called Infer.NET.
link text
You might want to check it out.
This library has:
Supervised
Perceptron
Kernel Perceptron
KNN
Decision Trees
Unsupervised
Hierarchical Clustering
KMeans
It is called Machine Learning for .NET.