Sandcastle

A friend had told me about Sandcastle and I looked it up. Sandcastle is a project by Microsoft, that is intended to create MSDN-style documentation from .NET assemblies…

I had managed to achieve my goal quite easily using Sandcastle, and I thought about sharing my experience to serve other people as a guide. This is just a quick write-up of what I did – I did not read Sandcastle’s documentation and I believe that I don’t know how to operate it to its full potential.

1. The first step is to download and install Sandcastle.
2. Next, if you haven’t done it already, you have to tell Visual Studio to build XML documentation files. This parses all your comments ( in the C# format ///

etc…) and creates an XML file that we will feed into Sandcastle. To enable XML documentation, you have to go to Proect->(Project Name) Properties… and tick the relevant checkbox in the Build menu:builddoc


3. We will now launch the Sandcastle GUI application, located in C:\Program Files\Sandcastle\Examples\generic ( replace C:\Program Files with wherever you had installed Sandcastle).
4. Add your assemblies (exe/dll) and XML comments file to the relevant list boxes and choose the desired output format. Enter you project name under “Name”.
5. Hit “Build”. The build process can take a while, and it may seem like the program is frozen, but it’s not.
6. Your documentation files should now be ready in C:\Program Files\Sandcastle\Examples\Your Project Name
7. If you chose CHM as an output format, you will now have to compile the CHM file. To do this you need to download and install Microsoft HTML Help Workshop
8. After installing HTML Help Workshop, you will have to run hhc.exe (from the directory where you installed it). hhc takes an hhp (HTML Help Project) file as an argument. Sandcastle has created this hhp file for you, and it should be in your Sandcastle project directory. Just run “hhc yourproject.hhp” and this will produce a CHM file in the project’s directory.

That’s it. You should now have your compiled CHM help file with nice MSDN-style documentation.

As I mentioned earlier, I don’t really know Sandcastle and will be happy to get some tips in the comments section if you have any.

From here:
http://www.bonf.net/2009/03/04/create-c-documentation-using-sandcastle/

Scientific Peer Review, ca 1945

"How Putin Came to power part 1 Как Путин пришел к власти 1" (Watch on YouTube)

Heute ein Beitrag aus dem echten Forscherleben. Wir schreiben Artikel, diese werden an Magazine eingereicht. Dort wird von einem Editor entschieden, ob der Artikel prinzipiell zum Journal passt.

Falls ja, wird das Manuskript an zwei bis drei sogenannte Reviewer weitergeleitet. Die haben dann zwischen zwei Wochen und unendlich Zeit, die Qualität der Manuskripts zu beurteilen. Die Reviewer schicken ihre Bewertung zurück an den Editor, der entscheidet was mit dem Manuskript passiert. Es gibt grob drei Möglichkeiten:

1. Die Kritik der Reviewer war so verheerernd, dass das Paper direkt abgelehnt wird.

2. Die Kritik der Reviewer war sehr verhalten, so dass das Paper mit leichten Korrekturen publiziert werden kann.

3. Die Kritik der Reviewer war substanziell, dennoch entscheidet der Editor, dem Paper eine Chance geben zu wollen. Eine Major Revision steht an. Wie die Diskussion in etwa aussieht, nachdem die Antwort des Editors eingeht inklusive der detaillierten Kritik von drei Reviewern im Video unten. Die Untertitel zählen. Es ist immer der verdammte dritte Reviewer.