[Insight-users] updating softwareguide ?

[Luis Ibanez]

Hi Asamwm,


           This is an excellent idea !


and as you already pointed out,
it is fully consistent with the spirit of Open Source.


   We can think about it as a

               "Wikipedia for ITK".


The natural name that comes to mind is the

                "InsightClopedia"


So far we have used the ITK Wiki mostly for
coordination among developers and users,
but we have not used it for "community supported
documentation"

The nice thing is that we can start *right now,*
and all the infrastructure is already in place,
given that we can do this directly in the ITK Wiki.

Given that any user can get Wiki write access now,
(just need to perform an automatic email verification),
anybody willing to participate simply needs to get her/his
Wiki account, and we can start creating pages for
individual classes.

Note that we will also need pages for "groups" of classes
that work together. For example, in the Image Registration
framework.

I just created the top level page at

      http://www.itk.org/Wiki/ITK_InsightClopedia

and throwed an initial set of categories,
(that we will certainly have to reorganize latter).


At some point we may want to come-up with predefined
Wiki-macros, such as the ones used by the Wikipedia for
"countries", "atomic elements" and so on, in such a way
that we standardize the basic information about every
class.


   Please take a look at the top page and let us know
   what you think.


         Thanks


                Luis




-------------
PS. Note that we could still do a community-effort on the Software Guide
       itself, given that its it all in LaTeX, and it is hosted in the same
CVS
       repository as ITK. (it may be a good option to keep in mind....)




----------------------------------------------------------------------------------------------
On Wed, Jul 1, 2009 at 1:04 AM, 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
>>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.itk.org/pipermail/insight-users/attachments/20090701/7e9f0c7b/attachment.htm>