[Insight-users] updating softwareguide ?

[Darren Weber]

It seems that a lot of the software guide is coded in the examples, using
comments in the example .cxx src.  Perhaps contributors for new classes can
develop simple examples with similar comments for inclusion in a regular
build for the software guide, to provide some degree of updating for the
guide.  It's fairly simple latex text in the comments.  I know most everyone
has learned M$ Word these days, but I would imagine latex is still prevalent
among the math and comp-sci community.  The advantage to this is that the
examples can be compiled and distributed with the src code, while the wiki
is not.

Take care,
Darren



On Tue, Jun 30, 2009 at 10:04 PM, asamwm <asamwm at gmail.com> wrote:

> Hi Luis,
> since this is all in the spirit of open source community,
> part of whose growth is credited to people from the
> community, why not create agree on an architecture
> for community-based documentation where everyone
> who participates in developing/evaluating/using a filter
> can contribute to the wiki. The journal is a stepping
> stone but the more detailed, elaborated documentation
> would be the wiki.
> There would be fixed sections such as:
> general purpose (what problem it attacks, image examples)
> advantages / why this one ,
> known disadvantages (why not),
> how it works (optimization),
> same category as in (list of other filters)
> see also (broader area)
> code snippets
> pitfalls
>
>
> I know one concern is to be careful not to misinform,
> but this is the beauty of open source. The community
> will correct falsehoods with time. Besides, this does
> not need to replace the itksoftwareguide since
> that one is specific to the basics.
>
> Just my 2c.
> I do not know how everyone feels about this.
> Please share.
> Regards.
>
>
> On Tue, Jun 30, 2009 at 3:06 PM, Luis Ibanez <luis.ibanez at kitware.com>wrote:
>
>>
>>
>> Hi Oliver,
>>
>>
>>
>> 1) Yes, the ITK Software Guide is overdue for an update.
>>
>>
>> 2) You can see a manifesto of new filters on the Wiki
>>   page of every release.
>>
>>   For example:
>>
>>     http://www.itk.org/Wiki/ITK_Release_3.14
>>     http://www.itk.org/Wiki/ITK_Release_3.12
>>     http://www.itk.org/Wiki/ITK_Release_3.10
>>     ....
>>
>>
>> 3) Yes, the ITK Software Guide will be updated,
>>   probably in the next year or two.
>>
>>
>> 4) Since 2006, All new classes in ITK must have been
>>   described in Insight Journal papers.
>>
>>   If you need information about a New class,
>>   there must be a paper in the Insight Journal
>>   describing this class.
>>
>>
>>   For example, the Chan and Vese level set filters
>>   are described in
>>
>>    http://www.midasjournal.org/browse/publication/322
>>
>>
>>
>>
>>  Regards,
>>
>>
>>     Luis
>>
>>
>> ----------------
>> Oliver Gloger wrote:
>>
>>> Hello together,
>>>
>>> Is it true that the SoftwareGuide did not change since 2005? On the other
>>> hand I can see from the mailing-list that there exist new filters now (i.e.
>>> itkScalarChanAndVeseSparseLevelSetImageFilter or other filters, which are
>>> not mentioned in the ITKSoftwareGuide). Will the ITKSoftwareGuide be
>>> updated? Where can I be informed about how to use new adjoined classes and
>>> filters in the ITK?
>>>
>>> best regards
>>> Oliver!
>>>
>>>
>>>
>>>  _____________________________________
>> Powered by www.kitware.com
>>
>> Visit other Kitware open-source projects at
>> http://www.kitware.com/opensource/opensource.html
>>
>> Please keep messages on-topic and check the ITK FAQ at:
>> http://www.itk.org/Wiki/ITK_FAQ
>>
>> Follow this link to subscribe/unsubscribe:
>> http://www.itk.org/mailman/listinfo/insight-users
>>
>
>
> _____________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
>
> Please keep messages on-topic and check the ITK FAQ at:
> http://www.itk.org/Wiki/ITK_FAQ
>
> Follow this link to subscribe/unsubscribe:
> http://www.itk.org/mailman/listinfo/insight-users
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.itk.org/pipermail/insight-users/attachments/20090630/454a37e4/attachment.htm>