Changes between Version 33 and Version 34 of Page Templates/Workplan/Action


Ignore:
Timestamp:
2017-05-17T19:43:19+02:00 (3 years ago)
Author:
nicolasmartin
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Page Templates/Workplan/Action

    v33 v34  
    11= '''''{{action, Title, text, "{WG or INSTITUTE}-{NUM}_{PIS}" Subject}}''''' 
    22 
    3 The PI is responsible to closely follow the progress of the action, and especially to contact NEMO project manager if the delay on preview (or review) are longer than the 2 weeks expected.[[BR]] 
     3The PI is responsible to closely follow the progress of the action, and especially to contact NEMO project manager if the delay on preview (or review) are longer than the 2 weeks expected. 
    44 
    55== Help 
    66 
    77The action has to be detailed briefly in the 'Summary' sub-page (ordinary wiki page) for later inclusion in other pages. Out of this, the rest of the page can be edited on-line inside the form fields considering the following color code given hereafter. 
    8 {{{#!html 
    9 <b>Record your modifications for the section you have edited by clicking on the corresponding button at the end of the section with <input type="submit" value="Save ... "/> button. Just above, the timestamp of the record will be updated. 
    10 </b> 
    11 }}} 
     8 
    129{{{#!div class="important" 
     10Record your modifications for the section you have edited by clicking on the corresponding button at the end of the section with 'Save ...' button. Just above, the log record will be updated. 
     11 
    1312The informations inside the form fields and this wiki page itself are stored in 2 separate databases. As a consequence, there is absolutely no risk to make any modification in the page itself as long as you don't rename the page or modify the source code of `{{{#!TracForm ... }}}` processors. 
     13 
     14Edit the 'Summary' section as with an ordinary wiki page. 
     15* ''Italic formatting'' shows the default values or help. 
     16* `Pre-formatted formatting` shows syntax for specific TracLinks (development ticket and branch). 
    1417}}} 
    1518 
     
    2629   }}} 
    2730   {{{#!td style="background:lightgrey" 
    28       {{{#!td width="100px" style="background:lightgrey; border:none" 
    29          1. [#summary Summary] 
    30       }}} 
    31       {{{#!td width="100px" style="border:none" 
    32          2. [#abstract Abstract] 
    33       }}} 
    34       {{{#!td width="100px" style="border:none" 
    35          4. [#tests Tests] 
    36       }}} 
     31      1.[#summary Summary]\\ 
     32      2.[#abstract Abstract]\\ 
     33      4.[#tests Tests] 
    3734   }}} 
    3835   |- 
     
    4138   }}} 
    4239   {{{#!td style="background:lightblue" 
    43       3. [#preview Preview] 
     40      3.[#preview Preview] 
    4441   }}} 
    4542   |- 
     
    4845   }}} 
    4946   {{{#!td style="background:lightgreen" 
    50       5. [#review Review] 
     47      5.[#review Review] 
    5148   }}} 
    5249}}} 
    5350 
    54 == Summary [=#summary] 
    55  
    56 {{{#!div class="important" 
    57 Edit this 'Summary' section like an common wiki page. 
    58 * ''Italic formatting'' shows the default values or help. 
    59 * `Preformatted formatting` shows syntax for specific TracLinks (development ticket and branch). 
    60 }}} 
     51== Summary #summary 
    6152 
    6253|| '''Action'''       || {{action, Title, text, "{WG or INSTITUTE}-{NUM}_{PIS}" Subject}}                    || 
     
    7768|| '''Status'''       || ''!Pending/In progress/Postponed/Ready''                                            || 
    7869 
     70{{{#!comment 
     71DON'T REMOVE THIS VOID HEADING OR IT WILL BREAK THE INCLUDE FEATURE BETWEEN WIKI PAGES 
     72}}} 
     73==  == 
     74{{{#!comment 
     75DON'T REMOVE THIS VOID HEADING OR IT WILL BREAK THE INCLUDE FEATURE BETWEEN WIKI PAGES 
     76}}} 
     77 
    7978{{{#!Fold title=Abstract tag=h2 
    8079[=#abstract] 
     
    8281This section should be completed before starting to develop the code, in order to find agreement on the method beforehand. 
    8382 
    84 {{{ 
    85 #!TracForm 
     83{{{#!TracForm 
    8684#!subcontext abstract 
    8785#!submit_label 'Save Abstract' 
    8886#!keep_history yes 
    89 === Description === 
    90  [tf.textarea:description -id=piform -class=taform 'Describe the goal of development, and the methodology.\n\nAdd reference documents or publications if relevant.' 0 20] 
    91 === Implementation === 
    92  [tf.textarea:implementation -id=piform -class=taform 'Describe flow chart of the changes in the code.\n\nList the .F90 files and modules to be changed.\n\nDetailed list of new variables (including namelists) to be defined.\nGive for each the chosen name (following coding rules) and definition.' 0 20] 
    93 === Reference manual and web pages updates === 
    94  [tf.textarea:manual -id=piform -class=taform 'Using part 1 and 2, define the summary of changes to be done in the NEMO reference manual (tex files), and in the content of web pages.' 0 20] 
     87 
     88=== Description 
     89 
     90[tf.textarea:description -id=piform -class=taform 'Describe the goal of development, and the methodology.\n\nAdd reference documents or publications if relevant.' 0 20] 
     91 
     92=== Implementation 
     93 
     94[tf.textarea:implementation -id=piform -class=taform 'Describe flow chart of the changes in the code.\n\nList the .F90 files and modules to be changed.\n\nDetailed list of new variables (including namelists) to be defined.\nGive for each the chosen name (following coding rules) and definition.' 0 20] 
     95 
     96=== Reference manual and web pages updates 
     97 
     98[tf.textarea:manual -id=piform -class=taform 'Using part 1 and 2, define the summary of changes to be done in the NEMO reference manual (tex files), and in the content of web pages.' 0 20] 
    9599 
    96100'''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 
     101 
    97102}}} 
    98103 
     
    106111Since the preview step must be completed before the PI starts the coding, the previewer(s) answers are expected to be completed within the two weeks after the PI has sent his request.[[BR]]For each question, an iterative process should take place between PI and previewer(s) in order to reach a "YES" answer for each of the following questions. 
    107112 
    108 {{{ 
    109 #!TracForm 
     113{{{#!TracForm 
    110114#!subcontext preview_ 
    111115#!submit_label 'Save Preview' 
     116 
    112117|| Questions || Answer || Comment || 
    113118|| Does the previewer agree with the proposed methodology? || [tf.select:2.1 -id=preform '' Yes No NR] || [tf.textarea:2.1c -id=preform 'Add a comment?' 50 10] || 
     
    118123 
    119124'''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 
     125 
    120126}}} 
    121127 
     
    129135Once the development is done, the PI should complete this section below and ask the reviewers to start their review in the lower section. 
    130136 
    131 {{{ 
    132 #!TracForm 
     137{{{#!TracForm 
    133138#!subcontext tests 
    134139#!submit_label 'Save Tests' 
     140 
    135141|| Questions || Answer || Comment || 
    136142|| Can this change be shown to produce expected impact? (if option activated)? || [tf.select:3.1 -id=piform '' Yes No NR] || [tf.textarea:3.1c -id=piform 'Add a comment?' 50 10] || 
     
    147153 
    148154'''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 
     155 
    149156}}} 
    150157 
     
    156163A successful review is needed to schedule the merge of this development into the future NEMO release during next Merge Party (usually in November). 
    157164 
    158 {{{ 
    159 #!TracForm 
     165{{{#!TracForm 
    160166#!subcontext review 
    161167#!submit_label 'Save Review' 
    162 === Code changes and documentation === 
     168 
     169=== Code changes and documentation 
     170 
    163171|| Question || Answer || Comment || 
    164172|| Is the proposed methodology now implemented? || [tf.select:3.11 -id=revform '' Yes No NR] || [tf.textarea:3.11c -id=revform 'Add a comment?' 50 10] || 
     
    171179|| Is there a need for some documentation on the web pages (in addition to in-line and reference manual)?[[BR]]If yes, please describe and ask PI. A yes answer must include all documentation available. || [tf.select:3.18 -id=revform '' Yes No NR] || [tf.textarea:3.18c -id=revform 'Add a comment?' 50 10] || 
    172180|| ... ... ... || [tf.select:3.XX -id=revform '' Yes No NR] || [tf.textarea:3.XXc -id=revform 'Add a comment?' 50 10] || 
    173 '''__Review Summary__'''[[BR]] 
    174 Is the review fully successful?[tf.select:status -id=revform '' Yes No][[BR]] 
     181 
     182==== Review Summary 
     183 
     184Is the review fully successful? [tf.select:status -id=revform '' Yes No] 
     185 
    175186[tf.textarea:comment -id=revform 'If not, please indicate what is still missing.' 50 10] 
    176187 
    177188'''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 
     189 
    178190}}} 
    179191