[Insight-developers] How to prepare ITKv4 XML Migration Guide pages

[Jim Miller]

Hey Luis, 

When you process these XML files, can there be multiple <SampleCode>, <MigrationFix-Automatic>, and <MigrationFix-Manual> sections?

This would be useful for the cases where we have a number of changes to describe related to one set of classes.

Jim

On May 29, 2011, at 9:43 AM, Luis Ibanez wrote:

> Hi Jim,
> 
> Following up on the discussion during the tcon,
> 
> 
> Here is the method for generating entries for the
> ITKv4 Migration Guide:
> 
>                  http://ij.itk.org/itkfaq/
> 
> 
> 1) Prepare Gerrit patches as usual.
> 
> 2) Review them, get them approved.
> 
> 3) Once approved, (and before merging them)
> 
>     on the git branch that contains the patch,
>     run the python script:
> 
>     .Documentation/Migration/InitializeXMLGuide.py
> 
>    It will ask you for a unique name to be used
>    for the generated XML file.
> 
>    Please be generous with the name length and
>    specificity because we probably will end up
>    with hundreds of these files.
> 
>    For example,
>    a good name for your changes could be:
> 
>    StatisticsFrameworkResolveDecisionRulesDuplicates.xml
> 
> 
> 4)  The python script will put the resulting XML file
>    in the directory:
> 
>                ./Documentation/Migration/
> 
>    at that point, you can edit it to document the details
>    of the change.
> 
>    You may want to pay particular attention at the sections
> 
>              A) Description
>              B) Sample Code
> 
>    Section (B) is what future applications developers
>    would want to see as the instructions on how to modify
>    the ITK 3.x-based code, to use ITKv4.
> 
> 
> 5)  Once you are satisfied with the descriptions,
> 
>    add this file to your branch,
> 
>    (git add, git commit --amend)
> 
>    and merge the approved branch
>    with the usual command
> 
>                 git    gerrit-merge
> 
> 
> 
> At that point, behind the scenes a Git hook
> will capture the XML file and will submit it to
> the ITK Migration Guide system online.
> 
>                  http://ij.itk.org/itkfaq/
> 
> If needed, you can do further edits to the
> online page as well.
> 
> 
> ---------------------
> 
> 
> More details about this process
> are available in the Wiki:
> 
> http://itk.org/Wiki/ITK_Release_4/What_Developers_Must_Do_To_Contribute_to_the_Users_Migration_Guide
> 
> 
> http://itk.org/Wiki/ITK_Release_4/Users_Migration_Guide
> http://itk.org/Wiki/ITK_Release_4/MigrationGuideDeveloperTutorial
> 
> 
>    Luis

Jim Miller
Senior Scientist
GE Research 
Interventional and Therapy

GE imagination at work

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.itk.org/mailman/private/insight-developers/attachments/20110531/ca3e1878/attachment.htm>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 3108 bytes
Desc: not available
URL: <http://www.itk.org/mailman/private/insight-developers/attachments/20110531/ca3e1878/attachment.bin>