I agree. We have out hands full writing unit/system tests, developing new algorithms and tracking down bugs. We try to keep the docs up to date, but it's pretty hard to do. If people were willing to contribute short pieces of documentation for different tools that they are familiar with, we can try to put it together into something coherent. Nick: maybe this should be done in Doxygen format so we can paste it right into the code, which will of course help the open source effort?
thanks Bruce On Thu, 14 Aug 2008, Eliezer Kanal wrote:
That's a great idea. I know that would have been helpful for me when doing my first run-through.
Eliezer
On Aug 14, 2008, at 7:00 AM, Pádraig Kitterick wrote:
I think at least part (1) of Eliezer's list is possible with the existing content on the FS wiki. Specifically, now that the wiki is using MoinMoin v1.6 it is possible to export pages as latex (see http://moinmo.in/FormatterMarket for the formatter plugin) which would be a very fast way to put together an offline manual. Even if it only contained the install docs, recommended reconstruction, recon-all dev table, and perhaps some of the tutorial pages it would be very very useful and relatively easy to keep in sync with the wiki. Having that information in printed form beside you can really help. I'd be willing to help compile various pages into a nicely-formatted latex doc if you need.
Obviously, a reference manual would be fantastic in the longer term, but having written tonnes of code with too little documentation, even when I intended to document as I developed, I can understand the massive challenge that is comprehensive documentation. Is there something to be said of tackling the command list (http://surfer.nmr.mgh.harvard.edu/fswiki/FreeSurferCommands) one at a time through the mailing list to try to compile information about the options/syntax for each command? I'm thinking specifically about the 'Description' and 'Examples' sections. There is probably a lot of shared knowledge out there which has yet to be committed to the wiki...
-Padraig
Freesurfer mailing list Freesurfer@nmr.mgh.harvard.edu https://mail.nmr.mgh.harvard.edu/mailman/listinfo/freesurfer