Preview: Better File Management with Projects

Live Documenter allows you to load a solution, project file or assembly and immediately view the XML comments as documentation. But what if you have your public API libraries spread across multiple solutions or projects? In the past you would have to create a new project or switch between libraries, but with the new documentation projects and project management features. Managing which libraries are documented has become as easy as exporting your documentation with Live Documenter. What are documentation projects? Live Documenter projects allow you to add and remove libraries, set project specific settings such as which members should be filtered and where the documentation be published to. And to save these settings to a project file which can easily be opened from your file system or through the Live Documenter interface. How will documentation projects work? After opening a solution, project or library you can see the add and remove toolbar icons are available. You can add a solution, project or file and it will merge the libraries together under a single documentation set. Remove shows you a list of assemblies in the documentation and allows you to remove them one by one. You will see the effects of adding and removing libraries immediately. After you have configured your documentation you can save this as a Live Documenter project file. The project file also stores other information about your documentation and how you wish to view it. It stores the current build configuration being viewed, the filters being applied and where the documentation is being published to. Documentation projects simplify how you manage the documentation for your projects by:...

Live Documenter Export goes to Alpha

To celebrate the release of Live Documenter to alpha testing, we are going to give you a preview of some of the changes and enhancements over the next few weeks. To start, here is a preview of the export functionality. The Live Documenter has always been about quick and easy and we have been working to make sure you don’t have to suffer another 40 minute export. Quick exports and the ability to see your documentation without waiting for the export to complete make the Live Documenter great. Output Formats Currently Live Documenter can export to Web (HTML/XHTML), XML, HTML Help 1, HTML Help 2 and MS Help Viewer. These are based on an XSLT/XML conversion process which allows greater flexibility over the output and styling. The first set of exporters are styled in the lightweight MSDN website style. The web output is XHTML transitional but can be updated and extended easily to HTML 5. It is easy to style and customise (as are all the output formats). The Process One of the advantages of using the Live Documenter is that it is live, being able to see your documentation before its exported saves you time in the long run. So after you are happy with the documentation you can press that export button. When you click the export button you are presented with the export dialogue which gives you some very simple options. What is the output location, which members do you want to export and finally what kind of output would you like. All there is left to do is hit that Export button. You won’t have to wait to...

Update

Firstly; thanks so far to the 1500 people who have downloaded the Live Documenter. For your support and feedback. The Box Software is still working away behind the scenes on the export functionality. We are still looking at first quarter of this year release schedule. So over the next month or so you should start seeing some updates and previews on this website; and a notification via email when it is released for all our newsletter...

Live Documenter V1.0.1 Released

Wow things have been hectic here. Thanks to everyone for their feedback and to those who sent in error reports. It is really helping us to make this product even better. So thank you! Version 1.0.1 has been released adding stability and a few enhancements, including better error reporting so we can iron out any issues you may have. A full list of all of the fixes and enhancements can be found at the end of this post. But now… What’s coming up? Exporting. We understand that some people still need to export documentation for clients and websites etc. So we are now hard at work implementing exporting. But we would really like to here what it is you think lacks on other documenters or that you would like to see or not see in ours. We haven’t been at it long but we got too excited and wanted you to see some of the first glimpse from exporting websites. Let us know what you think on Twitter, User Voice or good old email. Version 1.0.1 of Live Documenter You can download your copy straight away. Download your FREE* copy. Email We hate spam too, and will not pass on your email address. * free for non commercial use. Version 1.0.1 changes Exception thrown when viewing projects using Microsoft Code Contracts Exception thrown in dutch locales (overlocalisation issue .NET WPF) Bug in back/forward navigation would occasionally lose your place Exception thrown attempting to load some unmanaged libraries Exception thrown when reading in some solutions (different version issue) Cannot close or cancel the error report dialogue Error after sending error...

Twitter

You can now follow The Box Software on Twitter. Keep up to date with the whats going on with the Live Documenter and let us know what you think of our software....

Merry Christmas and a Happy New Year

It has been a busy and hectic time over Christmas and now it’s time to get back to work. The Box Software are working to get the Live Documenter out of beta but can not stop adding new functionality to the application. Over the next week or two we will be releasing previews of some of this functionality, and there is loads to get excited about. So keep tuned. Also, we are still welcoming people on the Beta program so make sure to get...